@open-turo/eslint-config-typescript 16.0.0-pr-373.7.1.1 → 16.0.0-pr-373.8.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/index.cjs

@@ -10,23 +10,31 @@ const sonarjsPlugin = require("eslint-plugin-sonarjs");
 const unicornPlugin = require("eslint-plugin-unicorn");
 const tsParser = require("@typescript-eslint/parser");
 
-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],
+    settings: {
+      "import/resolver": {
+        typescript: {
+          alwaysTryTypes: true,
+        },
       },
     },
     rules: {
@@ -36,17 +44,31 @@ 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",
+    },
+  });
+
+const nPluginConfig = (allowModules = ["@jest/globals", "nock"]) =>
+  tseslint.config({
+    extends: [nPlugin.configs["flat/recommended"]],
+    rules: {
       "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.
@@ -67,6 +89,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({
+    files: [FILES_TS, FILES_TSX],
+    extends: [
+      tseslint.configs.recommendedTypeChecked,
+      importPlugin.flatConfigs.typescript,
+    ],
+    languageOptions: typescriptLanguageOptions(),
+    rules: {
       /**
        * {@link https://typescript-eslint.io/rules/consistent-type-imports | TypeScript ESLint: consistent-type-imports docs}
        */
@@ -102,18 +136,15 @@ module.exports = tseslint.config(
       "@typescript-eslint/prefer-ts-expect-error": "error",
       "@typescript-eslint/unbound-method": "error",
     },
-  },
-  prettierPluginRecommended,
-  jsonPlugin.configs["recommended"],
-  {
-    files: ["test/**"],
+  });
+
+const testConfig = () =>
+  tseslint.config({
+    files: FILES_TEST,
     plugins: { jest: jestPlugin },
     languageOptions: {
       globals: jestPlugin.environments.globals.globals,
-      parser: tsParser,
-      parserOptions: {
-        projectService: true,
-      },
+      ...typescriptLanguageOptions(),
     },
     extends: [jestPlugin.configs["flat/recommended"]],
     rules: {
@@ -122,15 +153,36 @@ module.exports = tseslint.config(
       "@typescript-eslint/unbound-method": "off",
       "jest/no-jest-import": "off",
       "jest/unbound-method": "error",
+      "import/no-extraneous-dependencies": [
+        "error",
+        { devDependencies: FILES_TEST },
+      ],
     },
-  },
-  {
-    settings: {
-      "import/resolver": {
-        typescript: {
-          alwaysTryTypes: true,
-        },
-      },
-    },
-  },
-);
+  });
+
+const ignoresConfig = (ignores = []) =>
+  tseslint.config({
+    ignores: ["**/.yalc", "**/dist"].concat(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
+ * @returns {ConfigArray}
+ */
+module.exports = (options = {}) =>
+  tseslint.config(
+    eslint.configs.recommended,
+    importConfig(),
+    nPluginConfig(options.allowModules),
+    perfectionistPlugin.configs["recommended-alphabetical"],
+    sonarJsConfig(),
+    unicornPlugin.configs["flat/recommended"],
+    prettierPluginRecommended,
+    jsonPlugin.configs["recommended"],
+    typescriptConfig(),
+    testConfig(),
+    ignoresConfig(options.ignores),
+  );

package/index.mjs

@@ -1,136 +1,3 @@
-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";
+import config from "./index.cjs";
 
-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,
-        },
-      },
-    },
-  },
-);
+export default config;

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.8.1.1"
 }