.Prettierrc檔案的設定

adherent發表於2018-02-09

因為用到了Prettier所以在設定的時候看文件發現全是英文索性就翻譯了下希望大家能用到。

Prettier Option

.Prettierrc

Cli是在終端使用，

Api是在.Prettierrc中設定使用

printWidth

列印寬度指定列印將換行的行長。

Default Cli Override Api Override
80 --print-width printWidth:

Tab Width

指定每個縮排的空格數。

Default Cli Override Api Override
2 --tab-width tabWidth:

Tabs

用Tab縮排而不是空格

Default Cli Override Api Override
false --use-tabs useTabs:

Semicolons

在語句的末尾列印分號。

有效的選項：

  • true - 在每個語句的末尾新增一個分號。
  • false - 只在可能引入ASI故障的行的開頭新增分號。
Default Cli Override Api Override
true --no-semi semi:

Quotes

使用單引號而不是雙引號。

Default Cli Override Api Override
false --single-quote singleQuote:

Trailing Commas

多行時，儘可能列印尾隨逗號。 （例如，一個單行陣列永遠不會得到尾隨的逗號。）

有效選項：

  • none - 沒有尾隨逗號。
  • es5 - 在ES5中有效的尾隨逗號（object，arrays等）
  • all - 儘可能尾隨逗號（包括函式引數）。
Default Cli Override Api Override
None --trailing-comma <none|es5|all> trailingComma: "<none|es5|all>"

Bracket Spacing

在物件文字中的括號之間列印空格。

選項：

  • true - Example { foo: bar }
  • flase - Example {foo: bar}
Default Cli Override Api Override
true --no-bracket-spacing bracketSpacing:

JSX Brackets

將多行JSX元素的 > 放在最後一行的末尾，而不是單獨放在下一行（不適用於自閉元素）。

Default Cli Override Api Override
false --jsx-bracket-same-line jsxBracketSameLine:

Arrow Function Parentheses

圍繞一個唯一的箭頭函式引數包括括號。

選項：

  • avoid - 儘可能省略括號 Example： x => x
  • always - 總是包括括號 Example： (x) => x
Default Cli Override Api Override
avoid --arrow-parens <avoid|always> arrowParens: "<avoid|always>"

Range

只格式化檔案的一部分。

這兩個選項可用於格式化以給定字元偏移（分別包含和排除）開始和結束的程式碼。範圍將延伸:

  • 返回到包含選定語句的第一行的開頭。
  • 轉到選定語句的末尾。

這些選項不能與cursorOffset一起使用。

Default Cli Override Api Override
0 --range-start rangeStart:
Infinity --range-end rangeEnd:

Parser

指定使用哪個分析器。

Babylon和流解析器都支援相同的JavaScript特性（包括Flow）。Prettier會自動從輸入檔案路徑中推斷解析器，所以你不需要改變這個設定。

Built-in parsers:

Default Cli Override Api Override
babylon --parser
--parser ./my-parser		 parser: ""
parser: require("./my-parser")

FilePath

指定輸入檔案路徑。這將被用來做解析器推理。

例如，以下將使用postcss解析器：

cat foo | prettier --stdin-filepath foo.css

Default Cli Override Api Override
None --stdin-filepath filepath: ""

Require pragma

Prettier可以限制自己只能格式化檔案頂部包含特殊註釋的檔案，稱為雜注。逐漸將大型，無格式的程式碼庫轉換為漂亮的程式碼庫時，這非常有用。

例如，當提供--require-pragma時，將會格式化具有以下第一個註釋的檔案：

/**
 * @prettier
 */
複製程式碼

or

/**
 * @format
 */
複製程式碼
Default Cli Override Api Override
false --require-pragma requirePragma:

Insert Pragma

Prettier的可以在檔案的頂部插入一個特殊的@format標記，指定檔案已被格式化為Prettier。

Default Cli Override Api Override
false --insert-pragma insertPragma:

Prose Wrap

預設情況下，由於某些服務使用了對換行符敏感的呈現器，因此Prettier會按原樣包裝降價文字。

選項：

  • "always" - 如果超出了列印寬度，請將散的包好。
  • "never" - 不包散的。
  • "preserve" - 按原樣包散的。
Default Cli Override Api Override
"preserve" --prose-wrap <always|never|preserve> proseWrap: "<always|never|preserve>"

相關文章