eslint-plugin

快速开始

安装

<npm|yarn|pnpm> add --D eslint@^7.32.0 prettier@^2.4.1 @finter/eslint-plugin

使用 JavaScript 的项目

创建一个 .eslintrc.js 文件在项目根目录，然后复制下面的代码到这个文件中：

module.exports = {
  extends: ['plugin:@finter/eslint-plugin/javascript'],
  plugins: ['@finter/eslint-plugin'],
  env: {
    // Your environments (which contains several predefined global variables)
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // Your global variables (setting to false means it's not allowed to be reassigned)
    //
    // myGlobal: false
  },
  rules: {
    // Customize your rules
  },
}

使用 Typescript 的项目

创建一个 .eslintrc.js 文件在项目根目录，然后复制下面的代码到这个文件中：

module.exports = {
  extends: ['plugin:@finter/eslint-plugin/typescript'],
  plugins: ['@finter/eslint-plugin'],
  env: {
    // Your environments (which contains several predefined global variables)
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // Your global variables (setting to false means it's not allowed to be reassigned)
    //
    // myGlobal: false
  },
  rules: {
    // Customize your rules
  },
}

使用 React 的项目

创建一个 .eslintrc.js 文件在项目根目录，然后复制下面的代码到这个文件中（同时我们还提供可无障碍的规则集梳理，在 extends 字段中添加即可 plugin:@finter/eslint-plugin/react-a11y）：

module.exports = {
  extends: ['plugin:@finter/eslint-plugin/react', 'plugin:@finter/eslint-plugin/javascript'],
  plugins: ['@finter/eslint-plugin'],
  env: {
    // Your environments (which contains several predefined global variables)
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // Your global variables (setting to false means it's not allowed to be reassigned)
    //
    // myGlobal: false
  },
  rules: {
    // Customize your rules
  },
}

同时使用 Typescript 和 React 的项目

创建一个 .eslintrc.js 文件在项目根目录，然后复制下面的代码到这个文件中：

module.exports = {
  extends: ['plugin:@finter/eslint-plugin/react', 'plugin:@finter/eslint-plugin/typescript'],
  plugins: ['@finter/eslint-plugin'],
  env: {
    // Your environments (which contains several predefined global variables)
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // Your global variables (setting to false means it's not allowed to be reassigned)
    //
    // myGlobal: false
  },
  rules: {
    // Customize your rules
  },
}

使用 Vue3 的项目

创建一个 .eslintrc.js 文件在项目根目录，然后复制下面的代码到这个文件中：

module.exports = {
  extends: ['plugin:@finter/eslint-plugin/vue3', 'plugin:@finter/eslint-plugin/javascript'],
  plugins: ['@finter/eslint-plugin'],
  env: {
    // Your environments (which contains several predefined global variables)
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // Your global variables (setting to false means it's not allowed to be reassigned)
    //
    // myGlobal: false
  },
  rules: {
    // Customize your rules
  },
}

同时使用 Typescript 和 Vue3 的项目

创建一个 .eslintrc.js 文件在项目根目录，然后复制下面的代码到这个文件中：

module.exports = {
  extends: ['plugin:@finter/eslint-plugin/vue3', 'plugin:@finter/eslint-plugin/typescript'],
  plugins: ['@finter/eslint-plugin'],
  parserOptions: {
    parser: '@typescript-eslint/parser',
  },
  env: {
    // Your environments (which contains several predefined global variables)
    //
    // browser: true,
    // node: true,
    // mocha: true,
    // jest: true,
    // jquery: true
  },
  globals: {
    // Your global variables (setting to false means it's not allowed to be reassigned)
    //
    // myGlobal: false
  },
  rules: {
    // Customize your rules
  },
}