ST-NMG-002 - Convention d'affectation de noms des arguments

ID de règle : ST-NMG-002

Étendue : workflow

Description

Cette règle analyse tous les arguments du projet et détermine s'ils respectent la convention spécifique.

Les arguments dans le projet doivent suivre une convention d'affectation de nom spécifique pour faciliter la compréhension du projet et sa maintenance. Le nom de l'argument doit être significatif et inclure une indication concernant son type :

• in : l'argument ne peut être utilisé que dans le projet donné.
• out : vous pouvez utiliser l'argument pour transmettre les données en dehors d'un projet donné.
• io : l'argument peut être utilisé à la fois à l'intérieur et à l'extérieur d'un projet donné.

Recommandation

Assurez-vous que tous les arguments respectent la convention d'affectation de noms. L'expression Regex par défaut pour cette règle est :

• InRegex : ^in_(dt_)?([A-Z]|[a-z])+([0-9])*$
• OutRegex : ^out_(dt_)?([A-Z]|[a-z])+([0-9])*$
• InOutRegex : ^io_(dt_)?([A-Z]|[a-z])+([0-9])*$.

Selon l'expression Regex ci-dessus, l'argument correspond à l'expression si elle commence par un préfixe, suivi d'une minuscule ou d'une majuscule et d'un chiffre.

Par exemple, si le nom de l'argument dans le workflow est in_HelloWorld il est validé par la règle. Autres exemples de noms d'arguments qui respectent cette règle Regex : out_HelloWorld et io_Helloworld.

Modification de la règle

Dans la fenêtre Paramètres du projet (Project Settings), sélectionnez l'onglet Analyseur de workflow (Workflow Analyzer). Recherchez et sélectionnez la règle, comme sur l'image ci-dessous :

Dans la section Regex (Regex), ajoutez ou supprimez des caractères du modèle de recherche. Par exemple, si nous supprimons la partie [A-Z] de l'expression, le modèle de recherche devient ^in_(dt_)?([a-z])+([0-9])*$. La règle vérifie maintenant si les arguments d’entrée (In) commencent par une lettre minuscule après le préfixe.

Si nous ajoutons [a-z]|[A-Z]), la règle devient ^in_(dt_)?([A-Z]|[a-z]|[a-z]|[A-Z])+([0-9])*$, et reconnaît in_HelloWonderfulWorld comme nom d'argument d'entrée valide.

Exemples d'expressions Regex

L'expression Regex par défaut pour cette règle peut être remplacée par une autre convention d'affectation de noms. Consultez la liste ci-dessous :

Casse mixte

La convention de la casse mixte spécifie que chaque mot au milieu du nom de l'argument commence par une majuscule, sans espace ni ponctuation entre.

Exemple d'expression Regex : ^in_(dt_)?([A-Z]|[a-z]|[0-9])+([A-Z]|[a-z]|[0-9]).

Noms d'arguments valides : in_Hello1World2, in_helloWorld, in_Hello1World.

Casse Pascal

La convention d'affectation de la casse Pascal spécifie que le nom de l'argument doit contenir des mots en majuscules concaténés.

Exemple d'expression Regex : ^in_(dt_)?([A-Z]|[0-9])+([A-Z]|[a-z]|[0-9]).

Noms valides : in_Hello1World2, in_HelloWorld, in_Hello1World.

Casse Kebab

La convention d'affectation de noms de la casse Kebab est similaire à celle de casse Snake, sauf qu'elle remplace les espaces par des traits d'union plutôt que des traits de soulignement.

Exemples d'expressions Regex : ^in_(dt_)?([a-z]|[A-Z]|[0-9])+‐([a-z]|[A-Z]|[0-9])

Noms valides : in_Hello1‐World2, in_Hello‐World.

Rétablir les valeurs par défaut

Les valeurs par défaut pour l'expression régulière ST-NMG-002 sont :

• InRegex : ^in_(dt_)?([A-Z]|[a-z])+([0-9])*$
• OutRegex : ^out_(dt_)?([A-Z]|[a-z])+([0-9])*$
• InOutRegex : ^io_(dt_)?([A-Z]|[a-z])+([0-9])*$.

Pour réinitialiser ces valeurs par défaut, cliquez avec le bouton droit sur une règle dans la fenêtre Paramètres du projet (Project Settings), puis cliquez sur Rétablir les paramètres par défaut (Reset to default).