eslint prettier的配置選項（參數）官網直譯

terasum 發布于2019-08-22 13:54 / 2920人閱讀

摘要：的配置選項參數官網直譯本翻譯僅用于學習交流，禁止商業用途。內置的解析器包含是指的版本，并包含該版本，下同用戶自定義解析器默認值命令行參數重寫覆蓋默認值重寫配置文件指定文件的輸入路徑，這將被用于解析器參照。

prettier的配置選項（參數）官網直譯

ATTENTION PLEASE:
本翻譯僅用于學習交流，禁止商業用途。請參考prettier官網

我剛剛接觸文檔翻譯，英語自打大學英語六級（CET-6）通過后就在沒有提升過，現在基本上都快還給我的英語老師了@_@。直至發稿時，全網（百度）搜索沒有發現一片像樣的文檔，好事心又開始作怪，發出來就當祭天了（估計老天爺都嫌棄文筆差，最近看《明朝那些事兒》才知道祭天得用一種叫做“青詞”的專用文章，這事大奸臣嚴嵩的兒子做得好。。。。。）。好啦，不啰嗦了，如果有大神發現有錯誤，或者更好的翻譯，歡迎帶錘子來讀（萬分感激！）

參數

Prettier工具少數幾個可以定制的參數，在CLI命令行和配置文件中均可用。

Print Width

設置prettier單行輸出（不折行）的（最大）長度。

出于代碼的可讀性，我們不推薦（單行）超過80個字符的coding方式。

在代碼的書寫手冊中，單行最大長度常被設置為100或120。但是，人們寫代碼時，不會刻意的使每行都達到這個上限值。為便于閱讀，開發者們通常使用空格將過長的單行變成多行。最佳實踐是，每行的平均長度應當小于這個上限值。
另一方面，Prettier 會盡力讓代碼在一行（所以鏈式調用就都被搞到一行了，不得不吐槽了^~^）。當print width被設置成120時，工具有可能產出過于緊湊的或是其他不盡人意的代碼。

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
80	--print-width ?	printWidth:

注：如果在格式markdown時，不想折行，請設置 prose wrap參數來禁止這一行為。

Tab Width

設置工具每一個水平縮進的空格數

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
2	--tab-width ?	tabWidth:

Tabs

使用tab（制表位）縮進而非空格；

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
false	--use-tabs	useTabs:

Semicolons

在語句末尾添加分號；

有效參數：

true - 在每一條語句后面添加分號

false - 只在有可能導致ASI錯誤的行首添加分號

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
true	--mo-semi	semi:

Quotes

使用單引號而非雙引號；

提示：

在JSX語法中，所有引號均為雙引號，該設置在JSX中被自動忽略

在字符串中，如果一種引號在數量上超過另一種引號，數量少的引號，將被用于格式化字符串；示例："I "m double quoted "被格式化后是："I "m double quoted "(我覺得這里好像有點問題，但是親測例子結果就是這樣，按理說被較少使用的是單引號，但是例子就是雙引號包裹的，尊重原文吧) ；再例："This "example" is single quoted "格式化過后："This "example" is single quoted "

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
false	--single-quote	singleQuote:

Trailing Commas (尾逗號[a,b,c,d,] 數組項d后面的逗號就是尾逗號)

在任何可能的多行中輸入尾逗號。

有效參數：

?none? - 無尾逗號；

?es5? - 添加es5中被支持的尾逗號；

?all? - 所有可能的地方都被添加尾逗號；（包括函數參數），這個參數需要安裝nodejs8或更高版本；

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
none	--trailing-comma	trailingCommas:

Bracket Spacing (括號空格)

在對象字面量聲明所使用的的花括號后（{）和前（}）輸出空格

有效參數：

true - Example: { ? foo:?bar ?}

false - Example: {foo:?bar}

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
true	--none-bracket-spacing	bracketSpacing:

JSX Bracket上

在多行JSX元素最后一行的末尾添加 > 而使 > 多帶帶一行（不適用于自閉和元素）

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
false	--jsx-bracket-same-line	jsxBracketSameLinte:

Arrow Function Parentheses (適用于v1.9.0+)

為單行箭頭函數的參數添加圓括號。

有效參數：

" avoid " - 盡可能不添加圓括號，示例：x => x

" always " - 總是添加圓括號，示例： (x) => x

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
" avoid "	--arrow-parens < avoid always >	alwaysParens:

Range

只格式化某個文件的一部分；

這兩個參數可以用于從指定起止偏移字符(多帶帶指定開始或結束、兩者同時指定、分別指定)格式化代碼。
一下情況，范圍將會擴展：

回退至包含選中語句的第一行的開始

向前直到選中語句的末尾

注意：這些參數不可以同cursorOffset共用；

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
0	--range-start-< int >	rangeStart: < int >
Infinity	--range-end-< int >	rangeEnd: < int >

Parser

指定使用哪一種解析器。

babylon和flow都支持同一套JavaScript特性（包括Flow）.Prettier將自動根據文件的輸入路徑選擇解析器，如非必要，不要修改該項設置。

內置的解析器包含：

babylon

flow

typescript v1.4.0+（是指Prettier的版本，并包含該版本，下同）

postcss v1.4.0+

json v1.5.0+

graphql v1.5.0+

markdown v1.8.0+

用戶自定義解析器 v1.5.0+

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
babylon	--parser < string --parser ./my-parser	parser: " " parser: require(" ./my-parserrr ")

FilePath

指定文件的輸入路徑，這將被用于解析器參照。
示例：下面的將使用postcss解析器

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

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
None	--stdin-filepath	filePath: " "

Require pragma (v1.7.0+)

Prettier可以嚴格按照按照文件頂部的一些特殊的注釋格式化代碼，這些注釋稱為“require pragma”(必須雜注)。這在逐步格式化一些大型、未經格式化過的代碼是十分有用的。
例如，一個帶有下面注釋的文件將在執行帶有 --require-pragma的cli指令（api配置文件亦可）時被格式化

        /**
        *@prettier
        */

    或

        /**
        *@format
        */

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
false	--require-pragma	requirePragma:

Insert Pragma (v1.8.0+)

Prettier可以在文件的頂部插入一個 @format的特殊注釋，以表明改文件已經被Prettier格式化過了。在使用 --require-pragma參數處理一連串的文件時這個功能將十分有用。如果文件頂部已經有一個doclock，這個選項將新建一行注釋，并打上@format標記。

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
false	--insert-pragma	insertPragma:

Prose Wrap(v1.8.2+)

默認情況下，Prettier會因為使用了一些折行敏感型的渲染器（如GitHub comment 和 BitBucket）而按照markdown文本樣式進行折行，但在某些情況下，你可能只是希望這個文本在編譯器或查看器中soft-wrapping（是當屏幕放不下時發生的軟折行），所以這一參數允許設置為 " never "

有效參數：

" always " - 當超出print width（上面有這個參數）時就折行

" never " - 不折行

" perserve " - 按照文件原樣折行（v1.9.0+）

默認值	CLI(命令行參數)重寫（覆蓋）默認值	API重寫(配置文件)
" preserve "	--prose-wrap	proseWrap:

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/92601.html

我為什么推薦Prettier來統一代碼風格

摘要：但是，有條原則應該是對的少數服從多數用工具統一風格。我曾經以為，程序員有自己獨特的代碼風格挺好的。業界有一些流行的代碼風格，比如和。你也可以使用來統一風格。比如，的配置，只能統一示例的代碼風格，而不能統一后面兩者。相比于代碼風格，我更推薦。譯者按: 關于代碼風格，不同的人有不同的偏好，其實并沒有什么絕對的對錯。但是，有 2 條原則應該是對的：少數服從多數；用工具統一風格。原文...

YJNldm 2019-08-23 16:11 評論0 收藏0
梳理前端開發使用eslint-prettier檢查和格式化代碼

摘要：梳理前端開發使用檢查和格式化代碼問題痛點在團隊的項目開發過程中，代碼維護所占的時間比重往往大于新功能的開發。使用格式化所有代碼。參考文檔如何花分鐘解決產生的各種錯誤的記憶現場原文轉載梳理前端開發使用檢查和格式化代碼線上猛如虎，線下慫如鼠梳理前端開發使用eslint-prettier檢查和格式化代碼問題痛點在團隊的項目開發過程中，代碼維護所占的時間比重往往大于新功能的開發。因此編...

yangrd 2019-08-22 17:01 評論0 收藏0
使用ESLint+Prettier來統一前端代碼風格

摘要：但是關于代碼風格，我們很難區分誰對誰錯，不同的人有不同偏好，唯有強制要求才能規避爭論。所以，團隊關于代碼風格必須遵循兩個基本原則少數服從多數用工具統一風格。本文將介紹，如何使用來統一我們的前端代碼風格。加分號還是不加分號？tab還是空格？你還在為代碼風格與同事爭論得面紅耳赤嗎？正文之前，先看個段子放松一下：去死吧！你這個異教徒！想起自己剛入行的時候，從svn上把代碼checko...

Corwien 2019-08-22 18:07 評論0 收藏0
前端構建之webpack

摘要：前端構建之之前寫了一個前端構建之，同樣的目的寫一個，內容基本上和一樣，主要用來自己學習記錄。合并很方便的實現合并最后附上完整的源代碼。前端構建之webpack 之前寫了一個前端構建之gulp，同樣的目的寫一個webpack，內容基本上和gulp一樣，主要用來自己學習記錄。為什么需要前端構建不解釋本文大致分為以下幾個內容：規范校驗js代碼（jslint） js解釋器（b...

MartinHan 2019-08-26 12:00 評論0 收藏0
Prettier+VScode 治好你的代碼潔癖

摘要：忍無可忍只能拔槍相見了。而只關心格式化文件最大長度混合標簽和空格引用樣式等。可見，代碼格式統一的問題，交給再合適不過了。和配合使用，風味更佳。我的配置文件如下到此，安裝完畢，使用就可格式化代碼。兩者配合才能使項目代碼優雅健壯試想一個多人開發的項目，每次同步代碼，看到各個風格迥異，換行空格混亂，4格，2格縮進交替上演的代碼文件，分分鐘逼死強迫癥啊。忍無可忍只能拔槍相見了~~。統一的代碼...

qc1iu 2019-08-23 12:13 評論0 收藏0