.eslintrc.js

'use strict';

const debug = require('debug')(`${require('./package.json').name}:eslint-config`);
const restrictedGlobals = require('confusing-browser-globals');

module.exports = {
  parser: '@typescript-eslint/parser',
  plugins: ['jest', 'jest-dom', '@typescript-eslint', 'import'],
  extends: [
    'eslint:recommended',
    'plugin:@typescript-eslint/eslint-recommended',
    'plugin:@typescript-eslint/recommended',
    'plugin:import/errors',
    'plugin:import/warnings',
    'plugin:import/typescript',
    'plugin:@next/next/recommended'
  ],
  parserOptions: {
    ecmaVersion: 8,
    sourceType: 'module',
    ecmaFeatures: {
      impliedStrict: true,
      experimentalObjectRestSpread: true,
      jsx: true
    },
    project: 'tsconfig.eslint.json'
  },
  env: {
    es6: true,
    node: true,
    jest: true,
    'jest/globals': true,
    browser: true,
    webextensions: true
  },
  rules: {
    'no-console': 'warn',
    'no-return-await': 'warn',
    'no-await-in-loop': 'warn',
    'import/no-unresolved': [
      'error',
      {
        commonjs: true
      }
    ],
    'no-restricted-globals': ['warn'].concat(restrictedGlobals),
    'no-extra-boolean-cast': 'off',
    'no-empty': 'off',
    '@typescript-eslint/camelcase': 'off',
    '@typescript-eslint/explicit-function-return-type': 'off',
    '@typescript-eslint/explicit-module-boundary-types': 'off',
    '@typescript-eslint/prefer-ts-expect-error': 'warn',
    '@typescript-eslint/no-floating-promises': [
      'error',
      { ignoreVoid: true, ignoreIIFE: true }
    ],
    '@typescript-eslint/ban-ts-comment': [
      'warn',
      {
        'ts-expect-error': 'allow-with-description',
        minimumDescriptionLength: 6
      }
    ],
    '@typescript-eslint/no-unused-vars': [
      'warn',
      {
        argsIgnorePattern: '^_+',
        varsIgnorePattern: '^_+',
        caughtErrorsIgnorePattern: '^ignored?\\d*$',
        caughtErrors: 'all'
      }
    ],
    // ? Ever since v4, we will rely on TypeScript to catch these
    'no-undef': 'off',
    '@typescript-eslint/no-var-requires': 'off',
    'no-unused-vars': 'off',
    // ? Broken as of next 12.0.7
    '@next/next/no-page-custom-font': 'off',
    '@typescript-eslint/no-non-null-assertion': 'off'
  },
  overrides: [
    {
      files: ['*.test.*'],
      extends: [
        'plugin:jest/all',
        'plugin:jest/style',
        'plugin:jest-dom/recommended'
      ],
      rules: {
        'jest/lowercase': 'off',
        'jest/consistent-test-it': 'off',
        'jest/require-top-level-describe': 'off',
        'jest/valid-describe': 'off',
        'jest/no-hooks': 'off',
        'jest/require-to-throw-message': 'off',
        'jest/prefer-called-with': 'off',
        'jest/prefer-spy-on': 'off',
        'jest/no-if': 'off',
        'jest/no-disabled-tests': 'warn',
        'jest/no-commented-out-tests': 'warn',
        'jest/require-hook': 'off',
        'jest/no-alias-methods': 'off',
        'jest/no-conditional-in-test': 'off',
        'jest/no-conditional-expect': 'off',
        'jest/max-expects': 'off'
      }
    }
  ],
  settings: {
    react: {
      version: 'detect'
    },
    'import/extensions': ['.ts', '.tsx', '.js', '.jsx'],
    // ? Switch parsers depending on which type of file we're looking at
    'import/parsers': {
      '@typescript-eslint/parser': ['.ts', '.tsx'],
      'babel-eslint': ['.js', '.jsx']
    },
    'import/resolver': {
      alias: {
        map: [
          // ! If changed, also update these aliases in tsconfig.json,
          // ! webpack.config.js, next.config.ts, and jest.config.js
          ['universe', './src'],
          ['multiverse', './lib'],
          ['testverse', './test'],
          ['externals', './external-scripts'],
          ['types', './types'],
          ['package', './package.json'],
          // ? These are used at various points (including at compile time by
          // ? Next.js) to get mongo schema configuration and/or test dummy data.
          // ! Must be defined if using @xunnamius/mongo-schema
          ['configverse/get-schema-config', './src/backend/db.ts'],
          // ! Must be defined if using @xunnamius/mongo-test
          ['configverse/get-dummy-data', './test/db.ts']
        ],
        extensions: ['.js', '.jsx', '.ts', '.tsx']
      },
      typescript: {}
    },
    'import/ignore': [
      // ? Don't go complaining about anything that we don't own
      '.*/node_modules/.*',
      '.*/bin/.*'
    ]
  },
  ignorePatterns: ['coverage', 'dist', 'bin', 'build', '/next.config.js'],
  globals: {
    page: true,
    browser: true,
    context: true,
    jestPuppeteer: true
  }
};

debug('exports: %O', module.exports);