Nommer en TypeScript
Dossiers, fichiers, composants, fonctions, types, constantes et tests.
Pour chaque chose qu’on nomme : la forme, un exemple, et ce qu’il ne faut pas écrire. Le statut de chaque règle dit si elle est écrite, constatée ou à décider.
Les écrans et les fichiers
Section intitulée « Les écrans et les fichiers »NOM-TS-01 · Nommez un dossier d’écran en minuscules, mots reliés par des traits d’union
Section intitulée « NOM-TS-01 · Nommez un dossier d’écran en minuscules, mots reliés par des traits d’union »| À éviter | À faire |
|---|---|
app/PreparerUneTournee/, app/preparer_une_tournee/ |
app/preparer-une-tournee/ |
Un fichier utils.ts ou helpers.ts qui reçoit tout |
Les actions serveur de l’écran dans actions.ts |
Un composant d’un seul écran à la racine de app/ |
Le composant dans le dossier de l’écran ; à la racine seulement ce qui est partagé |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Exception. Un nom de collection s’écrit au pluriel (affaires), un nom d’objet ou d’espace au singulier (planning). Un segment dynamique dit ce qu’il désigne : [numero], [ref], [code].
NOM-TS-02 · Respectez les noms de fichiers imposés
Section intitulée « NOM-TS-02 · Respectez les noms de fichiers imposés »Aujourd’hui quelques écarts : un fichier d’actions à la racine de app/, des fichiers d’actions nommés par sujet. Un nouvel écran suit le motif.
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Les composants et les fonctions
Section intitulée « Les composants et les fonctions »NOM-TS-03 · Nommez un composant en PascalCase, complet, et unique
Section intitulée « NOM-TS-03 · Nommez un composant en PascalCase, complet, et unique »| À éviter | À faire |
|---|---|
Table, Tableau2, NouveauTableau |
TableauFiltrable dans tableau-filtrable.tsx |
Rattacher (trois composants différents portent déjà ce nom) |
RattacherLaFacture, RattacherLaJournee |
Formulaire pour deux formulaires différents |
Ajoutez ce qui les distingue : FormulaireDeDevis |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Voir aussi. Reprendre un composant partagé
NOM-TS-04 · Nommez un hook use + PascalCase
Section intitulée « NOM-TS-04 · Nommez un hook use + PascalCase »| À éviter | À faire |
|---|---|
fenetreHook, UseFenetre |
useFenetre |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
NOM-TS-05 · Nommez une fonction qui agit par un verbe à l’infinitif
Section intitulée « NOM-TS-05 · Nommez une fonction qui agit par un verbe à l’infinitif »Pourquoi. Les verbes les plus employés : poser, lire, retirer, creer, noter. Reprenez-les avant d’en inventer un autre.
| À éviter | À faire |
|---|---|
devisCreation, nouveauDevis, doCreate |
creerUnDevis |
voirComme, canViewAs |
peutVoirComme |
data2, tmp, res |
lignes, total, chemin |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Exception. Les noms de bibliothèque gardent leur orthographe : setOuvert d’un état React, error, data, router.
NOM-TS-06 · Déclarez un type avec type, jamais interface
Section intitulée « NOM-TS-06 · Déclarez un type avec type, jamais interface »| À éviter | À faire |
|---|---|
interface ILigne, type TLigne |
type LigneAFiltrer |
type Etat (trois types différents portent déjà ce nom) |
type EtatDeLaSaisie |
type Notif |
type Notification |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
NOM-TS-07 · Écrivez une constante de configuration en SCREAMING_SNAKE_CASE
Section intitulée « NOM-TS-07 · Écrivez une constante de configuration en SCREAMING_SNAKE_CASE »| À éviter | À faire |
|---|---|
const cleOrdreOperations = "…" |
const CLE_ORDRE_OPERATIONS = "…" |
export const NOMS_DES_ETATS = calculer() |
export const nomsDesEtats = calculer() |
Deux constantes POLICES de formes différentes |
Réutilisez celle de lib/ |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Les tests
Section intitulée « Les tests »NOM-TS-08 · Nommez un test unitaire <module>.test.ts et un parcours <domaine>.spec.ts
Section intitulée « NOM-TS-08 · Nommez un test unitaire <module>.test.ts et un parcours <domaine>.spec.ts »| À éviter | À faire |
|---|---|
test-semaine.ts, semaine.spec.ts pour un test unitaire |
semaine.test.ts |
| « should work », « test numéro », un nom de personne | « un numéro garde sa série, sans zéros de tête ni doublons » |
Usage constaté Le dépôt la suit presque partout ; aucun document ne la décide encore.
Référence rapide
Section intitulée « Référence rapide »| Règle | À retenir | Tenue par |
|---|---|---|
| NOM-TS-01 | Nommez un dossier d’écran en minuscules, mots reliés par des traits d’union | Usage constaté |
| NOM-TS-02 | Respectez les noms de fichiers imposés | Usage constaté |
| NOM-TS-03 | Nommez un composant en PascalCase, complet, et unique | Usage constaté |
| NOM-TS-04 | Nommez un hook use + PascalCase |
Usage constaté |
| NOM-TS-05 | Nommez une fonction qui agit par un verbe à l’infinitif | Usage constaté |
| NOM-TS-06 | Déclarez un type avec type, jamais interface |
Usage constaté |
| NOM-TS-07 | Écrivez une constante de configuration en SCREAMING_SNAKE_CASE | Usage constaté |
| NOM-TS-08 | Nommez un test unitaire <module>.test.ts et un parcours <domaine>.spec.ts |
Usage constaté |