# 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.

:::note[En bref]
- **NOM-TS-01** · [Nommez un dossier d'écran en minuscules, mots reliés par des traits d'union](#nom-ts-01--nommez-un-dossier-décran-en-minuscules-mots-reliés-par-des-traits-dunion)
- **NOM-TS-02** · [Respectez les noms de fichiers imposés](#nom-ts-02--respectez-les-noms-de-fichiers-imposés)
- **NOM-TS-03** · [Nommez un composant en PascalCase, complet, et unique](#nom-ts-03--nommez-un-composant-en-pascalcase-complet-et-unique)
- **NOM-TS-04** · [Nommez un hook `use` + PascalCase](#nom-ts-04--nommez-un-hook-use--pascalcase)
- **NOM-TS-05** · [Nommez une fonction qui agit par un verbe à l'infinitif](#nom-ts-05--nommez-une-fonction-qui-agit-par-un-verbe-à-linfinitif)
- **NOM-TS-06** · [Déclarez un type avec `type`, jamais `interface`](#nom-ts-06--déclarez-un-type-avec-type-jamais-interface)
- **NOM-TS-07** · [Écrivez une constante de configuration en SCREAMING_SNAKE_CASE](#nom-ts-07--écrivez-une-constante-de-configuration-en-screaming_snake_case)
- **NOM-TS-08** · [Nommez un test unitaire `<module>.test.ts` et un parcours `<domaine>.spec.ts`](#nom-ts-08--nommez-un-test-unitaire-moduletestts-et-un-parcours-domainespects)
:::

## Les écrans et les fichiers

### NOM-TS-01 · Nommez un dossier d'écran en minuscules, mots reliés par des traits d'union

:::tip[Règle]
Un écran est un dossier en `kebab-case` qui contient `page.tsx`, `actions.ts` et ses composants. Pas de majuscule, d'accent, d'espace ni de souligné.
:::

| À é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é |

<span class="puce usage">Usage constaté</span> 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

:::tip[Règle]
`page.tsx` (écran), `layout.tsx` (cadre), `route.ts` (route d'API) viennent de Next.js. Le dépôt ajoute `actions.ts` (actions serveur de l'écran) et `contenu.tsx` (contenu client d'une page serveur).
:::

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.

<span class="puce usage">Usage constaté</span> Le dépôt la suit presque partout ; aucun document ne la décide encore.

## Les composants et les fonctions

### NOM-TS-03 · Nommez un composant en PascalCase, complet, et unique

:::tip[Règle]
Un composant dit ce qu'il montre. Son fichier est en `kebab-case` et porte le nom du sujet. Deux composants différents ne portent jamais le même nom exporté.
:::

| À é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` |

<span class="puce usage">Usage constaté</span> Le dépôt la suit presque partout ; aucun document ne la décide encore.

**Voir aussi.** [Reprendre un composant partagé](/regles/interface/)

### NOM-TS-04 · Nommez un hook `use` + PascalCase

:::tip[Règle]
Un hook s'écrit `use` suivi d'un PascalCase. Les hooks de React et de Next.js gardent leur nom.
:::

| À éviter | À faire |
| --- | --- |
| `fenetreHook`, `UseFenetre` | `useFenetre` |

<span class="puce usage">Usage constaté</span> 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

:::tip[Règle]
En `camelCase`. Une fonction qui agit commence par un verbe à l'infinitif ; une fonction qui lit se nomme par la chose ; un booléen se lit comme une question (`est…`, `a…`, `peut…`).
:::

**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` |

<span class="puce usage">Usage constaté</span> 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`

:::tip[Règle]
En `PascalCase`, sans préfixe `I` ni `T`, avec un nom complet et unique.
:::

| À é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` |

<span class="puce usage">Usage constaté</span> 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

:::tip[Règle]
Une constante de configuration, une liste fermée ou une table de correspondance : `SCREAMING_SNAKE_CASE`. Une valeur calculée ou une fonction fléchée : `camelCase`.
:::

| À é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/` |

<span class="puce usage">Usage constaté</span> Le dépôt la suit presque partout ; aucun document ne la décide encore.

## Les tests

### NOM-TS-08 · Nommez un test unitaire `<module>.test.ts` et un parcours `<domaine>.spec.ts`

:::tip[Règle]
Un cas se lit comme une phrase au présent qui dit le comportement attendu. Les utilitaires restent hors des motifs `*.test.ts` et `*.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 » |

<span class="puce usage">Usage constaté</span> Le dépôt la suit presque partout ; aucun document ne la décide encore.

## 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é |

## Voir aussi

- [Nommer les choses](/regles/nommage/)
