Prettier 是什么?
Prettier 是一款支持多种语言的、有主见的代码格式化工具。它通过解析你的代码并根据其自身的规则(同时考虑行长)重新打印,来强制执行一致的代码风格。这消除了团队中所有关于样式的争论,因为该工具确保每个文件都具有相同的格式。它与大多数编辑器集成,并可以添加到 pre-commit 钩子中以完全自动化该过程。
主要功能
- 有主见的格式化: Prettier 为你做决定,所以你不需要。这种一致性是其理念的关键。
- 多语言支持: 无缝支持 JavaScript、TypeScript、JSX、Angular、Vue、CSS、Less、SCSS、HTML、JSON、GraphQL、Markdown 等。
- 编辑器集成: 在大多数流行的代码编辑器(如 VS Code、Vim 和 WebStorm)中作为插件提供,通常具有“保存时格式化”功能。
- CLI 工具: 强大的命令行界面允许你格式化文件、检查格式问题,并与 CI/CD 流水线集成。
- 最简配置: 尽管非常有主见,但如果需要,它也提供了一些选项来定制格式化规则。
使用场景
- 强制执行团队范围的代码风格: 主要用途是确保团队中的每个开发人员都贡献具有完全相同风格的代码。
- 自动化格式化: 在 pre-commit 钩子中运行 Prettier,以在提交前自动格式化暂存的文件。
- CI/CD 流水线: 在你的持续集成流水线中使用
--check命令,使包含未格式化代码的构建失败。 - 提高可读性: 快速格式化混乱或不一致的旧代码库,使其更具可读性和可维护性。
入门指南
开始使用 Prettier 很简单。首先,在你的项目中将其安装为开发依赖项。
```bash npm install –save-dev –save-exact prettier
或使用 yarn
yarn add –dev –exact prettier
接下来,创建一个配置文件,让编辑器和其他工具知道你正在使用 Prettier。一个简单的 prettierrc.json 文件就足够了:
```json {}
现在,你可以从命令行格式化你的文件。要格式化特定文件并写入更改:
```bash npx prettier –write src/index.js
要格式化项目中所有支持的文件:
```bash npx prettier –write .
定价
Prettier 是完全免费和开源的,由一个贡献者社区维护。
集成
Prettier 旨在与 ESLint 等 linter 工具协同工作。使用 eslint-config-prettier 来禁用所有不必要或可能与 Prettier 冲突的 ESLint 规则。这使得 ESLint 可以专注于捕捉错误和代码异味,而 Prettier 则处理所有格式化工作。