.eslintrc.cjs

module.exports = {
  root: true,

  ignorePatterns: [
    '**/*.*',
    '!**/*.js',
    '!**/*.cjs',
    'coverage',
    'node_modules',
    'dist',
  ],

  parserOptions: {
    ecmaVersion: 'latest',
    sourceType: 'module',
  },

  env: {
    browser: true,
    es2021: true,
  },

  extends: [
    'eslint:recommended',
    'plugin:jsdoc/recommended-typescript-flavor',
    'plugin:unicorn/recommended',
    'plugin:@stylistic/disable-legacy',
    'prettier-standard/prettier-file',
  ],

  plugins: ['@stylistic', '@stylistic/migrate'],

  settings: {
    jsdoc: {
      mode: 'typescript',
    },
  },

  // Keep rules grouped by plugin and sorted alphabetically
  rules: {
    // Sort import members
    'sort-imports': [
      'error',
      {
        ignoreDeclarationSort: true,
      },
    ],

    /* @stylistic/eslint-plugin */

    '@stylistic/migrate/migrate-js': 'error',

    '@stylistic/padding-line-between-statements': [
      'error',
      /* Empty line before if statement */
      { blankLine: 'always', prev: '*', next: 'if' },
      /* Empty line before return */
      { blankLine: 'always', prev: '*', next: 'return' },
      /* Empty line after const, let */
      { blankLine: 'always', prev: ['const', 'let'], next: '*' },
      { blankLine: 'any', prev: ['const', 'let'], next: ['const', 'let'] },
      /* Empty line between case and default inside switch */
      { blankLine: 'always', prev: 'case', next: ['case', 'default'] },
    ],

    /* eslint-plugin-jsdoc */

    // Descriptions should be sentence-like not comment-like
    'jsdoc/require-description-complete-sentence': 'warn',
    'jsdoc/require-hyphen-before-param-description': [
      'error',
      'never',
      { tags: { property: 'never' } },
    ],
    // Empty line after description
    'jsdoc/tag-lines': [
      'error',
      'never',
      {
        startLines: 1,
        tags: { description: { lines: 'always', count: 1 } },
      },
    ],
    // Adding JSDoc is preferable but not required
    'jsdoc/require-jsdoc': 'off',
    'jsdoc/require-param-description': 'off',
    'jsdoc/require-property-description': 'off',
    'jsdoc/require-returns-description': 'off',
    'jsdoc/require-returns': 'off',

    /* eslint-plugin-unicorn */

    // I like reduce
    'unicorn/no-array-reduce': 'off',

    /* eslint-plugin-import */

    // Require extension for imports. Required by Node.js with `type: "module"`
    'import/extensions': ['error', 'always', { ignorePackages: true }],
    // Force using only named exports. Default export allowed for a module main export
    'import/no-default-export': 'error',
    'import/newline-after-import': 'error',
    // Sort imports
    'import/order': [
      'error',
      {
        groups: [
          'builtin',
          'external',
          'internal',
          'parent',
          'sibling',
          'type',
        ],
        'newlines-between': 'always',
        alphabetize: {
          order: 'asc',
          caseInsensitive: false,
        },
      },
    ],

    /* eslint-plugin-prettier */

    'prettier/prettier': 'warn',
  },

  overrides: [
    // Test files
    {
      files: 'tests/**/*',
      extends: ['plugin:ava/recommended'],
    },
    // Config CommonJS
    {
      files: '*.cjs',
      rules: {
        /* eslint-plugin-unicorn */

        'unicorn/prefer-module': 'off',
      },
    },
    // Config ES module
    {
      files: '*.config.js',
      rules: {
        // Acceptable export type is not controlled for config files
        'import/no-default-export': 'off',
      },
    },
  ],
}