@cecdataFE/lint-config

一个包含 prettier，eslint，stylelint 的配置文件合集

A collection of configuration files containing prettier, eslint, stylelint

Use

1.安装与配置

npm i @cecdataFE/lint-config --save-dev
yarn add @cecdataFE/lint-config -D

根目录下新增 .eslintrc.js

module.exports = {
  extends: [require.resolve('@cecdataFE/lint-config/dist/eslint')],

  rules: {
    // your rules
  }
}

.eslintignore

# 根据项目实际情况调整
# dependencies
node_modules
# production
devops
dist
public
/.vscode
lib
es
.github
scripts
webpack.config.js
vue.config.js
customWebpack.config.js

.prettierrc.js

const config = require('@cecdataFE/lint-config')

module.exports = {
  ...config.prettier
}

.prettierignore

# 根据项目实际情况调整
**/*.svg
devops
**/dist
**/lib
**/es
**\__snapshots__\**

2.新增脚本命令

"lint": "eslint --ext .js,.jsx,.ts,.tsx  --fix --quiet --format=pretty ./src && npm run lint:prettier",
"lint:prettier": "npm run prettier && prettier --version && prettier --check \"src/**/**.{js,jsx,tsx,ts,less,md,json}\" --end-of-line auto",
"prettier": "prettier --write \"**/**.{js,jsx,tsx,ts,less,md,json}\" --loglevel warn"

3.验证与检查

npm run dev 和 npm run build查看功能是否正常

如果编译报错，可能需要重新删除node_modules和lock文件重新安装

检查正常之后，可以跑 npm run lint 检查代码、手动修复lint错误（会自动修复一些不会破坏代码结构的问题、并格式化代码）

4.与git hooks配合使用

TODO