Interface en ligne de commande

Traduction Bêta Non Officielle

Cette page a été traduite par PageTurner AI (bêta). Non approuvée officiellement par le projet. Vous avez trouvé une erreur ? Signaler un problème →

Utilisez la commande prettier pour exécuter Prettier depuis la ligne de commande.

prettier [options] [file/dir/glob ...]

remarque

Pour utiliser votre version locale de Prettier, préfixez la commande avec npx, yarn exec, pnpm exec, ou bunx, par exemple npx prettier --help, yarn exec prettier --help, pnpm exec prettier --help, ou bunx prettier --help.

Pour formater un fichier directement, utilisez --write. (Attention : cela écrase vos fichiers !)

En pratique, cela pourrait ressembler à :

prettier . --write

Cette commande formate tous les fichiers pris en charge par Prettier dans le répertoire courant et ses sous-répertoires.

Il est recommandé de toujours vérifier que prettier --write . ne formate que ce que vous souhaitez dans votre projet. Utilisez un fichier .prettierignore pour ignorer les éléments qui ne doivent pas être formatés.

Un exemple plus complexe :

prettier docs package.json "{app,__{tests,mocks}__}/**/*.js" --write --single-quote --trailing-comma all

avertissement

N'oubliez pas les guillemets autour des globs ! Les guillemets garantissent que Prettier CLI étend les globs plutôt que votre shell, ce qui est important pour une utilisation multiplateforme.

remarque

Il est préférable d'utiliser un fichier de configuration pour les options de formatage comme --single-quote et --trailing-comma plutôt que de les passer en drapeaux CLI. Ainsi, le CLI Prettier, les intégrations d'éditeur et les autres outils connaîtront vos options.

Modèles de fichiers

Étant donné une liste de chemins/modèles, le CLI Prettier traite d'abord chaque entrée comme un chemin littéral.

• Si le chemin pointe vers un fichier existant, le CLI Prettier traite ce fichier sans résoudre le chemin comme un glob pattern.

• Si le chemin pointe vers un répertoire existant, le CLI Prettier recherche récursivement les fichiers pris en charge dans ce répertoire. Ce processus se base sur les extensions de fichiers et les noms de fichiers connus que Prettier et ses plugins associent aux langages supportés.

• Sinon, l'entrée est résolue comme un glob pattern en utilisant la syntaxe glob du module fast-glob.

Prettier CLI ignore par défaut les fichiers dans node_modules. Pour désactiver ce comportement, utilisez le flag --with-node-modules.

Le CLI Prettier ne suivra pas les liens symboliques lors de l'expansion des arguments.

Pour échapper les caractères spéciaux dans les globs, deux syntaxes d'échappement sont possibles : prettier "\[my-dir]/*.js" ou prettier "[[]my-dir]/*.js". Les deux correspondent à tous les fichiers JS dans un répertoire nommé [my-dir], mais la seconde syntaxe est préférable car la première ne fonctionne pas sous Windows où les backslashes sont traités comme séparateurs de chemin.

--check

Pour vérifier si vos fichiers sont formatés, exécutez Prettier avec le drapeau --check (ou -c). Cela affichera un message explicite et la liste des fichiers non formatés, le cas échéant.

prettier . --check

Sortie console si tous les fichiers sont formatés :

Checking formatting...
All matched files use Prettier code style!

Sortie console si certains fichiers nécessitent un reformatage :

Checking formatting...
[warn] src/fileA.js
[warn] src/fileB.js
[warn] Code style issues found in 2 files. Run Prettier with --write to fix.

La commande renverra le code de sortie 1 dans le second cas, utile dans les pipelines CI. Les messages d'état explicites aident les contributeurs à réagir aux problèmes potentiels. Pour minimiser les occurrences où prettier --check trouve des fichiers non formatés, vous pouvez configurer un hook pre-commit dans votre dépôt. Cette pratique réduira les échecs CI dus à des problèmes de formatage.

Pour rediriger la liste des fichiers non formatés vers une autre commande, utilisez le drapeau --list-different au lieu de --check.

Codes de sortie

Code	Information
0	Everything formatted properly
1	Something wasn’t formatted properly
2	Something’s wrong with Prettier

--debug-check

Si vous craignez que Prettier modifie la correction de votre code, ajoutez --debug-check à la commande. Cela fera en sorte que Prettier affiche un message d'erreur s'il détecte un impact potentiel sur la correction du code. Notez que --write ne peut pas être utilisé avec --debug-check.

--find-config-path et --config

Lorsque vous formatez des fichiers individuels avec prettier, vous subissez un léger coût de performance pendant la recherche du fichier de configuration. Pour éviter cela, vous pouvez demander à Prettier de trouver le fichier de config une fois et le réutiliser ultérieurement.

$ prettier --find-config-path path/to/file.js
path/to/.prettierrc

Cette commande vous fournira le chemin vers le fichier de configuration, que vous pouvez passer à --config :

prettier path/to/file.js --write --config path/to/.prettierrc

Vous pouvez également utiliser --config si votre fichier de configuration se trouve dans un emplacement non détectable par Prettier, comme un dossier config/.

Si vous n'avez pas de fichier de configuration ou souhaitez l'ignorer s'il existe, utilisez --no-config.

--ignore-path

Chemin vers un fichier contenant des motifs de fichiers à ignorer. Par défaut, Prettier recherche ./.gitignore et ./.prettierignore.
Plusieurs valeurs sont acceptées.

--list-different

Une autre option utile est --list-different (ou -l) qui liste les fichiers dont le format diffère de celui appliqué par Prettier. S'il y a des différences, la commande renvoie un code d'erreur, utile dans un contexte d'intégration continue (CI).

prettier . --single-quote --list-different

Vous pouvez aussi utiliser le flag --check, qui fonctionne comme --list-different mais affiche en plus un résumé compréhensible sur stdout.

--no-config

Ne pas rechercher de fichier de configuration. Les paramètres par défaut seront utilisés.

--config-precedence

Définit la priorité entre le fichier de configuration et les options CLI.

cli-override (défaut)

Les options CLI priment sur le fichier de configuration

file-override

Le fichier de configuration prime sur les options CLI

prefer-file

Si un fichier de configuration est trouvé, il sera utilisé en ignorant les options CLI. Si aucun fichier n'est trouvé, les options CLI s'appliquent normalement.

Cette option ajoute un support pour les intégrations d'éditeurs où les utilisateurs définissent leur configuration par défaut mais souhaitent respecter la configuration spécifique au projet.

--no-editorconfig

Ignore le fichier .editorconfig lors du chargement de la configuration. Voir la documentation prettier.resolveConfig pour plus de détails.

--with-node-modules

Prettier CLI ignore par défaut les fichiers dans node_modules. Pour désactiver ce comportement, utilisez le flag --with-node-modules.

--write

Réécrit tous les fichiers traités directement. Similaire au workflow eslint --fix. L'alias -w est également disponible.

--log-level

Modifie le niveau de journalisation de l'interface CLI. Options valides :

• error

• warn

• log (défaut)

• debug

• silent

--stdin-filepath

Chemin vers un fichier que l'interface CLI de Prettier traitera comme une entrée standard (stdin). Par exemple :

abc.css

.name {
  display: none;
}

shell

$ cat abc.css | prettier --stdin-filepath abc.css
.name {
  display: none;
}

--ignore-unknown

Avec --ignore-unknown (ou -u), Prettier ignorera les fichiers inconnus correspondant aux motifs.

prettier "**/*" --write --ignore-unknown

--no-error-on-unmatched-pattern

Empêche les erreurs lorsque le motif ne correspond à aucun fichier.

--cache

Lorsque cette option est activée, les valeurs suivantes servent de clés de cache et le fichier n'est formaté que si l'une d'elles change :

• Version de Prettier

• Options

• Version de Node.js

• (si --cache-strategy est metadata) métadonnées du fichier, comme les horodatages

• (si --cache-strategy est content) contenu du fichier

prettier . --write --cache

Lancer Prettier sans --cache supprimera le cache.

De plus, comme le fichier de cache est stocké dans ./node_modules/.cache/prettier/.prettier-cache, vous pouvez utiliser rm ./node_modules/.cache/prettier/.prettier-cache pour le supprimer manuellement.

avertissement

Les versions et implémentations des plugins ne sont pas utilisées comme clés de cache. Nous recommandons de supprimer le cache lors de la mise à jour des plugins.

--cache-location

Chemin vers l'emplacement du fichier de cache utilisé par le flag --cache. Si vous ne spécifiez pas --cache-location, Prettier enregistre le cache à ./node_modules/.cache/prettier/.prettier-cache.

Si un chemin de fichier est fourni, ce fichier est utilisé comme cache.

prettier . --write --cache --cache-location=path/to/cache-file

--cache-strategy

Stratégie de cache utilisée pour détecter les fichiers modifiés. Peut être metadata ou content.

En général, metadata est plus rapide. Cependant, content est utile lorsque l'horodatage est mis à jour sans changement du contenu (par exemple lors d'opérations Git comme git clone, car Git ne suit pas les dates de modification).

Si aucune stratégie n'est spécifiée, content sera utilisé par défaut.

prettier . --write --cache --cache-strategy metadata