zao-lint

介绍

早早聊相关代码规范文件

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

内部集成了 eslint prettier，eslint，stylelint, commitlint 依赖

使用

postinstall

在 package.json 中 添加 如下内容

{
  ...,
  "scripts": {
    ...,
    "postinstall": "zaolint",
    "commitlint": "commitlint --config .commitlintrc.js -e -V",
    "lint-staged": "lint-staged",
    },
    "lint-staged": {
    // 内容可以根据实际需求进行修改
    },
  ...,
}

校验项配置举例

{
  ...,
  "scripts": {
    ...,
    "lint": "npm run lint:js && npm run lint:style && npm run lint:prettier && npm run tsc",
    "lint-staged": "lint-staged",
    "lint:fix": "eslint \"src/**/*\" --fix --cache --ext .js,.jsx,.ts,.tsx --format=pretty",
    "lint:js": "eslint \"src/**/*\" --cache --ext .js,.jsx,.ts,.tsx --format=pretty ",
    "lint:prettier": "prettier -c --write \"src/**/*\" --end-of-line auto",
    "precommit": "lint-staged",
    "prettier": "prettier -c --write \"src/**/*\"",
  },
  "lint-staged": {
    "**/*.less": "stylelint --syntax less",
    "**/*.{js,jsx,tsx,ts,less,md,json}": [
      "prettier --write"
    ],
    "*.{js,jsx,ts,tsx}": [
      "eslint",
      "prettier --write",
      "git add"
    ]
  },
  ...,
}

.commitlintrc.js

const zaoLint = require('zao-lint')
module.exports = {
  ...zaoLint.commitlint,
}

.eslintrc.js

module.exports = {
  extends: [require.resolve('zao-lint/eslint')],
  globals: {
    ANT_DESIGN_PRO_ONLY_DO_NOT_USE_IN_YOUR_PRODUCTION: true,
    page: true,
    REACT_APP_ENV: true,
  },
  parserOptions: {
    project: './tsconfig.json',
  }
}

.prettierrc.js

const zaoLint = require('zao-lint')
module.exports = {
  ...zaoLint.prettier
};

.stylelintrc.js

const zaoLint = require('zao-lint')

module.exports = {
  ...zaoLint.stylelint,
}