@so1ve/eslint-config 3.22.2 → 3.23.0

package/dist/{index.d.ts → index.d.mts}

@@ -400,6 +400,11 @@ interface RuleOptions {
    * @deprecated
    */
   'comma-style'?: Linter.RuleEntry<CommaStyle>;
+  /**
+   * Comment-as-command for one-off codemod with ESLint
+   * @see https://github.com/antfu/eslint-plugin-command
+   */
+  'command/command'?: Linter.RuleEntry<[]>;
   /**
    * Enforce a maximum cyclomatic complexity allowed in a program
    * @see https://eslint.org/docs/latest/rules/complexity
@@ -16288,7 +16293,7 @@ type Yoda = [] | [("always" | "never")] | [("always" | "never"), {
   onlyEquality?: boolean;
 }];
 // Names of all the configs
-type ConfigNames = 'antfu/astro/setup' | 'antfu/astro/rules' | 'so1ve/comments/setup' | 'so1ve/comments/rules' | 'so1ve/formatting/setup' | 'so1ve/formatting/rules' | 'so1ve/formatting/rules/sort-package-json' | 'so1ve/formatting/rules/sort-tsconfig' | 'so1ve/formatting/rules/test' | 'so1ve/html/setup' | 'so1ve/html/rules' | 'so1ve/ignores' | 'so1ve/imports/setup' | 'so1ve/imports/rules' | 'so1ve/imports/rules/dts' | 'so1ve/javascript/setup' | 'so1ve/javascript/rules' | 'so1ve/javascript/regexp' | 'so1ve/javascript/cli' | 'so1ve/jsonc/setup' | 'so1ve/jsonc/rules' | 'so1ve/mdx/setup' | 'so1ve/mdx/rules' | 'so1ve/node/setup' | 'so1ve/node/rules' | 'so1ve/only-error' | 'so1ve/perfectionist/setup' | 'so1ve/perfectionist/rules' | 'so1ve/pnpm/package-json' | 'so1ve/pnpm/pnpm-workspace-yaml' | 'so1ve/promise/setup' | 'so1ve/promise/rules' | 'so1ve/solid/setup' | 'so1ve/solid/rules' | 'so1ve/sort-imports/setup' | 'so1ve/sort-imports/rules' | 'so1ve/test/setup' | 'so1ve/test/rules' | 'so1ve/toml/setup' | 'so1ve/toml/rules' | 'so1ve/typescript/setup' | 'so1ve/typescript/rules' | 'so1ve/typescript/rules/type-aware' | 'so1ve/typescript/rules/dts' | 'so1ve/typescript/rules/js' | 'so1ve/unicorn/setup' | 'so1ve/unicorn/rules' | 'so1ve/vue/setup' | 'so1ve/vue/rules' | 'so1ve/yaml/setup' | 'so1ve/yaml/rules' | 'so1ve/yaml/pnpm-workspace';
+type ConfigNames = 'so1ve/ignores' | 'so1ve/javascript/setup' | 'so1ve/javascript/rules' | 'so1ve/javascript/regexp' | 'so1ve/javascript/cli' | 'so1ve/comments/setup' | 'so1ve/comments/rules' | 'so1ve/node/setup' | 'so1ve/node/rules' | 'so1ve/only-error' | 'so1ve/promise/setup' | 'so1ve/promise/rules' | 'so1ve/sort-imports/setup' | 'so1ve/sort-imports/rules' | 'so1ve/imports/setup' | 'so1ve/imports/rules' | 'so1ve/imports/rules/dts' | 'so1ve/unicorn/setup' | 'so1ve/unicorn/rules' | 'so1ve/command/rules' | 'so1ve/pnpm/package-json' | 'so1ve/pnpm/pnpm-workspace-yaml' | 'so1ve/yaml/pnpm-workspace-yaml-sort' | 'so1ve/html/setup' | 'so1ve/html/rules' | 'so1ve/typescript/setup' | 'so1ve/typescript/rules' | 'so1ve/typescript/rules/type-aware' | 'so1ve/typescript/rules/dts' | 'so1ve/typescript/rules/js' | 'so1ve/test/setup' | 'so1ve/test/rules' | 'antfu/astro/setup' | 'antfu/astro/rules' | 'so1ve/vue/setup' | 'so1ve/vue/rules' | 'so1ve/solid/setup' | 'so1ve/solid/rules' | 'so1ve/formatting/setup' | 'so1ve/formatting/rules' | 'so1ve/formatting/rules/sort-package-json' | 'so1ve/formatting/rules/sort-tsconfig' | 'so1ve/formatting/rules/test' | 'so1ve/perfectionist/setup' | 'so1ve/perfectionist/rules' | 'so1ve/jsonc/setup' | 'so1ve/jsonc/rules' | 'so1ve/toml/setup' | 'so1ve/toml/rules' | 'so1ve/yaml/setup' | 'so1ve/yaml/rules' | 'so1ve/mdx/setup' | 'so1ve/mdx/rules';
 //#endregion
 //#region src/types.d.ts
 type MaybePromise<T> = T | Promise<T>;
@@ -16319,6 +16324,24 @@ interface OptionsTypeScriptParserOptions {
 interface OptionsHasTypeScript {
   typescript?: boolean;
 }
+interface OptionsPnpm {
+  /**
+  * Requires catalogs usage
+  */
+  catalogs?: boolean;
+  /**
+  * Enable linting for package.json
+  *
+  * @default true
+  */
+  json?: boolean;
+  /**
+  * Enable linting for pnpm-workspace.yaml
+  *
+  * @default true
+  */
+  yaml?: boolean;
+}
 interface OptionsOverrides {
   overrides?: TypedFlatConfigItem["rules"];
 }
@@ -16333,11 +16356,20 @@ interface Options extends OptionsComponentExts {
   */
   gitignore?: boolean | FlatGitignoreOptions;
   /**
+  * Extend the global ignores.
+  *
+  * Passing an array to extends the ignores.
+  * Passing a function to modify the default ignores.
+  *
+  * @default []
+  */
+  ignores?: string[] | ((originals: string[]) => string[]);
+  /**
   * Enable pnpm catalogs support.
   *
   * @default false
   */
-  pnpm?: boolean;
+  pnpm?: boolean | OptionsPnpm;
   /**
   * Core rules. Can't be disabled.
   */
@@ -16450,7 +16482,7 @@ declare function formatting(options?: Options): Promise<TypedFlatConfigItem[]>;
 declare function html(): Promise<TypedFlatConfigItem[]>;
 //#endregion
 //#region src/configs/ignores.d.ts
-declare const ignores: () => TypedFlatConfigItem[];
+declare function ignores(userIgnores?: string[] | ((originals: string[]) => string[])): TypedFlatConfigItem[];
 //#endregion
 //#region src/configs/imports.d.ts
 declare const imports: (options?: Options) => TypedFlatConfigItem[];
@@ -16479,7 +16511,7 @@ declare const onlyError: () => TypedFlatConfigItem[];
 declare function perfectionist(): Promise<TypedFlatConfigItem[]>;
 //#endregion
 //#region src/configs/pnpm.d.ts
-declare function pnpm(): Promise<TypedFlatConfigItem[]>;
+declare function pnpm(options: OptionsPnpm): Promise<TypedFlatConfigItem[]>;
 //#endregion
 //#region src/configs/promise.d.ts
 declare const promise: () => TypedFlatConfigItem[];
@@ -16596,4 +16628,4 @@ declare function interopDefault<T>(m: MaybePromise<T>): Promise<T extends {
   default: infer U;
 } ? U : T>;
 //#endregion
-export { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DTS, GLOB_ESLINTRC, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_PACKAGEJSON, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSCONFIG, GLOB_TSX, GLOB_VUE, GLOB_YAML, MaybeArray, MaybePromise, Options, OptionsComponentExts, OptionsHasTypeScript, OptionsOverrides, OptionsTypeScriptParserOptions, ResolvedOptions, Rules, TypedFlatConfigItem, astro, command, comments, defaultPluginRenaming, formatting, getOverrides, html, ignores, imports, interopDefault, javascript, jsonc, mdx, node, onlyError, perfectionist, pnpm, promise, renameRules, so1ve, solid, sortImports, test, toml, typescript$1 as typescript, unicorn, vue, yaml };
+export { GLOB_ALL_SRC, GLOB_ASTRO, GLOB_ASTRO_TS, GLOB_CSS, GLOB_DTS, GLOB_ESLINTRC, GLOB_EXCLUDE, GLOB_HTML, GLOB_JS, GLOB_JSON, GLOB_JSON5, GLOB_JSONC, GLOB_JSX, GLOB_LESS, GLOB_MARKDOWN, GLOB_MARKDOWN_CODE, GLOB_PACKAGEJSON, GLOB_SCSS, GLOB_SRC, GLOB_SRC_EXT, GLOB_STYLE, GLOB_TESTS, GLOB_TOML, GLOB_TS, GLOB_TSCONFIG, GLOB_TSX, GLOB_VUE, GLOB_YAML, MaybeArray, MaybePromise, Options, OptionsComponentExts, OptionsHasTypeScript, OptionsOverrides, OptionsPnpm, OptionsTypeScriptParserOptions, ResolvedOptions, Rules, TypedFlatConfigItem, astro, command, comments, defaultPluginRenaming, formatting, getOverrides, html, ignores, imports, interopDefault, javascript, jsonc, mdx, node, onlyError, perfectionist, pnpm, promise, renameRules, so1ve, solid, sortImports, test, toml, typescript$1 as typescript, unicorn, vue, yaml };

package/dist/{index.js → index.mjs}

@@ -13,8 +13,12 @@ import * as pluginRegexp from "eslint-plugin-regexp";
 import pluginUnicorn from "eslint-plugin-unicorn";
 import pluginUnusedImports from "eslint-plugin-unused-imports";
 import globals from "globals";
+import fs from "node:fs/promises";
+import process$1 from "node:process";
+import { fileURLToPath } from "node:url";
+import fs$1 from "node:fs";
+import path from "node:path";
 import tseslint from "typescript-eslint";
-import fs from "node:fs";
 import { FlatConfigComposer } from "eslint-flat-config-utils";
 import { isPackageExists } from "local-pkg";
 
@@ -414,10 +418,14 @@ async function html() {
 
 //#endregion
 //#region src/configs/ignores.ts
-const ignores = () => [{
-	name: "so1ve/ignores",
-	ignores: GLOB_EXCLUDE
-}];
+function ignores(userIgnores = []) {
+	let ignores$1 = [...GLOB_EXCLUDE];
+	ignores$1 = typeof userIgnores === "function" ? userIgnores(ignores$1) : [...ignores$1, ...userIgnores];
+	return [{
+		name: "so1ve/ignores",
+		ignores: ignores$1
+	}];
+}
 
 //#endregion
 //#region src/configs/imports.ts
@@ -935,31 +943,153 @@ async function perfectionist() {
 	}];
 }
 
+//#endregion
+//#region ../../node_modules/.pnpm/find-up-simple@1.0.1/node_modules/find-up-simple/index.js
+const toPath = (urlOrPath) => urlOrPath instanceof URL ? fileURLToPath(urlOrPath) : urlOrPath;
+async function findUp(name, { cwd = process$1.cwd(), type = "file", stopAt } = {}) {
+	let directory = path.resolve(toPath(cwd) ?? "");
+	const { root } = path.parse(directory);
+	stopAt = path.resolve(directory, toPath(stopAt ?? root));
+	const isAbsoluteName = path.isAbsolute(name);
+	while (directory) {
+		const filePath = isAbsoluteName ? name : path.join(directory, name);
+		try {
+			const stats = await fs.stat(filePath);
+			if (type === "file" && stats.isFile() || type === "directory" && stats.isDirectory()) return filePath;
+		} catch {}
+		if (directory === stopAt || directory === root) break;
+		directory = path.dirname(directory);
+	}
+}
+function findUpSync(name, { cwd = process$1.cwd(), type = "file", stopAt } = {}) {
+	let directory = path.resolve(toPath(cwd) ?? "");
+	const { root } = path.parse(directory);
+	stopAt = path.resolve(directory, toPath(stopAt) ?? root);
+	const isAbsoluteName = path.isAbsolute(name);
+	while (directory) {
+		const filePath = isAbsoluteName ? name : path.join(directory, name);
+		try {
+			const stats = fs$1.statSync(filePath, { throwIfNoEntry: false });
+			if (type === "file" && stats?.isFile() || type === "directory" && stats?.isDirectory()) return filePath;
+		} catch {}
+		if (directory === stopAt || directory === root) break;
+		directory = path.dirname(directory);
+	}
+}
+
 //#endregion
 //#region src/configs/pnpm.ts
-async function pnpm() {
+async function detectCatalogUsage() {
+	const workspaceFile = await findUp("pnpm-workspace.yaml");
+	if (!workspaceFile) return false;
+	const yaml$1 = await fs.readFile(workspaceFile, "utf-8");
+	return yaml$1.includes("catalog:") || yaml$1.includes("catalogs:");
+}
+async function pnpm(options) {
+	const { catalogs = await detectCatalogUsage(), json = true, yaml: yaml$1 = true } = options;
 	const [pluginPnpm, yamlParser, jsoncParser] = await Promise.all([
 		interopDefault(import("eslint-plugin-pnpm")),
-		interopDefault(import("yaml-eslint-parser")),
-		interopDefault(import("jsonc-eslint-parser"))
+		yaml$1 ? interopDefault(import("yaml-eslint-parser")) : void 0,
+		json ? interopDefault(import("jsonc-eslint-parser")) : void 0
 	]);
-	return [{
+	const configs = [];
+	if (json) configs.push({
 		files: ["package.json", "**/package.json"],
 		languageOptions: { parser: jsoncParser },
 		name: "so1ve/pnpm/package-json",
 		plugins: { pnpm: pluginPnpm },
 		rules: {
-			"pnpm/json-enforce-catalog": "error",
+			...catalogs && { "pnpm/json-enforce-catalog": ["error", { ignores: ["@types/vscode"] }] },
 			"pnpm/json-prefer-workspace-settings": "error",
 			"pnpm/json-valid-catalog": "error"
 		}
-	}, {
+	});
+	if (yaml$1) configs.push({
 		files: ["pnpm-workspace.yaml"],
 		languageOptions: { parser: yamlParser },
 		name: "so1ve/pnpm/pnpm-workspace-yaml",
 		plugins: { pnpm: pluginPnpm },
-		rules: { "pnpm/yaml-no-unused-catalog-item": "error" }
-	}];
+		rules: {
+			"pnpm/yaml-enforce-settings": ["error", { settings: { shellEmulator: true } }],
+			"pnpm/yaml-no-unused-catalog-item": "error"
+		}
+	}, {
+		files: ["pnpm-workspace.yaml"],
+		name: "so1ve/yaml/pnpm-workspace-yaml-sort",
+		rules: { "yaml/sort-keys": [
+			"error",
+			{
+				order: [
+					...[
+						"cacheDir",
+						"catalogMode",
+						"cleanupUnusedCatalogs",
+						"dedupeDirectDeps",
+						"deployAllFiles",
+						"enablePrePostScripts",
+						"engineStrict",
+						"extendNodePath",
+						"hoist",
+						"hoistPattern",
+						"hoistWorkspacePackages",
+						"ignoreCompatibilityDb",
+						"ignoreDepScripts",
+						"ignoreScripts",
+						"ignoreWorkspaceRootCheck",
+						"managePackageManagerVersions",
+						"minimumReleaseAge",
+						"minimumReleaseAgeExclude",
+						"modulesDir",
+						"nodeLinker",
+						"nodeVersion",
+						"optimisticRepeatInstall",
+						"packageManagerStrict",
+						"packageManagerStrictVersion",
+						"preferSymlinkedExecutables",
+						"preferWorkspacePackages",
+						"publicHoistPattern",
+						"registrySupportsTimeField",
+						"requiredScripts",
+						"resolutionMode",
+						"savePrefix",
+						"scriptShell",
+						"shamefullyHoist",
+						"shellEmulator",
+						"stateDir",
+						"supportedArchitectures",
+						"symlink",
+						"tag",
+						"trustPolicy",
+						"trustPolicyExclude",
+						"updateNotifier"
+					],
+					"packages",
+					"overrides",
+					"patchedDependencies",
+					...[
+						"allowedDeprecatedVersions",
+						"allowNonAppliedPatches",
+						"configDependencies",
+						"ignoredBuiltDependencies",
+						"ignoredOptionalDependencies",
+						"neverBuiltDependencies",
+						"onlyBuiltDependencies",
+						"onlyBuiltDependenciesFile",
+						"packageExtensions",
+						"peerDependencyRules"
+					],
+					"catalog",
+					"catalogs"
+				],
+				pathPattern: "^$"
+			},
+			{
+				order: { type: "asc" },
+				pathPattern: ".*"
+			}
+		] }
+	});
+	return configs;
 }
 
 //#endregion
@@ -1549,57 +1679,21 @@ async function vue({ overrides, typescript: typescript$1 } = {}) {
 //#region src/configs/yaml.ts
 async function yaml({ overrides } = {}) {
 	const [parserYaml, pluginYaml] = await Promise.all([interopDefault(import("yaml-eslint-parser")), interopDefault(import("eslint-plugin-yml"))]);
-	return [
-		{
-			name: "so1ve/yaml/setup",
-			plugins: { yaml: pluginYaml }
-		},
-		{
-			name: "so1ve/yaml/rules",
-			languageOptions: { parser: parserYaml },
-			files: [GLOB_YAML],
-			rules: {
-				...renameRules(pluginYaml.configs.prettier.rules, { yml: "yaml" }),
-				...renameRules(pluginYaml.configs.recommended.rules, { yml: "yaml" }),
-				"style/spaced-comment": "off",
-				"yaml/no-empty-document": "off",
-				...overrides
-			}
-		},
-		{
-			files: ["pnpm-workspace.yaml"],
-			name: "so1ve/yaml/pnpm-workspace",
-			rules: { "yaml/sort-keys": [
-				"error",
-				{
-					order: [
-						"packages",
-						"overrides",
-						"patchedDependencies",
-						"hoistPattern",
-						"allowedDeprecatedVersions",
-						"allowNonAppliedPatches",
-						"configDependencies",
-						"ignoredBuiltDependencies",
-						"ignoredOptionalDependencies",
-						"neverBuiltDependencies",
-						"onlyBuiltDependencies",
-						"onlyBuiltDependenciesFile",
-						"packageExtensions",
-						"peerDependencyRules",
-						"supportedArchitectures",
-						"catalog",
-						"catalogs"
-					],
-					pathPattern: "^$"
-				},
-				{
-					order: { type: "asc" },
-					pathPattern: ".*"
-				}
-			] }
+	return [{
+		name: "so1ve/yaml/setup",
+		plugins: { yaml: pluginYaml }
+	}, {
+		name: "so1ve/yaml/rules",
+		languageOptions: { parser: parserYaml },
+		files: [GLOB_YAML],
+		rules: {
+			...renameRules(pluginYaml.configs.prettier.rules, { yml: "yaml" }),
+			...renameRules(pluginYaml.configs.recommended.rules, { yml: "yaml" }),
+			"style/spaced-comment": "off",
+			"yaml/no-empty-document": "off",
+			...overrides
 		}
-	];
+	}];
 }
 
 //#endregion
@@ -1632,13 +1726,17 @@ const defaultPluginRenaming = {
 * Construct an array of ESLint flat config items.
 */
 function so1ve(options = {}, ...userConfigs) {
-	const { astro: enableAstro = isPackageExists("astro"), componentExts = [], gitignore: enableGitignore = true, pnpm: enableCatalogs = false, solid: enableSolid = isPackageExists("solid-js"), typescript: enableTypeScript = isPackageExists("typescript"), vue: enableVue = VuePackages.some((i) => isPackageExists(i)) } = options;
+	const { astro: enableAstro = isPackageExists("astro"), componentExts = [], gitignore: enableGitignore = true, ignores: userIgnores = [], pnpm: enablePnpm = !!findUpSync("pnpm-workspace.yaml"), solid: enableSolid = isPackageExists("solid-js"), typescript: enableTypeScript = isPackageExists("typescript"), vue: enableVue = VuePackages.some((i) => isPackageExists(i)) } = options;
 	const configs = [];
 	if (enableGitignore) if (typeof enableGitignore === "boolean") {
-		if (fs.existsSync(".gitignore")) configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r()]));
+		if (fs$1.existsSync(".gitignore")) configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r()]));
 	} else configs.push(interopDefault(import("eslint-config-flat-gitignore")).then((r) => [r(enableGitignore)]));
-	configs.push(ignores(), javascript({ overrides: getOverrides(options, "javascript") }), comments(), node(), onlyError(), promise(), sortImports(), imports(), unicorn(), command());
-	if (enableCatalogs) configs.push(pnpm());
+	configs.push(ignores(userIgnores), javascript({ overrides: getOverrides(options, "javascript") }), comments(), node(), onlyError(), promise(), sortImports(), imports(), unicorn(), command());
+	if (enablePnpm) configs.push(pnpm({
+		json: options.jsonc !== false,
+		yaml: options.yaml !== false,
+		...typeof enablePnpm === "boolean" ? {} : enablePnpm
+	}));
 	if (enableVue) componentExts.push("vue");
 	if (options.html ?? true) configs.push(html());
 	if (enableTypeScript) configs.push(typescript({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@so1ve/eslint-config",
-  "version": "3.22.2",
+  "version": "3.23.0",
   "author": "Ray <i@mk1.io> (https://github.com/so1ve/)",
   "type": "module",
   "description": "Ray's eslint config.",
@@ -18,13 +18,12 @@
   },
   "license": "MIT",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
   },
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
   "files": [
     "dist"
   ],
@@ -77,8 +76,11 @@
     "typescript-eslint": "^8.50.1",
     "vue-eslint-parser": "^10.2.0",
     "yaml-eslint-parser": "^1.3.2",
-    "@so1ve/eslint-plugin": "3.22.2",
-    "@so1ve/eslint-plugin-sort-imports": "3.22.2"
+    "@so1ve/eslint-plugin": "3.23.0",
+    "@so1ve/eslint-plugin-sort-imports": "3.23.0"
+  },
+  "devDependencies": {
+    "find-up-simple": "^1.0.1"
   },
   "peerDependencies": {
     "eslint": "^9.39.2",