@open-turo/eslint-config-typescript 16.0.7 → 16.0.8

package/index.cjs

@@ -1,3 +1,6 @@
+// @ts-check
+
+/** @import { ConfigWithExtends } from "typescript-eslint" */
 const eslint = require("@eslint/js");
 const tsParser = require("@typescript-eslint/parser");
 const importPlugin = require("eslint-plugin-import");
@@ -28,6 +31,13 @@ const typescriptLanguageOptions = () => ({
   },
 });
 
+/**
+ * @typedef {NonNullable<NonNullable<ConfigWithExtends['languageOptions']>['parserOptions']>['ecmaVersion']} EcmaVersion
+ */
+
+/**
+ * @param {EcmaVersion} [ecmaVersion]
+ */
 const javascriptConfig = (ecmaVersion = "latest") =>
   tseslint.config(eslint.configs.recommended, {
     files: [FILES_JS],
@@ -38,9 +48,19 @@ const javascriptConfig = (ecmaVersion = "latest") =>
     },
   });
 
+const getImportPluginFlatConfigs = () => {
+  if (!importPlugin.flatConfigs) {
+    throw new Error(
+      "Unexpected value from eslint-plugin-import. You will need to upgrade the plugin.",
+    );
+  }
+
+  return importPlugin.flatConfigs;
+};
+
 const importConfig = () =>
   tseslint.config({
-    extends: [importPlugin.flatConfigs.recommended],
+    extends: [getImportPluginFlatConfigs().recommended],
     rules: {
       "import/default": "off",
       "import/named": "off",
@@ -110,7 +130,8 @@ const typescriptConfig = () =>
   tseslint.config({
     extends: [
       tseslint.configs.recommendedTypeChecked,
-      importPlugin.flatConfigs.typescript,
+      // @ts-expect-error -- We are inferring the types of this import from runtime, but the rule values are inferred as `string` instead of `RuleEntry` ("off" | "warn" | "error")
+      getImportPluginFlatConfigs().typescript,
     ],
     files: [FILES_TS, FILES_TSX],
     languageOptions: typescriptLanguageOptions(),
@@ -154,17 +175,16 @@ const typescriptConfig = () =>
 
 /**
  *
- * @param options Configuration options
- * @param options.typescript Whether to include typescript rules
- * @returns {ConfigArray}
+ * @param {object} options Configuration options
+ * @param {boolean} options.typescript Whether to include typescript rules
  */
 const testConfig = (options) => {
   const typescriptRules = options.typescript
-    ? {
+    ? /** @type {const} */ ({
         // 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"]],
@@ -186,6 +206,9 @@ const testConfig = (options) => {
   });
 };
 
+/**
+ * @param {string[]} ignores
+ */
 const ignoresConfig = (ignores = []) =>
   tseslint.config({
     ignores: ["**/.yalc", "**/dist", ...ignores],
@@ -193,16 +216,16 @@ const ignoresConfig = (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
- * @param [options.ecmaVersion] - The ECMAScript version to use
- * @returns {ConfigArray}
+ * @param {object} [options] - Eslint config options
+ * @param {string[]} [options.allowModules] - List of modules to allow in the n/no-unpublished-import rule
+ * @param {string[]} [options.ignores] - List of patterns to ignore
+ * @param {boolean} [options.typescript] - Whether to include typescript rules
+ * @param {EcmaVersion} [options.ecmaVersion] - The ECMAScript version to use
  */
 module.exports = function config(options = {}) {
   const useTypescript =
     options.typescript === undefined ? true : options.typescript;
+
   return tseslint.config(
     javascriptConfig(options.ecmaVersion),
     importConfig(),

package/package.json

@@ -4,7 +4,6 @@
   "type": "module",
   "dependencies": {
     "@eslint/js": "9.29.0",
-    "typescript-eslint": "8.34.1",
     "@typescript-eslint/eslint-plugin": "8.34.1",
     "@typescript-eslint/parser": "8.34.1",
     "eslint-config-prettier": "10.1.5",
@@ -16,7 +15,8 @@
     "eslint-plugin-perfectionist": "4.14.0",
     "eslint-plugin-prettier": "5.4.1",
     "eslint-plugin-sonarjs": "3.0.2",
-    "eslint-plugin-unicorn": "56.0.1"
+    "eslint-plugin-unicorn": "56.0.1",
+    "typescript-eslint": "8.34.1"
   },
   "devDependencies": {
     "eslint": "9.29.0",
@@ -54,5 +54,6 @@
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-typescript",
-  "version": "16.0.7"
+  "version": "16.0.8",
+  "packageManager": "npm@11.4.2+sha512.f90c1ec8b207b625d6edb6693aef23dacb39c38e4217fe8c46a973f119cab392ac0de23fe3f07e583188dae9fd9108b3845ad6f525b598742bd060ebad60bff3"
 }