.eslintrc.js

/*
 * Copyright IBM Corp. 2021, 2023
 *
 * This source code is licensed under the Apache-2.0 license found in the
 * LICENSE file in the root directory of this source tree.
 */
const path = require('path')

const noUnusedVarsOptions = { args: 'all', argsIgnorePattern: '^_', varsIgnorePattern: '^React' }
const noExtraneousModulesOptions = {
  allowModules: [
    ...Object.keys(require('./package.json').dependencies),
    ...Object.keys(require('./package.json').devDependencies)
  ]
}

module.exports = {
  env: {
    browser: true,
    es2021: true,
    node: true
  },
  extends: [
    'eslint:recommended',
    'standard',
    'plugin:@typescript-eslint/recommended',
    'plugin:eslint-comments/recommended',
    'plugin:node/recommended',
    path.join(__dirname, '.eslintrc.ava.js'),
    path.join(__dirname, '.eslintrc.carbon-platform.js'),
    path.join(__dirname, '.eslintrc.jsdoc.js'),
    path.join(__dirname, '.eslintrc.next.js'),
    path.join(__dirname, '.eslintrc.react.js'),
    path.join(__dirname, '.eslintrc.storybook.js')
  ],
  parser: '@typescript-eslint/parser',
  parserOptions: {
    ecmaFeatures: {
      jsx: true
    },
    ecmaVersion: 2021,
    lib: ['es2021']
  },
  plugins: ['@typescript-eslint', 'notice', 'simple-import-sort'],
  rules: {
    '@typescript-eslint/ban-types': [
      'error',
      {
        types: {
          Function: false // Allow Function type to be used
        },
        extendDefaults: true
      }
    ],
    '@typescript-eslint/no-explicit-any': 'error',
    '@typescript-eslint/no-non-null-assertion': 'off',
    '@typescript-eslint/no-unused-vars': ['error', noUnusedVarsOptions],
    '@typescript-eslint/no-use-before-define': [
      'error',
      { functions: false, classes: true, variables: false }
    ],
    '@typescript-eslint/no-var-requires': 'off',
    '@typescript-eslint/space-before-function-paren': [
      'error',
      {
        anonymous: 'always',
        named: 'never',
        asyncArrow: 'always'
      }
    ],
    'eslint-comments/require-description': 'error',
    indent: [
      'error',
      2,
      {
        ignoredNodes: [
          'PropertyDefinition[decorators]',
          'VariableDeclaration[declarations.length=0]'
        ],
        SwitchCase: 1
      }
    ],
    'max-len': [
      'error',
      {
        code: 150, // Effectively disable this rule and allow Prettier to handle it
        comments: 100
      }
    ],
    'no-implicit-globals': 'error',
    'no-use-before-define': 'off', // Disabled in favor of @typescript-eslint/no-use-before-define
    'no-unused-vars': 'off', // Disabled in favor of @typescript-eslint/no-unused-vars
    'node/no-extraneous-import': ['error', noExtraneousModulesOptions],
    'node/no-extraneous-require': ['error', noExtraneousModulesOptions],
    'node/no-missing-import': 'off', // Too restrictive in a monorepo
    'node/no-missing-require': 'off', // Too restrictive in a monorepo
    'node/no-unpublished-import': 'off', // Too restrictive in a monorepo
    'node/no-unsupported-features/es-builtins': ['error', { version: '16' }],
    'node/no-unsupported-features/es-syntax': 'off', // Doesn't account for TypeScript and Babel
    'node/no-unsupported-features/node-builtins': ['error', { version: '16' }],
    'notice/notice': [
      'error',
      {
        templateFile: path.join(__dirname, '.copyright.js')
      }
    ],
    'simple-import-sort/imports': 'error',
    'simple-import-sort/exports': 'error',
    'space-before-function-paren': 'off' // Disabled in favor of @typescript-eslint/space-before-function-paren
  },
  overrides: [
    {
      files: ['*.test.ts'],
      rules: {
        // Test files can use 'any'
        '@typescript-eslint/no-explicit-any': 'off'
      }
    },
    {
      files: ['*.js', '*.jsx', '*.ts', '*.tsx'],
      excludedFiles: ['.*.js'],
      processor: '@graphql-eslint/graphql'
    },
    {
      files: ['*.graphql'],
      // graphql-eslint doesn't work as a top-level extension/plugin, so include it here instead
      extends: [path.join(__dirname, '.eslintrc.graphql.js')]
    }
  ],
  settings: {
    next: {
      rootDir: ['services/web-app']
    }
  }
}