返回
兼得规则与自由:Eslint+Prettier打造统一代码风格
前端
2023-09-12 16:59:19
Eslint与Prettier的优势
Eslint和Prettier各有其优势。Eslint是一款静态代码分析工具,可以帮助我们发现代码中的潜在问题,例如语法错误、拼写错误、代码风格不一致等。Prettier是一款代码格式化工具,可以帮助我们自动将代码格式化为统一的风格。
如何使用Eslint+Prettier统一代码风格
- 安装Eslint和Prettier
npm install eslint --save-dev
npm install prettier --save-dev
- 配置.eslintrc.json文件
{
"extends": "eslint:recommended",
"rules": {
"semi": ["error", "always"],
"quotes": ["error", "double"],
"indent": ["error", 2]
}
}
- 配置.prettierrc文件
{
"singleQuote": true,
"trailingComma": "es5",
"tabWidth": 2,
"semi": true
}
- 在package.json中添加脚本
{
"scripts": {
"lint": "eslint src/**/*.js",
"format": "prettier --write src/**/*.js"
}
}
- 运行脚本
npm run lint
npm run format
如何编写.eslintrc.json和.prettierrc文件
.eslintrc.json文件是Eslint的配置文件,我们可以通过它来配置Eslint的规则。.prettierrc文件是Prettier的配置文件,我们可以通过它来配置Prettier的格式化规则。
在.eslintrc.json文件中,我们可以配置Eslint的规则。这些规则可以分为两类:内置规则和扩展规则。内置规则是Eslint自带的规则,扩展规则是第三方提供的规则。我们可以通过在"extends"字段中指定要扩展的规则集来使用扩展规则。
在.prettierrc文件中,我们可以配置Prettier的格式化规则。这些规则可以分为两类:内置规则和自定义规则。内置规则是Prettier自带的规则,自定义规则是我们自己定义的规则。我们可以通过在"rules"字段中指定要使用的规则来使用这些规则。
结语
Eslint和Prettier是两款强大的代码风格工具,可以帮助我们轻松实现代码风格的统一。通过使用这些工具,我们可以提高代码的可读性和可维护性,促进团队协作,并降低代码质量问题。