微信号:frontshow

介绍:InfoQ大前端技术社群:囊括前端、移动、Node全栈一线技术,紧跟业界发展步伐。

用Prettier格式化JavaScript代码

2018-03-01 10:15 孙浩 译

Prettier 是 2017 年上升最快的开源项目之一,发布到现在仅仅一年多,它在 Github 上的 Star 已经达到 2.1W+,可见它受欢迎的程度。

假如你有过编程经验的话,你应该很清楚,很难做到既让代码简洁明了,又使不同的代码书写风格在一个项目中保持一致性。即便你花了很多时间达到了这个目的,其它的开发者也会提交他们的修改或者禁用某些标志以方便他们快速提交代码,从而让你的努力功亏一篑。

在格式化代码上浪费时间是一件很枯燥的事情,Prettier 的目标便是解决这个问题。它将用简单的设置来帮助你克服格式化带来的困扰。

Prettier 可以做什么?

Prettier 是一个很有特色的代码格式化工具,它可以使整个代码库的格式化过程自动化。因此在设置好 Prettier 之后,你不再需要与同事讨论代码格式化规则、分号、换行符等问题了。它会导入你所有代码,删除所有格式,并根据其样式规则重新格式化代码。

在 Prettier 环境下,所有的 javascript 代码都会转换为抽象语法树,然后被重新格式化。因此,它确保不会对编写的代码进行任何破坏更改。对你来说,所有的东西都会被神奇地格式化,这你并不用担心。

例如:

foo(reallyLongArg(), omgSoManyParameters(), IShouldRefactorThis(), isThereSeriouslyAnotherOne());

会被被格式化为

foo(
  reallyLongArg(),
  omgSoManyParameters(),
  IShouldRefactorThis(),
  isThereSeriouslyAnotherOne()
);

如果你想让体验一下,可以使用 playground 来试试。总结一下:

  与 ESLint 的差异

这是最常见的问题之一,简明的回答是 ESLint 只是一个代码质量工具 (确保没有未使用的变量、没有全局变量,等等)。而 Prettier 只关心格式化文件 (最大长度、混合标签和空格、引用样式等)。你可以将 ESLint 和 Prettier 结合起来使用,以获得双赢的组合。

  Editorconfig 的作用

Prettier 1.9 版本之前会从 editorconfig 中读取配置值,推荐的配置选项包括:indent_style、indent_size/tab_width 和 max_line_length。

如何设置

如上所述,Prettier 的自动化程序会将整个代码库格式化。以下是你可以使用 Prettier 的场景:

  • 编辑器插件

  • CLI

  • Pre-commit hooks

  在编辑器中使用

进入网站的交互页面并下载相应的插件,在你的 IDE/ 编辑器中安装它。这应该是一个非常简单的过程。对于 Visual Studio Code,你只需要从市场下载便可。之后,在用户设置中添加了一个首选项 ("editor.formatOnSave": true)。这样便可以起效了。我还根据我的需要设置了"prettier.singleQuote": true,其它的编辑器属性也可以在这里设置。

  在项目中使用

你需要先安装 Prettier 的 CLI。我们将把它添加为 dev 依赖项:

yarn add prettier --dev --exact 
//or 
npm install --save-dev --save-exact prettier

Prettier 推荐在项目中安装恰当的版本,因为 Prettier 会在补丁发布时引入代码格式的变化。安装成功后,要针对某个特定文件运行的话,只需要运行命令 yarn prettier --write index.js,这样便可在当前目录生成 index.js 文件。

你可以根据需要配置 Prettier 的其他选项,通常使用配置文件来做。也可以将这些添加到.prettierrc 文件中并放置在项目的根文件夹下。可用选项可以在网站上找到。

然后,你可以将这个命令添加到你的 NPM 脚本中,并将 src 文件夹作为一个 glob 传递给它,而不是一个单独的文件。格式化脚本是这样的:

prettier --write './src/**/*.{ts,js,css,json}'

如果你没有使用这种复杂的配置,也没用.prettierrc 文件,你也可以使用命令行参数指定选项配置。

然后你可以将其作为构建步骤的一部分进行调用。所有的改变也都会生效的。

在项目中,你可以更进一步将 Prettier 代码整合为一个 pre-commit hook。你需要安装 husky 来配合 lint-stage /pretty-quick 使用 (如果你正在使用其他工具,比如 ESLint,请使用 lint-stage)。从 NPM 安装这些包作为 dev 依赖项之后,你可以将以下配置添加到 package.json 文件中:

pretty-quick:

"scripts": {
    "precommit": "pretty-quick --staged”
  }

lint-staged:

"scripts": {
   "precommit": "lint-staged",
   "lint-staged": {
    "*.{ts,js,css,json}": [
       "prettier --write", 
       "git add"
     ]
  }
}

要注意的是,当你将 prettier 作为一个 pre-commit hook 运行时,它会破坏你项目的状态。一个解决方案 (gocarsno 在 Reddit 上建议的) 是在提交之前存储所有尚未载入的变更 (git stash -k)。

你可以更进一步在项目的构建步骤中添加另一个检查。Facebook 是这样做的,我是在一个员工会议演讲中知道这件事的。你可以在文件上的 CI/CD 服务器上运行 Prettier,如果 Prettier 的文件输出与签入的文件不同,那么服务器编译就会失败。你可以选择这样做,这取决于你依赖它的程度。

你还在等什么? 赶紧去配置使用 Prettier 吧!别再人工格式化项目代码了,让机器为你做这事。

如果你喜欢 Prettier 的话请分享这篇文章,我也是为了让更多的人发现 Prettier 的魅力。

查看原文:

https://www.wisdomgeek.com/web-development/using-prettier-format-javascript-code/

前端之巅

「前端之巅」是 InfoQ 旗下关注前端技术的垂直社群,加入前端之巅学习群请关注「前端之巅」公众号后回复 “ 加群 ”。投稿请发邮件到 editors@cn.infoq.com,注明 “ 前端之巅投稿 ”。

活动推荐:

随着人工智能、物联网等技术的普及,从未来的端来看,端已经不仅仅是手机和 PC,会涉及到各种各样的端的交互和展现形式。QCon 北京 2018,与淘宝高级技术专家寒冬、新浪微博技术专家聂永、百度资深前端工程师彭星等技术大咖探索前端技术实践,以及实践中的思考和经验参考。目前大会 8 折报名中,立减 1360 元。有任何问题可咨询购票经理 Hanna,电话:15110019061,微信:qcon-0410。

 
前端之巅 更多文章 这里有25个React Native免费教程,请您查收~ RedMonk发布编程语言排行榜:Swift成为全球增长最快的编程语言 滴滴出行跨地域 iOS 构建优化与持续集成 Swift 4.2进入最后开发阶段,为Swift 5铺平道路 致移动开发前线读者
猜您喜欢 转战WebApp: 最适合Android开发者的WebApp框架 小而巧的数字压缩算法:zigzag 一大波python基础知识,让你面试更轻松! 那些你应该知道却不一定知道的——View坐标分析汇总 23 岁 IT 男与女友不欢而散,扔下一箱 200 万元分手费走了