@favorodera/eslint-config 0.0.11 → 0.0.13

package/README.md

@@ -33,7 +33,8 @@ The following configurations are bundled and enabled by default (they can be ind
 - **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`)
+- **Imports** — Auto-sorting and import quality rules (`eslint-plugin-import-lite`)
+- **Unused Imports** — Unused imports and variables detection and cleanup (`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`)
 - **JSDoc** — Standardized comment formatting (`eslint-plugin-jsdoc`)
@@ -80,7 +81,9 @@ bun add -D eslint @favorodera/eslint-config
 
 ### Configure
 
-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:
+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.
+
+The `factory()` function returns a `FlatConfigComposer` instance (powered by [`eslint-flat-config-utils`](https://github.com/antfu/eslint-flat-config-utils)), which acts as a powerful composer. This makes it incredibly easy to append your own configurations, override existing rules, or insert plugins seamlessly.
 
 ```ts
 import { factory } from '@favorodera/eslint-config'
@@ -99,6 +102,19 @@ export default factory({
   // Example: Disable tailwind if you aren't using it
   tailwind: false,
 })
+  // You can seamlessly chain methods to compose your config
+  .append({
+    // Add your own custom ESLint configs
+    ignores: ['src/types/rules.d.ts'],
+  })
+  .overrides({
+    // Easily override predefined rules by their name
+    'favorodera/typescript/rules': {
+      rules: {
+        'ts/no-explicit-any': 'off',
+      },
+    },
+  })
 ```
 
 ## Development

package/dist/index.d.mts

@@ -18125,7 +18125,7 @@ type Yoda = [] | [("always" | "never")] | [("always" | "never"), {
   exceptRange?: boolean;
   onlyEquality?: boolean;
 }]; // Names of all the configs
-type ConfigNames = 'favorodera/ignores' | 'favorodera/imports/setup' | 'favorodera/imports/rules' | 'favorodera/javascript/setup' | 'favorodera/javascript/rules' | 'favorodera/jsdoc/setup' | 'favorodera/jsdoc/rules' | 'favorodera/jsonc/setup' | 'favorodera/jsonc/rules' | 'favorodera/jsonc/sort/package-json' | 'favorodera/jsonc/sort/tsconfig-json' | 'favorodera/jsonc/disables' | 'favorodera/markdown/setup' | 'favorodera/markdown/rules' | 'favorodera/markdown/code-in-md/disables' | 'favorodera/node/setup' | 'favorodera/node/rules' | 'favorodera/node/disables' | 'favorodera/perfectionist/setup' | 'favorodera/perfectionist/rules' | 'favorodera/pnpm/setup' | 'favorodera/pnpm/package-json' | 'favorodera/pnpm/pnpm-workspace-yaml' | 'favorodera/stylistic/setup' | 'favorodera/stylistic/rules' | 'favorodera/tailwind/setup' | 'favorodera/tailwind/rules' | 'favorodera/test/setup' | 'favorodera/test/rules' | 'favorodera/test/disables' | 'favorodera/typescript/setup' | 'favorodera/typescript/rules' | 'favorodera/unicorn/setup' | 'favorodera/unicorn/rules' | 'favorodera/vue/setup' | 'favorodera/vue/rules' | 'favorodera/yaml/setup' | 'favorodera/yaml/rules' | 'favorodera/yaml/sort/pnpm-workspace-yaml';
+type ConfigNames = 'favorodera/ignores' | 'favorodera/imports/setup' | 'favorodera/imports/rules' | 'favorodera/javascript/setup' | 'favorodera/javascript/rules' | 'favorodera/jsdoc/setup' | 'favorodera/jsdoc/rules' | 'favorodera/jsonc/setup' | 'favorodera/jsonc/rules' | 'favorodera/jsonc/sort/package-json' | 'favorodera/jsonc/sort/tsconfig-json' | 'favorodera/jsonc/disables' | 'favorodera/markdown/setup' | 'favorodera/markdown/rules' | 'favorodera/markdown/code-in-md/disables' | 'favorodera/node/setup' | 'favorodera/node/rules' | 'favorodera/node/disables' | 'favorodera/perfectionist/setup' | 'favorodera/perfectionist/rules' | 'favorodera/pnpm/setup' | 'favorodera/pnpm/package-json' | 'favorodera/pnpm/pnpm-workspace-yaml' | 'favorodera/stylistic/setup' | 'favorodera/stylistic/rules' | 'favorodera/tailwind/setup' | 'favorodera/tailwind/rules' | 'favorodera/test/setup' | 'favorodera/test/rules' | 'favorodera/test/disables' | 'favorodera/typescript/setup' | 'favorodera/typescript/rules' | 'favorodera/unicorn/setup' | 'favorodera/unicorn/rules' | 'favorodera/unused-imports/setup' | 'favorodera/unused-imports/rules' | 'favorodera/unused-imports/disables' | 'favorodera/vue/setup' | 'favorodera/vue/rules' | 'favorodera/yaml/setup' | 'favorodera/yaml/rules' | 'favorodera/yaml/sort/pnpm-workspace-yaml';
 //#endregion
 //#region src/types/utils.d.ts
 /** ESLint rules configuration with type-safe autocompletion */
@@ -18241,8 +18241,8 @@ type PerfectionistConfigOptions = SharedOptions & {
     /**
      * Locale(s) used for locale-aware string comparison.
      * A BCP 47 language tag or an array of such tags.
-     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare#locales
      * @default 'en-US'
+     * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare#locales
      */
     locales?: Array<string> | string;
     /**
@@ -18337,6 +18337,10 @@ type TypescriptConfigOptions = SharedOptions;
 /** Options for configuring Unicorn linting rules. */
 type UnicornConfigOptions = SharedOptions;
 //#endregion
+//#region src/configs/unused-imports.d.ts
+/** Options for configuring unused imports linting rules. */
+type UnusedImportsConfigOptions = SharedOptions;
+//#endregion
 //#region src/configs/vue.d.ts
 /** Options for configuring Vue single-file component linting rules. */
 type VueConfigOptions = SharedOptions & {
@@ -18364,7 +18368,7 @@ type YAMLConfigOptions = SharedOptions;
 interface ConfigOptions {
   /** Glob patterns to exclude from linting. */
   ignores?: IgnoresPatterns;
-  /** Imports sorting and unused imports cleanup (via `eslint-plugin-import-lite` and `eslint-plugin-unused-imports`). */
+  /** Imports sorting and quality rules (via `eslint-plugin-import-lite`). */
   imports?: boolean | ImportsConfigOptions;
   /** Core JavaScript language rules (via `@eslint/js`). */
   javascript?: boolean | JavascriptConfigOptions;
@@ -18390,6 +18394,8 @@ interface ConfigOptions {
   typescript?: boolean | TypescriptConfigOptions;
   /** Unicorn rules for various code quality improvements (via `eslint-plugin-unicorn`). */
   unicorn?: boolean | UnicornConfigOptions;
+  /** Unused imports and variables detection and cleanup (via `eslint-plugin-unused-imports`). */
+  unusedImports?: boolean | UnusedImportsConfigOptions;
   /** Vue single-file components linting (via `eslint-plugin-vue`). */
   vue?: boolean | VueConfigOptions;
   /** YAML files linting and sorting (via `eslint-plugin-yml`). */
@@ -18463,4 +18469,4 @@ declare function importModule<TModule>(module: Awaitable<TModule>): Promise<TMod
   default: infer TModuleDefault;
 } ? TModuleDefault : TModule>;
 //#endregion
-export { type ConfigNames, type ConfigOptions, type RuleOptions, type Rules, type SharedOptions, type TypedFlatConfigItem, codeInMdGlob, extractRules, factory, ignoresGlob, importModule, jsGlob, json5Glob, jsonGlob, jsoncGlob, mdGlob, mdInMdGlob, packageJsonGlob, pnpmWorkspaceGlob, scriptsGlob, testGlob, tsConfigGlob, tsGlob, vueGlob, yamlGlob };
+export { type ConfigNames, type ConfigOptions, type TypedFlatConfigItem, codeInMdGlob, extractRules, factory, ignoresGlob, importModule, jsGlob, json5Glob, jsonGlob, jsoncGlob, mdGlob, mdInMdGlob, packageJsonGlob, pnpmWorkspaceGlob, scriptsGlob, testGlob, tsConfigGlob, tsGlob, vueGlob, yamlGlob };

package/dist/index.mjs

@@ -135,20 +135,17 @@ const importsDefaults = { files: [
 ] };
 /**
 * Constructs the flat config items for imports linting, providing plugin setup and
-* specific rules to enforce consistent import ordering and unused variable checks.
+* specific rules to enforce consistent import ordering and quality.
 * @param options Configuration options for imports linting.
 * @returns Promise resolving to imports ESLint config items.
 */
 async function imports(options) {
 	const resolved = defu(options, importsDefaults);
-	const [importPlugin, unusedImportsPlugin] = await Promise.all([importModule(import("eslint-plugin-import-lite")), importModule(import("eslint-plugin-unused-imports"))]);
+	const importPlugin = await importModule(import("eslint-plugin-import-lite"));
 	const baseRules = importPlugin.configs.recommended?.rules || {};
 	return [{
 		name: "favorodera/imports/setup",
-		plugins: {
-			"import": importPlugin,
-			"unused-imports": unusedImportsPlugin
-		}
+		plugins: { import: importPlugin }
 	}, {
 		files: resolved.files,
 		name: "favorodera/imports/rules",
@@ -157,17 +154,9 @@ async function imports(options) {
 			"import/consistent-type-specifier-style": ["error", "prefer-top-level"],
 			"import/first": "error",
 			"import/newline-after-import": ["error", { count: 1 }],
-			"import/no-duplicates": "error",
+			"import/no-duplicates": ["error", { "prefer-inline": true }],
 			"import/no-mutable-exports": "error",
 			"import/no-named-default": "error",
-			"unused-imports/no-unused-imports": "error",
-			"unused-imports/no-unused-vars": ["error", {
-				args: "after-used",
-				argsIgnorePattern: "^_",
-				ignoreRestSiblings: true,
-				vars: "all",
-				varsIgnorePattern: "^_"
-			}],
 			...resolved.overrides
 		}
 	}];
@@ -210,148 +199,68 @@ async function javascript(options) {
 			...baseRules,
 			"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
-			}],
+			"dot-notation": "error",
+			"eqeqeq": "error",
+			"new-cap": "error",
 			"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-await-in-loop": "error",
+			"no-constructor-return": "error",
+			"no-continue": "error",
+			"no-duplicate-imports": ["error", { includeExports: true }],
+			"no-else-return": "error",
+			"no-eq-null": "error",
 			"no-lone-blocks": "error",
-			"no-loss-of-precision": "error",
-			"no-misleading-character-class": "error",
+			"no-loop-func": "error",
 			"no-multi-str": "error",
+			"no-negated-condition": "error",
+			"no-nested-ternary": "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-object-constructor": "error",
 			"no-octal-escape": "error",
+			"no-param-reassign": "error",
+			"no-promise-executor-return": "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-return-assign": "error",
+			"no-script-url": "error",
 			"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
+				functions: false
 			}],
-			"no-useless-backreference": "error",
 			"no-useless-call": "error",
-			"no-useless-catch": "error",
 			"no-useless-computed-key": "error",
+			"no-useless-concat": "error",
 			"no-useless-constructor": "error",
 			"no-useless-rename": "error",
 			"no-useless-return": "error",
-			"no-var": "error",
-			"no-with": "error",
 			"object-shorthand": [
 				"error",
 				"always",
@@ -372,18 +281,12 @@ async function javascript(options) {
 			"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
-			}],
+			"unicode-bom": "error",
 			"valid-typeof": ["error", { requireStringLiterals: true }],
 			"vars-on-top": "error",
-			"yoda": ["error", "never"],
+			"yoda": "error",
 			...resolved.overrides
 		}
 	}];
@@ -416,23 +319,15 @@ async function jsdoc(options) {
 		name: "favorodera/jsdoc/rules",
 		rules: {
 			...baseRules,
-			"jsdoc/check-access": "warn",
-			"jsdoc/check-alignment": "warn",
-			"jsdoc/check-param-names": "warn",
-			"jsdoc/check-property-names": "warn",
-			"jsdoc/check-types": "warn",
-			"jsdoc/empty-tags": "warn",
-			"jsdoc/implements-on-classes": "warn",
-			"jsdoc/multiline-blocks": "warn",
-			"jsdoc/no-defaults": "warn",
-			"jsdoc/no-multi-asterisks": "warn",
-			"jsdoc/require-param-name": "warn",
-			"jsdoc/require-property": "warn",
-			"jsdoc/require-property-description": "warn",
-			"jsdoc/require-property-name": "warn",
-			"jsdoc/require-returns-check": "warn",
-			"jsdoc/require-returns-description": "warn",
-			"jsdoc/require-yields-check": "warn",
+			"jsdoc/check-indentation": "error",
+			"jsdoc/check-template-names": "error",
+			"jsdoc/imports-as-dependencies": "error",
+			"jsdoc/multiline-blocks": "error",
+			"jsdoc/no-bad-blocks": "error",
+			"jsdoc/no-blank-block-descriptions": "error",
+			"jsdoc/no-blank-blocks": "error",
+			"jsdoc/require-throws-type": "off",
+			"jsdoc/sort-tags": "error",
 			...resolved.overrides
 		}
 	}];
@@ -1218,6 +1113,51 @@ async function unicorn(options) {
 	}];
 }
 //#endregion
+//#region src/configs/unused-imports.ts
+const unusedImportsDefaults = { files: [
+	jsGlob,
+	tsGlob,
+	vueGlob
+] };
+/**
+* Constructs the flat config items for unused imports linting, providing plugin setup and
+* specific rules to detect and remove unused imports and variables.
+* @param options Configuration options for unused imports linting.
+* @returns Promise resolving to unused imports ESLint config items.
+*/
+async function unusedImports(options) {
+	const resolved = defu(options, unusedImportsDefaults);
+	return [
+		{
+			name: "favorodera/unused-imports/setup",
+			plugins: { "unused-imports": await importModule(import("eslint-plugin-unused-imports")) }
+		},
+		{
+			files: resolved.files,
+			name: "favorodera/unused-imports/rules",
+			rules: {
+				"unused-imports/no-unused-imports": "error",
+				"unused-imports/no-unused-vars": ["error", {
+					args: "after-used",
+					argsIgnorePattern: "^_",
+					ignoreRestSiblings: true,
+					vars: "all",
+					varsIgnorePattern: "^_"
+				}],
+				...resolved.overrides
+			}
+		},
+		{
+			files: resolved.files,
+			name: "favorodera/unused-imports/disables",
+			rules: {
+				"no-unused-vars": "off",
+				"ts/no-unused-vars": "off"
+			}
+		}
+	];
+}
+//#endregion
 //#region src/configs/vue.ts
 const sfcBlocksDefaults = { blocks: {
 	customBlocks: true,
@@ -1484,6 +1424,7 @@ function factory(options = {}) {
 		test,
 		typescript,
 		unicorn,
+		unusedImports,
 		vue,
 		yaml
 	};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@favorodera/eslint-config",
   "type": "module",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "private": false,
   "description": "Opinionated, type-safe flat ESLint configuration factory for Vue, TypeScript, Tailwind, and more.",
   "author": "Favour Emeka <favorodera@gmail.com>",