eslint-config-oclif/index.js

eslint config for oclif

import eslint from '@eslint/js'
import stylistic from '@stylistic/eslint-plugin'
import xo from 'eslint-config-xo'
import jsdoc from 'eslint-plugin-jsdoc'
import mocha from 'eslint-plugin-mocha'
import nodePlugin from 'eslint-plugin-n'
import perfectionist from 'eslint-plugin-perfectionist'
import tseslint, {configs} from 'typescript-eslint'

// Strip the plugins key from the import-plugin-n plugin, so that it doesn't conflict with the one used by xo.
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const {plugins: _, ...nodeRecommended} = nodePlugin.configs['flat/recommended']

export default tseslint.config(
  eslint.configs.recommended,
  configs.recommended,
  // Strip the '@typescript-eslint' and '@stylistic' plugins from xo's configs so they aren't
  // registered twice. Both are direct dependencies here (via typescript-eslint and the '@stylistic'
  // block below) and may resolve to a different version than the copies xo bundles; flat config
  // throws "Cannot redefine plugin" when the same namespace is registered with two non-identical
  // plugin objects. We register both namespaces ourselves, so xo can reference their rules without
  // re-declaring the plugins.
  ...xo({space: true})
  .filter(c => ['xo/base', 'xo/ignores', 'xo/typescript'].includes(c.name))
  .map(c => {
    if (!c.plugins) return c
    // eslint-disable-next-line @typescript-eslint/no-unused-vars
    const {'@stylistic': _stylistic, '@typescript-eslint': _tsPlugin, ...plugins} = c.plugins
    return {...c, plugins}
  }),
  mocha.configs.recommended,
  nodeRecommended,
  perfectionist.configs['recommended-natural'],
  jsdoc.configs['flat/recommended'],
  {
    files: ['test/**/*.test.ts'],
    rules: {
      '@typescript-eslint/no-unused-expressions': 'off',
    },
  },
  {
    languageOptions: {
      globals: {
        describe: true,
        it: true,
        NodeJS: true,
      },
    },
    plugins: {
      '@stylistic': stylistic,
    },
    rules: {
      '@stylistic/comma-dangle': ['error', 'always-multiline'],
      '@stylistic/curly-newline': ['off'],
      '@stylistic/indent': [
        'error',
        2,
        {
          MemberExpression: 0,
          SwitchCase: 0,
        },
      ],
      '@stylistic/no-multi-spaces': 0,
      '@stylistic/quotes': [
        'error',
        'single',
        {
          avoidEscape: true,
        },
      ],
      '@stylistic/semi': 0,
      '@typescript-eslint/naming-convention': 'off',
      '@typescript-eslint/no-deprecated': 'off',
      '@typescript-eslint/no-dupe-class-members': 'error',
      '@typescript-eslint/no-redeclare': 'off',
      '@typescript-eslint/no-unused-vars': [
        'error',
        {
          argsIgnorePattern: '^_',
        },
      ],
      '@typescript-eslint/no-useless-constructor': 'error',
      '@typescript-eslint/no-var-requires': 'off',
      '@typescript-eslint/strict-boolean-expressions': 'off',
      'capitalized-comments': 0,
      curly: 0,
      'default-case': 0,
      'import-x/no-unresolved': 'error',
      'import-x/order': 'off', // Conflicts with 'perfectionist/sort-imports', which we already use.
      'jsdoc/require-jsdoc': 'off',
      'jsdoc/require-param': 'off',
      'jsdoc/require-param-type': 'off',
      'jsdoc/require-returns': 'off',
      'jsdoc/require-returns-type': 'off',
      'jsdoc/tag-lines': 'off',
      'logical-assignment-operators': 'off',
      'mocha/no-async-suite': 'off',
      'mocha/no-identical-title': 'off',
      'mocha/no-mocha-arrows': 'off',
      'mocha/no-setup-in-describe': 'off',
      'n/hashbang': 0,
      'n/no-missing-import': 'off',
      'n/no-process-exit': 'off', // Disabled in favor of unicorn/no-process-exit
      'n/no-unsupported-features/es-syntax': 'off',
      'n/prefer-global/process': ['error', 'always'],
      'no-dupe-class-members': 'off',
      'no-implicit-globals': 'off',
      'no-redeclare': 'off',
      'no-unused-expressions': 'off',
      'no-unused-vars': 'off',
      'no-useless-constructor': 'off',
      'perfectionist/sort-classes': [
        'error',
        {
          groups: [
            'index-signature',
            'static-property',
            'property',
            'private-property',
            'constructor',
            'static-method',
            'static-private-method',
            ['get-method', 'set-method'],
            'method',
            'private-method',
            'unknown',
          ],
          order: 'asc',
          type: 'alphabetical',
        },
      ],
      'perfectionist/sort-modules': 'off',
      'unicorn/import-style': [
        'error',
        {
          styles: {
            'node:path': {
              named: true,
            },
          },
        },
      ],
      'unicorn/name-replacements': 'off',
      'unicorn/no-await-expression-member': 'off',
      'unicorn/no-null': 'off',
      'unicorn/no-useless-coercion': 'off', //  Disabled in favor of @typescript-eslint/no-unnecessary-type-conversion
      'unicorn/prefer-module': 'warn',
    },
    settings: {
      'import-x/parsers': {
        '@typescript-eslint/parser': ['.ts', '.tsx'],
      },
      'import-x/resolver': {
        typescript: {
          alwaysTryTypes: true,
        },
      },
    },
  },
)