@open-turo/eslint-config-typescript 18.0.12 → 18.1.0-pr-440.291.1.1

package/.nvmrc

@@ -1 +1 @@
-22.19.0
+22.20.0

package/.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
         additional_dependencies: ["prettier@3.6.2"]
         stages: [pre-commit]
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v9.22.0
+    rev: v9.23.0
     hooks:
       - id: commitlint
         stages: [commit-msg]

package/README.md

@@ -29,10 +29,21 @@ module.exports = turoConfig();
 
 The `turoConfig` function accepts an options object with the following properties:
 
-- `allowModules` - List of modules to allow in the `n/no-unpublished-import` rule
-- `ignores` - List of patterns to ignore. Defaults to `["@jest/globals", "nock"]`
+- `allowModules` - List of modules to allow in the `n/no-unpublished-import` rule. Defaults to `["@jest/globals", "nock"]` for Jest or `["nock"]` for Vitest
+- `ignores` - List of patterns to ignore
 - `typescript` - Whether to include typescript rules. Defaults to `true`
 - `ecmaVersion` - The ECMAScript version to use. Defaults to `latest`
+- `testFramework` - Test framework to use: `"jest"` (default) or `"vitest"`
+
+#### Vitest Configuration Example
+
+```js
+const turoConfig = require("@open-turo/eslint-config-typescript");
+
+module.exports = turoConfig({
+  testFramework: "vitest",
+});
+```
 
 ### **[.eslintrc](https://eslint.org/docs/latest/use/configure/configuration-files)** (legacy example)
 

package/index.cjs

@@ -11,6 +11,7 @@ const perfectionistPlugin = require("eslint-plugin-perfectionist");
 const prettierPluginRecommended = require("eslint-plugin-prettier/recommended");
 const sonarjsPlugin = require("eslint-plugin-sonarjs");
 const unicornPlugin = require("eslint-plugin-unicorn");
+const vitestPlugin = require("@vitest/eslint-plugin");
 const tseslint = require("typescript-eslint");
 
 const FILES_JS = "**/*.?([cm])js";
@@ -183,10 +184,9 @@ const typescriptConfig = () =>
  * @param {object} options Configuration options
  * @param {boolean} options.typescript Whether to include typescript rules
  */
-const testConfig = (options) => {
+const jestTestConfig = (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",
       })
@@ -211,6 +211,42 @@ const testConfig = (options) => {
   });
 };
 
+/**
+ *
+ * @param {object} options Configuration options
+ * @param {boolean} options.typescript Whether to include typescript rules
+ */
+const vitestTestConfig = (options) => {
+  return tseslint.config({
+    extends: [vitestPlugin.configs.recommended],
+    files: FILES_TEST,
+    languageOptions: {
+      globals: vitestPlugin.environments.env.globals,
+      ...(options.typescript ? typescriptLanguageOptions() : {}),
+    },
+    plugins: { vitest: vitestPlugin },
+    rules: {
+      "import/no-extraneous-dependencies": [
+        "error",
+        { devDependencies: FILES_TEST },
+      ],
+    },
+  });
+};
+
+/**
+ *
+ * @param {object} options Configuration options
+ * @param {boolean} options.typescript Whether to include typescript rules
+ * @param {"jest" | "vitest"} options.testFramework Test framework to use
+ */
+const testConfig = (options) => {
+  if (options.testFramework === "vitest") {
+    return vitestTestConfig(options);
+  }
+  return jestTestConfig(options);
+};
+
 /**
  * @param {string[]} ignores
  */
@@ -226,22 +262,34 @@ const ignoresConfig = (ignores = []) =>
  * @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
+ * @param {"jest" | "vitest"} [options.testFramework] - Test framework to use (defaults to "jest")
  */
 module.exports = function config(options = {}) {
   const useTypescript =
     options.typescript === undefined ? true : options.typescript;
+  const testFramework = options.testFramework || "jest";
+
+  if (testFramework !== "jest" && testFramework !== "vitest") {
+    throw new Error(
+      `Invalid testFramework option: "${testFramework}". Valid values are "jest" or "vitest".`,
+    );
+  }
+
+  const defaultAllowModules =
+    testFramework === "vitest" ? ["nock"] : ["@jest/globals", "nock"];
+  const allowModules = options.allowModules || defaultAllowModules;
 
   return tseslint.config(
     javascriptConfig(options.ecmaVersion),
     importConfig(),
-    nPluginConfig(options.allowModules),
+    nPluginConfig(allowModules),
     perfectionistPlugin.configs["recommended-alphabetical"],
     sonarJsConfig(),
     unicornPlugin.configs["flat/recommended"],
     prettierPluginRecommended,
     jsonPlugin.configs["recommended"],
     useTypescript ? typescriptConfig() : {},
-    testConfig({ typescript: useTypescript }),
+    testConfig({ testFramework, typescript: useTypescript }),
     ignoresConfig(options.ignores),
   );
 };

package/package.json

@@ -6,6 +6,7 @@
     "@eslint/js": "9.36.0",
     "@typescript-eslint/eslint-plugin": "8.45.0",
     "@typescript-eslint/parser": "8.45.0",
+    "@vitest/eslint-plugin": "1.1.23",
     "eslint-config-prettier": "10.1.8",
     "eslint-import-resolver-typescript": "4.4.4",
     "eslint-plugin-import": "2.32.0",
@@ -55,6 +56,6 @@
     "access": "public"
   },
   "repository": "https://github.com/open-turo/eslint-config-typescript",
-  "version": "18.0.12",
+  "version": "18.1.0-pr-440.291.1.1",
   "packageManager": "npm@11.6.1"
 }