attribuer et inspecter les métadonnées de la fonction bash

Je génère et enregistre souvent un grand nombre de fonctions bash qui automatisent la plupart des tâches que je fais habituellement dans mes projets de développement. Cette génération dépend des métadonnées du projet sur lequel je travaille.

Je veux annoter les fonctions avec les informations du projet qu'elles ont été générées, de cette façon:

func1() {
# This function was generated for project: PROJECT1
echo "do my automation"
}

Idéalement, je serais en mesure de voir le commentaire lorsque j'inspecterai la définition:

$ type func1

func1 is a function
func1 () 
{
    # This function was generated for project: PROJECT1
    echo "do my automation"
}

Mais bash semble ignorer les commentaires au moment du chargement de la fonction, pas lors de son exécution. Donc les commentaires sont perdus et j'obtiens ce résultat:

func1 is a function
func1 () 
{
    echo "do my automation"
}

Existe-t-il un moyen d'affecter des métadonnées à des fonctions et de les vérifier ensuite? Il est possible de le récupérer lors de l'inspection de la définition avec le type?

function func_name()
{
  : '
  Invocation:   func_name $1 $2 ... $n
  Function:     Display the values of the supplied arguments, in double quotes.
  Exit status:  func_name always returns with exit status 0.
  ' :
  local i
  echo "func_name: $# arguments"
  for ((i = 1; i <= $#; ++i)); do
    echo "func_name [$i] \"$1\""
    shift
  done
  return 0
}

Oui, typesemble imprimer uniquement les parties d'une fonction qui seront exécutées. Cela me semble vraiment raisonnable, car c'est généralement tout ce qui vous intéresse lorsque vous interrogez type.

Pour contourner le problème, au lieu d'utiliser des commentaires, ajoutez vos métadonnées comme ceci:

func1() {
    meta="This function was generated for project: PROJECT1"
    echo "do my automation"
}

Il n'est pas nécessaire d'utiliser réellement cette variable, mais elle apparaîtra lors de l'interrogation de la fonction avec type:

$ type func1
func1 is a function
func1 () 
{ 
    meta="This function was generated for project: PROJECT1";
    echo "do my automation"
}

Vous pouvez utiliser le nop builtin :. De plus, vous n'avez pas besoin de le stocker en tant que variable:

function f() {
  : your metadata here
  : "or here"
  # do yours
}

EDIT : Méfiez-vous des caractères spéciaux dans vos métadonnées. Pour du texte pur, vous pouvez utiliser:

: <<EOT
Your metadata text here.
EOT

EDIT : Vous pouvez utiliser à la place un tableau associatif global pour stocker toutes les métadonnées de la fonction:

declare -A METADATA=()
METADATA[fun1]='foo bar'
function fun1() {
  echo I have some metadata: "${METADATA[$FUNCNAME]}"
}
METADATA[fun2]='baz you'
function fun2() {
  echo I have some other metadata: "${METADATA[$FUNCNAME]}"
}

De cette façon, vous n'avez pas besoin d'analyser declareou type« de la sortie, mais seulement pour la requête clé d'un tableau.

Tu peux le faire.

$ f() { This function does nothing. 2> /dev/null; }
$ f
$ type f
f is a function
f () 
{ 
    This function does nothing. 2> /dev/null
}