.eslintrc.js

const { codes: httpStatusCodes } = require('statuses')

module.exports = {
  parser: '@babel/eslint-parser',
  parserOptions: {
    requireConfigFile: false,
    sourceType: 'script',
  },
  plugins: ['markdown', 'html', 'fp'],
  extends: [
    'eslint:recommended',
    'standard',
    'prettier',
    'plugin:eslint-comments/recommended',
    'plugin:unicorn/recommended',
    'plugin:node/recommended',
    'plugin:import/recommended',
    'plugin:promise/recommended',
    'plugin:ava/recommended',
    'plugin:react/recommended',
    'plugin:you-dont-need-lodash-underscore/all',
    'plugin:markdown/recommended',
  ],
  reportUnusedDisableDirectives: true,
  rules: {
    // Those ESLint rules are not enabled by Prettier, ESLint recommended rules
    // nor standard JavaScript. However, they are still useful
    'array-callback-return': [2, { allowImplicit: true, checkForEach: true }],
    'arrow-body-style': 2,
    'block-scoped-var': 2,
    'class-methods-use-this': 2,
    complexity: [2, 5],
    'consistent-this': 2,
    'default-case': 2,
    'default-param-last': 2,
    'func-name-matching': [2, { considerPropertyDescriptor: true }],
    'func-names': [2, 'as-needed'],
    'func-style': 2,
    'id-length': [2, { exceptions: ['t', '_'] }],
    'line-comment-position': 2,
    'max-classes-per-file': 2,
    'max-depth': [2, 2],
    'max-lines': [2, { max: 150, skipBlankLines: true, skipComments: true }],
    'max-lines-per-function': [2, { max: 100, skipBlankLines: true, skipComments: true, IIFEs: true }],
    'max-nested-callbacks': [2, 2],
    'max-params': [2, { max: 4 }],
    'max-statements': [2, 15],
    'max-statements-per-line': [2, { max: 2 }],
    'multiline-comment-style': [2, 'separate-lines'],
    'no-await-in-loop': 2,
    'no-bitwise': 2,
    'no-constructor-return': 2,
    'no-duplicate-imports': 2,
    'no-else-return': [2, { allowElseIf: false }],
    'no-extra-label': 2,
    'no-implicit-coercion': 2,
    'no-implicit-globals': [2, { lexicalBindings: true }],
    'no-inline-comments': 2,
    'no-invalid-this': 2,
    'no-label-var': 2,
    'no-lonely-if': 2,
    'no-loop-func': 2,
    'no-magic-numbers': [
      2,
      {
        ignore: [
          ...httpStatusCodes,
          // Common small numbers
          -2,
          -1,
          0,
          1,
          2,
          3,
        ],
        enforceConst: true,
        detectObjects: true,
      },
    ],
    'no-multi-assign': 2,
    'no-negated-condition': 2,
    'no-nested-ternary': 2,
    'no-nonoctal-decimal-escape': 2,
    'no-param-reassign': [
      2,
      {
        props: true,
        ignorePropertyModificationsFor: [
          'error',
          'errorA',
          'req',
          'request',
          'res',
          'response',
          'state',
          'runState',
          'logs',
          'logsArray',
          'currentEnv',
          't',
        ],
      },
    ],
    'no-plusplus': [2, { allowForLoopAfterthoughts: true }],
    'no-promise-executor-return': 2,
    'no-shadow': 2,
    'no-underscore-dangle': [2, { enforceInMethodNames: true }],
    'no-undef': [2, { typeof: true }],
    'no-unsafe-optional-chaining': [2, { disallowArithmeticOperators: true }],
    'no-unused-vars': [2, {}],
    'no-useless-computed-key': [2, { enforceForClassMembers: true }],
    'no-useless-concat': 2,
    'no-var': 2,
    'object-shorthand': 2,
    'operator-assignment': 2,
    'padding-line-between-statements': 2,
    'prefer-arrow-callback': [2, { allowNamedFunctions: true }],
    'prefer-destructuring': 2,
    'prefer-exponentiation-operator': 2,
    'prefer-numeric-literals': 2,
    'prefer-object-spread': 2,
    'prefer-rest-params': 2,
    'prefer-spread': 2,
    'prefer-template': 2,
    radix: [2, 'as-needed'],
    'require-await': 2,

    // TODO: enable
    // strict: 2,

    // The autofix makes it impossible to use those in debugging
    'ava/no-only-test': 0,
    'ava/no-skip-test': 0,

    'eslint-comments/no-unused-disable': 0,
    'eslint-comments/no-use': [
      2,
      { allow: ['eslint-disable-next-line', 'eslint-disable', 'eslint-enable', 'eslint-env'] },
    ],

    // Those rules are too strict
    'fp/no-rest-parameters': 0,
    'fp/no-unused-expression': 0,
    'fp/no-nil': 0,
    'fp/no-throw': 0,

    'import/extensions': [2, 'never', { json: 'always' }],
    'import/max-dependencies': [2, { max: 20 }],
    'import/newline-after-import': 2,
    'import/no-amd': 2,
    'import/no-anonymous-default-export': 2,
    'import/no-cycle': [2, { commonjs: true }],
    'import/no-deprecated': 2,
    'import/no-dynamic-require': [2, { esmodule: true }],
    'import/no-extraneous-dependencies': 2,
    'import/no-mutable-exports': 2,
    'import/no-named-default': 2,
    'import/no-namespace': 2,
    'import/no-self-import': 2,
    'import/no-unassigned-import': [2, { allow: ['*polyfill*', '**/*polyfill*', 'log-process-errors/**'] }],
    'import/no-unresolved': [2, { commonjs: true }],
    'import/no-useless-path-segments': [2, { commonjs: true }],
    'import/order': [
      2,
      {
        'newlines-between': 'always',
        alphabetize: {
          order: 'asc',
          caseInsensitive: true,
        },
      },
    ],

    'node/no-sync': 2,
    'node/callback-return': 2,
    'node/exports-style': 2,
    'node/global-require': 2,
    'node/no-mixed-requires': 2,
    // Using path.join() is often not needed when using only core Node.js APIs
    'node/no-path-concat': 0,
    // Browser globals should not use `require()`. Non-browser globals should
    'node/prefer-global/console': 2,
    'node/prefer-global/buffer': [2, 'never'],
    'node/prefer-global/process': [2, 'never'],
    // TODO: enable after dropping support for Node <10.0.0
    'node/prefer-global/url-search-params': 0,
    'node/prefer-global/url': 0,
    // TODO: enable after dropping support for Node <11.0.0
    'node/prefer-global/text-decoder': 0,
    'node/prefer-global/text-encoder': 0,
    // TODO: enable after dropping support for Node <11.4.0
    'node/prefer-promises/fs': 0,
    'node/prefer-promises/dns': 0,
    // This does not work well in a monorepo
    'node/shebang': 0,

    'promise/no-callback-in-promise': 2,
    'promise/no-nesting': 2,
    'promise/no-promise-in-callback': 2,
    'promise/no-return-in-finally': 2,
    'promise/prefer-await-to-callbacks': 2,
    'promise/prefer-await-to-then': 2,
    'promise/valid-params': 2,

    'react/prop-types': 0,

    // Not enabled by default in unicorn/recommended, but still pretty useful
    'unicorn/custom-error-definition': 2,
    'unicorn/no-unused-properties': 2,
    // The additional `non-zero` option is useful for code consistency
    'unicorn/explicit-length-check': [2, { 'non-zero': 'not-equal' }],
    // TODO: harmonize with filename snake_case in other Netlify Dev projects
    'unicorn/filename-case': [2, { case: 'snakeCase', ignore: ['.*.md'] }],
    // The `sortCharacterClasses` option is not very useful
    'unicorn/better-regex': [2, { sortCharacterClasses: false }],

    // TODO: enable once https://github.com/sindresorhus/eslint-plugin-unicorn/issues/1343 is fixed
    'unicorn/prefer-prototype-methods': 0,

    // Too strict
    'unicorn/no-null': 0,
    'unicorn/no-array-reduce': 0,
    'unicorn/no-array-for-each': 0,
    'unicorn/prefer-module': 0,
    'unicorn/prefer-object-from-entries': 0,
    // Conflicts with no-unresolved and no-missing-import
    'unicorn/prefer-node-protocol': 0,
    // This rule gives too many false positives
    'unicorn/prevent-abbreviations': 0,
    // Conflicts with Prettier sometimes
    'unicorn/number-literal-case': 0,
    // Conflicts with the core ESLint `prefer-destructuring` rule
    'unicorn/no-unreadable-array-destructuring': 0,
    // Not useful for us
    'unicorn/expiring-todo-comments': 0,
    'unicorn/no-array-callback-reference': 0,
    // TODO: enable those rules
    'unicorn/no-process-exit': 0,
    'unicorn/import-style': 0,
    // TODO: enable after dropping Node 8 support
    'unicorn/prefer-optional-catch-binding': 0,
    'unicorn/prefer-string-trim-start-end': 0,
    // TODO: enable after dropping Node <12 support
    'unicorn/numeric-separators-style': 0,
    'unicorn/prefer-array-flat': 0,
    'unicorn/prefer-array-flat-map': 0,
  },
  overrides: [
    {
      files: ['**/tests.js', '**/tests/**/*.js'],
      rules: {
        'max-lines': 0,
        'node/no-unpublished-require': 0,
        'node/no-missing-require': 0,
        'unicorn/no-process-exit': 0,
        'fp/no-mutating-methods': 0,
        'fp/no-mutation': 0,
        'fp/no-delete': 0,
      },
    },
    {
      files: ['.*.js'],
      rules: {
        'max-lines': 0,
        'no-magic-numbers': 0,
        'node/no-unpublished-require': 0,
      },
    },
    {
      files: ['scripts/**/*.js'],
      rules: {
        'node/no-unpublished-require': 0,
      },
    },
    {
      // **/*.md/*.js references code blocks inside markdown files
      files: ['**/*.md/*.js'],
      rules: {
        'no-undef': 0,
        'no-unused-vars': 0,

        // Inline comments making code samples vertically shorter are useful
        'line-comment-position': 0,
        'no-inline-comments': 0,

        // Using literal numbers is simpler in documentation examples
        'no-magic-numbers': 0,

        strict: 0,
        'import/no-unresolved': 0,
        'node/no-missing-require': 0,

        // code blocks in markdown files have autogenerated file names
        'unicorn/filename-case': 0,

        // Documentation might import dependencies not in package.json
        'node/no-unpublished-require': 0,
        'node/no-extraneous-require': 0,
        'import/no-extraneous-dependencies': 0,
      },
    },
  ],
  settings: {
    react: {
      version: '16.13.1',
    },
  },
}