@will-stone/eslint-config 19.0.0 → 20.0.0

package/README.md

@@ -18,7 +18,6 @@ the corresponding plugin.
 | Package       | Plugin                                          |
 | ------------- | ----------------------------------------------- |
 | `astro`       | `astro-eslint-parser eslint-plugin-astro`       |
-| `jest`        | `eslint-plugin-jest`                            |
 | `react`       | `eslint-plugin-react eslint-plugin-react-hooks` |
 | `tailwindcss` | `eslint-plugin-tailwindcss`                     |
 | `vitest`      | `@vitest/eslint-plugin`                         |

package/dist/index.d.ts

@@ -6,15 +6,19 @@ import { TSESLint } from "@typescript-eslint/utils";
  */
 type Options = {
   astro?: boolean;
-  jest?: boolean;
   react?: boolean;
   tailwind?: {
     config?: string;
     cssFiles?: string[];
   } | boolean;
-  typescript?: boolean;
+  typescript?: boolean | {
+    tsconfigPath?: string;
+  };
   vitest?: boolean;
 };
+/**
+ * A context of data and options passed to all configs.
+ */
 //#endregion
 //#region src/index.d.ts
 /**

package/dist/index.js

@@ -2,11 +2,12 @@ import parserTypescript from "@typescript-eslint/parser";
 import restrictedGlobals from "confusing-browser-globals";
 import globals from "globals";
 import gitignore from "eslint-config-flat-gitignore";
+import jsdocPlugin from "eslint-plugin-jsdoc";
 import pluginNode from "eslint-plugin-n";
 import pluginPackageJson from "eslint-plugin-package-json";
 import pluginPerfectionist from "eslint-plugin-perfectionist";
 import stylistic from "@stylistic/eslint-plugin";
-import pluginTsdoc from "eslint-plugin-tsdoc";
+import pluginTypescript from "@typescript-eslint/eslint-plugin";
 import pluginUnicorn from "eslint-plugin-unicorn";
 import { globbySync } from "globby";
 import { readFileSync } from "node:fs";
@@ -62,7 +63,7 @@ async function interopDefault(m) {
 
 //#endregion
 //#region src/configs/astro.ts
-async function astro(_options) {
+async function astro(_configContext) {
 	const [pluginAstro, parserAstro] = await Promise.all([interopDefault(import("eslint-plugin-astro")), interopDefault(import("astro-eslint-parser"))]);
 	return [{
 		files: [GLOB_ASTRO],
@@ -140,7 +141,7 @@ async function astro(_options) {
 
 //#endregion
 //#region src/configs/base.ts
-async function base() {
+function base() {
 	return [{
 		languageOptions: { globals: {
 			...globals.browser,
@@ -366,7 +367,7 @@ async function base() {
 
 //#endregion
 //#region src/configs/ignores.ts
-async function ignores() {
+function ignores() {
 	return [{
 		ignores: GLOB_EXCLUDE,
 		name: "will-stone/ignores"
@@ -377,97 +378,84 @@ async function ignores() {
 }
 
 //#endregion
-//#region src/configs/jest.ts
-async function jest(_options) {
-	const pluginJest = await interopDefault(import("eslint-plugin-jest"));
-	return [
-		{
-			files: GLOB_TESTS,
-			languageOptions: { globals: globals.jest },
-			name: "will-stone/jest/globals"
-		},
-		{
-			files: [GLOB_TESTS],
-			name: "will-stone/jest/base",
-			plugins: { jest: pluginJest },
-			rules: {
-				"jest/consistent-test-it": ["error", {
-					fn: "test",
-					withinDescribe: "it"
-				}],
-				"jest/expect-expect": "error",
-				"jest/max-expects": "off",
-				"jest/max-nested-describe": "off",
-				"jest/no-alias-methods": "error",
-				"jest/no-commented-out-tests": "error",
-				"jest/no-conditional-expect": "error",
-				"jest/no-conditional-in-test": "error",
-				"jest/no-confusing-set-timeout": "error",
-				"jest/no-deprecated-functions": "warn",
-				"jest/no-disabled-tests": "warn",
-				"jest/no-done-callback": "error",
-				"jest/no-duplicate-hooks": "error",
-				"jest/no-export": "error",
-				"jest/no-focused-tests": "error",
-				"jest/no-hooks": "off",
-				"jest/no-identical-title": "error",
-				"jest/no-interpolation-in-snapshots": "error",
-				"jest/no-jasmine-globals": "warn",
-				"jest/no-large-snapshots": "off",
-				"jest/no-mocks-import": "error",
-				"jest/no-restricted-jest-methods": "off",
-				"jest/no-restricted-matchers": "off",
-				"jest/no-standalone-expect": "error",
-				"jest/no-test-prefixes": "warn",
-				"jest/no-test-return-statement": "error",
-				"jest/padding-around-after-all-blocks": "warn",
-				"jest/padding-around-after-each-blocks": "warn",
-				"jest/padding-around-all": "warn",
-				"jest/padding-around-before-all-blocks": "warn",
-				"jest/padding-around-before-each-blocks": "warn",
-				"jest/padding-around-describe-blocks": "warn",
-				"jest/padding-around-expect-groups": "warn",
-				"jest/padding-around-test-blocks": "warn",
-				"jest/prefer-called-with": "off",
-				"jest/prefer-comparison-matcher": "warn",
-				"jest/prefer-each": "error",
-				"jest/prefer-equality-matcher": "error",
-				"jest/prefer-expect-assertions": "off",
-				"jest/prefer-expect-resolves": "warn",
-				"jest/prefer-hooks-in-order": "error",
-				"jest/prefer-hooks-on-top": "error",
-				"jest/prefer-importing-jest-globals": "off",
-				"jest/prefer-jest-mocked": "warn",
-				"jest/prefer-lowercase-title": "off",
-				"jest/prefer-mock-promise-shorthand": "warn",
-				"jest/prefer-snapshot-hint": "error",
-				"jest/prefer-spy-on": "error",
-				"jest/prefer-strict-equal": "error",
-				"jest/prefer-to-be": "warn",
-				"jest/prefer-to-contain": "error",
-				"jest/prefer-to-have-length": "error",
-				"jest/prefer-todo": "error",
-				"jest/require-hook": "error",
-				"jest/require-to-throw-message": "error",
-				"jest/require-top-level-describe": "off",
-				"jest/unbound-method": "off",
-				"jest/valid-describe-callback": "error",
-				"jest/valid-expect": "error",
-				"jest/valid-expect-in-promise": "error",
-				"jest/valid-title": "error"
-			}
-		},
-		{
-			files: ["**/*.{spec,test}.{ts,tsx}"],
-			name: "will-stone/jest/typescript",
-			rules: { "jest/no-untyped-mock-factory": "warn" }
+//#region src/configs/jsdoc.ts
+function jsdoc() {
+	return [{
+		files: [GLOB_TS, GLOB_TSX],
+		name: "will-stone/jsdoc",
+		plugins: { jsdoc: jsdocPlugin },
+		rules: {
+			"jsdoc/check-access": "off",
+			"jsdoc/check-alignment": "warn",
+			"jsdoc/check-examples": "off",
+			"jsdoc/check-indentation": "off",
+			"jsdoc/check-line-alignment": [
+				"warn",
+				"never",
+				{ wrapIndent: "  " }
+			],
+			"jsdoc/check-param-names": "warn",
+			"jsdoc/check-property-names": "off",
+			"jsdoc/check-syntax": "off",
+			"jsdoc/check-tag-names": ["warn", {
+				definedTags: ["jest-environment"],
+				typed: false
+			}],
+			"jsdoc/check-template-names": "off",
+			"jsdoc/check-types": "off",
+			"jsdoc/check-values": "warn",
+			"jsdoc/convert-to-jsdoc-comments": "off",
+			"jsdoc/empty-tags": "warn",
+			"jsdoc/implements-on-classes": "off",
+			"jsdoc/imports-as-dependencies": "off",
+			"jsdoc/informative-docs": "warn",
+			"jsdoc/lines-before-block": "off",
+			"jsdoc/match-description": "off",
+			"jsdoc/match-name": "off",
+			"jsdoc/multiline-blocks": "off",
+			"jsdoc/no-bad-blocks": "warn",
+			"jsdoc/no-blank-block-descriptions": "warn",
+			"jsdoc/no-blank-blocks": "off",
+			"jsdoc/no-defaults": "warn",
+			"jsdoc/no-missing-syntax": "off",
+			"jsdoc/no-multi-asterisks": "warn",
+			"jsdoc/no-restricted-syntax": "off",
+			"jsdoc/no-types": "warn",
+			"jsdoc/no-undefined-types": "off",
+			"jsdoc/require-asterisk-prefix": "warn",
+			"jsdoc/require-description": "off",
+			"jsdoc/require-description-complete-sentence": "warn",
+			"jsdoc/require-example": "off",
+			"jsdoc/require-file-overview": "off",
+			"jsdoc/require-hyphen-before-param-description": "warn",
+			"jsdoc/require-jsdoc": "off",
+			"jsdoc/require-param": "off",
+			"jsdoc/require-param-description": "warn",
+			"jsdoc/require-param-name": "warn",
+			"jsdoc/require-param-type": "off",
+			"jsdoc/require-property": "off",
+			"jsdoc/require-property-description": "off",
+			"jsdoc/require-property-name": "off",
+			"jsdoc/require-property-type": "off",
+			"jsdoc/require-returns": "off",
+			"jsdoc/require-returns-check": "warn",
+			"jsdoc/require-returns-description": "warn",
+			"jsdoc/require-returns-type": "off",
+			"jsdoc/require-template": "off",
+			"jsdoc/require-throws": "warn",
+			"jsdoc/require-yields": "warn",
+			"jsdoc/require-yields-check": "warn",
+			"jsdoc/sort-tags": "warn",
+			"jsdoc/tag-lines": "off",
+			"jsdoc/text-escaping": "off",
+			"jsdoc/valid-types": "off"
 		}
-	];
+	}];
 }
 
 //#endregion
 //#region src/configs/node.ts
-async function node() {
+function node() {
 	return [{
 		languageOptions: { globals: globals.node },
 		name: "will-stone/node",
@@ -518,7 +506,7 @@ async function node() {
 
 //#endregion
 //#region src/configs/package-json.ts
-async function packageJson() {
+function packageJson() {
 	return [{
 		...pluginPackageJson.configs.recommended,
 		name: "will-stone/package.json",
@@ -550,7 +538,7 @@ async function packageJson() {
 
 //#endregion
 //#region src/configs/perfectionist.ts
-async function perfectionist() {
+function perfectionist() {
 	return [{
 		name: "will-stone/perfectionist",
 		plugins: { perfectionist: pluginPerfectionist },
@@ -571,7 +559,7 @@ async function perfectionist() {
 
 //#endregion
 //#region src/configs/react.ts
-async function react(_options) {
+async function react(_configContext) {
 	const [pluginJsxA11y, pluginReact, pluginReactHooks] = await Promise.all([
 		interopDefault(import("eslint-plugin-jsx-a11y")),
 		interopDefault(import("eslint-plugin-react")),
@@ -837,7 +825,7 @@ async function react(_options) {
 
 //#endregion
 //#region src/configs/style.ts
-async function style() {
+function style() {
 	return [{
 		name: "will-stone/style",
 		plugins: { "@stylistic": stylistic },
@@ -859,7 +847,7 @@ async function style() {
 
 //#endregion
 //#region src/configs/tailwind.ts
-async function tailwind(rawOptions) {
+async function tailwind({ options: { tailwind: rawOptions } }) {
 	const options = !rawOptions || rawOptions === true ? {} : rawOptions;
 	const plugin = await interopDefault(import("eslint-plugin-tailwindcss"));
 	return [{
@@ -883,22 +871,10 @@ async function tailwind(rawOptions) {
 	}];
 }
 
-//#endregion
-//#region src/configs/tsdoc.ts
-async function tsdoc() {
-	return [{
-		files: [GLOB_TS, GLOB_TSX],
-		name: "will-stone/tsdoc",
-		plugins: { tsdoc: pluginTsdoc },
-		rules: { "tsdoc/syntax": "error" }
-	}];
-}
-
 //#endregion
 //#region src/configs/typescript.ts
-async function typescript(rawOptions) {
+function typescript({ options: { typescript: rawOptions } }) {
 	const options = !rawOptions || typeof rawOptions === "boolean" ? {} : rawOptions;
-	const [pluginTypescript, parserTypescript$1] = await Promise.all([interopDefault(import("@typescript-eslint/eslint-plugin")), interopDefault(import("@typescript-eslint/parser"))]);
 	return [{
 		files: [
 			GLOB_ASTRO_TS,
@@ -906,7 +882,7 @@ async function typescript(rawOptions) {
 			GLOB_TSX
 		],
 		languageOptions: {
-			parser: parserTypescript$1,
+			parser: parserTypescript,
 			parserOptions: { ...options.tsconfigPath ? {
 				projectService: {
 					allowDefaultProject: ["./*.js"],
@@ -1090,7 +1066,7 @@ async function typescript(rawOptions) {
 
 //#endregion
 //#region src/configs/unicorn.ts
-async function unicorn() {
+function unicorn() {
 	return [{
 		name: "will-stone/unicorn",
 		plugins: { unicorn: pluginUnicorn },
@@ -1235,7 +1211,7 @@ async function unicorn() {
 
 //#endregion
 //#region src/configs/vitest.ts
-async function vitest(_options) {
+async function vitest(_configContext) {
 	const pluginVitest = await interopDefault(import("@vitest/eslint-plugin"));
 	return [{
 		files: GLOB_TESTS,
@@ -1334,8 +1310,8 @@ const defaultConfigs = [
 		name: "package.json"
 	},
 	{
-		config: tsdoc,
-		name: "TSDoc"
+		config: jsdoc,
+		name: "JSDoc"
 	},
 	{
 		config: style,
@@ -1344,27 +1320,19 @@ const defaultConfigs = [
 	{
 		config: perfectionist,
 		name: "Perfectionist"
+	},
+	{
+		config: typescript,
+		name: "Typescript"
 	}
 ];
 const autoConfigs = [
-	{
-		config: typescript,
-		dep: "typescript",
-		name: "Typescript",
-		optionName: "typescript"
-	},
 	{
 		config: astro,
 		dep: "astro",
 		name: "Astro.js",
 		optionName: "astro"
 	},
-	{
-		config: jest,
-		dep: "jest",
-		name: "Jest",
-		optionName: "jest"
-	},
 	{
 		config: react,
 		dep: "react",
@@ -1414,23 +1382,24 @@ function checkDepsExist(depNames) {
 
 //#endregion
 //#region src/index.ts
+const defaultOptions = {};
 /**
 * Construct an array of ESLint flat config items.
 */
-async function config(options) {
+async function config(options = defaultOptions) {
 	const configs = [];
 	const autoConfigDeps = Object.values(autoConfigs).map(({ dep }) => dep);
 	const existingAutoConfigDeps = checkDepsExist(autoConfigDeps);
-	for await (const defaultConfig of defaultConfigs) configs.push(await defaultConfig.config());
 	const enabledAutoConfigs = autoConfigs.filter(({ dep, optionName }) => {
 		return options?.[optionName] || existingAutoConfigDeps[dep] && options?.[optionName] !== false;
 	});
 	if (enabledAutoConfigs.length > 0) console.log("Auto-configured plugins:");
-	for await (const autoConfig of enabledAutoConfigs) {
+	const configContext = { options };
+	for (const defaultConfig of defaultConfigs) configs.push(defaultConfig.config(configContext));
+	await Promise.all(enabledAutoConfigs.map(async (autoConfig) => {
 		console.log(`- ${autoConfig.name}`);
-		const autoConfigOptions = options?.[autoConfig.optionName];
-		configs.push(await autoConfig.config(autoConfigOptions));
-	}
+		configs.push(await autoConfig.config(configContext));
+	}));
 	const merged = configs.flat();
 	return merged;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@will-stone/eslint-config",
-  "version": "19.0.0",
+  "version": "20.0.0",
   "description": "Will Stone's ESLint config",
   "keywords": [
     "eslint-config"
@@ -20,11 +20,9 @@
   ],
   "scripts": {
     "build": "tsdown",
-    "predev": "pnpm build",
-    "dev": "tsdown --watch & config-inspector --config ./eslint-config-for-inspector.js",
-    "lint": "pnpm build && eslint .",
+    "dev": "config-inspector --config ./eslint-config-for-inspector.js",
+    "lint": "eslint .",
     "prepare": "husky",
-    "prepublishOnly": "pnpm build",
     "release": "release-it",
     "test": "vitest",
     "typecheck": "tsc --noEmit"
@@ -35,11 +33,11 @@
     "@typescript-eslint/parser": "^8.33.1",
     "confusing-browser-globals": "^1.0.11",
     "eslint-config-flat-gitignore": "^2.1.0",
+    "eslint-plugin-jsdoc": "^54.1.0",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-n": "^17.19.0",
     "eslint-plugin-package-json": "^0.33.2",
     "eslint-plugin-perfectionist": "^4.14.0",
-    "eslint-plugin-tsdoc": "^0.4.0",
     "eslint-plugin-unicorn": "^59.0.1",
     "globals": "^16.2.0",
     "globby": "^14.1.0",
@@ -57,11 +55,11 @@
     "@will-stone/prettier-config": "^11.0.1",
     "astro-eslint-parser": "^1.2.2",
     "eslint-plugin-astro": "^1.3.1",
-    "eslint-plugin-jest": "^28.12.0",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-tailwindcss": "^3.18.0",
     "husky": "^9.1.7",
+    "jiti": "^2.5.1",
     "lint-staged": "^16.1.0",
     "memfs": "^4.17.2",
     "prettier": "^3.5.3",
@@ -75,7 +73,6 @@
     "astro-eslint-parser": "^1.2.2",
     "eslint": ">=9.23.0",
     "eslint-plugin-astro": "^1.3.1",
-    "eslint-plugin-jest": "^28.11.0",
     "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-hooks": "^5.2.0",
     "eslint-plugin-tailwindcss": "^3.18.0"
@@ -90,9 +87,6 @@
     "eslint-plugin-astro": {
       "optional": true
     },
-    "eslint-plugin-jest": {
-      "optional": true
-    },
     "eslint-plugin-react": {
       "optional": true
     },
@@ -103,7 +97,7 @@
       "optional": true
     }
   },
-  "packageManager": "pnpm@10.11.1",
+  "packageManager": "pnpm@10.14.0",
   "engines": {
     "node": ">=22"
   },