.eslintrc.json

{
  "root": true,
  "parser": "@typescript-eslint/parser",
  "plugins": [
    "@typescript-eslint",
    "eslint-plugin",
    "functional",
    "import",
    "jsdoc",
    "prettier"
  ],
  "env": {
    "es6": true,
    "node": true
  },
  "extends": [
    "@rebeccastevens/eslint-config/modern",
    "@rebeccastevens/eslint-config/typescript",
    "@rebeccastevens/eslint-config/common-overrides",
    "plugin:prettier/recommended",
    "prettier"
  ],
  "parserOptions": {
    "ecmaVersion": 10,
    "project": [
      "./tsconfig.json",
      "./tests/tsconfig.json",
      "./cz-adapter/tsconfig.json"
    ],
    "sourceType": "module"
  },
  "ignorePatterns": [
    "/build/",
    "/coverage/",
    "/lib/",
    "/**/*.cjs",
    "/**/*.js"
  ],
  "rules": {
    "@typescript-eslint/explicit-module-boundary-types": "off",
    "@typescript-eslint/no-unnecessary-condition": "off",
    "@typescript-eslint/no-unsafe-argument": "off",
    "@typescript-eslint/no-unsafe-assignment": "off",
    "@typescript-eslint/no-unsafe-call": "off",
    "@typescript-eslint/no-unsafe-member-access": "off",
    "@typescript-eslint/no-unsafe-return": "off",
    "@typescript-eslint/prefer-readonly-parameter-types": "warn",
    "import/no-relative-parent-imports": "error",
    "functional/prefer-readonly-type": "off",
    "functional/prefer-readonly-type-declaration": "warn",
    "node/no-unsupported-features/es-builtins": "off",
    "node/no-unsupported-features/es-syntax": "off",
    "promise/prefer-await-to-callbacks": "off",
    // enable once supported in all our supported node versions.
    "unicorn/prefer-node-protocol": "off",
    // only available for node >= 16
    "unicorn/prefer-string-replace-all": "off",
    // only available for node >= 16
    "unicorn/prefer-top-level-await": "off"
  },
  "overrides": [
    // Top level files.
    {
      "files": [
        "./*"
      ],
      "extends": [
        "plugin:functional/off"
      ]
    },
    // Source files.
    {
      "files": [
        "./src/**/*"
      ],
      "extends": [
        "plugin:eslint-plugin/recommended"
      ],
      "rules": {
        "functional/no-expression-statement": "error"
      }
    },
    // Rule util file.
    {
      "files": [
        "./src/util/rule.ts"
      ],
      "rules": {
        "@typescript-eslint/prefer-readonly-parameter-types": "warn"
      }
    },
    // Typeguard files.
    {
      "files": [
        "./src/util/typeguard.ts"
      ],
      "rules": {
        "jsdoc/require-jsdoc": "off"
      }
    },
    // Test files.
    {
      "files": [
        "./tests/**/*"
      ],
      "rules": {
        "jsdoc/require-jsdoc": "off"
      }
    },
    // CZ Adapter files.
    {
      "files": [
        "./src/util/typeguard.ts",
        "./tests/**/*",
        "./cz-adapter/**/*"
      ],
      "rules": {
        "jsdoc/require-jsdoc": "off"
      }
    },
    {
      "files": ["**/*.md/**"],
      "rules": {
        "functional/prefer-readonly-type-declaration": "off"
      }
    },
    // FIXME: This override is defined in the upsteam; it shouldn't need to be redefined here. Why?
    {
      "files": [
        "./**/*.md/**"
      ],
      "parserOptions": {
        "project": null
      },
      "rules": {
        "@typescript-eslint/await-thenable": "off",
        "@typescript-eslint/consistent-type-definitions": "off",
        "@typescript-eslint/dot-notation": "off",
        "@typescript-eslint/explicit-member-accessibility": "off",
        "@typescript-eslint/no-confusing-void-expression": "off",
        "@typescript-eslint/no-empty-function": "off",
        "@typescript-eslint/no-floating-promises": "off",
        "@typescript-eslint/no-for-in-array": "off",
        "@typescript-eslint/no-implied-eval": "off",
        "@typescript-eslint/no-misused-promises": "off",
        "@typescript-eslint/no-throw-literal": "off",
        "@typescript-eslint/no-unnecessary-type-assertion": "off",
        "@typescript-eslint/no-unsafe-assignment": "off",
        "@typescript-eslint/no-unsafe-call": "off",
        "@typescript-eslint/no-unsafe-member-access": "off",
        "@typescript-eslint/no-unsafe-return": "off",
        "@typescript-eslint/no-unused-expressions": "off",
        "@typescript-eslint/no-unused-vars": "off",
        "@typescript-eslint/non-nullable-type-assertion-style": "off",
        "@typescript-eslint/prefer-includes": "off",
        "@typescript-eslint/prefer-nullish-coalescing": "off",
        "@typescript-eslint/prefer-readonly-parameter-types": "off",
        "@typescript-eslint/prefer-readonly": "off",
        "@typescript-eslint/prefer-regexp-exec": "off",
        "@typescript-eslint/prefer-string-starts-ends-with": "off",
        "@typescript-eslint/promise-function-async": "off",
        "@typescript-eslint/require-await": "off",
        "@typescript-eslint/restrict-plus-operands": "off",
        "@typescript-eslint/restrict-template-expressions": "off",
        "@typescript-eslint/strict-boolean-expressions": "off",
        "@typescript-eslint/switch-exhaustiveness-check": "off",
        "@typescript-eslint/unbound-method": "off",
        "functional/functional-parameters": "off",
        "functional/immutable-data": "off",
        "functional/no-class": "off",
        "functional/no-expression-statement": "off",
        "functional/no-let": "off",
        "functional/no-loop-statement": "off",
        "functional/no-return-void": "off",
        "functional/no-this-expression": "off",
        "functional/no-throw-statement": "off",
        "functional/no-try-statement": "off",
        "functional/prefer-readonly-type": "off",
        "import/no-unresolved": "off",
        "init-declarations": "off",
        "jsdoc/require-jsdoc": "off",
        "no-console": "off",
        "no-empty": "off",
        "no-invalid-this": "off",
        "no-undef": "off",
        "no-useless-return": "off",
        "node/handle-callback-err": "off",
        "prefer-const": "off",
        "prettier/prettier": "off",
        "sonarjs/no-extra-arguments": "off",
        "sonarjs/no-unused-collection": "off",
        "unicorn/prefer-optional-catch-binding": "off",
        "unicorn/prefer-top-level-await": "off",
        "dot-notation": "error",
        "no-implied-eval": "error",
        "require-await": "error"
      }
    }
  ]
}