@tuia/base-config-common

- stylelint - commit-lint - lint-staged

Usage no npm install needed!

<script type="module">
  import tuiaBaseConfigCommon from 'https://cdn.skypack.dev/@tuia/base-config-common';
</script>

README

下列基础配置

  • stylelint
  • commit-lint
  • lint-staged

接入指南

安装

yarn add base-config-tuia -D

// 安装对应的依赖
# stylelint
yarn add stylelint stylelint-config-standard -D

#commmit-lint
yarn add @commitlint/cli @commitlint/config-conventional husky@4.2.5 -D

#lintstaged
yarn add lint-staged husky -D

根目录下添加对应配置文件

  • .stylelintrc.js
module.exports = {
  extends: ['base-config-tuia/stylelintrc'],
  rules: {
    // 其他自定义规则
  },
}
  • .lintstagedrc.js
module.exports = {
  ...require('base-config-tuia/lintstaged'),
  // 其他自定义操作 eg:
  //  "*.{css,md,html,json}": [
  //   "prettier --write",
  //   "git add"
  // ]
}
  • commitlint.config.js
module.exports = {
  ...require('base-config-tuia/commitlint.config'),
  // 其他属性需要全量覆盖
}

注意事项

  • 配置对应的 githooks
{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
      "pre-commit": "lint-staged"
    }
  }
}
  • 添加.lintstagedrc.js后,需要在 package.json 中移除对应操作,配置文件的优先级是package.json最高的。 eg package.json
{
  // ...
-   "lint-staged": {
-    "*.{js,jsx,vue,ts}": [
-      "eslint",
-      "git add"
-    ],
-    // ...
 }
}