摘要:的配置選項(xiàng)參數(shù)官網(wǎng)直譯本翻譯僅用于學(xué)習(xí)交流,禁止商業(yè)用途。內(nèi)置的解析器包含是指的版本,并包含該版本,下同用戶自定義解析器默認(rèn)值命令行參數(shù)重寫覆蓋默認(rèn)值重寫配置文件指定文件的輸入路徑,這將被用于解析器參照。
prettier的配置選項(xiàng)(參數(shù))官網(wǎng)直譯
ATTENTION PLEASE:
本翻譯僅用于學(xué)習(xí)交流,禁止商業(yè)用途。請(qǐng)參考prettier官網(wǎng)
我剛剛接觸文檔翻譯,英語自打大學(xué)英語六級(jí)(CET-6)通過后就在沒有提升過,現(xiàn)在基本上都快還給我的英語老師了@_@。直至發(fā)稿時(shí),全網(wǎng)(百度)搜索沒有發(fā)現(xiàn)一片像樣的文檔,好事心又開始作怪,發(fā)出來就當(dāng)祭天了(估計(jì)老天爺都嫌棄文筆差,最近看《明朝那些事兒》才知道祭天得用一種叫做“青詞”的專用文章,這事大奸臣嚴(yán)嵩的兒子做得好。。。。。)。好啦,不啰嗦了,如果有大神發(fā)現(xiàn)有錯(cuò)誤,或者更好的翻譯,歡迎帶錘子來讀(萬分感激?。?/p> 參數(shù)
Prettier工具少數(shù)幾個(gè)可以定制的參數(shù),在CLI命令行和配置文件中均可用。
Print Width設(shè)置prettier單行輸出(不折行)的(最大)長(zhǎng)度。
出于代碼的可讀性,我們不推薦(單行)超過80個(gè)字符的coding方式。
在代碼的書寫手冊(cè)中,單行最大長(zhǎng)度常被設(shè)置為100或120。但是,人們寫代碼時(shí),不會(huì)刻意的使每行都達(dá)到這個(gè)上限值。為便于閱讀,開發(fā)者們通常使用空格將過長(zhǎng)的單行變成多行。最佳實(shí)踐是,每行的平均長(zhǎng)度應(yīng)當(dāng)小于這個(gè)上限值。
另一方面,Prettier 會(huì)盡力讓代碼在一行(所以鏈?zhǔn)秸{(diào)用就都被搞到一行了,不得不吐槽了^~^)。當(dāng)print width被設(shè)置成120時(shí),工具有可能產(chǎn)出過于緊湊的或是其他不盡人意的代碼。
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
80 | --print-width ? |
printWidth: |
注:如果在格式markdown時(shí),不想折行,請(qǐng)?jiān)O(shè)置 prose wrap參數(shù)來禁止這一行為。
Tab Width設(shè)置工具每一個(gè)水平縮進(jìn)的空格數(shù)
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
2 | --tab-width ? |
tabWidth: |
使用tab(制表位)縮進(jìn)而非空格;
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
false | --use-tabs | useTabs: |
在語句末尾添加分號(hào);
有效參數(shù):
true - 在每一條語句后面添加分號(hào)
false - 只在有可能導(dǎo)致ASI錯(cuò)誤的行首添加分號(hào)
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
true | --mo-semi | semi: |
使用單引號(hào)而非雙引號(hào);
提示:
在JSX語法中,所有引號(hào)均為雙引號(hào),該設(shè)置在JSX中被自動(dòng)忽略
在字符串中,如果一種引號(hào)在數(shù)量上超過另一種引號(hào),數(shù)量少的引號(hào),將被用于格式化字符串;示例:"I "m double quoted "被格式化后是:"I "m double quoted "(我覺得這里好像有點(diǎn)問題,但是親測(cè)例子結(jié)果就是這樣,按理說被較少使用的是單引號(hào),但是例子就是雙引號(hào)包裹的,尊重原文吧) ;再例:"This "example" is single quoted "格式化過后:"This "example" is single quoted "
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
false | --single-quote | singleQuote: |
在任何可能的多行中輸入尾逗號(hào)。
有效參數(shù):
?none? - 無尾逗號(hào);
?es5? - 添加es5中被支持的尾逗號(hào);
?all? - 所有可能的地方都被添加尾逗號(hào);(包括函數(shù)參數(shù)),這個(gè)參數(shù)需要安裝nodejs8或更高版本;
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
none | --trailing-comma |
trailingCommas: |
在對(duì)象字面量聲明所使用的的花括號(hào)后({)和前(})輸出空格
有效參數(shù):
true - Example: { ? foo:?bar ?}
false - Example: {foo:?bar}
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
true | --none-bracket-spacing | bracketSpacing: |
在多行JSX元素最后一行的末尾添加 > 而使 > 多帶帶一行(不適用于自閉和元素)
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
false | --jsx-bracket-same-line | jsxBracketSameLinte: |
為單行箭頭函數(shù)的參數(shù)添加圓括號(hào)。
有效參數(shù):
" avoid " - 盡可能不添加圓括號(hào),示例:x => x
" always " - 總是添加圓括號(hào),示例: (x) => x
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
" avoid " | --arrow-parens < avoid always > | alwaysParens: |
只格式化某個(gè)文件的一部分;
這兩個(gè)參數(shù)可以用于從指定起止偏移字符(多帶帶指定開始或結(jié)束、兩者同時(shí)指定、分別指定)格式化代碼。
一下情況,范圍將會(huì)擴(kuò)展:
回退至包含選中語句的第一行的開始
向前直到選中語句的末尾
注意:這些參數(shù)不可以同cursorOffset共用;
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
0 | --range-start-< int > | rangeStart: < int > |
Infinity | --range-end-< int > | rangeEnd: < int > |
指定使用哪一種解析器。
babylon和flow都支持同一套JavaScript特性(包括Flow).Prettier將自動(dòng)根據(jù)文件的輸入路徑選擇解析器,如非必要,不要修改該項(xiàng)設(shè)置。
內(nèi)置的解析器包含:
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+
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
babylon | --parser < string --parser ./my-parser |
parser: " parser: require(" ./my-parserrr ") |
指定文件的輸入路徑,這將被用于解析器參照。
示例:下面的將使用postcss解析器
cat foo | prettier --stdin-filepath foo.css
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
None | --stdin-filepath |
filePath: " |
Prettier可以嚴(yán)格按照按照文件頂部的一些特殊的注釋格式化代碼,這些注釋稱為“require pragma”(必須雜注)。這在逐步格式化一些大型、未經(jīng)格式化過的代碼是十分有用的。
例如,一個(gè)帶有下面注釋的文件將在執(zhí)行帶有 --require-pragma的cli指令(api配置文件亦可)時(shí)被格式化
/** *@prettier */ 或 /** *@format */
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
false | --require-pragma | requirePragma: |
Prettier可以在文件的頂部插入一個(gè) @format的特殊注釋,以表明改文件已經(jīng)被Prettier格式化過了。在使用 --require-pragma參數(shù)處理一連串的文件時(shí)這個(gè)功能將十分有用。如果文件頂部已經(jīng)有一個(gè)doclock,這個(gè)選項(xiàng)將新建一行注釋,并打上@format標(biāo)記。
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
false | --insert-pragma | insertPragma: |
默認(rèn)情況下,Prettier會(huì)因?yàn)槭褂昧艘恍┱坌忻舾行偷匿秩酒鳎ㄈ鏕itHub comment 和 BitBucket)而按照markdown文本樣式進(jìn)行折行,但在某些情況下,你可能只是希望這個(gè)文本在編譯器或查看器中soft-wrapping(是當(dāng)屏幕放不下時(shí)發(fā)生的軟折行),所以這一參數(shù)允許設(shè)置為 " never "
有效參數(shù):
" always " - 當(dāng)超出print width(上面有這個(gè)參數(shù))時(shí)就折行
" never " - 不折行
" perserve " - 按照文件原樣折行 (v1.9.0+)
默認(rèn)值 | CLI(命令行參數(shù))重寫(覆蓋)默認(rèn)值 | API重寫(配置文件) |
---|---|---|
" preserve " | --prose-wrap |
proseWrap: |
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://systransis.cn/yun/92601.html
摘要:但是,有條原則應(yīng)該是對(duì)的少數(shù)服從多數(shù)用工具統(tǒng)一風(fēng)格。我曾經(jīng)以為,程序員有自己獨(dú)特的代碼風(fēng)格挺好的。業(yè)界有一些流行的代碼風(fēng)格,比如和。你也可以使用來統(tǒng)一風(fēng)格。比如,的配置,只能統(tǒng)一示例的代碼風(fēng)格,而不能統(tǒng)一后面兩者。相比于代碼風(fēng)格,我更推薦。 譯者按: 關(guān)于代碼風(fēng)格,不同的人有不同的偏好,其實(shí)并沒有什么絕對(duì)的對(duì)錯(cuò)。但是,有 2 條原則應(yīng)該是對(duì)的: 少數(shù)服從多數(shù);用工具統(tǒng)一風(fēng)格。 原文...
摘要:梳理前端開發(fā)使用檢查和格式化代碼問題痛點(diǎn)在團(tuán)隊(duì)的項(xiàng)目開發(fā)過程中,代碼維護(hù)所占的時(shí)間比重往往大于新功能的開發(fā)。使用格式化所有代碼。參考文檔如何花分鐘解決產(chǎn)生的各種錯(cuò)誤的記憶現(xiàn)場(chǎng)原文轉(zhuǎn)載梳理前端開發(fā)使用檢查和格式化代碼線上猛如虎,線下慫如鼠 梳理前端開發(fā)使用eslint-prettier檢查和格式化代碼 問題痛點(diǎn) 在團(tuán)隊(duì)的項(xiàng)目開發(fā)過程中,代碼維護(hù)所占的時(shí)間比重往往大于新功能的開發(fā)。因此編...
摘要:但是關(guān)于代碼風(fēng)格,我們很難區(qū)分誰對(duì)誰錯(cuò),不同的人有不同偏好,唯有強(qiáng)制要求才能規(guī)避爭(zhēng)論。所以,團(tuán)隊(duì)關(guān)于代碼風(fēng)格必須遵循兩個(gè)基本原則少數(shù)服從多數(shù)用工具統(tǒng)一風(fēng)格。本文將介紹,如何使用來統(tǒng)一我們的前端代碼風(fēng)格。 加分號(hào)還是不加分號(hào)?tab還是空格?你還在為代碼風(fēng)格與同事爭(zhēng)論得面紅耳赤嗎? 正文之前,先看個(gè)段子放松一下: 去死吧!你這個(gè)異教徒! 想起自己剛?cè)胄械臅r(shí)候,從svn上把代碼checko...
摘要:前端構(gòu)建之之前寫了一個(gè)前端構(gòu)建之,同樣的目的寫一個(gè),內(nèi)容基本上和一樣,主要用來自己學(xué)習(xí)記錄。合并很方便的實(shí)現(xiàn)合并最后附上完整的源代碼。 前端構(gòu)建之webpack 之前寫了一個(gè)前端構(gòu)建之gulp,同樣的目的寫一個(gè)webpack, 內(nèi)容基本上和gulp一樣,主要用來自己學(xué)習(xí)記錄。 為什么需要前端構(gòu)建 不解釋 本文大致分為以下幾個(gè)內(nèi)容: 規(guī)范校驗(yàn)js代碼(jslint) js解釋器(b...
摘要:忍無可忍只能拔槍相見了。而只關(guān)心格式化文件最大長(zhǎng)度混合標(biāo)簽和空格引用樣式等。可見,代碼格式統(tǒng)一的問題,交給再合適不過了。和配合使用,風(fēng)味更佳。我的配置文件如下到此,安裝完畢,使用就可格式化代碼。兩者配合才能使項(xiàng)目代碼優(yōu)雅健壯 試想一個(gè)多人開發(fā)的項(xiàng)目,每次同步代碼,看到各個(gè)風(fēng)格迥異,換行空格混亂,4格,2格縮進(jìn)交替上演的代碼文件,分分鐘逼死強(qiáng)迫癥啊。忍無可忍只能拔槍相見了~~。統(tǒng)一的代碼...
閱讀 2446·2021-11-22 13:53
閱讀 1140·2021-09-22 16:06
閱讀 1382·2021-09-02 15:21
閱讀 1915·2019-08-30 15:55
閱讀 3133·2019-08-29 11:19
閱讀 1932·2019-08-26 13:23
閱讀 948·2019-08-23 18:23
閱讀 1767·2019-08-23 16:06