1.执行命令,安装 husky
yarn add -D husky@6.0.0 lint-staged
husky 是提供git钩子的解决方案,它可以提供git在多个阶段前的操作,比如pre-commit、pre-push等,这里我们使用pre-commit
lint-staged,它只对git暂存区的文件执行linter检测,相对每次执行lint命令,这种只对增量修改的检测效率会高很多
2.在package.json的scripts中配置prepare指令
"prepare": "cd .. && cd .. && husky install ./各种活动/medical_cosmetology/.husky"
按照设计,husky install必须在与 相同的目录中运行.git,但您可以在prepare脚本期间更改目录并传递子目录:
必须在与git相同的目录中运行
3.执行刚才配置的命令
yarn run prepare
执行完之后会在项目下生成如下.husky文件
4.执行这个命令
npx husky add .husky/pre-commit
执行完之后会在.husky下面生成一个pre-commit文件
5.修改pre-commit文件
打开刚刚生成的pre-commit文件是这样子的,接下来需要修改它
修改成这个样子,
6.在当前项目文件夹下,添加.lintstagedrc.js文件,内容如下
module.exports = { "src/**/\*{js,jsx,ts,tsx,md,html}": ["eslint", "prettier --write"],}
文件内容根据,根据情况,按需配置。
.lintstagedrc.js添加的位置如下
7.将.eslintrc.js文件内容修改成如下
module.exports = { env: { browser: true, es6: true }, extends: ["plugin:react/recommended", "prettier"], globals: { Atomics: "readonly", SharedArrayBuffer: "readonly" }, parserOptions: { ecmaFeatures: { jsx: true }, ecmaVersion: 2018, sourceType: "module" }, parser: "babel-eslint", plugins: ["react"], settings: { react: { version: "detect" } }, rules: { semi: ["error"], "no-unused-vars": ["error"], quotes: ["error", "double"], "react/prop-types": "off", "no-mixed-spaces-and-tabs": ["error"], "comma-dangle": ["error", "only-multiline"] } };
.eslintrc.js位置如下
这个文件用于做一些格式校验
8.安装几个插件
yarn add -D eslint-plugin-react babel-eslint eslint eslint-config-prettier prettier
.eslintignore/.eslintrc.js/.prettierignore/.prettierrc.js(这里几个文件eslintrc可以自己写检测,忽略规则,除了它eslintrc.js其它的不强求)
eslint-plugin-react:设定react组件的相关规范
eslint-config-prettier:
eslint :eslint中集成了prettier
eslint-config-prettier: eslint-plugin-prettier 插件会调用 prettier对你的代码风格进行检查,其原理是先使用 prettier对你的代码进行格式化,然后与格式化之前的代码进行对比,如果过出现了不一致,这个地方就会被 prettier进行 标记。
prettier:自定以代码风格
9.拉一个文件出来,做一点小修改,我这里添加了一个空行,测试刚才的配置是否正确
10.到此位置就配置好了
参考文献: