.eslintrc.js

// 仅 commit 时会用
const commitRules = {
  'no-alert': 2,
  'no-debugger': 2,
  'no-console': [
    'error',
    {
      allow: ['warn', 'error'],
    },
  ],
  'no-unused-vars': 2,
};

module.exports = {
  root: true,
  extends: [
    'airbnb',
    'airbnb-typescript',
    'plugin:@typescript-eslint/recommended',
    'plugin:prettier/recommended',
    'prettier',
  ],
  parserOptions: {
    project: './tsconfig.json',
    ecmaVersion: 6,
    sourceType: 'module',
    ecmaFeatures: {
      jsx: true,
    },
  },
  globals: {
    React: true,
    ReactDOM: true,
    _: true,
    moment: true,
    mobx: true
  },
  rules: {
    // javascript
    'brace-style': [2, '1tbs', { allowSingleLine: true }],
    'block-spacing': [2, 'always'],
    'no-const-assign': 2,
    'prefer-destructuring': 0, // 推荐通过结构赋值访问 object 或者 array
    'no-prototype-builtins': 0,
    'no-useless-escape': 0,
    'no-unused-expressions': 2, // 开启对短路求值和三元表达式的支持
    'no-console': [2, { allow: ['warn', 'error', 'log'] }],
    'no-nested-ternary': 2, // 禁止三元表达式嵌套
    'class-methods-use-this': 1,
    // jsx
    'jsx-a11y/anchor-is-valid': 0,
    'jsx-a11y/click-events-have-key-events': 0, // 强制 绑定 onClick 事件同时也绑定 onKeyUp, onKeyDown, onKeyPress 等事件
    'jsx-a11y/no-static-element-interactions': 0, // 强制给 div span 等没有语义的标签加上 role 角色，（在有onClick 等事件的前提下）
    // react
    '@typescript-eslint/no-unused-expressions': 2, // 开启对短路求值和三元表达式的支持
    'react/jsx-no-undef': [
      2,
      {
        allowGlobals: true,
      },
    ],
    'react/jsx-no-bind': 0,
    'react/static-property-placement': 0, // static 静态类型强制定义在class 组件外
    'react/no-deprecated': 0,
    'react/jsx-no-target-blank': 0,
    'react/jsx-filename-extension': [1, { extensions: ['.js', '.jsx', '.ts', '.tsx'] }], // 识别扩展名
    'react/jsx-props-no-spreading': 0, // 禁止 jsx 组件上使用 <button {...props} />
    'react/no-array-index-key': 2, // 禁止使用遍历中的 index 作为 key, 通过重新命名变量避开 const count = idx;
    'react/require-default-props': 0, // 强制给 默认值
    'react/function-component-definition': 0, // 强制使用一致的函数命名
    'react/no-unused-class-component-methods': 1,
    'import/prefer-default-export': 0,
    'import/no-extraneous-dependencies': 0, // import 的内容要在 package.json 的 dependencies下（关闭）
    /*
     * 1. 循环引用检查, 运行时开销很大
     * https://github.com/benmosher/eslint-plugin-import/blob/d81f48a2506182738409805f5272eff4d77c9348/docs/rules/no-cycle.md
     * */
    'import/no-cycle': 'off',
    /*
     * 2. 用来检查未使用的模块或者代码，会导致控制台频繁打印error
     * https://github.com/benmosher/eslint-plugin-import/blob/f63dd261809de6883b13b6b5b960e6d7f42a7813/docs/rules/no-unused-modules.md
     * */
    'import/no-unused-modules': 'off',
    '@typescript-eslint/camelcase': 0,
    '@typescript-eslint/lines-between-class-members': [
      2,
      'always',
      {
        exceptAfterSingleLine: true, // 单行的类成员跳过检查
        exceptAfterOverload: true, // 重载的跳过检查
      },
    ],
    '@typescript-eslint/naming-convention': [
      2,
      { selector: 'variable', format: ['camelCase', 'PascalCase', 'UPPER_CASE'] },
      { selector: 'function', format: ['camelCase', 'PascalCase'] },
      { selector: 'typeLike', format: ['PascalCase'] },
      { selector: 'enumMember', format: ['UPPER_CASE', 'camelCase', 'PascalCase'] },
      { selector: 'enum', format: ['UPPER_CASE', 'PascalCase'] },
    ],
    'prettier/prettier': [
      'error',
      {},
      {
        fileInfoOptions: {
          withNodeModules: false,
        },
      },
    ],
    // NOTICE: 因为测试暂时关闭检查，
    // ...(process.env.ESLINT_ENV === 'commit' ? commitRules : {}),
  },
  env: {
    browser: true,
    node: true,
  },
  settings: {
    react: {
      version: require('./package.json').dependencies.react,
    },
  },
};