CLI

Inofficiell Beta-översättning

Denna sida har översatts av PageTurner AI (beta). Inte officiellt godkänd av projektet. Hittade du ett fel? Rapportera problem →

Använd kommandot prettier för att köra Prettier från kommandoraden.

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

notera

För att köra din lokalt installerade version av Prettier, lägg till npx, yarn exec, pnpm exec, eller bunx före kommandot, t.ex. npx prettier --help, yarn exec prettier --help, pnpm exec prettier --help, eller bunx prettier --help.

För att formatera en fil direkt, använd --write. (OBS: Detta skriver över dina filer!)

I praktiken kan det se ut ungefär så här:

prettier . --write

Det här kommandot formaterar alla filer som stöds av Prettier i aktuell katalog och dess underkataloger.

Det rekommenderas att alltid säkerställa att prettier --write . endast formaterar det du vill i ditt projekt. Använd en .prettierignore-fil för att ignorera saker som inte bör formateras.

Ett mer komplext exempel:

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

varning

Glöm inte citationstecknen runt glob-mönstren! Citationstecknen säkerställer att Prettier CLI expanderar globs istället för ditt skal, vilket är viktigt för plattformsoberoende användning.

notera

Det är bättre att använda en konfigurationsfil för formateringsalternativ som --single-quote och --trailing-comma istället för att skicka dem som CLI-flaggor. På så sätt kan Prettier CLI, editorintegrationer och andra verktyg alla veta vilka alternativ du använder.

Filmönster

Givet en lista med sökvägar/mönster behandlar Prettier CLI varje post först som en bokstavlig sökväg.

• Om sökvägen pekar på en befintlig fil fortsätter Prettier CLI med den filen och tolkar inte sökvägen som ett glob-mönster.

• Om sökvägen pekar på en befintlig katalog letar Prettier CLI rekursivt efter filer som stöds i den katalogen. Denna process baseras på filändelser och välkända filnamn som Prettier och dess plugins associerar med språk som stöds.

• Annars tolkas posten som ett glob-mönster med hjälp av glob-syntaxen från fast-glob-modulen.

Prettier CLI kommer att ignorera filer i node_modules-katalogen. För att inkludera dessa, använd flaggan --with-node-modules.

Prettier CLI följer inte symboliska länkar vid argumentexpansion.

För att undvika specialtecken i globs kan två syntaxer användas: prettier "\[my-dir]/*.js" eller prettier "[[]my-dir]/*.js". Båda matchar alla JS-filer i en katalog som heter [my-dir], men den senare syntaxen föredras eftersom den första inte fungerar på Windows där bakstreck tolkas som sökvägsseparatorer.

--check

När du vill kontrollera om dina filer är formaterade kan du köra Prettier med flaggan --check (eller -c).
Detta kommer att visa ett användarvänligt meddelande och en lista över oformaterade filer, om sådana finns.

prettier . --check

Konsolutskrift om alla filer är formaterade:

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

Konsolutskrift om vissa filer kräver omformatering:

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

Kommandot returnerar felkod 1 i det andra fallet, vilket är användbart i CI-pipeliner.
Användarvänliga statusmeddelanden hjälper projektmedlemmar att hantera eventuella problem.
För att minimera antalet gånger prettier --check hittar oformaterade filer kan du konfigurera en pre-commit-hook i ditt repo.
Denna metod minskar risken för CI-fel på grund av formateringsproblem.

Om du behöver skicka listan över oformaterade filer till ett annat kommando kan du använda flaggan --list-different istället för --check.

Avslutskoder

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

--debug-check

Om du är orolig att Prettier kan ändra korrektheten i din kod, lägg till --debug-check till kommandot. Detta gör att Prettier skriver ut ett felmeddelande om den upptäcker att kodens korrekthet kan ha ändrats. Observera att --write inte kan användas tillsammans med --debug-check.

--find-config-path och --config

Om du formaterar enskilda filer upprepade gånger med prettier, kommer du att få en liten prestandapåverkan när Prettier försöker hitta en konfigurationsfil. För att undvika detta kan du be Prettier hitta konfigurationsfilen en gång och återanvända den senare.

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

Detta ger dig sökvägen till konfigurationsfilen, som du kan skicka till --config:

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

Du kan också använda --config om din konfigurationsfil finns någonstans där Prettier inte kan hitta den, till exempel i en config/-katalog.

Om du inte har någon konfigurationsfil, eller vill ignorera den om den finns, kan du istället använda --no-config.

--ignore-path

Sökväg till en fil som innehåller mönster för filer som ska ignoreras. Som standard letar Prettier efter ./.gitignore och ./.prettierignore.
Flera värden accepteras.

--list-different

En annan användbar flagga är --list-different (eller -l) som skriver ut filnamnen på filer som skiljer sig från Prettiers formatering. Om det finns skillnader avslutas skriptet med fel, vilket är användbart i CI-scenarier.

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

Du kan också använda flaggan --check, som fungerar på samma sätt som --list-different, men även skriver ut ett användarvänligt sammanfattningsmeddelande till stdout.

--no-config

Sök inte efter någon konfigurationsfil. Standardinställningarna kommer att användas.

--config-precedence

Definierar hur konfigurationsfiler ska utvärderas i kombination med CLI-alternativ.

cli-override (standard)

CLI-alternativ har företräde framför konfigurationsfil

file-override

Konfigurationsfil har företräde framför CLI-alternativ

prefer-file

Om en konfigurationsfil hittas kommer den att utvärderas och andra CLI-alternativ ignoreras. Om ingen konfigurationsfil hittas utvärderas CLI-alternativen normalt.

Detta alternativ lägger till stöd för redigerarintegrationer där användare definierar sin standardkonfiguration men vill respektera projektspecifik konfiguration.

--no-editorconfig

Ta inte hänsyn till .editorconfig vid konfigurationsparsing. Se dokumentationen för prettier.resolveConfig för detaljer.

--with-node-modules

Prettier CLI kommer att ignorera filer i node_modules-katalogen. För att inkludera dessa, använd flaggan --with-node-modules.

--write

Detta skriver om alla bearbetade filer direkt. Motsvarar arbetsflödet för eslint --fix. Du kan också använda aliaset -w.

--log-level

Ändra loggningsnivån för CLI:n. Giltiga alternativ är:

• error

• warn

• log (standard)

• debug

• silent

--stdin-filepath

En sökväg till filen som Prettier CLI kommer att behandla som stdin. Till exempel:

abc.css

.name {
  display: none;
}

shell

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

--ignore-unknown

Med --ignore-unknown (eller -u) kommer prettier att ignorera okända filer som matchas av mönster.

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

--no-error-on-unmatched-pattern

Förhindrar fel när mönstret inte matchar någon fil.

--cache

Om detta alternativ är aktiverat används följande värden som cache-nycklar, och filen formateras endast om något av dem ändras:

• Prettier-version

• Alternativ

• Node.js-version

• (om --cache-strategy är metadata) filmetadata som tidsstämplar

• (om --cache-strategy är content) filens innehåll

prettier . --write --cache

Att köra Prettier utan --cache raderar cachen.

Eftersom cachefilen lagras i ./node_modules/.cache/prettier/.prettier-cache kan du även ta bort den manuellt med rm ./node_modules/.cache/prettier/.prettier-cache.

varning

Pluginversioner och implementering används inte som cache-nycklar. Vi rekommenderar att du tar bort cachen när du uppdaterar plugins.

--cache-location

Sökväg till cachefilens plats som används av --cache-flaggan. Om du inte explicit anger --cache-location sparar Prettier cachefilen i ./node_modules/.cache/prettier/.prettier-cache.

Om en filsökväg anges används den filen som cachefil.

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

--cache-strategy

Strategi för cachen att använda vid identifiering av ändrade filer. Kan vara metadata eller content.

metadata är generellt snabbare, medan content är användbart när tidsstämpel uppdateras utan innehållsändring (t.ex. vid git-operationer som git clone eftersom git inte spårar filändringstider).

Om ingen strategi anges används content.

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