eslint prettier的设置选项(参数)官网直译

prettier的设置选项(参数)官网直译

ATTENTION PLEASE:
本翻译仅用于进修交换,制止商业用途。请参考prettier官网

我方才打仗文档翻译,英语自打大学英语六级(CET-6)通事后就在没有提升过,如今基本上都快还给我的英语老师了@_@。直至发稿时,全网(百度)搜刮没有发明一片像样的文档,功德心又最先作祟,发出来就当祭天了(预计老天爷都厌弃文笔差,近来看《明代那些事儿》才晓得祭天得用一种叫做“青词”的专用文章,这事大奸臣严嵩的儿子做得好。。。。。)。好啦,不烦琐了,假如有大神发明有毛病,或许更好的翻译,迎接带锤子来读(万分感激!)

参数

Prettier东西少数几个能够定制的参数,在CLI命令行和设置文件中均可用。

Print Width

设置prettier单行输出(不折行)的(最大)长度。

出于代码的可读性,我们不引荐(单行)凌驾80个字符的coding体式格局。

在代码的誊写手册中,单行最大长度常被设置为100或120。然则,人们写代码时,不会锐意的使每行都到达这个上限值。为便于浏览,开发者们一般运用空格将太长的单行变成多行。最好实践是,每行的均匀长度应该小于这个上限值。
另一方面,Prettier 会全力让代码在一行(所以链式挪用就都被搞到一行了,不得不吐槽了^~^)。当print width被设置成120时,东西有能够产出过于紧凑的或是其他不尽人意的代码。

默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
80–print-width  <int>printWidth: <int>

注:假如在花样markdown时,不想折行,请设置 prose wrap参数来制止这一行动。

Tab Width

设置东西每个程度缩进的空格数

默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
2–tab-width  <int>tabWidth: <int>

Tabs

运用tab(制表位)缩进而非空格;

默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
false–use-tabsuseTabs: <bool>

Semicolons

在语句末端增加分号;

有效参数:

  • true – 在每一条语句背面增加分号
  • false – 只在有能够致使ASI毛病的行首增加分号
默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
true–mo-semisemi: <bool>

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-quotesingleQuote: <bool>

Trailing Commas (尾逗号[a,b,c,d,] 数组项d背面的逗号就是尾逗号)

在任何能够的多行中输入尾逗号。

有效参数:

  •  none  – 无尾逗号;
  •  es5  – 增加es5中被支撑的尾逗号;
  •  all  – 一切能够的处所都被增加尾逗号;(包括函数参数),这个参数须要装置nodejs8或更高版本;
默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
none–trailing-comma <none \ es5 \ all >trailingCommas: <none \ es5 \ all>

Bracket Spacing (括号空格)

在对象字面量声明所运用的的花括号后({)和前(})输出空格

有效参数:

  • true – Example: {   foo: bar  }
  • false – Example: {foo: bar}
默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
true–none-bracket-spacingbracketSpacing: <bool>

JSX Bracket上

在多行JSX元素末了一行的末端增加 > 而使 > 零丁一行(不适用于自闭和元素)

默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
false–jsx-bracket-same-linejsxBracketSameLinte: <bool>

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

为单行箭头函数的参数增加圆括号。

有效参数:

  • ” avoid ” – 尽能够不增加圆括号,示例:x => x
  • ” always ” – 老是增加圆括号,示例: (x) => x
默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
” avoid “–arrow-parens < avoid \ always >alwaysParens: <avoid \ always>

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 <br/> –parser ./my-parserparser: ” <string> ” <br/> parser: require(” ./my-parserrr “)

FilePath

指定文件的输入途径,这将被用于解析器参照。
示例:下面的将运用postcss解析器

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

默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
None–stdin-filepath <string>filePath: ” <string> “

Require pragma (v1.7.0+)

Prettier能够严厉根据根据文件顶部的一些特别的解释花样化代码,这些解释称为“require pragma”(必需杂注)。这在逐渐花样化一些大型、未经花样化过的代码是非常有效的。
比方,一个带有下面解释的文件将在实行带有 –require-pragma的cli指令(api设置文件亦可)时被花样化


        /**
        *@prettier
        */

    或

        /**
        *@format
        */
默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
false–require-pragmarequirePragma: <bool>

Insert Pragma (v1.8.0+)

Prettier能够在文件的顶部插进去一个 @format的特别解释,以表明改文件已被Prettier花样化过了。在运用 –require-pragma参数处置惩罚一连串的文件时这个功能将非常有效。假如文件顶部已有一个doclock,这个选项将新建一行解释,并打上@format标记。

默许值CLI(命令行参数)重写(掩盖)默许值API重写(设置文件)
false–insert-pragmainsertPragma: <bool>

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 <always \ neve \preserver >proseWrap:<always \ never \ preserver >
    原文作者:等风来
    原文地址: https://segmentfault.com/a/1190000012909159
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞