@waiting/eslint-config/src/rule/recommended-rules.mjs

ESLint Shareable Configuration for Typescript

import stylistic from '@stylistic/eslint-plugin'

// https://eslint.style/packages/default
export const stylesRules = {
  '@stylistic/indent': [0, 2],
  '@stylistic/indent-binary-ops': [0, 2],
  '@stylistic/func-call-spacing': ['error', 'never'],
  '@stylistic/function-paren-newline': [1, 'multiline-arguments'],
  '@stylistic/implicit-arrow-linebreak': 2,
  '@stylistic/linebreak-style': ['error', 'unix'],
  '@stylistic/max-statements-per-line': [2, { max: 2 }],
  '@stylistic/member-delimiter-style': [
    2,
    {
      multiline: {
        delimiter: 'comma',
        requireLast: true,
      },
      singleline: {
        delimiter: 'comma',
        requireLast: false,
      },
      overrides: {
        interface: {
          multiline: {
            delimiter: 'none',
            requireLast: false,
          },
        },
      },
    },
  ],
  '@stylistic/newline-per-chained-call': [2, { ignoreChainWithDepth: 5 }],
  '@stylistic/no-extra-parens': ['error', 'all', {
    ternaryOperandBinaryExpressions: false,
    nestedBinaryExpressions: false,
  }],
  '@stylistic/no-multiple-empty-lines': ['error', { max: 4, maxBOF: 1, maxEOF: 2 }],
  '@stylistic/no-trailing-spaces': ['error', { skipBlankLines: false, ignoreComments: true }],
  '@stylistic/object-curly-newline': [
    'error',
    {
      ObjectExpression: { multiline: true, minProperties: 6, consistent: true },
      ObjectPattern: { multiline: true, minProperties: 6, consistent: true },
      ImportDeclaration: { multiline: true, minProperties: 8 },
      ExportDeclaration: { multiline: true, minProperties: 2 },
    },
  ],
  '@stylistic/padded-blocks': 0,
  '@stylistic/padding-line-between-statements': [2,
    { blankLine: 'always', prev: ['case', 'default'], next: '*' },
    // { blankLine: 'never', prev: ['const'], next: ['const'] },
    // { blankLine: 'never', prev: ['let'], next: ['let'] },
  ],
  '@stylistic/quote-props': [1, 'as-needed'],
  '@stylistic/semi-style': ['error', 'last'],
  '@stylistic/space-unary-ops': [
    2,
    {
      words: true,
      nonwords: false,
      overrides: {
        '!': true,
        '!!': true,
      },
    },
  ],
  '@stylistic/switch-colon-spacing': 2,
}


export const lintRules = {
  '@typescript-eslint/prefer-ts-expect-error': 0,
  // https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin
  // https://typescript-eslint.io/rules/array-type
  '@typescript-eslint/ban-ts-comment': [
    0,
    {
      'ts-expect-error': 'allow-with-description',
      minimumDescriptionLength: 3,
    },
  ],
  'default-param-last': 0,
  '@typescript-eslint/default-param-last': 2,
  'dot-notation': 0,
  '@typescript-eslint/dot-notation': 0,
  '@typescript-eslint/explicit-function-return-type': 0,
  'no-shadow': 0,
  '@typescript-eslint/no-shadow': 2,
  '@typescript-eslint/no-unnecessary-qualifier': 2,
  'no-use-before-define': 0,
  '@typescript-eslint/no-use-before-define': ['error', { functions: false, typedefs: false }],

  '@typescript-eslint/no-extraneous-class': 0,
  '@typescript-eslint/no-require-imports': 2,
  '@typescript-eslint/prefer-includes': 1,
  '@typescript-eslint/prefer-nullish-coalescing': 1,
  '@typescript-eslint/prefer-optional-chain': 1,
  '@typescript-eslint/require-array-sort-compare': 2,
  '@typescript-eslint/require-await': 0,
  'no-return-await': 0,
  '@typescript-eslint/return-await': 2,

  // https://eslint.org/docs/rules/#best-practices
  curly: 2,
  eqeqeq: 2,
  'no-eval': 2,
  'no-throw-literal': 'off',
  '@typescript-eslint/only-throw-error': 'error',
  'no-unmodified-loop-condition': 2,
  'no-lonely-if': 1,

  // https://eslint.org/docs/rules/
  'no-await-in-loop': 1,
  'no-console': [2, { allow: ['warn', 'error', 'info'] }],
  'no-loop-func': 2,
  'no-multi-assign': 2,
  'no-multi-str': 2,
  'no-negated-condition': 1,
  'no-new-wrappers': 2,
  'no-object-constructor': 2,
  'no-octal-escape': 2,
  'no-param-reassign': 2,
  'no-return-assign': 2,
  'no-self-compare': 2,
  'no-sequences': 2,
  'no-template-curly-in-string': 1,
  'no-undef-init': 1,
  'prefer-const': 1,
  'prefer-rest-params': 1,
  'prefer-spread': 1,
  radix: 2,
  'require-unicode-regexp': 1,

  '@typescript-eslint/no-unused-expressions': [
    2,
    {
      allowShortCircuit: true,
      allowTernary: false,
      allowTaggedTemplates: false,
    },
  ],
}


const CI = !! ((process.env.CI
  ?? process.env.MIDWAY_SERVER_ENV === 'unittest')
  || process.env.MIDWAY_SERVER_ENV === 'local'
  || process.env.NODE_ENV === 'unittest'
  || process.env.NODE_ENV === 'local'
)
const isWin32 = process.platform === 'win32'

if (isWin32 && CI) {
  stylesRules['@stylistic/linebreak-style'] = 0
}


// https://eslint.style/packages/default
export const recommendedStyles = [
  stylistic.configs['recommended-flat'],
  {
    rules: {
      ...stylesRules,
    },
  },
]