.eslintrc.js

/* eslint-disable license-header/header */
module.exports = {
  env: {
    browser: true,
    es6: true,
    node: true,
  },
  extends: [
    'airbnb-base',
    'plugin:@typescript-eslint/recommended',
    'prettier',
    'prettier/@typescript-eslint',
    'plugin:jsdoc/recommended',
  ],
  globals: {
    Atomics: 'readonly',
    SharedArrayBuffer: 'readonly',
  },
  parser: '@typescript-eslint/parser',
  parserOptions: {
    ecmaVersion: 2018,
    sourceType: 'module',
    project: './tsconfig.json',
  },
  plugins: [
    '@typescript-eslint',
    'prettier',
    'jsdoc',
    'license-header',
    'import',
  ],
  rules: {
    'import/no-cycle': 'off', // TODO: This rule does not seem to be working atm.
    'import/no-extraneous-dependencies': [
      'error',
      {
        devDependencies: [
          '**/*.test.ts',
          '**/*.spec.ts',
          'tests/**/*',
          '**/webpack.config.js',
        ],
      },
    ],
    'import/extensions': [
      'error',
      'ignorePackages',
      {
        utils: 'never',
        chain: 'never',
      },
    ],
    'no-restricted-imports': ['error', '.', '..'],
    // Taken care of by typescript
    'import/no-unresolved': 'off',
    'prettier/prettier': 'error',
    semi: ['error', 'never'],
    'lines-between-class-members': [
      'error',
      'always',
      { exceptAfterSingleLine: true },
    ],
    '@typescript-eslint/explicit-function-return-type': [
      'warn',
      {
        allowExpressions: true,
      },
    ],
    '@typescript-eslint/prefer-interface': 'off',
    '@typescript-eslint/array-type': [
      'error',
      {
        default: 'array-simple',
      },
    ],
    '@typescript-eslint/ban-ts-comment': 'warn',
    '@typescript-eslint/strict-boolean-expressions': [
      'error',
      {
        allowNumber: false,
        allowNullableString: true,
        allowNullableBoolean: true,
      },
    ],
    'jsdoc/require-description': 'warn',
    'jsdoc/require-description-complete-sentence': 'warn',
    'jsdoc/no-types': 'warn',
    'jsdoc/require-param-type': 'off',
    'jsdoc/require-returns-type': 'off',
    'jsdoc/require-jsdoc': [
      'warn',
      {
        publicOnly: true,
        exemptEmptyConstructors: true,
        contexts: ['MethodDefinition:has([accessibility="public"])'],
        require: {
          FunctionDeclaration: true, // require jsdoc on exported functions
          FunctionExpression: true,
          ArrowFunctionExpression: false, // do not require jsdoc on arrow functions
          MethodDefinition: false, // bc we only want to enforce jsdoc on public methods, this must be false
          ClassDeclaration: false, // do not require jsdoc on declarations of exported classes
          ClassExpression: false,
        },
      },
    ],
    'jsdoc/check-examples': [
      'warn',
      {
        exampleCodeRegex:
          '^```(?:js|javascript|typescript)\\n([\\s\\S]*)```\\s*$',
        configFile: '.eslintrc-jsdoc.json',
      },
    ],
    'jsdoc/check-tag-names': [
      'warn',
      {
        definedTags: ['preferred', 'packageDocumentation'],
      },
    ],
    'jsdoc/check-alignment': 'off',
    'jsdoc/no-multi-asterisks': 'off',
    'jsdoc/tag-lines': 'off',
    'license-header/header': ['error', './license-header.js'],
    'import/prefer-default-export': 'off',
    'import/no-default-export': 'error',
    '@typescript-eslint/no-explicit-any': 'off',
    'no-shadow': 'off',
    '@typescript-eslint/no-shadow': 'error',
  },
  overrides: [
    {
      files: ['**/*.spec.ts'],
      env: {
        jest: true,
      },
      rules: {
        'import/extensions': 'off',
        '@typescript-eslint/no-object-literal-type-assertion': 'off',
        'no-underscore-dangle': 'off',
        'global-require': 'off',
        'jsdoc/require-jsdoc': 'off',
        'jsdoc/check-tag-names': [
          'warn',
          {
            definedTags: ['packageDocumentation'],
          },
        ],
        '@typescript-eslint/no-var-requires': 'off',
        '@typescript-eslint/no-non-null-assertion': 'off',
        '@typescript-eslint/explicit-function-return-type': 'off',
        '@typescript-eslint/ban-ts-comment': 'off',
        'no-console': 'off',
      },
    },
    {
      files: ['tests/**/*'],
      rules: {
        'import/extensions': 'off',
        'jsdoc/require-jsdoc': 'off',
        'no-console': 'off',
        '@typescript-eslint/explicit-function-return-type': 'off',
        'import/no-extraneous-dependencies': 'off',
        'no-underscore-dangle': 'off'
      },
    },
  ],
}