资讯专栏INFORMATION COLUMN

上云采购季！| 2核2G4M爆款云服务器低至59元/年，更有多台、长期优惠，快来选购！

立即前往
首页/文章专栏/eslint prettier的配置选项（参数）官网直译

eslint prettier的配置选项（参数）官网直译

terasum / 2926人阅读

摘要：的配置选项参数官网直译本翻译仅用于学习交流，禁止商业用途。内置的解析器包含是指的版本，并包含该版本，下同用户自定义解析器默认值命令行参数重写覆盖默认值重写配置文件指定文件的输入路径，这将被用于解析器参照。

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:
云服务器 GPU云服务器 linux 选项参数 云服务器的配置参数 配置选项 云服务器配置指什么参数的意思

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/92601.html

相关文章

  • 我为什么推荐Prettier来统一代码风格

    摘要：但是，有条原则应该是对的少数服从多数用工具统一风格。我曾经以为，程序员有自己独特的代码风格挺好的。业界有一些流行的代码风格，比如和。你也可以使用来统一风格。比如，的配置，只能统一示例的代码风格，而不能统一后面两者。相比于代码风格，我更推荐。 译者按: 关于代码风格，不同的人有不同的偏好，其实并没有什么绝对的对错。但是，有 2 条原则应该是对的： 少数服从多数；用工具统一风格。 原文...

    YJNldm 评论0 收藏0

  • 梳理前端开发使用eslint-prettier检查和格式化代码

    摘要：梳理前端开发使用检查和格式化代码问题痛点在团队的项目开发过程中，代码维护所占的时间比重往往大于新功能的开发。使用格式化所有代码。参考文档如何花分钟解决产生的各种错误的记忆现场原文转载梳理前端开发使用检查和格式化代码线上猛如虎，线下怂如鼠 梳理前端开发使用eslint-prettier检查和格式化代码 问题痛点 在团队的项目开发过程中，代码维护所占的时间比重往往大于新功能的开发。因此编...

    yangrd 评论0 收藏0

  • 使用ESLint+Prettier来统一前端代码风格

    摘要：但是关于代码风格，我们很难区分谁对谁错，不同的人有不同偏好，唯有强制要求才能规避争论。所以，团队关于代码风格必须遵循两个基本原则少数服从多数用工具统一风格。本文将介绍，如何使用来统一我们的前端代码风格。 加分号还是不加分号？tab还是空格？你还在为代码风格与同事争论得面红耳赤吗？ 正文之前，先看个段子放松一下： 去死吧！你这个异教徒！ 想起自己刚入行的时候，从svn上把代码checko...

    Corwien 评论0 收藏0

  • 前端构建之webpack

    摘要：前端构建之之前写了一个前端构建之，同样的目的写一个，内容基本上和一样，主要用来自己学习记录。合并很方便的实现合并最后附上完整的源代码。 前端构建之webpack 之前写了一个前端构建之gulp，同样的目的写一个webpack， 内容基本上和gulp一样，主要用来自己学习记录。 为什么需要前端构建 不解释 本文大致分为以下几个内容： 规范校验js代码（jslint） js解释器（b...

    MartinHan 评论0 收藏0

  • Prettier+VScode 治好你的代码洁癖

    摘要：忍无可忍只能拔枪相见了。而只关心格式化文件最大长度混合标签和空格引用样式等。可见，代码格式统一的问题，交给再合适不过了。和配合使用，风味更佳。我的配置文件如下到此，安装完毕，使用就可格式化代码。两者配合才能使项目代码优雅健壮 试想一个多人开发的项目，每次同步代码，看到各个风格迥异，换行空格混乱，4格，2格缩进交替上演的代码文件，分分钟逼死强迫症啊。忍无可忍只能拔枪相见了~~。统一的代码...

    qc1iu 评论0 收藏0

发表评论

登陆后可评论

0条评论

terasum

男|高级讲师
我要私信

TA的文章

阅读更多
最新活动
阅读需要支付1元查看
<