Skip to content

Latest commit

 

History

History
77 lines (45 loc) · 3.55 KB

使用 Prettier 格式化代码.md

File metadata and controls

77 lines (45 loc) · 3.55 KB

使用 Prettier 格式化代码

Prettier 是一个固执己见的代码格式化程序。

Prettier 的标志

它支持许多开箱即用的不同语法,包括:

  • HTML
  • CSS、SCSS 和 Less
  • JavaScript
  • Flow 和 TypeScript
  • Vue
  • JSX
  • YAML
  • JSON
  • GraphQL
  • Markdown

通过插件,您可以将其用于 Python、PHP、Swift、Ruby 和 Java 等。

它与最流行的代码编辑器集成,包括 VS Code、Sublime Text、Atom 等。

更少的选项

我最近在学习了 Go,Go 最棒的地方之一是 gofmt,这是一个官方工具,可以根据通用标准自动格式化您的代码。

Go 代码的 95%(由统计数据组成)看起来完全一样,因为这个工具可以很容易地执行,而且由于风格是由 Go 维护人员为您定义的,您更有可能适应该标准,而不是坚持自己的风格。例如制表符与空格,或者在何处放置左括号。

这听起来像是一个限制,但它实际上非常强大。所有 Go 代码看起来都一样。

Prettier 与 gofmt 类似。

它的选项很少,而且大部分决定已经为您做出,因此您可以停止争论关于风格的任何问题,并专注于您的代码。

与 ESLint 的区别

ESLint 是一个 linter,它不只是格式化,而且由于对代码的静态分析,它还突出了一些错误提示。

这是一个非常棒的工具,可以与 Prettier 一起使用。

ESLint 还强调了格式化问题,但由于它的可配置性更高,每个人都可以有一套不同的格式化规则。而 Prettier 为所有人提供了一个共同点。

现在,您可以自定义一些内容,例如:

  • tab 宽度
  • 单引号与双引号
  • 行列数
  • 尾随逗号

还有其他一些选项,但 Prettier 试图控制这些定制的数量,以避免变得过于可定制。

安装

Prettier 可以从命令行运行,您可以使用 npm、yarn 和 pnpm 安装它。

Prettier 的另一个很好的用例是在您的 Git 存储库的 PR 上运行它,例如在 GitHub 上。

如果您使用受支持的编辑器,最好是直接从编辑器中使用 Prettier,每次保存时都会运行 Prettier 格式。

例如,VS Code 的 Prettier 扩展

Prettier 更适合初学者

如果您认为 Prettier 仅适用于团队或专业用户,那么您就错过了该工具的一个良好价值主张。

良好的风格会强化良好的习惯。

格式化是一个经常被初学者忽视的话题,但拥有清晰一致的格式化是您作为一名新开发人员成功的关键。

此外,即使您刚开始学习 JavaScript,从代码风格上看,您的代码也会变得更漂亮,就像一位资深大佬编写代码一样。

最后

可以看看 Anthony Fu 月初发表的为什么我不使用 Prettier。他解释了自己为什么使用 ESLint 而不使用 Prettier。

如果你确定在项目中同时使用 ESLint 和 Prettier,又很出现一些奇特的行为不知道怎么解决,可以看看彻底搞懂 ESLint 与 Prettier 在 vscode 中的代码自动格式化