Les noms de commandes
Définition
Un nom de commande ou une ligne de terminal doit rester exact et copiable. Les règles portent sur la chasse fixe, les tirets d’option, la casse, les espaces, les arguments, la ponctuation autour de la commande et les retours à la ligne.
Chasse fixe
Les commandes se composent généralement en chasse fixe pour signaler une saisie exacte. Les mots qui les entourent restent en texte courant.
Tapez npm install, puis lancez npm run dev.
La commande en chasse fixe, la phrase en texte courant.
Respect de la casse
La casse d’une commande, d’une option ou d’un argument doit être conservée. Une capitale ajoutée ou supprimée peut produire une commande différente.
Git Status
NPM run Dev
git status
npm run dev
Les commandes gardent leur casse exacte, presque toujours bas de casse.
Options et tirets
Les options de commande utilisent souvent un ou deux traits d’union. Ils ne doivent pas être remplacés par un tiret typographique ou un signe moins décoratif.
npm install —save
ls –la
npm install --save
ls -la
Traits d’union du clavier ; le tiret typographique rend l’option invalide.
Espaces entre arguments
Les espaces d’une commande sont significatifs pour la lecture et la copie. Les corrections automatiques ne doivent ni les supprimer ni en ajouter autour des signes techniques.
git commit-m "init"
git commit -m "init"
Chaque espace de la commande est significatif.
Ponctuation extérieure
La ponctuation de la phrase doit rester extérieure à la commande si elle n’en fait pas partie. On évite qu’un point final soit copié dans la commande.
Exécutez
git status,
Exécutezgit status.
La ponctuation reste hors de la zone copiable.
Guillemets dans les commandes
Les guillemets droits nécessaires à une commande doivent rester droits. Les guillemets typographiques peuvent rendre la commande incorrecte ou difficile à copier.
git commit -m “Initial commit”
git commit -m "Initial commit"
Guillemets droits obligatoires dans le shell.
Prompt, sortie et placeholders
Si un prompt est affiché, il doit être clairement distingué de la commande à copier. Dans une documentation pratique, on peut éviter le prompt pour faciliter la copie.
Les placeholders doivent être typographiquement distincts de la commande réelle et leur forme doit rester stable : chevrons, capitales ou style dédié selon la convention.
Exemple contexte
git checkout <nom-de-branche>
cp <source> <destination>
$ npm installprésenté comme texte à copier
npm install— le prompt$reste illustratif
Le prompt copié avec la commande la fait échouer : on l’omet ou on le distingue.
Retours à la ligne
Une commande courte reste sur une ligne. Une commande longue peut être coupée selon une convention explicite, sans insérer de trait d’union ni modifier les arguments.
npm rundev
npm run dev
Une commande courte reste sur sa ligne.