@open-turo/eslint-config-typescript 16.0.0-pr-373.7.1.1 → 16.0.0-pr-373.9.1.1

package/README.md

@@ -24,7 +24,7 @@ npx install-peerdeps --dev @open-turo/eslint-config-typescript
 ```js
 const turoConfig = require("@open-turo/eslint-config-typescript");
 
-module.exports = turoConfig;
+module.exports = turoConfig();
 ```
 
 ### **[.eslintrc](https://eslint.org/docs/latest/use/configure/configuration-files)** (legacy example)

package/eslint.config.mjs

@@ -1,3 +1,4 @@
 import openTuroTypescriptConfig from "./index.mjs";
 
-export default openTuroTypescriptConfig;
+// eslint-disable-next-line import/no-default-export
+export default openTuroTypescriptConfig({ typescript: false });

package/index.cjs

@@ -1,34 +1,35 @@
-const jestPlugin = require("eslint-plugin-jest");
-const nPlugin = require("eslint-plugin-n");
+const eslint = require("@eslint/js");
+const tsParser = require("@typescript-eslint/parser");
 const importPlugin = require("eslint-plugin-import");
+const jestPlugin = require("eslint-plugin-jest");
 const jsonPlugin = require("eslint-plugin-json");
-const eslint = require("@eslint/js");
+const nPlugin = require("eslint-plugin-n");
 const perfectionistPlugin = require("eslint-plugin-perfectionist");
 const prettierPluginRecommended = require("eslint-plugin-prettier/recommended");
-const tseslint = require("typescript-eslint");
 const sonarjsPlugin = require("eslint-plugin-sonarjs");
 const unicornPlugin = require("eslint-plugin-unicorn");
-const tsParser = require("@typescript-eslint/parser");
+const tseslint = require("typescript-eslint");
 
-module.exports = tseslint.config(
-  {
-    files: ["**/*.ts", "**/*.tsx"],
-    extends: [
-      eslint.configs.recommended,
-      tseslint.configs.recommendedTypeChecked,
-      importPlugin.flatConfigs.recommended,
-      importPlugin.flatConfigs.typescript,
-      nPlugin.configs["flat/recommended-script"],
-      perfectionistPlugin.configs["recommended-alphabetical"],
-      sonarjsPlugin.configs.recommended,
-      unicornPlugin.configs["flat/recommended"],
-    ],
-    languageOptions: {
-      parser: tsParser,
-      parserOptions: {
-        projectService: true,
-      },
-    },
+const FILES_SRC_EXTENSION = "?([cm])[jt]s?(x)";
+const FILES_TS = "**/*.?([cm])ts";
+const FILES_TSX = "**/*.?([cm])tsx";
+const FILES_TEST = [
+  `**/__tests__/**/*.${FILES_SRC_EXTENSION}`,
+  `**/*.spec.${FILES_SRC_EXTENSION}`,
+  `**/*.test.${FILES_SRC_EXTENSION}`,
+];
+
+const typescriptLanguageOptions = () => ({
+  parser: tsParser,
+  parserOptions: {
+    projectService: true,
+    tsconfigRootDir: process.cwd(),
+  },
+});
+
+const importConfig = () =>
+  tseslint.config({
+    extends: [importPlugin.flatConfigs.recommended],
     rules: {
       "import/default": "off",
       "import/named": "off",
@@ -36,17 +37,41 @@ module.exports = tseslint.config(
       "import/no-default-export": "error",
       "import/no-extraneous-dependencies": [
         "error",
-        { devDependencies: ["test/**"] },
+        { devDependencies: [`eslint.config.${FILES_SRC_EXTENSION}`] },
       ],
       "import/prefer-default-export": "off",
+    },
+    settings: {
+      "import/resolver": {
+        typescript: {
+          alwaysTryTypes: true,
+        },
+      },
+    },
+  });
+
+const nPluginConfig = (allowModules = ["@jest/globals", "nock"]) =>
+  tseslint.config({
+    extends: [
+      nPlugin.configs["flat/recommended"],
+      nPlugin.configs["flat/mixed-esm-and-cjs"],
+    ],
+    rules: {
+      "n/no-missing-import": "off",
       "n/no-unpublished-import": [
         "error",
         {
-          allowModules: ["@jest/globals", "nock"],
+          allowModules,
         },
       ],
       "n/no-unsupported-features/es-syntax": "off",
-      "n/no-missing-import": "off",
+    },
+  });
+
+const sonarJsConfig = () =>
+  tseslint.config({
+    extends: [sonarjsPlugin.configs.recommended],
+    rules: {
       // Noisy rule - we may have helpers/methods that we mark as @deprecated but aren't planning to remove in the near future. This rule also significantly adds to eslint running time, which slows down both local development and CI.
       "sonarjs/deprecation": "off",
       // This rule is not helpful in TypeScript files, and in JavaScript we often return different types from functions, so this is not a strictness level we want to enforce.
@@ -55,10 +80,10 @@ module.exports = tseslint.config(
       "sonarjs/no-ignored-exceptions": "off",
       "sonarjs/no-nested-functions": ["warn", { threshold: 5 }],
       "sonarjs/no-small-switch": "off",
-      // Overlaps with @typescript-eslint/prefer-nullish-coalescing
-      "sonarjs/prefer-nullish-coalescing": "off",
       // Overlaps with @typescript-eslint/no-unused-vars
       "sonarjs/no-unused-vars": "off",
+      // Overlaps with @typescript-eslint/prefer-nullish-coalescing
+      "sonarjs/prefer-nullish-coalescing": "off",
       // Overlaps with @typescript-eslint/prefer-optional-chain
       "sonarjs/prefer-optional-chain": "off",
       // Useful for guarding against prop mutation in React, but too much of a lift as very rarely do we apply readonly/ReadonlyArray<T> to type definitions
@@ -67,6 +92,18 @@ module.exports = tseslint.config(
       "sonarjs/todo-tag": "off",
       // A useful rule to consider for libraries to better document (and export) type definitions, but noisy in app usages (especially around redux type definitions)
       "sonarjs/use-type-alias": "off",
+    },
+  });
+
+const typescriptConfig = () =>
+  tseslint.config({
+    extends: [
+      tseslint.configs.recommendedTypeChecked,
+      importPlugin.flatConfigs.typescript,
+    ],
+    files: [FILES_TS, FILES_TSX],
+    languageOptions: typescriptLanguageOptions(),
+    rules: {
       /**
        * {@link https://typescript-eslint.io/rules/consistent-type-imports | TypeScript ESLint: consistent-type-imports docs}
        */
@@ -102,35 +139,69 @@ module.exports = tseslint.config(
       "@typescript-eslint/prefer-ts-expect-error": "error",
       "@typescript-eslint/unbound-method": "error",
     },
-  },
-  prettierPluginRecommended,
-  jsonPlugin.configs["recommended"],
-  {
-    files: ["test/**"],
-    plugins: { jest: jestPlugin },
+  });
+
+/**
+ *
+ * @param options Configuration options
+ * @param options.typescript Whether to include typescript rules
+ * @returns {ConfigArray}
+ */
+const testConfig = (options) => {
+  const typescriptRules = options.typescript
+    ? {
+        // this turns the original rule off *only* for test files, for jestPlugin compatibility
+        "@typescript-eslint/unbound-method": "off",
+        "jest/unbound-method": "error",
+      }
+    : {};
+  return tseslint.config({
+    extends: [jestPlugin.configs["flat/recommended"]],
+    files: FILES_TEST,
     languageOptions: {
       globals: jestPlugin.environments.globals.globals,
-      parser: tsParser,
-      parserOptions: {
-        projectService: true,
-      },
+      ...(options.typescript ? typescriptLanguageOptions() : {}),
     },
-    extends: [jestPlugin.configs["flat/recommended"]],
+    plugins: { jest: jestPlugin },
     rules: {
       ...jestPlugin.configs["flat/recommended"].rules,
-      // this turns the original rule off *only* for test files, for jestPlugin compatibility
-      "@typescript-eslint/unbound-method": "off",
+      ...typescriptRules,
+      "import/no-extraneous-dependencies": [
+        "error",
+        { devDependencies: FILES_TEST },
+      ],
       "jest/no-jest-import": "off",
-      "jest/unbound-method": "error",
     },
-  },
-  {
-    settings: {
-      "import/resolver": {
-        typescript: {
-          alwaysTryTypes: true,
-        },
-      },
-    },
-  },
-);
+  });
+};
+
+const ignoresConfig = (ignores = []) =>
+  tseslint.config({
+    ignores: ["**/.yalc", "**/dist", ...ignores],
+  });
+
+/**
+ * Turo eslint configuration for typescript
+ * @param [options] - Eslint config options
+ * @param [options.allowModules] - List of modules to allow in the n/no-unpublished-import rule
+ * @param [options.ignores] - List of patterns to ignore
+ * @param [options.typescript] - Whether to include typescript rules
+ * @returns {ConfigArray}
+ */
+module.exports = function config(options = {}) {
+  const useTypescript =
+    options.typescript === undefined ? true : options.typescript;
+  return tseslint.config(
+    eslint.configs.recommended,
+    importConfig(),
+    nPluginConfig(options.allowModules),
+    perfectionistPlugin.configs["recommended-alphabetical"],
+    sonarJsConfig(),
+    unicornPlugin.configs["flat/recommended"],
+    prettierPluginRecommended,
+    jsonPlugin.configs["recommended"],
+    useTypescript ? typescriptConfig() : {},
+    testConfig({ typescript: useTypescript }),
+    ignoresConfig(options.ignores),
+  );
+};

package/index.mjs

@@ -1,136 +1,2 @@
-import jestPlugin from "eslint-plugin-jest";
-import nPlugin from "eslint-plugin-n";
-import importPlugin from "eslint-plugin-import";
-import jsonPlugin from "eslint-plugin-json";
-import eslint from "@eslint/js";
-import perfectionistPlugin from "eslint-plugin-perfectionist";
-import prettierPluginRecommended from "eslint-plugin-prettier/recommended";
-import tseslint from "typescript-eslint";
-import sonarjsPlugin from "eslint-plugin-sonarjs";
-import unicornPlugin from "eslint-plugin-unicorn";
-import tsParser from "@typescript-eslint/parser";
-
-export default tseslint.config(
-  {
-    files: ["**/*.ts", "**/*.tsx"],
-    extends: [
-      eslint.configs.recommended,
-      tseslint.configs.recommendedTypeChecked,
-      importPlugin.flatConfigs.recommended,
-      importPlugin.flatConfigs.typescript,
-      nPlugin.configs["flat/recommended-script"],
-      perfectionistPlugin.configs["recommended-alphabetical"],
-      sonarjsPlugin.configs.recommended,
-      unicornPlugin.configs["flat/recommended"],
-    ],
-    languageOptions: {
-      parser: tsParser,
-      parserOptions: {
-        projectService: true,
-      },
-    },
-    rules: {
-      "import/default": "off",
-      "import/named": "off",
-      "import/namespace": "off",
-      "import/no-default-export": "error",
-      "import/no-extraneous-dependencies": [
-        "error",
-        { devDependencies: ["test/**"] },
-      ],
-      "import/prefer-default-export": "off",
-      "n/no-unpublished-import": [
-        "error",
-        {
-          allowModules: ["@jest/globals", "nock"],
-        },
-      ],
-      "n/no-unsupported-features/es-syntax": "off",
-      "n/no-missing-import": "off",
-      // Noisy rule - we may have helpers/methods that we mark as @deprecated but aren't planning to remove in the near future. This rule also significantly adds to eslint running time, which slows down both local development and CI.
-      "sonarjs/deprecation": "off",
-      // This rule is not helpful in TypeScript files, and in JavaScript we often return different types from functions, so this is not a strictness level we want to enforce.
-      "sonarjs/function-return-type": "off",
-      // We may want to catch errors but not use the error object directly, just trigger error handling fallbacks within the catch block.
-      "sonarjs/no-ignored-exceptions": "off",
-      "sonarjs/no-nested-functions": ["warn", { threshold: 5 }],
-      "sonarjs/no-small-switch": "off",
-      // Overlaps with @typescript-eslint/prefer-nullish-coalescing
-      "sonarjs/prefer-nullish-coalescing": "off",
-      // Overlaps with @typescript-eslint/no-unused-vars
-      "sonarjs/no-unused-vars": "off",
-      // Overlaps with @typescript-eslint/prefer-optional-chain
-      "sonarjs/prefer-optional-chain": "off",
-      // Useful for guarding against prop mutation in React, but too much of a lift as very rarely do we apply readonly/ReadonlyArray<T> to type definitions
-      "sonarjs/prefer-read-only-props": "off",
-      // Noisy rule: if we wanted stricter linting of TODOs, we could use unicorn/expiring-todo-comments
-      "sonarjs/todo-tag": "off",
-      // A useful rule to consider for libraries to better document (and export) type definitions, but noisy in app usages (especially around redux type definitions)
-      "sonarjs/use-type-alias": "off",
-      /**
-       * {@link https://typescript-eslint.io/rules/consistent-type-imports | TypeScript ESLint: consistent-type-imports docs}
-       */
-      "@typescript-eslint/consistent-type-imports": [
-        "error",
-        {
-          disallowTypeAnnotations: true,
-          fixStyle: "inline-type-imports",
-          prefer: "type-imports",
-        },
-      ],
-      /** We do not need to force people to wrap `void`-return implicit arrow returns with braces just for a lint rule. TypeScript alone covers functionality, by the return type being `void`. */
-      "@typescript-eslint/no-confusing-void-expression": "off",
-      /** Included as part of `strict-type-checked`, but nothing we want to enforce. */
-      "@typescript-eslint/no-deprecated": "off",
-      /** Prefers `import type {}` syntax over `import { type }` if all imports are type-only */
-      "@typescript-eslint/no-import-type-side-effects": "error",
-      /** A relatively stylistic rule, downgraded to "off" to limit breaking changes in the update that includes `strict-type-checked`. */
-      "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off",
-      /** This rule can help us identify syntax that is more defensive than the types suggest. Unfortunately, it may be protecting us from runtime errors where the type definitions are incorrect. As such, it is turned "off", as even "warn" auto-fixes source code. */
-      "@typescript-eslint/no-unnecessary-condition": "off",
-      /** There is readability benefit to passing in type arguments that match defaults. If defaults change, we may prefer the manual inspection of all the types changed, too. */
-      "@typescript-eslint/no-unnecessary-type-arguments": "off",
-      /** Errors on generic type parameters that are only used once, even though that helps with return type inference. */
-      "@typescript-eslint/no-unnecessary-type-parameters": "off",
-      "@typescript-eslint/no-unused-vars": [
-        "error",
-        {
-          // Allow to name unused vars with _
-          argsIgnorePattern: "^_",
-        },
-      ],
-      "@typescript-eslint/prefer-ts-expect-error": "error",
-      "@typescript-eslint/unbound-method": "error",
-    },
-  },
-  prettierPluginRecommended,
-  jsonPlugin.configs["recommended"],
-  {
-    files: ["test/**/*.{ts,tsx}"],
-    plugins: { jest: jestPlugin },
-    languageOptions: {
-      globals: jestPlugin.environments.globals.globals,
-      parser: tsParser,
-      parserOptions: {
-        projectService: true,
-      },
-    },
-    extends: [jestPlugin.configs["flat/recommended"]],
-    rules: {
-      ...jestPlugin.configs["flat/recommended"].rules,
-      // this turns the original rule off *only* for test files, for jestPlugin compatibility
-      "@typescript-eslint/unbound-method": "off",
-      "jest/no-jest-import": "off",
-      "jest/unbound-method": "error",
-    },
-  },
-  {
-    settings: {
-      "import/resolver": {
-        typescript: {
-          alwaysTryTypes: true,
-        },
-      },
-    },
-  },
-);
+// eslint-disable-next-line import/no-default-export
+export { default } from "./index.cjs";

package/package.json

@@ -54,5 +54,5 @@
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-typescript",
-  "version": "16.0.0-pr-373.7.1.1"
+  "version": "16.0.0-pr-373.9.1.1"
 }

package/recommended.cjs

@@ -1,22 +1,8 @@
 module.exports = {
-  root: true,
   env: {
     es2022: true,
     jest: true,
   },
-  parser: "@typescript-eslint/parser",
-  plugins: [
-    "@typescript-eslint",
-    "eslint-plugin-jest",
-    "import",
-    "jest",
-    "json",
-    "n",
-    "perfectionist",
-    "prettier",
-    "sonarjs",
-    "unicorn",
-  ],
   extends: [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended-type-checked",
@@ -31,11 +17,6 @@ module.exports = {
     "plugin:sonarjs/recommended-legacy",
     "plugin:unicorn/recommended",
   ],
-  parserOptions: {
-    ecmaVersion: "latest",
-    project: "./tsconfig.json",
-    sourceType: "module",
-  },
   overrides: [
     {
       files: ["test/**"],
@@ -47,7 +28,60 @@ module.exports = {
       },
     },
   ],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: "latest",
+    project: "./tsconfig.json",
+    sourceType: "module",
+  },
+  plugins: [
+    "@typescript-eslint",
+    "eslint-plugin-jest",
+    "import",
+    "jest",
+    "json",
+    "n",
+    "perfectionist",
+    "prettier",
+    "sonarjs",
+    "unicorn",
+  ],
+  root: true,
   rules: {
+    /**
+     * {@link https://typescript-eslint.io/rules/consistent-type-imports | TypeScript ESLint: consistent-type-imports docs}
+     */
+    "@typescript-eslint/consistent-type-imports": [
+      "error",
+      {
+        disallowTypeAnnotations: true,
+        fixStyle: "inline-type-imports",
+        prefer: "type-imports",
+      },
+    ],
+    /** We do not need to force people to wrap `void`-return implicit arrow returns with braces just for a lint rule. TypeScript alone covers functionality, by the return type being `void`. */
+    "@typescript-eslint/no-confusing-void-expression": "off",
+    /** Included as part of `strict-type-checked`, but nothing we want to enforce. */
+    "@typescript-eslint/no-deprecated": "off",
+    /** Prefers `import type {}` syntax over `import { type }` if all imports are type-only */
+    "@typescript-eslint/no-import-type-side-effects": "error",
+    /** A relatively stylistic rule, downgraded to "off" to limit breaking changes in the update that includes `strict-type-checked`. */
+    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off",
+    /** This rule can help us identify syntax that is more defensive than the types suggest. Unfortunately, it may be protecting us from runtime errors where the type definitions are incorrect. As such, it is turned "off", as even "warn" auto-fixes source code. */
+    "@typescript-eslint/no-unnecessary-condition": "off",
+    /** There is readability benefit to passing in type arguments that match defaults. If defaults change, we may prefer the manual inspection of all the types changed, too. */
+    "@typescript-eslint/no-unnecessary-type-arguments": "off",
+    /** Errors on generic type parameters that are only used once, even though that helps with return type inference. */
+    "@typescript-eslint/no-unnecessary-type-parameters": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      {
+        // Allow to name unused vars with _
+        argsIgnorePattern: "^_",
+      },
+    ],
+    "@typescript-eslint/prefer-ts-expect-error": "error",
+    "@typescript-eslint/unbound-method": "error",
     "import/default": "off",
     "import/named": "off",
     "import/namespace": "off",
@@ -59,6 +93,7 @@ module.exports = {
     "import/prefer-default-export": "off",
     "jest/no-jest-import": "off",
     "json/*": "error",
+    "n/no-missing-import": "off",
     "n/no-unpublished-import": [
       "error",
       {
@@ -66,7 +101,6 @@ module.exports = {
       },
     ],
     "n/no-unsupported-features/es-syntax": "off",
-    "n/no-missing-import": "off",
     // Noisy rule - we may have helpers/methods that we mark as @deprecated but aren't planning to remove in the near future. This rule also significantly adds to eslint running time, which slows down both local development and CI.
     "sonarjs/deprecation": "off",
     // This rule is not helpful in TypeScript files, and in JavaScript we often return different types from functions, so this is not a strictness level we want to enforce.
@@ -75,10 +109,10 @@ module.exports = {
     "sonarjs/no-ignored-exceptions": "off",
     "sonarjs/no-nested-functions": ["warn", { threshold: 5 }],
     "sonarjs/no-small-switch": "off",
-    // Overlaps with @typescript-eslint/prefer-nullish-coalescing
-    "sonarjs/prefer-nullish-coalescing": "off",
     // Overlaps with @typescript-eslint/no-unused-vars
     "sonarjs/no-unused-vars": "off",
+    // Overlaps with @typescript-eslint/prefer-nullish-coalescing
+    "sonarjs/prefer-nullish-coalescing": "off",
     // Overlaps with @typescript-eslint/prefer-optional-chain
     "sonarjs/prefer-optional-chain": "off",
     // Useful for guarding against prop mutation in React, but too much of a lift as very rarely do we apply readonly/ReadonlyArray<T> to type definitions
@@ -87,40 +121,6 @@ module.exports = {
     "sonarjs/todo-tag": "off",
     // A useful rule to consider for libraries to better document (and export) type definitions, but noisy in app usages (especially around redux type definitions)
     "sonarjs/use-type-alias": "off",
-    /**
-     * {@link https://typescript-eslint.io/rules/consistent-type-imports | TypeScript ESLint: consistent-type-imports docs}
-     */
-    "@typescript-eslint/consistent-type-imports": [
-      "error",
-      {
-        disallowTypeAnnotations: true,
-        fixStyle: "inline-type-imports",
-        prefer: "type-imports",
-      },
-    ],
-    /** We do not need to force people to wrap `void`-return implicit arrow returns with braces just for a lint rule. TypeScript alone covers functionality, by the return type being `void`. */
-    "@typescript-eslint/no-confusing-void-expression": "off",
-    /** Included as part of `strict-type-checked`, but nothing we want to enforce. */
-    "@typescript-eslint/no-deprecated": "off",
-    /** Prefers `import type {}` syntax over `import { type }` if all imports are type-only */
-    "@typescript-eslint/no-import-type-side-effects": "error",
-    /** A relatively stylistic rule, downgraded to "off" to limit breaking changes in the update that includes `strict-type-checked`. */
-    "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off",
-    /** This rule can help us identify syntax that is more defensive than the types suggest. Unfortunately, it may be protecting us from runtime errors where the type definitions are incorrect. As such, it is turned "off", as even "warn" auto-fixes source code. */
-    "@typescript-eslint/no-unnecessary-condition": "off",
-    /** There is readability benefit to passing in type arguments that match defaults. If defaults change, we may prefer the manual inspection of all the types changed, too. */
-    "@typescript-eslint/no-unnecessary-type-arguments": "off",
-    /** Errors on generic type parameters that are only used once, even though that helps with return type inference. */
-    "@typescript-eslint/no-unnecessary-type-parameters": "off",
-    "@typescript-eslint/no-unused-vars": [
-      "error",
-      {
-        // Allow to name unused vars with _
-        argsIgnorePattern: "^_",
-      },
-    ],
-    "@typescript-eslint/prefer-ts-expect-error": "error",
-    "@typescript-eslint/unbound-method": "error",
   },
   settings: {
     "import/parsers": {

package/test/test.spec.js

@@ -1,6 +1,4 @@
 import { loadESLint } from "eslint";
-import { fileURLToPath } from "node:url";
-import path from "node:path";
 
 describe("validate config", () => {
   test.each(["./index.mjs", "./index.cjs", "./recommended.cjs"])(
@@ -12,8 +10,6 @@ describe("validate config", () => {
         useFlatConfig,
       });
       const linter = new ESLint({
-        // cwd: cwd,
-        overrideConfigFile: config,
         overrideConfig: useFlatConfig
           ? [
               {
@@ -34,6 +30,8 @@ describe("validate config", () => {
                 },
               },
             },
+        // cwd: cwd,
+        overrideConfigFile: config,
       });
       const messages = await linter.lintText(
         `const foo = 1;\nconsole.log(foo);\n`,