|
| 1 | +const { FlatCompat } = require("@eslint/eslintrc"); |
| 2 | +const js = require("@eslint/js"); |
| 3 | +const path = require("path"); |
| 4 | + |
| 5 | +const compat = new FlatCompat({ |
| 6 | + baseDirectory: __dirname, |
| 7 | + recommendedConfig: js.configs.recommended, |
| 8 | + allConfig: js.configs.all |
| 9 | +}); |
| 10 | + |
| 11 | +module.exports = [ |
| 12 | + { |
| 13 | + ignores: [ |
| 14 | + "lib/", |
| 15 | + "dev/", |
| 16 | + "node_modules/", |
| 17 | + "coverage/", |
| 18 | + "docgen/", |
| 19 | + "v1/", |
| 20 | + "v2/", |
| 21 | + "logger/", |
| 22 | + "dist/", |
| 23 | + "spec/fixtures/", |
| 24 | + "scripts/**/*.js", |
| 25 | + "scripts/**/*.mjs", |
| 26 | + "protos/", |
| 27 | + ".prettierrc.js", |
| 28 | + "eslint.config.*", |
| 29 | + "tsdown.config.*", |
| 30 | + "scripts/bin-test/sources/esm-ext/index.mjs", |
| 31 | + ], |
| 32 | + }, |
| 33 | + ...compat.extends( |
| 34 | + "eslint:recommended", |
| 35 | + "plugin:@typescript-eslint/recommended", |
| 36 | + "plugin:@typescript-eslint/recommended-requiring-type-checking", |
| 37 | + "plugin:jsdoc/recommended", |
| 38 | + "google", |
| 39 | + "prettier" |
| 40 | + ), |
| 41 | + { |
| 42 | + languageOptions: { |
| 43 | + parser: require("@typescript-eslint/parser"), |
| 44 | + parserOptions: { |
| 45 | + project: "tsconfig.json", |
| 46 | + tsconfigRootDir: __dirname, |
| 47 | + }, |
| 48 | + ecmaVersion: 2022 |
| 49 | + }, |
| 50 | + plugins: { |
| 51 | + "prettier": require("eslint-plugin-prettier"), |
| 52 | + }, |
| 53 | + rules: { |
| 54 | + "jsdoc/newline-after-description": "off", |
| 55 | + "jsdoc/require-jsdoc": ["warn", { publicOnly: true }], |
| 56 | + "jsdoc/check-tag-names": ["warn", { definedTags: ["alpha", "remarks", "typeParam", "packageDocumentation", "hidden"] }], |
| 57 | + "no-restricted-globals": ["error", "name", "length"], |
| 58 | + "prefer-arrow-callback": "error", |
| 59 | + "prettier/prettier": "error", |
| 60 | + "require-atomic-updates": "off", // This rule is so noisy and isn't useful: https://github.com/eslint/eslint/issues/11899 |
| 61 | + "require-jsdoc": "off", // This rule is deprecated and superseded by jsdoc/require-jsdoc. |
| 62 | + "valid-jsdoc": "off", // This is deprecated but included in recommended configs. |
| 63 | + "no-prototype-builtins": "warn", |
| 64 | + "no-useless-escape": "warn", |
| 65 | + "prefer-promise-reject-errors": "warn", |
| 66 | + }, |
| 67 | + }, |
| 68 | + { |
| 69 | + files: ["**/*.ts"], |
| 70 | + rules: { |
| 71 | + "jsdoc/require-param-type": "off", |
| 72 | + "jsdoc/require-returns-type": "off", |
| 73 | + // Google style guide allows us to omit trivial parameters and returns |
| 74 | + "jsdoc/require-param": "off", |
| 75 | + "jsdoc/require-returns": "off", |
| 76 | + |
| 77 | + "@typescript-eslint/no-invalid-this": "error", |
| 78 | + "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_", caughtErrorsIgnorePattern: "^_" }], // Unused vars should not exist. |
| 79 | + "@typescript-eslint/no-misused-promises": "warn", // rule does not work with async handlers for express. |
| 80 | + "no-invalid-this": "off", // Turned off in favor of @typescript-eslint/no-invalid-this. |
| 81 | + "no-unused-vars": "off", // Off in favor of @typescript-eslint/no-unused-vars. |
| 82 | + eqeqeq: ["error", "always", { null: "ignore" }], |
| 83 | + camelcase: ["error", { properties: "never" }], // snake_case allowed in properties iif to satisfy an external contract / style |
| 84 | + |
| 85 | + // Ideally, all these warning should be error - let's fix them in the future. |
| 86 | + "@typescript-eslint/no-unsafe-argument": "warn", |
| 87 | + "@typescript-eslint/no-unsafe-assignment": "warn", |
| 88 | + "@typescript-eslint/no-unsafe-call": "warn", |
| 89 | + "@typescript-eslint/no-unsafe-member-access": "warn", |
| 90 | + "@typescript-eslint/no-unsafe-return": "warn", |
| 91 | + "@typescript-eslint/restrict-template-expressions": "warn", |
| 92 | + "@typescript-eslint/no-explicit-any": "warn", |
| 93 | + "@typescript-eslint/no-redundant-type-constituents": "warn", |
| 94 | + "@typescript-eslint/no-base-to-string": "warn", |
| 95 | + "@typescript-eslint/no-duplicate-type-constituents": "warn", |
| 96 | + "@typescript-eslint/no-require-imports": "warn", |
| 97 | + "@typescript-eslint/no-empty-object-type": "warn", |
| 98 | + "@typescript-eslint/prefer-promise-reject-errors": "warn", |
| 99 | + }, |
| 100 | + }, |
| 101 | + { |
| 102 | + files: ["**/*.spec.ts", "**/*.spec.js", "spec/helper.ts", "scripts/bin-test/**/*.ts", "integration_test/**/*.ts"], |
| 103 | + languageOptions: { |
| 104 | + globals: { |
| 105 | + mocha: true, |
| 106 | + }, |
| 107 | + }, |
| 108 | + rules: { |
| 109 | + "@typescript-eslint/no-unused-expressions": "off", |
| 110 | + } |
| 111 | + }, |
| 112 | +]; |
0 commit comments