@ntnyq/eslint-config 5.5.0 → 5.7.0

package/dist/index.js

@@ -333,7 +333,7 @@ const unCategorizedRules = {
 * @returns ESLint configs
 */
 const configVue = (options = {}) => {
-	const { files = [GLOB_VUE], extraFileExtensions = [] } = options;
+	const { files = [GLOB_VUE], ecmaVersion = "latest", extraFileExtensions = [] } = options;
 	const sfcBlocks = options.sfcBlocks === true ? {} : options.sfcBlocks ?? {};
 	function getVueProcessor() {
 		const processorVueSFC = pluginVue.processors[".vue"];
@@ -359,7 +359,7 @@ const configVue = (options = {}) => {
 		languageOptions: {
 			parser: parserVue,
 			parserOptions: {
-				ecmaVersion: "latest",
+				ecmaVersion,
 				extraFileExtensions,
 				parser: parserTypeScript,
 				sourceType: "module",
@@ -550,8 +550,7 @@ function getOverrides(options, key) {
 //#endregion
 //#region src/utils/combineConfigs.ts
 async function combineConfigs(...configs) {
-	const resolved = await Promise.all(configs);
-	return resolved.flat();
+	return (await Promise.all(configs)).flat();
 }
 
 //#endregion
@@ -577,8 +576,7 @@ async function ensurePackages(packages) {
 	const nonExistingPackages = packages.filter((pkg) => !!pkg && !isPackageInScope(pkg));
 	if (nonExistingPackages.length === 0) return;
 	const { confirm } = await import("@clack/prompts");
-	const confirmInstall = await confirm({ message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?` });
-	if (confirmInstall) try {
+	if (await confirm({ message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?` })) try {
 		const { installPackage } = await import("@antfu/install-pkg");
 		await installPackage(nonExistingPackages, { dev: true });
 	} catch (err) {
@@ -601,12 +599,11 @@ async function interopDefault(mod) {
 //#endregion
 //#region src/utils/mergePrettierOptions.ts
 function mergePrettierOptions(options = {}, overrides = {}) {
-	const result = {
+	return {
 		...options,
 		...overrides,
 		plugins: [...options.plugins || [], ...overrides.plugins || []]
 	};
-	return result;
 }
 
 //#endregion
@@ -1292,6 +1289,10 @@ const configAstro = async (options = {}) => {
 
 //#endregion
 //#region src/configs/jsdoc.ts
+const SPECIAL_CHAR = {
+	emptyString: "",
+	singleSpace: " "
+};
 /**
 * JavaScript specific rules
 */
@@ -1324,6 +1325,8 @@ const configJsdoc = (options = {}) => [{
 	name: "ntnyq/jsdoc",
 	plugins: { jsdoc: pluginJsdoc },
 	rules: {
+		"jsdoc/prefer-import-tag": "off",
+		"jsdoc/require-tags": "off",
 		"jsdoc/tag-lines": "off",
 		"jsdoc/text-escaping": "off",
 		"jsdoc/check-access": "warn",
@@ -1334,7 +1337,17 @@ const configJsdoc = (options = {}) => [{
 		"jsdoc/require-property-name": "warn",
 		"jsdoc/require-returns-check": "warn",
 		"jsdoc/require-returns-description": "warn",
+		"jsdoc/require-template-description": "warn",
 		"jsdoc/require-yields-check": "warn",
+		"jsdoc/require-next-description": "warn",
+		"jsdoc/require-next-type": "warn",
+		"jsdoc/require-throws-description": "warn",
+		"jsdoc/require-throws-type": "warn",
+		"jsdoc/require-yields-description": "warn",
+		"jsdoc/require-yields-type": "warn",
+		"jsdoc/ts-method-signature-style": "warn",
+		"jsdoc/ts-no-empty-object-type": "warn",
+		"jsdoc/ts-no-unnecessary-template-expression": "warn",
 		"jsdoc/check-alignment": "error",
 		"jsdoc/check-line-alignment": "error",
 		"jsdoc/check-param-names": "error",
@@ -1364,8 +1377,25 @@ const configJsdoc = (options = {}) => [{
 		"jsdoc/no-blank-blocks": "error",
 		"jsdoc/no-defaults": "error",
 		"jsdoc/no-multi-asterisks": "error",
+		"jsdoc/reject-any-type": "error",
+		"jsdoc/reject-function-type": "error",
 		"jsdoc/require-asterisk-prefix": "error",
 		"jsdoc/require-hyphen-before-param-description": "error",
+		"jsdoc/type-formatting": ["error", {
+			arrayBrackets: "square",
+			enableFixer: true,
+			genericDot: false,
+			keyValuePostColonSpacing: SPECIAL_CHAR.singleSpace,
+			keyValuePostKeySpacing: SPECIAL_CHAR.emptyString,
+			keyValuePostOptionalSpacing: SPECIAL_CHAR.emptyString,
+			keyValuePostVariadicSpacing: SPECIAL_CHAR.emptyString,
+			objectFieldIndent: SPECIAL_CHAR.emptyString,
+			objectFieldQuote: null,
+			objectFieldSeparator: "comma",
+			stringQuotes: "single",
+			typeBracketSpacing: SPECIAL_CHAR.emptyString,
+			unionSpacing: SPECIAL_CHAR.singleSpace
+		}],
 		...options.typescript ? typescriptRules : javscriptRules,
 		...options.overrides
 	}
@@ -1529,25 +1559,31 @@ const configPinia = (options = {}) => {
 * @returns ESLint configs
 */
 const configDepend = (options = {}) => {
-	const { files = [GLOB_SRC], allowed = [], packageJson: enableCheckPackageJson = true } = options;
+	const { files = [GLOB_SRC], allowed = [], modules = [], packageJson: enableCheckPackageJson = true, presets = [
+		"native",
+		"microutilities",
+		"preferred"
+	] } = options;
+	const rules = {
+		"depend/ban-dependencies": ["error", {
+			allowed,
+			modules,
+			presets
+		}],
+		...options.overrides
+	};
 	const configs = [{
 		name: "ntnyq/depend",
 		files,
 		plugins: { depend: pluginDepend },
-		rules: {
-			"depend/ban-dependencies": ["error", { allowed }],
-			...options.overrides
-		}
+		rules
 	}];
 	if (enableCheckPackageJson) configs.push({
 		name: "ntnyq/depend/package-json",
 		files: [GLOB_PACKAGE_JSON],
 		plugins: { depend: pluginDepend },
 		languageOptions: { parser: parserJsonc },
-		rules: {
-			"depend/ban-dependencies": ["error", { allowed }],
-			...options.overrides
-		}
+		rules
 	});
 	return configs;
 };
@@ -1885,7 +1921,6 @@ const configSvelte = async (options = {}) => {
 			"svelte/no-dupe-else-if-blocks": "error",
 			"svelte/no-dupe-style-properties": "error",
 			"svelte/no-dupe-use-directives": "error",
-			"svelte/no-dynamic-slot-name": "error",
 			"svelte/no-export-load-in-svelte-module-in-kit-pages": "error",
 			"svelte/no-inner-declarations": "error",
 			"svelte/no-not-function-handler": "error",
@@ -2190,7 +2225,7 @@ const configDeMorgan = (options = {}) => [{
 */
 const configMarkdown = (options = {}) => {
 	const { files = [GLOB_MARKDOWN_CODE], extraFileExtensions = [] } = options;
-	const configs = [
+	return [
 		...pluginMarkdown.configs.processor.map((config) => ({
 			...config,
 			name: `ntnyq/${config.name}`
@@ -2243,7 +2278,6 @@ const configMarkdown = (options = {}) => {
 			}
 		}
 	];
-	return configs;
 };
 
 //#endregion
@@ -2454,179 +2488,184 @@ const strictRules = {
 * @param options - {@link ConfigJavaScriptOptions}
 * @returns ESLint configs
 */
-const configJavaScript = (options = {}) => [{
-	...jsConfig.configs.recommended,
-	name: "ntnyq/js/recommended"
-}, {
-	name: "ntnyq/js/core",
-	languageOptions: {
-		sourceType: "module",
-		globals: {
-			...globals.browser,
-			...globals.es2021,
-			...globals.node
-		}
-	},
-	rules: {
-		"consistent-return": "off",
-		"no-return-assign": "off",
-		"no-useless-escape": "off",
-		"require-await": "off",
-		"sort-imports": "off",
-		"accessor-pairs": ["error", {
-			enforceForClassMembers: true,
-			setWithoutGet: true
-		}],
-		"array-callback-return": "error",
-		"block-scoped-var": "error",
-		camelcase: ["error", {
-			allow: ["^UNSAFE_"],
-			ignoreGlobals: true,
-			properties: "never"
-		}],
-		"constructor-super": "error",
-		curly: ["error", "all"],
-		"default-case-last": "error",
-		"dot-notation": ["error", { allowKeywords: true }],
-		eqeqeq: ["error", "smart"],
-		"new-cap": ["error", {
-			capIsNew: false,
-			newIsCap: true,
-			properties: true
-		}],
-		"no-alert": "error",
-		"no-array-constructor": "error",
-		"no-async-promise-executor": "error",
-		"no-caller": "error",
-		"no-case-declarations": "error",
-		"no-class-assign": "error",
-		"no-compare-neg-zero": "error",
-		"no-cond-assign": "error",
-		"no-const-assign": "error",
-		"no-constant-condition": ["error", { checkLoops: false }],
-		"no-control-regex": "error",
-		"no-debugger": "error",
-		"no-delete-var": "error",
-		"no-dupe-args": "error",
-		"no-dupe-class-members": "error",
-		"no-dupe-keys": "error",
-		"no-duplicate-case": "error",
-		"no-empty": ["error", { allowEmptyCatch: true }],
-		"no-empty-character-class": "error",
-		"no-empty-pattern": "error",
-		"no-empty-static-block": "error",
-		"no-eval": "error",
-		"no-ex-assign": "error",
-		"no-extend-native": "error",
-		"no-extra-bind": "error",
-		"no-extra-boolean-cast": "error",
-		"no-fallthrough": "error",
-		"no-func-assign": "error",
-		"no-global-assign": "error",
-		"no-implied-eval": "error",
-		"no-import-assign": "error",
-		"no-invalid-regexp": "error",
-		"no-irregular-whitespace": "error",
-		"no-iterator": "error",
-		"no-labels": ["error", {
-			allowLoop: false,
-			allowSwitch: false
-		}],
-		"no-lone-blocks": "error",
-		"no-loss-of-precision": "error",
-		"no-misleading-character-class": "error",
-		"no-multi-str": "error",
-		"no-negated-condition": "error",
-		"no-new": "error",
-		"no-new-func": "error",
-		"no-new-native-nonconstructor": "error",
-		"no-new-wrappers": "error",
-		"no-obj-calls": "error",
-		"no-octal": "error",
-		"no-octal-escape": "error",
-		"no-proto": "error",
-		"no-prototype-builtins": "error",
-		"no-redeclare": ["error", { builtinGlobals: false }],
-		"no-regex-spaces": "error",
-		"no-self-assign": ["error", { props: true }],
-		"no-self-compare": "error",
-		"no-sequences": "error",
-		"no-shadow-restricted-names": "error",
-		"no-sparse-arrays": "error",
-		"no-template-curly-in-string": "error",
-		"no-this-before-super": "error",
-		"no-throw-literal": "error",
-		"no-undef": "error",
-		"no-undef-init": "error",
-		"no-unexpected-multiline": "error",
-		"no-unmodified-loop-condition": "error",
-		"no-unneeded-ternary": ["error", { defaultAssignment: false }],
-		"no-unreachable": "error",
-		"no-unreachable-loop": "error",
-		"no-unsafe-finally": "error",
-		"no-unsafe-negation": "error",
-		"no-unused-expressions": ["error", {
-			allowShortCircuit: true,
-			allowTaggedTemplates: true,
-			allowTernary: true
-		}],
-		"no-unused-vars": ["error", {
-			args: "none",
-			caughtErrors: "none",
-			ignoreRestSiblings: true,
-			vars: "all"
-		}],
-		"no-use-before-define": ["error", {
-			allowNamedExports: false,
-			classes: false,
-			functions: false,
-			variables: true
-		}],
-		"no-useless-backreference": "error",
-		"no-useless-call": "error",
-		"no-useless-catch": "error",
-		"no-useless-computed-key": "error",
-		"no-useless-constructor": "error",
-		"no-useless-rename": "error",
-		"no-useless-return": "error",
-		"no-var": "error",
-		"no-void": "error",
-		"no-with": "error",
-		"object-shorthand": [
-			"error",
-			"always",
-			{
-				avoidQuotes: true,
-				ignoreConstructors: false
+const configJavaScript = (options = {}) => {
+	const { ecmaVersion = "latest" } = options;
+	return [{
+		...jsConfig.configs.recommended,
+		name: "ntnyq/js/recommended"
+	}, {
+		name: "ntnyq/js/core",
+		languageOptions: {
+			ecmaVersion,
+			sourceType: "module",
+			globals: {
+				...globals.browser,
+				...globals.es2021,
+				...globals.node
 			}
-		],
-		"one-var": ["error", "never"],
-		"prefer-arrow-callback": ["error", {
-			allowNamedFunctions: false,
-			allowUnboundThis: true
-		}],
-		"prefer-const": ["error", {
-			destructuring: "all",
-			ignoreReadBeforeAssign: true
-		}],
-		"prefer-promise-reject-errors": "error",
-		"prefer-regex-literals": ["error", { disallowRedundantWrapping: true }],
-		"prefer-rest-params": "error",
-		"prefer-spread": "error",
-		"prefer-template": "error",
-		"symbol-description": "error",
-		"unicode-bom": ["error", "never"],
-		"use-isnan": ["error", {
-			enforceForIndexOf: true,
-			enforceForSwitchCase: true
-		}],
-		"valid-typeof": ["error", { requireStringLiterals: true }],
-		"vars-on-top": "error",
-		yoda: ["error", "never"],
-		...options.strict ? strictRules : {},
-		...options.overrides
-	}
-}];
+		},
+		rules: {
+			"consistent-return": "off",
+			"no-return-assign": "off",
+			"no-useless-escape": "off",
+			"require-await": "off",
+			"sort-imports": "off",
+			"accessor-pairs": ["error", {
+				enforceForClassMembers: true,
+				setWithoutGet: true
+			}],
+			"array-callback-return": "error",
+			"block-scoped-var": "error",
+			camelcase: ["error", {
+				allow: ["^UNSAFE_"],
+				ignoreGlobals: true,
+				properties: "never"
+			}],
+			"constructor-super": "error",
+			curly: ["error", "all"],
+			"default-case-last": "error",
+			"dot-notation": ["error", { allowKeywords: true }],
+			eqeqeq: ["error", "smart"],
+			"new-cap": ["error", {
+				capIsNew: false,
+				newIsCap: true,
+				properties: true
+			}],
+			"no-alert": "error",
+			"no-array-constructor": "error",
+			"no-async-promise-executor": "error",
+			"no-caller": "error",
+			"no-case-declarations": "error",
+			"no-class-assign": "error",
+			"no-compare-neg-zero": "error",
+			"no-cond-assign": "error",
+			"no-const-assign": "error",
+			"no-constant-condition": ["error", { checkLoops: false }],
+			"no-control-regex": "error",
+			"no-debugger": "error",
+			"no-delete-var": "error",
+			"no-dupe-args": "error",
+			"no-dupe-class-members": "error",
+			"no-dupe-keys": "error",
+			"no-duplicate-case": "error",
+			"no-empty": ["error", { allowEmptyCatch: true }],
+			"no-empty-character-class": "error",
+			"no-empty-pattern": "error",
+			"no-empty-static-block": "error",
+			"no-eval": "error",
+			"no-ex-assign": "error",
+			"no-extend-native": "error",
+			"no-extra-bind": "error",
+			"no-extra-boolean-cast": "error",
+			"no-fallthrough": "error",
+			"no-func-assign": "error",
+			"no-global-assign": "error",
+			"no-implied-eval": "error",
+			"no-import-assign": "error",
+			"no-invalid-regexp": "error",
+			"no-irregular-whitespace": "error",
+			"no-iterator": "error",
+			"no-labels": ["error", {
+				allowLoop: false,
+				allowSwitch: false
+			}],
+			"no-lone-blocks": "error",
+			"no-loss-of-precision": "error",
+			"no-misleading-character-class": "error",
+			"no-multi-str": "error",
+			"no-negated-condition": "error",
+			"no-new": "error",
+			"no-new-func": "error",
+			"no-new-native-nonconstructor": "error",
+			"no-new-wrappers": "error",
+			"no-obj-calls": "error",
+			"no-octal": "error",
+			"no-octal-escape": "error",
+			"no-proto": "error",
+			"no-prototype-builtins": "error",
+			"no-redeclare": ["error", { builtinGlobals: false }],
+			"no-regex-spaces": "error",
+			"no-self-assign": ["error", { props: true }],
+			"no-self-compare": "error",
+			"no-sequences": "error",
+			"no-shadow-restricted-names": "error",
+			"no-sparse-arrays": "error",
+			"no-template-curly-in-string": "error",
+			"no-this-before-super": "error",
+			"no-throw-literal": "error",
+			"no-undef": "error",
+			"no-undef-init": "error",
+			"no-unexpected-multiline": "error",
+			"no-unmodified-loop-condition": "error",
+			"no-unneeded-ternary": ["error", { defaultAssignment: false }],
+			"no-unreachable": "error",
+			"no-unreachable-loop": "error",
+			"no-unsafe-finally": "error",
+			"no-unsafe-negation": "error",
+			"no-unused-expressions": ["error", {
+				allowShortCircuit: true,
+				allowTaggedTemplates: true,
+				allowTernary: true
+			}],
+			"no-unused-vars": ["error", {
+				args: "none",
+				caughtErrors: "none",
+				ignoreRestSiblings: true,
+				vars: "all"
+			}],
+			"no-use-before-define": ["error", {
+				allowNamedExports: false,
+				classes: false,
+				functions: false,
+				variables: true
+			}],
+			"no-useless-backreference": "error",
+			"no-useless-call": "error",
+			"no-useless-catch": "error",
+			"no-useless-computed-key": "error",
+			"no-useless-constructor": "error",
+			"no-useless-rename": "error",
+			"no-useless-return": "error",
+			"no-var": "error",
+			"no-void": "error",
+			"no-with": "error",
+			"object-shorthand": [
+				"error",
+				"always",
+				{
+					avoidQuotes: true,
+					ignoreConstructors: false
+				}
+			],
+			"one-var": ["error", "never"],
+			"prefer-arrow-callback": ["error", {
+				allowNamedFunctions: false,
+				allowUnboundThis: true
+			}],
+			"prefer-const": ["error", {
+				destructuring: "all",
+				ignoreReadBeforeAssign: true
+			}],
+			"prefer-promise-reject-errors": "error",
+			"prefer-regex-literals": ["error", { disallowRedundantWrapping: true }],
+			"prefer-rest-params": "error",
+			"prefer-spread": "error",
+			"prefer-template": "error",
+			"preserve-caught-error": ["error", { requireCatchParameter: true }],
+			"symbol-description": "error",
+			"unicode-bom": ["error", "never"],
+			"use-isnan": ["error", {
+				enforceForIndexOf: true,
+				enforceForSwitchCase: true
+			}],
+			"valid-typeof": ["error", { requireStringLiterals: true }],
+			"vars-on-top": "error",
+			yoda: ["error", "never"],
+			...options.strict ? strictRules : {},
+			...options.overrides
+		}
+	}];
+};
 const configJSX = () => [{
 	name: "ntnyq/jsx",
 	files: [GLOB_JSX_ONLY],
@@ -2691,7 +2730,7 @@ const configTypeScript = (options = {}) => {
 	* @see {@link https://typescript-eslint.io/troubleshooting/typed-linting}
 	*/
 	const enableTypeAwareLint = !!options?.tsconfigPath;
-	const { allowDefaultProject = [], extraFileExtensions = [], filesTypeAware = [GLOB_TS, GLOB_TSX], ignoresTypeAware = [GLOB_ASTRO, `${GLOB_MARKDOWN}/**`], overridesTypeAwareRules = {}, parserOptions = {} } = options;
+	const { allowDefaultProject = [], ecmaVersion = "latest", extraFileExtensions = [], filesTypeAware = [GLOB_TS, GLOB_TSX], ignoresTypeAware = [GLOB_ASTRO, `${GLOB_MARKDOWN}/**`], overridesTypeAwareRules = {}, parserOptions = {} } = options;
 	const files = options.files ?? [
 		GLOB_TS,
 		GLOB_TSX,
@@ -2699,6 +2738,7 @@ const configTypeScript = (options = {}) => {
 	];
 	function createParserConfig(enableTypeAware = false, files$1 = [], ignores = []) {
 		const typescriptParserOptions = {
+			ecmaVersion,
 			extraFileExtensions,
 			sourceType: "module",
 			...enableTypeAware ? {
@@ -2710,7 +2750,7 @@ const configTypeScript = (options = {}) => {
 			} : {},
 			...parserOptions
 		};
-		const parserConfig = {
+		return {
 			name: `ntnyq/ts/${enableTypeAware ? "parser-type-aware" : "parser"}`,
 			files: files$1,
 			ignores: [...ignores],
@@ -2719,7 +2759,6 @@ const configTypeScript = (options = {}) => {
 				parserOptions: typescriptParserOptions
 			}
 		};
-		return parserConfig;
 	}
 	return [
 		{
@@ -3086,12 +3125,13 @@ const configESLintComments = (options = {}) => [{
 function defineESLintConfig(options = {}, ...userConfigs) {
 	const { shareable = {}, vue: enableVue = hasVue(), pinia: enablePinia = hasPinia(), test: enableTest = hasVitest(), unocss: enableUnoCSS = hasUnoCSS(), typescript: enableTypeScript = hasTypeScript(), yml: enableYML = true, sort: enableSort = true, toml: enableTOML = true, jsonc: enableJSONC = true, antfu: enableAntfu = true, ntnyq: enableNtnyq = true, depend: enableDepend = true, regexp: enableRegexp = true, unicorn: enableUnicorn = true, deMorgan: enableDeMorgan = true, prettier: enablePrettier = true, markdown: enableMarkdown = true, gitignore: enableGitIgnore = true, jsdoc: enableJsdoc = true, importX: enableImportX = true, specials: enableSpecials = true, githubAction: enableGitHubAction = true, perfectionist: enablePerfectionist = true, pnpm: enablePnpm = false, svgo: enableSVGO = false, html: enableHTML = false, astro: enableAstro = false, svelte: enableSvelte = false, eslintPlugin: enableESLintPlugin = false } = options;
 	const configs = [];
-	const { extraFileExtensions = [] } = shareable;
+	const { ecmaVersion = "latest", extraFileExtensions = [] } = shareable;
 	if (enableVue) extraFileExtensions.push(".vue");
 	if (enableAstro) extraFileExtensions.push(".astro");
 	if (enableSvelte) extraFileExtensions.push(".svelte");
 	if (enableGitIgnore) configs.push(configGitIgnore(resolveSubOptions(options, "gitignore")));
 	configs.push(configIgnores(options.ignores), configJSX(), configNode({ overrides: getOverrides(options, "node") }), configCommand(resolveSubOptions(options, "command")), configESLintComments({ overrides: getOverrides(options, "eslintComments") }), configJavaScript({
+		ecmaVersion,
 		...resolveSubOptions(options, "javascript"),
 		overrides: getOverrides(options, "javascript")
 	}));
@@ -3120,11 +3160,13 @@ function defineESLintConfig(options = {}, ...userConfigs) {
 		overrides: getOverrides(options, "regexp")
 	}));
 	if (enableTypeScript) configs.push(configTypeScript({
+		ecmaVersion,
 		...resolveSubOptions(options, "typescript"),
 		overrides: getOverrides(options, "typescript"),
 		extraFileExtensions
 	}));
 	if (enableVue) configs.push(configVue({
+		ecmaVersion,
 		...resolveSubOptions(options, "vue"),
 		typescript: !!enableTypeScript,
 		overrides: getOverrides(options, "vue"),
@@ -3186,8 +3228,7 @@ function defineESLintConfig(options = {}, ...userConfigs) {
 		...resolveSubOptions(options, "prettier"),
 		overrides: getOverrides(options, "prettier")
 	}) : [];
-	const composer = new FlatConfigComposer(...configs, ...userConfigs, ...prettierConfigs);
-	return composer;
+	return new FlatConfigComposer(...configs, ...userConfigs, ...prettierConfigs);
 }
 
 //#endregion