@jimmy.codes/eslint-config 6.21.0 → 6.23.0

package/README.md

@@ -42,7 +42,7 @@ import { defineConfig } from "@jimmy.codes/eslint-config";
 export default defineConfig();
 ```
 
-It’ll auto-configure based on your installed dependencies.
+It'll auto-configure based on your installed dependencies.
 
 ---
 
@@ -75,6 +75,44 @@ export default defineConfig({
 });
 ```
 
+### Vitest Configuration
+
+Vitest also supports some configuration options. If options are provided then Vitest support is enabled.
+
+#### Configure Vitest Globals
+
+Control how [Vitest globals configuration](https://vitest.dev/config/globals.html) (`describe`, `it`, `expect`, etc.) are handled:
+
+```ts
+import { defineConfig } from "@jimmy.codes/eslint-config";
+
+export default defineConfig({
+  vitest: {
+    globals: "explicit", // Require explicit imports from 'vitest'
+  },
+});
+```
+
+Options:
+
+- `'explicit'`: Require explicit imports from `'vitest'`
+- `'implicit'`: Use implicit global APIs (vitest config `globals: true`)
+- `'either'`: Allow both styles (default)
+
+#### Configure Type Testing
+
+Indicate whether [Vitest's type testing utilities](https://vitest.dev/guide/testing-types.html) (`expectTypeOf`, `assertType`) are being used:
+
+```ts
+import { defineConfig } from "@jimmy.codes/eslint-config";
+
+export default defineConfig({
+  vitest: {
+    typecheck: true,
+  },
+});
+```
+
 ### Override Specific Rules
 
 ```ts

package/dist/{astro-D3Zl135N.mjs → astro-DNtOkeq5.mjs}

@@ -1,4 +1,4 @@
-import { t as GLOB_ASTRO } from "./globs-C_yfK842.mjs";
+import { t as GLOB_ASTRO } from "./globs-uKx5b8lV.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 import globals from "globals";
 

package/dist/{globs-C_yfK842.mjs → globs-uKx5b8lV.mjs}

@@ -1,10 +1,12 @@
 //#region src/globs.ts
 const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+const GLOB_TS_EXT = "?([cm])ts";
+const GLOB_TSX_EXT = "?([cm])tsx";
 const GLOB_JS = "**/*.?([cm])js";
 const GLOB_JSX = "**/*.?([cm])jsx";
 const GLOB_CJS = "**/*.cjs";
-const GLOB_TS = "**/*.?([cm])ts";
-const GLOB_TSX = "**/*.?([cm])tsx";
+const GLOB_TS = `**/*.${GLOB_TS_EXT}`;
+const GLOB_TSX = `**/*.${GLOB_TSX_EXT}`;
 const GLOB_ASTRO = "**/*.astro";
 const GLOB_TESTS = [
 	`**/__tests__/**/*.${GLOB_SRC_EXT}`,
@@ -13,6 +15,12 @@ const GLOB_TESTS = [
 	`**/*.bench.${GLOB_SRC_EXT}`,
 	`**/*.benchmark.${GLOB_SRC_EXT}`
 ];
+const GLOB_TYPE_TESTS = [
+	`**/*.test-d.${GLOB_TS_EXT}`,
+	`**/*.test-d.${GLOB_TSX_EXT}`,
+	`**/*.spec-d.${GLOB_TS_EXT}`,
+	`**/*.spec-d.${GLOB_TSX_EXT}`
+];
 const GLOB_PLAYWRIGHT = [`**/e2e/**/*.spec.${GLOB_SRC_EXT}`, `**/e2e/**/*.test.${GLOB_SRC_EXT}`];
 const GLOB_E2E = [
 	...GLOB_PLAYWRIGHT,
@@ -69,4 +77,4 @@ const GLOB_IGNORES = [
 ];
 
 //#endregion
-export { GLOB_JS as a, GLOB_PLAYWRIGHT as c, GLOB_TSX as d, GLOB_IGNORES as i, GLOB_TESTS as l, GLOB_CJS as n, GLOB_JSX as o, GLOB_E2E as r, GLOB_NEXTJS as s, GLOB_ASTRO as t, GLOB_TS as u };
+export { GLOB_JS as a, GLOB_PLAYWRIGHT as c, GLOB_TSX as d, GLOB_TYPE_TESTS as f, GLOB_IGNORES as i, GLOB_TESTS as l, GLOB_CJS as n, GLOB_JSX as o, GLOB_E2E as r, GLOB_NEXTJS as s, GLOB_ASTRO as t, GLOB_TS as u };

package/dist/globs.d.mts

@@ -6,9 +6,10 @@ declare const GLOB_TS = "**/*.?([cm])ts";
 declare const GLOB_TSX = "**/*.?([cm])tsx";
 declare const GLOB_ASTRO = "**/*.astro";
 declare const GLOB_TESTS: readonly ["**/__tests__/**/*.?([cm])[jt]s?(x)", "**/*.spec.?([cm])[jt]s?(x)", "**/*.test.?([cm])[jt]s?(x)", "**/*.bench.?([cm])[jt]s?(x)", "**/*.benchmark.?([cm])[jt]s?(x)"];
+declare const GLOB_TYPE_TESTS: readonly ["**/*.test-d.?([cm])ts", "**/*.test-d.?([cm])tsx", "**/*.spec-d.?([cm])ts", "**/*.spec-d.?([cm])tsx"];
 declare const GLOB_PLAYWRIGHT: readonly ["**/e2e/**/*.spec.?([cm])[jt]s?(x)", "**/e2e/**/*.test.?([cm])[jt]s?(x)"];
 declare const GLOB_E2E: readonly ["**/e2e/**/*.spec.?([cm])[jt]s?(x)", "**/e2e/**/*.test.?([cm])[jt]s?(x)", "**/cypress/**/*.spec.?([cm])[jt]s?(x)", "**/cypress/**/*.test.?([cm])[jt]s?(x)"];
 declare const GLOB_NEXTJS: readonly ["**/*.?([cm])js", "**/*.?([cm])jsx", "**/*.?([cm])ts", "**/*.?([cm])tsx"];
 declare const GLOB_IGNORES: readonly ["**/node_modules", "**/dist", "**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml", "**/bun.lockb", "**/output", "**/coverage", "**/temp", "**/.temp", "**/tmp", "**/.tmp", "**/.history", "**/.vitepress/cache", "**/.nuxt", "**/.next", "**/.vercel", "**/.changeset", "**/.idea", "**/.cache", "**/.output", "**/.vite-inspect", "**/.yarn", "**/storybook-static", "**/.eslint-config-inspector", "**/playwright-report", "**/.astro", "**/.vinxi", "**/app.config.timestamp_*.js", "**/.tanstack", "**/.nitro", "**/CHANGELOG*.md", "**/*.min.*", "**/LICENSE*", "**/__snapshots__", "**/auto-import?(s).d.ts", "**/components.d.ts", "**/vite.config.ts.*.mjs", "**/*.gen.*", "!.storybook"];
 //#endregion
-export { GLOB_ASTRO, GLOB_CJS, GLOB_E2E, GLOB_IGNORES, GLOB_JS, GLOB_JSX, GLOB_NEXTJS, GLOB_PLAYWRIGHT, GLOB_TESTS, GLOB_TS, GLOB_TSX };
+export { GLOB_ASTRO, GLOB_CJS, GLOB_E2E, GLOB_IGNORES, GLOB_JS, GLOB_JSX, GLOB_NEXTJS, GLOB_PLAYWRIGHT, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_TYPE_TESTS };

package/dist/globs.mjs

@@ -1,3 +1,3 @@
-import { a as GLOB_JS, c as GLOB_PLAYWRIGHT, d as GLOB_TSX, i as GLOB_IGNORES, l as GLOB_TESTS, n as GLOB_CJS, o as GLOB_JSX, r as GLOB_E2E, s as GLOB_NEXTJS, t as GLOB_ASTRO, u as GLOB_TS } from "./globs-C_yfK842.mjs";
+import { a as GLOB_JS, c as GLOB_PLAYWRIGHT, d as GLOB_TSX, f as GLOB_TYPE_TESTS, i as GLOB_IGNORES, l as GLOB_TESTS, n as GLOB_CJS, o as GLOB_JSX, r as GLOB_E2E, s as GLOB_NEXTJS, t as GLOB_ASTRO, u as GLOB_TS } from "./globs-uKx5b8lV.mjs";
 
-export { GLOB_ASTRO, GLOB_CJS, GLOB_E2E, GLOB_IGNORES, GLOB_JS, GLOB_JSX, GLOB_NEXTJS, GLOB_PLAYWRIGHT, GLOB_TESTS, GLOB_TS, GLOB_TSX };
+export { GLOB_ASTRO, GLOB_CJS, GLOB_E2E, GLOB_IGNORES, GLOB_JS, GLOB_JSX, GLOB_NEXTJS, GLOB_PLAYWRIGHT, GLOB_TESTS, GLOB_TS, GLOB_TSX, GLOB_TYPE_TESTS };

package/dist/index.d.mts

@@ -15004,6 +15004,26 @@ interface LinterConfigOverrides {
   plugins?: Record<string, unknown>;
 }
 type TypedConfigItem = Prettify<Override<Base, LinterConfigOverrides>>;
+interface VitestOptions {
+  /**
+   * How to handle Vitest global APIs (describe, it, expect, etc.).
+   *
+   * - 'explicit': Require explicit imports from 'vitest'
+   * - 'implicit': Use implicit global APIs (vitest config globals: true)
+   * - 'either': Allow both styles (default)
+   *
+   * @see https://vitest.dev/config/globals.html
+   *
+   * @default 'either'
+   */
+  globals?: "either" | "explicit" | "implicit";
+  /**
+   * Indicate whether [Vitest's type testing utilities](https://vitest.dev/guide/testing-types.html) (`expectTypeOf`, `assertType`) are being used
+   *
+   * @default false
+   */
+  typecheck?: boolean;
+}
 interface Options {
   /**
    * Are astro rules enabled?
@@ -15091,7 +15111,7 @@ interface Options {
    *
    * @default false
    */
-  vitest?: boolean;
+  vitest?: boolean | VitestOptions;
 }
 //#endregion
 //#region src/factory.d.ts
@@ -15122,4 +15142,4 @@ declare const defineConfig: ({
   vitest
 }?: Options, ...moreOverrides: Linter.Config[] | TypedConfigItem[]) => Promise<any[]>;
 //#endregion
-export { Options, Rules, TypedConfigItem, defineConfig };
+export { type Options, type TypedConfigItem, type VitestOptions, defineConfig };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-import { i as GLOB_IGNORES, l as GLOB_TESTS, n as GLOB_CJS } from "./globs-C_yfK842.mjs";
+import { i as GLOB_IGNORES, l as GLOB_TESTS, n as GLOB_CJS } from "./globs-uKx5b8lV.mjs";
 import { a as hasReact, c as hasTestingLibrary, d as hasVitest, i as hasPlaywright, l as hasTypescript, n as hasJest, o as hasReactQuery, r as hasNext, s as hasStorybook, t as hasAstro } from "./has-dependency-BreXO1rF.mjs";
 import gitignoreConfig from "eslint-config-flat-gitignore";
 import globals from "globals";
@@ -424,6 +424,22 @@ const unicornConfig = () => {
 	}];
 };
 
+//#endregion
+//#region src/utils/create-featured.ts
+/**
+* Creates a featured flag checker function.
+*
+* @param autoDetect  - Whether to auto-detect features.
+*
+* @returns A function that determines if a feature is enabled.
+*/
+const createFeatured = (autoDetect) => {
+	return (explicit, detector) => {
+		if (typeof explicit !== "boolean") return true;
+		return explicit || autoDetect && detector();
+	};
+};
+
 //#endregion
 //#region src/utils/unwrap.ts
 /**
@@ -436,16 +452,19 @@ const unicornConfig = () => {
 *
 * @param module - A dynamically imported module.
 *
+* @param args - Optional arguments forwarded to the module's default export if it's a function.
+*
 * @returns
 * If the module has a `default` export that is a function, it returns the result of calling it.
 * Otherwise, it returns the module itself.
 *
 * @example
 * const config = await unwrap(import("./configs/react"));
+* const configWithOptions = await unwrap(import("./configs/react"), { version: "12" });
 */
-const unwrap = async (module) => {
+const unwrap = async (module, ...args) => {
 	const resolved = await module;
-	if (typeof resolved.default === "function") return resolved.default();
+	if (typeof resolved.default === "function") return resolved.default(...args);
 	return resolved;
 };
 
@@ -462,19 +481,17 @@ const unwrap = async (module) => {
 * export default defineConfig();
 */
 const defineConfig = async ({ astro = false, autoDetect = true, gitignore = false, ignores = [], jest = false, nextjs = false, overrides = [], playwright = false, react = false, storybook = false, tanstackQuery = false, testingLibrary = false, typescript = false, vitest = false } = {}, ...moreOverrides) => {
-	const getFlag = (explicit, detector) => {
-		return explicit || autoDetect && detector();
-	};
-	const isTypescriptEnabled = getFlag(typescript, hasTypescript);
-	const isReactEnabled = getFlag(react, hasReact);
-	const isAstroEnabled = getFlag(astro, hasAstro);
-	const isTanstackQueryEnabled = getFlag(tanstackQuery, hasReactQuery);
-	const isTestingLibraryEnabled = getFlag(testingLibrary, hasTestingLibrary);
-	const isPlaywrightEnabled = getFlag(playwright, hasPlaywright);
-	const isStorybookEnabled = getFlag(storybook, hasStorybook);
-	const isNextjsEnabled = getFlag(nextjs, hasNext);
-	const isJestEnabled = getFlag(jest, hasJest);
-	const isVitestEnabled = getFlag(vitest, hasVitest);
+	const featured = createFeatured(autoDetect);
+	const isTypescriptEnabled = featured(typescript, hasTypescript);
+	const isReactEnabled = featured(react, hasReact);
+	const isAstroEnabled = featured(astro, hasAstro);
+	const isTanstackQueryEnabled = featured(tanstackQuery, hasReactQuery);
+	const isTestingLibraryEnabled = featured(testingLibrary, hasTestingLibrary);
+	const isPlaywrightEnabled = featured(playwright, hasPlaywright);
+	const isStorybookEnabled = featured(storybook, hasStorybook);
+	const isNextjsEnabled = featured(nextjs, hasNext);
+	const isJestEnabled = featured(jest, hasJest);
+	const isVitestEnabled = featured(vitest, hasVitest);
 	const baseConfigs = [
 		javascriptConfig(),
 		perfectionistConfig(),
@@ -487,16 +504,16 @@ const defineConfig = async ({ astro = false, autoDetect = true, gitignore = fals
 		stylisticConfig()
 	];
 	const featureConfigs = await Promise.all([
-		isTypescriptEnabled && unwrap(import("./typescript-w0LuBIDT.mjs")),
-		isReactEnabled && unwrap(import("./react-sWdvHd_J.mjs")),
-		isTanstackQueryEnabled && unwrap(import("./tanstack-query-D1gpzKY3.mjs")),
-		isAstroEnabled && unwrap(import("./astro-D3Zl135N.mjs")),
-		isJestEnabled && unwrap(import("./jest-DZtYWPoX.mjs")),
-		isVitestEnabled && unwrap(import("./vitest-57vZrKwy.mjs")),
-		isTestingLibraryEnabled && unwrap(import("./testing-library-BBWV3thw.mjs")),
-		isPlaywrightEnabled && unwrap(import("./playwright-CrBcE3qD.mjs")),
+		isTypescriptEnabled && unwrap(import("./typescript-CMkBsIGI.mjs")),
+		isReactEnabled && unwrap(import("./react-DY8zODCu.mjs")),
+		isTanstackQueryEnabled && unwrap(import("./tanstack-query-DG6a41GH.mjs")),
+		isAstroEnabled && unwrap(import("./astro-DNtOkeq5.mjs")),
+		isJestEnabled && unwrap(import("./jest-DgTHyrfz.mjs")),
+		isVitestEnabled && unwrap(import("./vitest-C4QXivmM.mjs"), vitest),
+		isTestingLibraryEnabled && unwrap(import("./testing-library-oE675dT3.mjs")),
+		isPlaywrightEnabled && unwrap(import("./playwright-CM4et1Wx.mjs")),
 		isStorybookEnabled && unwrap(import("./storybook-CyxpG33Q.mjs")),
-		isNextjsEnabled && unwrap(import("./nextjs-DEk_ANZ4.mjs"))
+		isNextjsEnabled && unwrap(import("./nextjs-VPeisXpq.mjs"))
 	]);
 	return [
 		...gitignore ? [gitignoreConfig({ strict: false })] : [],

package/dist/{jest-DZtYWPoX.mjs → jest-DgTHyrfz.mjs}

@@ -1,4 +1,4 @@
-import { l as GLOB_TESTS, r as GLOB_E2E } from "./globs-C_yfK842.mjs";
+import { l as GLOB_TESTS, r as GLOB_E2E } from "./globs-uKx5b8lV.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 
 //#region src/rules/jest.ts

package/dist/{nextjs-DEk_ANZ4.mjs → nextjs-VPeisXpq.mjs}

@@ -1,4 +1,4 @@
-import { s as GLOB_NEXTJS } from "./globs-C_yfK842.mjs";
+import { s as GLOB_NEXTJS } from "./globs-uKx5b8lV.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 import { t as upwarn } from "./upwarn-BWFMaOyK.mjs";
 

package/dist/{playwright-CrBcE3qD.mjs → playwright-CM4et1Wx.mjs}

@@ -1,4 +1,4 @@
-import { c as GLOB_PLAYWRIGHT } from "./globs-C_yfK842.mjs";
+import { c as GLOB_PLAYWRIGHT } from "./globs-uKx5b8lV.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 
 //#region src/rules/playwright.ts

package/dist/{react-sWdvHd_J.mjs → react-DY8zODCu.mjs}

@@ -1,4 +1,4 @@
-import { d as GLOB_TSX, o as GLOB_JSX } from "./globs-C_yfK842.mjs";
+import { d as GLOB_TSX, o as GLOB_JSX } from "./globs-uKx5b8lV.mjs";
 import { l as hasTypescript, r as hasNext, u as hasVite } from "./has-dependency-BreXO1rF.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 import { t as upwarn } from "./upwarn-BWFMaOyK.mjs";

package/dist/{tanstack-query-D1gpzKY3.mjs → tanstack-query-DG6a41GH.mjs}

@@ -1,4 +1,4 @@
-import { d as GLOB_TSX, o as GLOB_JSX } from "./globs-C_yfK842.mjs";
+import { d as GLOB_TSX, o as GLOB_JSX } from "./globs-uKx5b8lV.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 
 //#region src/configs/tanstack-query.ts

package/dist/{testing-library-BBWV3thw.mjs → testing-library-oE675dT3.mjs}

@@ -1,4 +1,4 @@
-import { l as GLOB_TESTS, r as GLOB_E2E } from "./globs-C_yfK842.mjs";
+import { l as GLOB_TESTS, r as GLOB_E2E } from "./globs-uKx5b8lV.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 
 //#region src/rules/testing-library.ts

package/dist/{typescript-w0LuBIDT.mjs → typescript-CMkBsIGI.mjs}

@@ -1,4 +1,4 @@
-import { a as GLOB_JS, l as GLOB_TESTS, o as GLOB_JSX } from "./globs-C_yfK842.mjs";
+import { a as GLOB_JS, l as GLOB_TESTS, o as GLOB_JSX } from "./globs-uKx5b8lV.mjs";
 
 //#region src/rules/typescript.ts
 const disabledEslintRules = {

package/dist/{vitest-57vZrKwy.mjs → vitest-C4QXivmM.mjs}

@@ -1,8 +1,8 @@
-import { l as GLOB_TESTS, r as GLOB_E2E } from "./globs-C_yfK842.mjs";
+import { f as GLOB_TYPE_TESTS, l as GLOB_TESTS, r as GLOB_E2E } from "./globs-uKx5b8lV.mjs";
 import { t as interopDefault } from "./interop-default-Bn64p66u.mjs";
 
 //#region src/rules/vitest.ts
-const vitestRules = async () => {
+const vitestRules = async (options) => {
 	return {
 		...(await interopDefault(import("@vitest/eslint-plugin"))).configs.recommended.rules,
 		"vitest/consistent-each-for": ["error", {
@@ -21,6 +21,7 @@ const vitestRules = async () => {
 		"vitest/no-conditional-in-test": "error",
 		"vitest/no-duplicate-hooks": "error",
 		"vitest/no-hooks": "off",
+		"vitest/no-importing-vitest-globals": options?.globals === "implicit" ? "error" : "off",
 		"vitest/no-large-snapshots": "off",
 		"vitest/no-restricted-matchers": "off",
 		"vitest/no-restricted-vi-methods": "off",
@@ -39,6 +40,7 @@ const vitestRules = async () => {
 		"vitest/prefer-expect-type-of": "error",
 		"vitest/prefer-hooks-in-order": "error",
 		"vitest/prefer-hooks-on-top": "error",
+		"vitest/prefer-importing-vitest-globals": options?.globals === "explicit" ? "error" : "off",
 		"vitest/prefer-lowercase-title": "off",
 		"vitest/prefer-mock-promise-shorthand": "error",
 		"vitest/prefer-snapshot-hint": "error",
@@ -59,15 +61,31 @@ const vitestRules = async () => {
 	};
 };
 
+//#endregion
+//#region src/utils/extract-options.ts
+/**
+* A simple utility to derive options for configurations when one option is a boolean.
+*
+* @param options - The options to derive.
+*
+* @returns The extracted options or `undefined` if the input was a boolean.
+*/
+const extractOptions = (options) => {
+	if (typeof options !== "boolean") return options;
+};
+
 //#endregion
 //#region src/configs/vitest.ts
-async function vitestConfig() {
+async function vitestConfig(options) {
+	const vitestPlugin = await interopDefault(import("@vitest/eslint-plugin"));
+	const extractedOptions = extractOptions(options);
 	return [{
-		files: GLOB_TESTS,
+		files: [...GLOB_TESTS, ...extractedOptions?.typecheck ? GLOB_TYPE_TESTS : []],
 		ignores: GLOB_E2E,
-		...(await interopDefault(import("@vitest/eslint-plugin"))).configs.recommended,
+		...vitestPlugin.configs.recommended,
 		name: "jimmy.codes/vitest",
-		rules: await vitestRules()
+		rules: await vitestRules(extractedOptions),
+		settings: { vitest: { typecheck: extractedOptions?.typecheck ?? false } }
 	}];
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jimmy.codes/eslint-config",
-  "version": "6.21.0",
+  "version": "6.23.0",
   "description": "A simple, modern ESLint config that covers most use cases.",
   "keywords": [
     "eslint",
@@ -63,13 +63,13 @@
     "eslint-plugin-perfectionist": "^4.15.1",
     "eslint-plugin-playwright": "^2.3.0",
     "eslint-plugin-react-compiler": "19.1.0-rc.2",
-    "eslint-plugin-react-dom": "^2.3.7",
+    "eslint-plugin-react-dom": "^2.3.9",
     "eslint-plugin-react-hooks": "^7.0.1",
-    "eslint-plugin-react-hooks-extra": "^2.3.7",
-    "eslint-plugin-react-naming-convention": "^2.3.7",
+    "eslint-plugin-react-hooks-extra": "^2.3.9",
+    "eslint-plugin-react-naming-convention": "^2.3.9",
     "eslint-plugin-react-refresh": "0.4.24",
-    "eslint-plugin-react-web-api": "^2.3.7",
-    "eslint-plugin-react-x": "^2.3.7",
+    "eslint-plugin-react-web-api": "^2.3.9",
+    "eslint-plugin-react-x": "^2.3.9",
     "eslint-plugin-regexp": "^2.10.0",
     "eslint-plugin-storybook": "0.12.0",
     "eslint-plugin-testing-library": "^7.13.5",