@zayne-labs/eslint-config 0.11.4 → 0.11.6

package/dist/index.js

@@ -1,9 +1,13 @@
 import { assert, defineEnum, isFunction, isObject as isObject$1, isObjectAndNotArray } from "@zayne-labs/toolkit-type-helpers";
-import { fileURLToPath } from "node:url";
 import { isPackageExists } from "local-pkg";
+import { fileURLToPath } from "node:url";
 import { globalIgnores } from "eslint/config";
 import globals from "globals";
 import { mergeProcessors, processorPassThrough } from "eslint-merge-processors";
+import process$1 from "node:process";
+import fsp from "node:fs/promises";
+import fs from "node:fs";
+import path from "node:path";
 import { FlatConfigComposer } from "eslint-flat-config-utils";
 
 //#region src/globs.ts
@@ -21,8 +25,8 @@ const GLOB_SCSS = "**/*.scss";
 const GLOB_JSON = "**/*.json";
 const GLOB_JSON5 = "**/*.json5";
 const GLOB_JSONC = "**/*.jsonc";
-const GLOB_MARKDOWN = "**/*.md";
-const GLOB_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
+const GLOB_MARKDOWN = "**/*.md?(x)";
+const GLOB_MARKDOWN_IN_MARKDOWN = `${GLOB_MARKDOWN}/*.md?(x)`;
 const GLOB_SVELTE = "**/*.svelte?(.{js,ts})";
 const GLOB_VUE = "**/*.vue";
 const GLOB_YAML = "**/*.y?(a)ml";
@@ -239,7 +243,9 @@ const ensurePackages = async (packages) => {
 	if (nonExistingPackages.length === 0) return;
 	if (await (await import("@clack/prompts")).confirm({ message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?` })) await (await import("@antfu/install-pkg")).installPackage(nonExistingPackages, { dev: true });
 };
-const resolveOptions = (option) => isObject(option) ? option : {};
+const resolveOptions = (option) => {
+	return isObject(option) ? option : {};
+};
 const parserPlain = {
 	meta: { name: "parser-plain" },
 	parseForESLint: (code) => ({
@@ -375,7 +381,9 @@ const expo = async (options = {}) => {
 //#endregion
 //#region src/configs/ignores.ts
 const ignores = (userIgnores = []) => {
-	return [globalIgnores([...GLOB_EXCLUDE, ...userIgnores], "zayne/defaults/ignores")];
+	const initIgnores = [...GLOB_EXCLUDE];
+	const resolvedUserIgnores = isFunction(userIgnores) ? userIgnores(initIgnores) : userIgnores;
+	return [globalIgnores([...initIgnores, ...resolvedUserIgnores], "zayne/defaults/ignores")];
 };
 const gitIgnores = async (options) => {
 	return [(await interopDefault(import("eslint-config-flat-gitignore")))({
@@ -914,11 +922,6 @@ const markdown = async (options = {}) => {
 			name: "zayne/markdown/recommended",
 			rules: recommendedRules
 		},
-		{
-			files,
-			name: "zayne/markdown/rules",
-			rules: { ...overrides }
-		},
 		{
 			files: [
 				...files,
@@ -952,7 +955,8 @@ const markdown = async (options = {}) => {
 				"ts-eslint/no-use-before-define": "off",
 				"unicode-bom": "off",
 				"unicorn/filename-case": "off",
-				"unicorn/prefer-export-from": "off"
+				"unicorn/prefer-export-from": "off",
+				...overrides
 			}
 		}
 	];
@@ -1080,43 +1084,145 @@ const perfectionist = async (options = {}) => {
 	}];
 };
 
+//#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 fsp.stat(filePath);
+			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
+const detectCatalogUsage = async () => {
+	const workspaceFile = await findUp("pnpm-workspace.yaml");
+	if (!workspaceFile) return false;
+	const yaml$1 = await fsp.readFile(workspaceFile, "utf8");
+	return yaml$1.includes("catalog:") || yaml$1.includes("catalogs:");
+};
 async function pnpm(options = {}) {
-	const { overrides } = options;
+	const { catalogs = detectCatalogUsage(), json = true, overrides, sort = true, yaml: yaml$1 = true } = options;
 	await ensurePackages(["eslint-plugin-pnpm"]);
-	const [eslintPluginPnpm, yamlParser, jsoncParser] = await Promise.all([
+	const [eslintPluginPnpm, yamlParser, eslintPluginYaml, jsoncParser] = await Promise.all([
 		interopDefault(import("eslint-plugin-pnpm")),
 		interopDefault(import("yaml-eslint-parser")),
+		interopDefault(import("eslint-plugin-yml")),
 		interopDefault(import("jsonc-eslint-parser"))
 	]);
-	return [
-		{
-			name: "zayne/pnpm/setup",
-			plugins: { pnpm: eslintPluginPnpm }
-		},
-		{
-			files: ["package.json", "**/package.json"],
-			languageOptions: { parser: jsoncParser },
-			name: "zayne/pnpm/package-json/rules",
-			rules: {
-				"pnpm/json-enforce-catalog": "error",
-				"pnpm/json-prefer-workspace-settings": "error",
-				"pnpm/json-valid-catalog": "error",
-				...overrides?.json
-			}
-		},
-		{
-			files: ["pnpm-workspace.yaml"],
-			languageOptions: { parser: yamlParser },
-			name: "zayne/pnpm/pnpm-workspace-yaml/rules",
-			rules: {
-				"pnpm/yaml-no-duplicate-catalog-item": "error",
-				"pnpm/yaml-no-unused-catalog-item": "error",
-				...overrides?.yaml
-			}
+	const configs = [];
+	if (json) configs.push({
+		files: ["package.json", "**/package.json"],
+		languageOptions: { parser: jsoncParser },
+		name: "zayne/pnpm/package-json/rules",
+		plugins: { pnpm: eslintPluginPnpm },
+		rules: {
+			...catalogs && { "pnpm/json-enforce-catalog": ["error", { ignores: ["@types/vscode"] }] },
+			"pnpm/json-prefer-workspace-settings": "error",
+			"pnpm/json-valid-catalog": "error",
+			...overrides?.json
 		}
-	];
+	});
+	if (yaml$1) configs.push({
+		files: ["pnpm-workspace.yaml"],
+		languageOptions: { parser: yamlParser },
+		name: "zayne/pnpm/pnpm-workspace-yaml/rules",
+		plugins: { pnpm: eslintPluginPnpm },
+		rules: {
+			"pnpm/yaml-enforce-settings": ["error", { settings: {
+				shellEmulator: true,
+				trustPolicy: "no-downgrade"
+			} }],
+			"pnpm/yaml-no-duplicate-catalog-item": "error",
+			"pnpm/yaml-no-unused-catalog-item": "error",
+			...overrides?.yaml
+		}
+	});
+	if (yaml$1 && sort) configs.push({
+		files: ["pnpm-workspace.yaml"],
+		languageOptions: { parser: yamlParser },
+		name: "zayne/pnpm/sort/pnpm-workspace-yaml",
+		plugins: { yaml: eslintPluginYaml },
+		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",
+					"catalog",
+					"catalogs",
+					"allowedDeprecatedVersions",
+					"allowNonAppliedPatches",
+					"configDependencies",
+					"ignoredBuiltDependencies",
+					"ignoredOptionalDependencies",
+					"neverBuiltDependencies",
+					"onlyBuiltDependencies",
+					"onlyBuiltDependenciesFile",
+					"packageExtensions",
+					"peerDependencyRules"
+				],
+				pathPattern: "^$"
+			},
+			{
+				order: { type: "asc" },
+				pathPattern: ".*"
+			}
+		] }
+	});
+	return configs;
 }
 
 //#endregion
@@ -1190,7 +1296,7 @@ const react = async (options = {}) => {
 		enableReact ? interopDefault(import("@eslint-react/eslint-plugin")) : void 0,
 		enableReact ? interopDefault(import("eslint-plugin-react-hooks")) : void 0,
 		refresh ? interopDefault(import("eslint-plugin-react-refresh")) : void 0,
-		youMightNotNeedAnEffect ? interopDefault(import("./src-MgbFTVE-.js")) : void 0,
+		youMightNotNeedAnEffect ? interopDefault(import("./src-BncWNtPe.js")) : void 0,
 		nextjs ? interopDefault(import("@next/eslint-plugin-next")) : void 0
 	]);
 	const strictConfigKey = typescript$1 ? "strict-type-checked" : "strict";
@@ -1868,6 +1974,7 @@ const unicorn = async (options = {}) => {
 			"unicorn/no-useless-undefined": ["error", { checkArguments: true }],
 			"unicorn/numeric-separators-style": "off",
 			"unicorn/prefer-global-this": type === "lib" || type === "lib-strict" ? "warn" : "off",
+			"unicorn/prefer-native-coercion-functions": "off",
 			"unicorn/prevent-abbreviations": "off",
 			...overrides
 		}
@@ -2063,11 +2170,11 @@ const vue = async (options = {}) => {
 //#region src/configs/yaml.ts
 const yaml = async (options = {}) => {
 	const { files = [GLOB_YAML], overrides, stylistic: stylistic$1 = true } = options;
-	const [pluginYaml, parserYaml] = await Promise.all([interopDefault(import("eslint-plugin-yml")), interopDefault(import("yaml-eslint-parser"))]);
+	const [eslintPluginYaml, parserYaml] = await Promise.all([interopDefault(import("eslint-plugin-yml")), interopDefault(import("yaml-eslint-parser"))]);
 	return [
 		{
 			name: "zayne/yaml/setup",
-			plugins: { yaml: pluginYaml }
+			plugins: { yaml: eslintPluginYaml }
 		},
 		{
 			files,
@@ -2120,7 +2227,7 @@ const ReactPackages = ["react", "react-dom"];
 *  The merged ESLint configurations.
 */
 const zayne = (options = {}, ...userConfigs) => {
-	const { autoRenamePlugins = true, componentExts = [], componentExtsTypeAware = [], type = "app", withDefaults = true,...restOfOptions } = options;
+	const { autoRenamePlugins = true, componentExts = [], componentExtsTypeAware = [], ignores: userIgnores, type = "app", withDefaults = true, ...restOfOptions } = options;
 	const enableGitignore = restOfOptions.gitignore ?? true;
 	const enableJsx = restOfOptions.jsx ?? true;
 	const enableComments = restOfOptions.comments ?? withDefaults;
@@ -2140,8 +2247,7 @@ const zayne = (options = {}, ...userConfigs) => {
 	const isStylistic = Boolean(enableStylistic);
 	const tsconfigPath = isObject(enableTypeScript) && "tsconfigPath" in enableTypeScript ? enableTypeScript.tsconfigPath : enableTypeScript === true ? enableTypeScript : null;
 	const isTypeAware = Boolean(tsconfigPath);
-	const configs = [];
-	configs.push(ignores(restOfOptions.ignores), javascript(restOfOptions.javascript));
+	const configs = [ignores(userIgnores), javascript(restOfOptions.javascript)];
 	if (enableGitignore) configs.push(gitIgnores(resolveOptions(enableGitignore)));
 	if (enableJsx) configs.push(jsx(resolveOptions(enableJsx)));
 	if (restOfOptions.vue) {