eslint-config-mingelz

A shared ESLint configuration with Chinese comments by mingelz.

一份带有完整中文注释的 ESLint 规则。请打开 rules 目录下的文件，阅读每个规则的详细说明。

• Quick start
  • Installation
  • Configure
• Documentation
  • Basic configuration
  • Vue configuration
  • React configuration
  • Node.js configuration
  • ES Module configuration
  • JSDoc configuration
  • [WIP] JSX accessibility configuration

Quick start

Installation

npm install eslint-config-mingelz --save-dev

Configure

Add a .eslintrc.js file with following content to your project root directory:

module.exports = {
  env: {
    browser: true,
    node: true,
  },
  extends: [
    'mingelz',
  ],
}

Documentation

Basic configuration

NOTICE: This configuration is dependent on eslint@^7.16, please install it manually: npm install -D eslint.

module.exports = {
  env: {
    browser: true,
    node: true,
  },
  extends: [
    'mingelz',
  ],
  rules: {
    // your special rules
  },
}

Vue configuration

NOTICE: This configuration is dependent on eslint-plugin-vue@^7.3, please install it manually: npm install -D eslint-plugin-vue

module.exports = {
  // ...
  extends: [
    'mingelz',
    // The configuration will detect Vue.js version of your project automatic.
    'mingelz/rules/vue',
  ],
  // ...
}

React configuration

NOTICE: This configuration is dependent on eslint-plugin-react@^7.21, please install it manually: npm install -D eslint-plugin-react

module.exports = {
  // ...
  extends: [
    'mingelz',
    'mingelz/rules/react',
  ],
  // ...
}

Node.js configuration

The ESLint built-in Node.js/CommonJS-specific rules are deprecating, use eslint-plugin-node instead.

NOTICE: This configuration is dependent on eslint-plugin-node@^11.1, please install it manually: npm install -D eslint-plugin-node

module.exports = {
  // ...
  extends: [
    'mingelz',
    'mingelz/rules/node',
  ],
  // ...
}

ES Module configuration

NOTICE: This configuration is dependent on eslint-plugin-import@^2.22, please install it manually: npm install -D eslint-plugin-import

If you are using Webpack resolve.alias, it is recommended to install eslint-import-resolver-webpack via npm install -D eslint-import-resolver-webpack, and configure it according to the webpack configuration file.

module.exports = {
  // ...
  extends: [
    'mingelz',
    'mingelz/rules/es-module',
  ],
  // webpack config example
  settings: {
    'import/resolver': {
      webpack: {
        config: './webpack.config.js',
      },
    },
  },
  // ...
}

JSDoc configuration

The ESLint built-in JSDoc rules was deprecated, use eslint-plugin-jsdoc instead.

NOTICE: This configuration is dependent on eslint-plugin-jsdoc@30.7, please install it manually: npm install -D eslint-plugin-jsdoc

module.exports = {
  // ...
  extends: [
    'mingelz',
    'mingelz/rules/jsdoc',
  ],
  // ...
}

[WIP] JSX accessibility configuration

NOTICE: This configuration is dependent on eslint-plugin-jsx-a11y, please install it manually: npm install -D eslint-plugin-jsx-a11y

module.exports = {
  // ...
  extends: [
    'mingelz',
    'mingelz/rules/jsx-a11y',
  ],
  // ...
}