Aller au contenu principal

Ignorer du code

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 .prettierignore pour ignorer complètement (c'est-à-dire ne pas reformater) certains fichiers et dossiers.

Utilisez les commentaires « prettier-ignore » pour ignorer des parties de fichiers.

Ignorer des fichiers : .prettierignore​

Pour exclure des fichiers du formatage, créez un fichier .prettierignore à la racine de votre projet. .prettierignore utilise la syntaxe gitignore.

Exemple :

# Ignore artifacts:
build
coverage

# Ignore all HTML files:
**/*.html

Il est recommandé d'avoir un fichier .prettierignore dans votre projet ! Ainsi, vous pouvez exécuter prettier --write . pour vous assurer que tout est formaté (sans altérer les fichiers que vous ne souhaitez pas modifier ou bloquer sur des fichiers générés). De plus, votre éditeur saura quels fichiers ne pas formater !

Par défaut, Prettier ignore les fichiers dans les répertoires des systèmes de contrôle de version (".git", ".jj", ".sl", ".svn" et ".hg") et node_modules (sauf si l'option CLI --with-node-modules est spécifiée). Prettier suivra également les règles spécifiées dans le fichier ".gitignore" s'il existe dans le même répertoire à partir duquel il est exécuté.

Ainsi, par défaut, ce sera

**/.git
**/.svn
**/.hg
**/node_modules

et

**/.git
**/.svn
**/.hg

si l'option CLI --with-node-modules est fournie

(Voir aussi l'option CLI --ignore-path.)

JavaScript​

Un commentaire JavaScript // prettier-ignore exclura le nœud suivant dans l'arbre de syntaxe abstraite du formatage.

Par exemple :

matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

// prettier-ignore
matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

sera transformé en :

matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);

// prettier-ignore
matrix(
  1, 0, 0,
  0, 1, 0,
  0, 0, 1
)

JSX​

<div>
  {/* prettier-ignore */}
  <span     ugly  format=''   />
</div>

HTML​

<!-- prettier-ignore -->
<div         class="x"       >hello world</div            >

<!-- prettier-ignore-attribute -->
<div
  (mousedown)="       onStart    (    )         "
  (mouseup)="         onEnd      (    )         "
></div>

<!-- prettier-ignore-attribute (mouseup) -->
<div
  (mousedown)="onStart()"
  (mouseup)="         onEnd      (    )         "
></div>

CSS​

/* prettier-ignore */
.my    ugly rule
{

}

Markdown​

<!-- prettier-ignore -->
Do   not    format   this

Ignorer une plage​

disponible à partir de la v1.12.0+

Ce type d'ignorance est uniquement autorisé au niveau supérieur et vise à désactiver le formatage pour le contenu généré automatiquement, par exemple all-contributors, markdown-toc, etc.

<!-- prettier-ignore-start -->
<!-- SOMETHING AUTO-GENERATED BY TOOLS - START -->

| MY | AWESOME | AUTO-GENERATED | TABLE |
|-|-|-|-|
| a | b | c | d |

<!-- SOMETHING AUTO-GENERATED BY TOOLS - END -->
<!-- prettier-ignore-end -->

Important : Vous devez avoir une ligne vide avant <!-- prettier-ignore-start --> et <!-- prettier-ignore-end --> pour que Prettier reconnaisse les commentaires.

YAML​

Pour ignorer une partie d'un fichier YAML, # prettier-ignore doit être placé sur la ligne immédiatement au-dessus du nœud ignoré :

# prettier-ignore
key  : value
hello: world

GraphQL​

{
  # prettier-ignore
  addReaction(input:{superLongInputFieldName:"MDU6SXNzdWUyMzEzOTE1NTE=",content:HOORAY}) {
    reaction {content}
  }
}

Handlebars​

{{! prettier-ignore }}
<div>
  "hello! my parent was ignored"
  {{#my-crazy-component     "shall"     be="preserved"}}
    <This
      is  =  "also preserved as is"
    />
  {{/my-crazy-component}}
</div>

Modèles de fichiers en ligne de commande​

Pour des commandes ponctuelles, lorsque vous souhaitez exclure certains fichiers sans les ajouter à .prettierignore, les motifs d'exclusion (negative patterns) peuvent être utiles :

prettier . "!**/*.{js,jsx,vue}" --write

Consultez fast-glob pour en savoir plus sur la syntaxe glob avancée.