@favorodera/eslint-config 0.0.5 → 0.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Favour  Emeka
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -32,6 +32,7 @@ The following configurations are bundled and enabled by default (they can be ind
 - **Vue** — Single-file component support (`eslint-plugin-vue`, `vue-eslint-parser`)
 - **Stylistic** — Formatting rules (`@stylistic/eslint-plugin`)
 - **Tailwind CSS** — Utility class linting and sorting (`eslint-plugin-better-tailwindcss`)
+- **Test** — Test and Vitest specific linting (`@vitest/eslint-plugin`)
 - **Imports** — Auto-sorting and unused imports removal (`eslint-plugin-import-lite`, `eslint-plugin-unused-imports`)
 - **Markdown** — Linting for markdown files and embedded code blocks (`@eslint/markdown`)
 - **JSON/JSONC/JSON5** — Formatting and sorting for JSON files like `package.json` (`eslint-plugin-jsonc`)
@@ -79,9 +80,9 @@ bun add -D eslint @favorodera/eslint-config
 
 ### Configure
 
-Create an `eslint.config.mjs` (or `eslint.config.ts`) file in the root of your project. Since all configurations are enabled by default, you only need to pass options if you want to disable or customize something:
+Create an `eslint.config.ts` file in the root of your project. Since all configurations are enabled by default, you only need to pass options if you want to disable or customize something:
 
-```javascript
+```ts
 import { factory } from '@favorodera/eslint-config'
 
 export default factory({

package/dist/index.cjs

@@ -41,6 +41,8 @@ const mdGlob = "**/*.md";
 const mdInMdGlob = "**/*.md/*.md";
 /** Glob pattern for matching code blocks embedded in Markdown files */
 const codeInMdGlob = "**/*.md/**/*.{js,cjs,mjs,ts,cts,mts,vue}";
+/** Glob pattern for matching test files */
+const testsGlob = ["**/*.{tests,specs,benchmark,bench}.{js,cjs,mjs,ts,cts,mts}", "**/__tests__/**/*.{js,cjs,mjs,ts,cts,mts}"];
 /** Glob pattern for matching JSON files */
 const jsonGlob = "**/*.json";
 /** Glob pattern for matching JSON5 files */
@@ -49,6 +51,10 @@ const json5Glob = "**/*.json5";
 const jsoncGlob = "**/*.jsonc";
 /** Glob patterns for matching TypeScript configuration files */
 const tsConfigGlob = ["**/tsconfig.json", "**/tsconfig.*.json"];
+/** Glob pattern for matching YAML files */
+const yamlGlob = "**/*.{yml,yaml}";
+/** Glob pattern for matching pnpm-workspace.yaml file */
+const pnpmWorkspaceGlob = "pnpm-workspace.yaml";
 /** Glob pattern for matching package.json files */
 const packageJsonGlob = "**/package.json";
 //#endregion
@@ -220,12 +226,182 @@ async function javascript(options) {
 		name: "favorodera/javascript/rules",
 		rules: {
 			...baseRules,
-			"accessor-pairs": ["error", {
-				enforceForClassMembers: true,
-				setWithoutGet: true
-			}],
 			"array-callback-return": "error",
 			"block-scoped-var": "error",
+			"constructor-super": "error",
+			"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", "always"],
+			"no-console": ["error", { allow: ["warn", "error"] }],
+			"no-const-assign": "error",
+			"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-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-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-restricted-globals": [
+				"error",
+				{
+					message: "Use `globalThis` instead.",
+					name: "global"
+				},
+				{
+					message: "Use `globalThis` instead.",
+					name: "self"
+				}
+			],
+			"no-restricted-properties": [
+				"error",
+				{
+					message: "Use `Object.getPrototypeOf` or `Object.setPrototypeOf` instead.",
+					property: "__proto__"
+				},
+				{
+					message: "Use `Object.defineProperty` instead.",
+					property: "__defineGetter__"
+				},
+				{
+					message: "Use `Object.defineProperty` instead.",
+					property: "__defineSetter__"
+				},
+				{
+					message: "Use `Object.getOwnPropertyDescriptor` instead.",
+					property: "__lookupGetter__"
+				},
+				{
+					message: "Use `Object.getOwnPropertyDescriptor` instead.",
+					property: "__lookupSetter__"
+				}
+			],
+			"no-restricted-syntax": [
+				"error",
+				"TSEnumDeclaration[const=true]",
+				"TSExportAssignment"
+			],
+			"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", {
+				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-with": "error",
+			"object-shorthand": [
+				"error",
+				"always",
+				{
+					avoidQuotes: true,
+					ignoreConstructors: false
+				}
+			],
+			"one-var": ["error", { initialized: "never" }],
+			"prefer-arrow-callback": ["error", {
+				allowNamedFunctions: false,
+				allowUnboundThis: true
+			}],
+			"prefer-const": ["error", {
+				destructuring: "all",
+				ignoreReadBeforeAssign: true
+			}],
+			"prefer-exponentiation-operator": "error",
+			"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"],
 			...resolved.overrides
 		}
 	}];
@@ -255,7 +431,7 @@ async function jsdoc(options) {
 		plugins: { jsdoc: jsdocPlugin }
 	}, {
 		files: resolved.files,
-		name: "favorodera/tailwind/rules",
+		name: "favorodera/jsdoc/rules",
 		rules: {
 			...baseRules,
 			"jsdoc/check-access": "warn",
@@ -605,7 +781,7 @@ async function markdown(options) {
 		{
 			files: [codeInMdGlob],
 			languageOptions: { parserOptions: { ecmaFeatures: { impliedStrict: true } } },
-			name: "favorodera/markdown/disables/code",
+			name: "favorodera/markdown/code-in-md/disables",
 			rules: {
 				"no-alert": "off",
 				"no-console": "off",
@@ -742,6 +918,47 @@ async function perfectionist(options) {
 	}];
 }
 //#endregion
+//#region src/configs/pnpm.ts
+/**
+* Constructs the flat config items for pnpm linting.
+* @returns Promise resolving to pnpm ESLint config items.
+*/
+async function pnpm() {
+	const [pnpmPlugin, yamlParser] = await Promise.all([importModule(import("eslint-plugin-pnpm")), importModule(import("yaml-eslint-parser"))]);
+	return [
+		{
+			name: "favorodera/pnpm/setup",
+			plugins: { pnpm: pnpmPlugin }
+		},
+		{
+			files: [packageJsonGlob],
+			language: "jsonc/x",
+			name: "favorodera/pnpm/package-json",
+			rules: {
+				"pnpm/json-enforce-catalog": ["error", {
+					autofix: true,
+					ignores: ["@types/vscode"]
+				}],
+				"pnpm/json-prefer-workspace-settings": ["error", { autofix: true }],
+				"pnpm/json-valid-catalog": ["error", { autofix: true }]
+			}
+		},
+		{
+			files: [pnpmWorkspaceGlob],
+			languageOptions: { parser: yamlParser },
+			name: "favorodera/pnpm/pnpm-workspace-yaml",
+			rules: {
+				"pnpm/yaml-enforce-settings": ["error", { settings: {
+					shellEmulator: true,
+					trustPolicy: "no-downgrade"
+				} }],
+				"pnpm/yaml-no-duplicate-catalog-item": ["error", { checkDuplicates: "exact-version" }],
+				"pnpm/yaml-no-unused-catalog-item": "error"
+			}
+		}
+	];
+}
+//#endregion
 //#region src/configs/stylistic.ts
 const stylisticDefaults = {
 	files: [
@@ -836,12 +1053,55 @@ async function tailwind(options) {
 		rules: {
 			...(0, eslint_flat_config_utils.renamePluginsInRules)(baseRules, { "better-tailwindcss": "tailwind" }),
 			"tailwind/enforce-consistent-line-wrapping": ["error", { group: "emptyLine" }],
-			"tailwind/no-unregistered-classes": "off",
 			...resolved.overrides
 		}
 	}];
 }
 //#endregion
+//#region src/configs/test.ts
+const testDefaults = { files: testsGlob };
+/**
+* Constructs the flat config items for test linting, extending
+* the recommended Vitest rule sets.
+* @param options Test configuration options.
+* @returns Promise resolving to test ESLint config items.
+*/
+async function test(options) {
+	const resolved = (0, defu.defu)(options, testDefaults);
+	const testPlugin = await importModule(import("@vitest/eslint-plugin"));
+	const baseRules = extractRules(testPlugin.configs.recommended);
+	return [
+		{
+			name: "favorodera/test/setup",
+			plugins: { test: testPlugin }
+		},
+		{
+			files: resolved.files,
+			name: "favorodera/test/rules",
+			rules: {
+				...(0, eslint_flat_config_utils.renamePluginsInRules)(baseRules, { vitest: "test" }),
+				"test/consistent-test-it": ["error", {
+					fn: "it",
+					withinDescribe: "it"
+				}],
+				"test/no-identical-title": "error",
+				"test/no-import-node-test": "error",
+				"test/prefer-hooks-in-order": "error",
+				"test/prefer-lowercase-title": "error",
+				...resolved.overrides
+			}
+		},
+		{
+			files: resolved.files,
+			name: "favorodera/test/disables",
+			rules: {
+				"no-unused-expressions": "off",
+				"node/prefer-global/process": "off"
+			}
+		}
+	];
+}
+//#endregion
 //#region src/configs/typescript.ts
 const typescriptDefaults = { files: [tsGlob] };
 /**
@@ -892,7 +1152,7 @@ const unicornDefaults = { files: [
 async function unicorn(options) {
 	const resolved = (0, defu.defu)(options, unicornDefaults);
 	const unicornPlugin = await importModule(import("eslint-plugin-unicorn"));
-	const baseRules = unicornPlugin.configs["unopinionated"]?.rules || {};
+	const baseRules = unicornPlugin.configs.unopinionated?.rules || {};
 	return [{
 		name: "favorodera/unicorn/setup",
 		plugins: { unicorn: unicornPlugin }
@@ -1002,6 +1262,130 @@ async function vue(options) {
 	}];
 }
 //#endregion
+//#region src/configs/yaml.ts
+const yamlDefaults = { files: [yamlGlob] };
+/**
+* Constructs the flat config items for YAML linting, setting up
+* the custom parser and rule validations.
+* @param options YAML configuration options.
+* @returns Promise resolving to YAML ESLint config items.
+*/
+async function yaml(options) {
+	const resolved = (0, defu.defu)(options, yamlDefaults);
+	const [yamlPlugin, yamlParser] = await Promise.all([importModule(import("eslint-plugin-yml")), importModule(import("yaml-eslint-parser"))]);
+	const baseRules = extractRules(yamlPlugin.configs.recommended);
+	return [
+		{
+			name: "favorodera/yaml/setup",
+			plugins: { yaml: yamlPlugin }
+		},
+		{
+			files: resolved.files,
+			languageOptions: { parser: yamlParser },
+			name: "favorodera/yaml/rules",
+			rules: {
+				...(0, eslint_flat_config_utils.renamePluginsInRules)(baseRules, { yml: "yaml" }),
+				"style/spaced-comment": "off",
+				"yaml/block-mapping": "error",
+				"yaml/block-mapping-question-indicator-newline": "error",
+				"yaml/block-sequence": "error",
+				"yaml/block-sequence-hyphen-indicator-newline": "error",
+				"yaml/flow-mapping-curly-newline": "error",
+				"yaml/flow-mapping-curly-spacing": "error",
+				"yaml/flow-sequence-bracket-newline": "error",
+				"yaml/flow-sequence-bracket-spacing": "error",
+				"yaml/indent": ["error", 2],
+				"yaml/key-spacing": "error",
+				"yaml/no-empty-key": "error",
+				"yaml/no-empty-sequence-entry": "error",
+				"yaml/no-irregular-whitespace": "error",
+				"yaml/no-tab-indent": "error",
+				"yaml/plain-scalar": "error",
+				"yaml/quotes": ["error", {
+					avoidEscape: true,
+					prefer: "single"
+				}],
+				"yaml/spaced-comment": "error",
+				"yaml/vue-custom-block/no-parsing-error": "error",
+				...resolved.overrides
+			}
+		},
+		{
+			files: [pnpmWorkspaceGlob],
+			languageOptions: { parser: yamlParser },
+			name: "favorodera/yaml/sort/pnpm-workspace-yaml",
+			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: ".*"
+				}
+			] }
+		}
+	];
+}
+//#endregion
 //#region src/factory.ts
 /**
 * Factory to create a flat ESLint config.
@@ -1019,11 +1403,14 @@ function factory(options = {}) {
 		markdown,
 		node,
 		perfectionist,
+		pnpm,
 		stylistic,
 		tailwind,
+		test,
 		typescript,
 		unicorn,
-		vue
+		vue,
+		yaml
 	};
 	for (const [key, configFunction] of Object.entries(configFunctions)) {
 		const configOption = options[key];
@@ -1036,10 +1423,13 @@ function factory(options = {}) {
 		"better-tailwindcss": "tailwind",
 		"import-lite": "import",
 		"markdown": "md",
-		"n": "node"
+		"n": "node",
+		"vitest": "test",
+		"yml": "yaml"
 	});
 	return composer;
 }
 //#endregion
+exports.extractRules = extractRules;
 exports.factory = factory;
 exports.importModule = importModule;