Prettier
一、概述
- 是什么:
- 特点:
- 会移除所有原始的代码样式,并确保所有的输出代码符合一致的代码风格
- 会根据行长度来从头开始重新排版代码
- 优点:
- 能使项目和团队拥有一个共同的代码风格指南
- 是一个完全自动的“代码风格指南”
二、安装与使用
- 安装:
- npm install --save-dev --save-exact prettier 或 yarn add --dev --exact prettier
- 创建一个配置文件.prettierrc.json,告诉编辑器和其他工具在用Prettier
- echo {} > .prettierrc.json
- 创建一个.prettierignore文件,告诉Prettier CLI和编辑器不要格式化哪些文件
- echo {} > .prettierignore
- 使用:
- 格式化所有文件:
- npx prettier --write / yarn prettier --write
- 格式化特定目录或文件:
- npx prettier --write path/filename
- 检查文件是否格式化:
- 协调Prettier和ESLint:
- 安装eslint-config-prettier
- 作用:
- 关闭所有不必要的ESLint规则或者可能与Prettier冲突的规则
- husky中配置Prettier作为预提交钩子运行:(配置前:husky本身的配置已完毕)
- 安装lint-staged
- npm install -D lint-staged
- 添加相应的钩子脚本
- npx husky add ./husky/_/pre-commit "npx lint-staged"
- package.json里增加内容
- "lint-staged": {"**/*":"prettier --write --ignore-unknown"}