CLI

Inoffizielle Beta-Übersetzung

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

Verwenden Sie den Befehl prettier, um Prettier über die Kommandozeile auszuführen.

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

Hinweis

Um Ihre lokal installierte Prettier-Version auszuführen, setzen Sie den Befehl mit npx, yarn exec, pnpm exec oder bunx voran, z.B. npx prettier --help, yarn exec prettier --help, pnpm exec prettier --help oder bunx prettier --help.

Um eine Datei direkt zu formatieren, verwenden Sie --write. (Hinweis: Dies überschreibt Ihre Dateien!)

In der Praxis könnte das so aussehen:

prettier . --write

Dieser Befehl formatiert alle von Prettier unterstützten Dateien im aktuellen Verzeichnis und seinen Unterverzeichnissen.

Es wird empfohlen, stets sicherzustellen, dass prettier --write . nur das gewünschte in Ihrem Projekt formatiert. Verwenden Sie eine .prettierignore-Datei, um Elemente zu ignorieren, die nicht formatiert werden sollen.

Ein komplexeres Beispiel:

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

Warnung

Vergessen Sie nicht die Anführungszeichen um die Globs! Die Anführungszeichen stellen sicher, dass die Prettier-CLI die Globs erweitert und nicht Ihre Shell, was für plattformübergreifende Nutzung wichtig ist.

Hinweis

Es ist besser, eine Konfigurationsdatei für Formatierungsoptionen wie --single-quote und --trailing-comma zu verwenden, anstatt sie als CLI-Flags zu übergeben. Auf diese Weise wissen die Prettier-CLI, Editor-Integrationen und andere Tools, welche Optionen Sie verwenden.

Dateimuster

Bei einer Liste von Pfaden/Mustern behandelt die Prettier-CLI jeden Eintrag zunächst als wörtlichen Pfad.

• Zeigt der Pfad auf eine existierende Datei, verarbeitet die Prettier-CLI diese Datei und löst den Pfad nicht als Glob-Muster auf.

• Zeigt der Pfad auf ein existierendes Verzeichnis, sucht die Prettier-CLI rekursiv nach unterstützten Dateien in diesem Verzeichnis. Dieser Auflösungsprozess basiert auf Dateiendungen und bekannten Dateinamen, die Prettier und seine Plugins mit unterstützten Sprachen verknüpfen.

• Andernfalls wird der Eintrag als Glob-Muster mithilfe der Glob-Syntax des fast-glob-Moduls aufgelöst.

Prettier CLI ignoriert standardmäßig Dateien im node_modules-Verzeichnis. Um dieses Verhalten zu deaktivieren, verwenden Sie das --with-node-modules-Flag.

Die Prettier-CLI folgt keinen symbolischen Links beim Erweitern von Argumenten.

Um Sonderzeichen in Globs zu maskieren, können zwei Escape-Syntaxen verwendet werden: prettier "\[my-dir]/*.js" oder prettier "[[]my-dir]/*.js". Beide erfassen alle JS-Dateien in einem Verzeichnis namens [my-dir], wobei die letztere Syntax vorzuziehen ist, da die erstere unter Windows nicht funktioniert, wo Backslashes als Pfadtrenner behandelt werden.

--check

Wenn Sie prüfen möchten, ob Ihre Dateien formatiert sind, führen Sie Prettier mit dem Flag --check (oder -c) aus. Dies gibt eine benutzerfreundliche Meldung und eine Liste nicht formatierter Dateien aus, falls vorhanden.

prettier . --check

Konsolenausgabe, wenn alle Dateien formatiert sind:

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

Konsolenausgabe, wenn einige Dateien neu formatiert werden müssen:

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

Der Befehl gibt im zweiten Fall den Exit-Code 1 zurück, was in CI-Pipelines hilfreich ist. Benutzerfreundliche Statusmeldungen helfen Projektmitwirkenden, auf mögliche Probleme zu reagieren. Um die Anzahl der Fälle zu minimieren, in denen prettier --check nicht formatierte Dateien findet, können Sie einen Pre-Commit-Hook in Ihrem Repository konfigurieren. Diese Praxis minimiert die Anzahl der CI-Fehler aufgrund von Codeformatierungsproblemen.

Wenn Sie die Liste nicht formatierter Dateien an einen anderen Befehl weiterleiten müssen, können Sie stattdessen das Flag --list-different anstelle von --check verwenden.

Exit-Codes

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

--debug-check

Wenn Sie Bedenken haben, dass Prettier die Korrektheit Ihres Codes beeinträchtigen könnte, fügen Sie --debug-check zum Befehl hinzu. Dadurch gibt Prettier eine Fehlermeldung aus, falls es feststellt, dass die Codekorrektheit möglicherweise geändert wurde. Beachten Sie, dass --write nicht mit --debug-check kombiniert werden kann.

--find-config-path und --config

Wenn Sie wiederholt einzelne Dateien mit prettier formatieren, entsteht ein kleiner Performance-Nachteil, weil Prettier versucht, eine Konfigurationsdatei zu finden. Um dies zu vermeiden, können Sie Prettier anweisen, die Konfigurationsdatei einmalig zu suchen und später wiederzuverwenden.

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

Dies liefert Ihnen den Pfad zur Konfigurationsdatei, den Sie an --config übergeben können:

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

Sie können --config auch verwenden, wenn Ihre Konfigurationsdatei an einem Ort liegt, den Prettier nicht findet, wie etwa ein config/-Verzeichnis.

Falls Sie keine Konfigurationsdatei haben oder sie ignorieren möchten, falls vorhanden, können Sie stattdessen --no-config übergeben.

--ignore-path

Pfad zu einer Datei mit Mustern, die zu ignorierende Dateien beschreiben. Standardmäßig sucht Prettier nach ./.gitignore und ./.prettierignore.
Mehrere Werte werden akzeptiert.

--list-different

Ein weiteres nützliches Flag ist --list-different (oder -l), das die Dateinamen der Dateien ausgibt, die von der Prettier-Formatierung abweichen. Falls Abweichungen vorhanden sind, führt das Skript zu einem Fehler, was in CI-Szenarien hilfreich ist.

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

Sie können auch das --check-Flag verwenden, das genauso funktioniert wie --list-different, aber zusätzlich eine menschenlesbare Zusammenfassung auf stdout ausgibt.

--no-config

Es wird keine Konfigurationsdatei gesucht. Es werden die Standardeinstellungen verwendet.

--config-precedence

Definiert, wie Konfigurationsdateien in Kombination mit CLI-Optionen ausgewertet werden sollen.

cli-override (Standard)

CLI-Optionen haben Vorrang vor der Konfigurationsdatei.

file-override

Die Konfigurationsdatei hat Vorrang vor CLI-Optionen.

prefer-file

Falls eine Konfigurationsdatei gefunden wird, wird diese ausgewertet und andere CLI-Optionen werden ignoriert. Falls keine Konfigurationsdatei gefunden wird, werden CLI-Optionen normal ausgewertet.

Diese Option unterstützt Editor-Integrationen, bei denen Benutzer ihre Standardkonfiguration definieren, aber projektspezifische Konfigurationen respektieren möchten.

--no-editorconfig

Beim Parsen der Konfiguration wird .editorconfig nicht berücksichtigt. Details finden Sie in der prettier.resolveConfig-Dokumentation.

--with-node-modules

Prettier CLI ignoriert standardmäßig Dateien im node_modules-Verzeichnis. Um dieses Verhalten zu deaktivieren, verwenden Sie das --with-node-modules-Flag.

--write

Dadurch werden alle verarbeiteten Dateien direkt überschrieben. Dies entspricht dem eslint --fix-Workflow. Sie können auch das Alias -w verwenden.

--log-level

Ändert den Detailgrad der CLI-Protokollierung. Gültige Optionen sind:

• error

• warn

• log (Standard)

• debug

• silent

--stdin-filepath

Ein Pfad zur Datei, den die Prettier-CLI wie Standard-Eingabe (stdin) behandelt. Beispiel:

abc.css

.name {
  display: none;
}

shell

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

--ignore-unknown

Mit --ignore-unknown (oder -u) ignoriert Prettier unbekannte Dateien, die durch Muster gefunden wurden.

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

--no-error-on-unmatched-pattern

Verhindert Fehler, wenn kein passendes Muster gefunden wird.

--cache

Wenn diese Option aktiviert ist, werden die folgenden Werte als Cache-Schlüssel verwendet, und die Datei wird nur formatiert, wenn sich einer davon geändert hat.

• Prettier-Version

• Optionen

• Node.js-Version

• (wenn --cache-strategy auf metadata steht) Datei-Metadaten, wie Zeitstempel

• (wenn --cache-strategy auf content steht) Dateiinhalt

prettier . --write --cache

Das Ausführen von Prettier ohne --cache löscht den Cache.

Da die Cache-Datei unter ./node_modules/.cache/prettier/.prettier-cache gespeichert ist, können Sie sie manuell mit rm ./node_modules/.cache/prettier/.prettier-cache entfernen.

Warnung

Plugin-Versionen und Implementierungen werden nicht als Cache-Schlüssel verwendet. Wir empfehlen, den Cache bei Plugin-Updates zu löschen.

--cache-location

Pfad zum Cache-Speicherort, der mit dem Flag --cache verwendet wird. Ohne explizite Angabe von --cache-location speichert Prettier die Cache-Datei unter ./node_modules/.cache/prettier/.prettier-cache.

Bei Übergabe eines Dateipfads wird diese Datei als Cache-Datei verwendet.

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

--cache-strategy

Strategie, die der Cache zur Erkennung geänderter Dateien verwendet. Mögliche Werte: metadata oder content.

Generell ist metadata schneller. content ist jedoch nützlich, wenn sich Zeitstempel ohne Änderung des Dateiinhalts aktualisieren, etwa bei Git-Operationen wie git clone, da Git keine Dateiänderungszeiten erfasst.

Wenn keine Strategie angegeben ist, wird content verwendet.

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