Code ignorieren

Inoffizielle Beta-Übersetzung

Diese Seite wurde von PageTurner AI übersetzt (Beta). Nicht offiziell vom Projekt unterstützt. Fehler gefunden? Problem melden →

Verwenden Sie .prettierignore, um bestimmte Dateien und Ordner komplett zu ignorieren (d.h. nicht neu zu formatieren).

Verwenden Sie "prettier-ignore"-Kommentare, um Teile von Dateien zu ignorieren.

Dateien ignorieren: .prettierignore

Um Dateien von der Formatierung auszuschließen, erstellen Sie eine .prettierignore-Datei im Stammverzeichnis Ihres Projekts. .prettierignore verwendet gitignore-Syntax.

Beispiel:

# Ignore artifacts:
build
coverage

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

Wir empfehlen eine .prettierignore-Datei in Ihrem Projekt! So können Sie prettier --write . ausführen, um sicherzustellen, dass alles formatiert ist (ohne ungewollte Dateien zu verändern oder bei generierten Dateien Probleme zu verursachen). Und – Ihr Editor weiß, welche Dateien er nicht formatieren soll!

Standardmäßig ignoriert Prettier Dateien in Versionskontrollsystem-Verzeichnissen (".git", ".jj", ".sl", ".svn" und ".hg") und node_modules (sofern nicht die --with-node-modules CLI-Option angegeben ist). Prettier befolgt auch Regeln in ".gitignore"-Dateien, falls sie im selben Ausführungsverzeichnis existieren.

Standardmäßig gilt also:

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

und

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

falls die --with-node-modules CLI-Option angegeben wird

(Siehe auch die --ignore-path CLI-Option.)

JavaScript

Ein JavaScript-Kommentar // prettier-ignore schließt den nächsten Knoten im abstrakten Syntaxbaum von der Formatierung aus.

Beispiel:

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

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

wird transformiert zu:

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

Bereichs-Ignorierung

verfügbar ab v1.12.0+

Dieser Ignorierungstyp ist nur auf oberster Ebene erlaubt und dient dazu, die Formatierung automatisch generierter Inhalte zu deaktivieren, z.B. 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 -->

Wichtig: Vor <!-- prettier-ignore-start --> und <!-- prettier-ignore-end --> muss eine Leerzeile stehen, damit Prettier die Kommentare erkennt.

YAML

Um einen Teil einer YAML-Datei zu ignorieren, muss # prettier-ignore in der Zeile direkt über dem zu ignorierenden Knoten stehen:

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

Dateimuster in der Kommandozeile

Für einmalige Befehle, bei denen Sie Dateien ohne .prettierignore-Eintrag ausschließen möchten, sind Negativmuster praktisch:

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

Weitere Informationen zur erweiterten Glob-Syntax finden Sie unter fast-glob.