code-config

安装

$ npm install --save-dev @buibis/code-config

使用

修改了相关规则后，有可能出现不会生效的情况，这时首先尝试重启编辑器

• 编辑器配合EditorConfig一起使用，参考

版本控制

• 忽略文件.gitignore

在项目根目录创建commitlint.config.js文件，内容如下:

module.exports = {
  extends: ["@buibis/code-config/commitlint.config.js"],
};

package.json中增加如下配置：

// husky 版本4.x
{
  "husky": {
    "hooks": {
      // npm run codecheck 为scripts中的命令
      "pre-commit": "npm run codecheck",
      "commit-msg": "cross-env-shell \"commitlint -e $HUSKY_GIT_PARAMS\""
    }
  }
}

使用lint-staged来配合linter检查

使用lint-staged 的好处是，它只会对本次加到git暂存区的文件进行检查，而不是全量检查。这样就提高了lint的速度。

$ npm install lint-staged -D

.lintstagedrc.js

module.exports = {
  'packages/**/*.{js,jsx,ts,tsx}': ["eslint -c .eslintrc.js --rule \"'no-console':'error'\""],
  'packages/**/*.ts?(x)': () => 'tsc --noEmit',
};

package.json

{
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged",
      "commit-msg": "cross-env-shell \"commitlint -e $HUSKY_GIT_PARAMS\""
    }
  },
}

stylelint

• 编辑器集成
• 忽略文件.stylelintignore

在项目根目录创建.stylelintrc.js文件，内容如下:

module.exports = {
  extends: ["@buibis/code-config/stylelint.js"],
  rules: {},
};

Prettier

• 编辑器集成
• 忽略文件.prettierignore

在项目根目录创建.prettierrc.js文件，内容如下:

module.exports = {
  ...require("@buibis/code-config/prettier.js"),
};

VScode 下 prettier 自动格式化

.vscode/settings.json 配置如下：

{
  // 保存时自动格式化
  "editor.formatOnSave": true,
  // 采取prettier作为默认的格式化工具
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  // 为包括ESLint在内的所有插件打开“自动修复”
  "editor.codeActionsOnSave": {
    "source.fixAll": true
  }
}

TypeScript 使用 tsconfig.json

在项目根目录创建tsconfig.json文件，内容如下:

{
  "extends": "@buibis/code-config/tsconfig.json"
}