@jimmy.codes/eslint-config 6.21.0 → 6.22.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,30 @@ 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)
+
 ### Override Specific Rules
 
 ```ts

package/dist/index.d.mts

@@ -15004,6 +15004,20 @@ 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";
+}
 interface Options {
   /**
    * Are astro rules enabled?
@@ -15091,7 +15105,7 @@ interface Options {
    *
    * @default false
    */
-  vitest?: boolean;
+  vitest?: boolean | VitestOptions;
 }
 //#endregion
 //#region src/factory.d.ts
@@ -15122,4 +15136,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

@@ -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(),
@@ -492,7 +509,7 @@ const defineConfig = async ({ astro = false, autoDetect = true, gitignore = fals
 		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")),
+		isVitestEnabled && unwrap(import("./vitest-oIUtAksi.mjs"), vitest),
 		isTestingLibraryEnabled && unwrap(import("./testing-library-BBWV3thw.mjs")),
 		isPlaywrightEnabled && unwrap(import("./playwright-CrBcE3qD.mjs")),
 		isStorybookEnabled && unwrap(import("./storybook-CyxpG33Q.mjs")),

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

@@ -2,7 +2,7 @@ import { l as GLOB_TESTS, r as GLOB_E2E } from "./globs-C_yfK842.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,30 @@ 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,
 		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)
 	}];
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jimmy.codes/eslint-config",
-  "version": "6.21.0",
+  "version": "6.22.0",
   "description": "A simple, modern ESLint config that covers most use cases.",
   "keywords": [
     "eslint",