lint-mc

eslint 配置集成 eslint prettier husky lint-staged，利用pre-commit脚本添加prettier提交前格式化，eslint fix自动修复和eslint 错误上报等功能

Usage no npm install needed!

<script type="module">
  import lintMc from 'https://cdn.skypack.dev/lint-mc';
</script>

README

Lint-mc

方便 git hook、prettier、 eslint、commlint 快速便捷的使用，拷贝推荐配置，提交时 prettier 格式化，检测并修复git 改动的文件可修复错误，输出并在 push 到仓库时上报 eslint 报错。

Install

npm i -D lint-mc

// package.json
"lint-staged": {
  "**/*.{js,jsx}": [
    "prettier --write", // 可选
    "node ./node_modules/lint-mc/bin/pre-lint.js"
  ]
},
"husky": {
  "hooks": {
    "pre-commit": "lint-staged",
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
    "pre-push": "npm run prepush"
  }
}

git add . && git commit -m 'feat: commit new feat'

使用

包在安装时默认会初始化， 在 git 提交默认会自动修复，在 push 到仓库时会自动上报。

也可使用指令

mclint init // 初始化

mclint // 默认当前目录
mclint lint -p 指定相对目录 // 指定项目目录检查修复

也可使用 npm 命令在提交前检查修复

npm run eslint -s // eslint 检查
npm run prettier -s // prettier 格式化

配置文件

eslint-config-mcfe

默认是基础配置， 有 vue、react、reactnative、typescript 等推荐配置。

// eslintrc.js 
module.exports = {
  extends: ['mcfe'] // 基础配置
}

module.exports = {
  extends: ['mcfe/react'] // react
}

module.exports = {
  extends: ['mcfe/vue'] // vue
}
module.exports = {
  extends: ['mcfe/react-native'] // reactnative
}

module.exports = {
  extends: ['mcfe/mini'] // 小程序
}