@abinnovision/eslint-config-base 3.4.1 → 3.4.2

package/dist/configs/flavour-nestjs.cjs

@@ -1,4 +1,3 @@
-require("../_virtual/_rolldown/runtime.cjs");
 //#region src/configs/flavour-nestjs.ts
 /**
 * ESLint configuration tailored for NestJS projects.
@@ -10,9 +9,33 @@ require("../_virtual/_rolldown/runtime.cjs");
 const config = (0, require("eslint/config").defineConfig)([{
 	files: ["**/*.{ts,js}"],
 	rules: {
+		/**
+		* Enforce a maximum number of parameters in function definitions.
+		* Increased to 8 for NestJS dependency injection patterns.
+		*
+		* @see https://eslint.org/docs/latest/rules/max-params
+		*/
 		"max-params": ["error", 8],
+		/**
+		* Disallow useless constructors.
+		* Disabled for NestJS as DI decorators make constructors appear "useless".
+		*
+		* @see https://typescript-eslint.io/rules/no-useless-constructor
+		*/
 		"@typescript-eslint/no-useless-constructor": "off",
+		/**
+		* Disallow empty functions.
+		* Allow empty constructors for NestJS DI parameter properties.
+		*
+		* @see https://typescript-eslint.io/rules/no-empty-function
+		*/
 		"@typescript-eslint/no-empty-function": ["error", { allow: ["constructors"] }],
+		/**
+		* Require or disallow parameter properties in class constructors.
+		* Enforces NestJS DI pattern using parameter properties.
+		*
+		* @see https://typescript-eslint.io/rules/parameter-properties
+		*/
 		"@typescript-eslint/parameter-properties": ["error", {
 			allow: [
 				"private readonly",

package/dist/configs/flavour-nestjs.d.cts

@@ -1,5 +1,3 @@
-import * as eslint_config0 from "eslint/config";
-
 //#region src/configs/flavour-nestjs.d.ts
 /**
  * ESLint configuration tailored for NestJS projects.
@@ -8,6 +6,6 @@ import * as eslint_config0 from "eslint/config";
  * NOTE: This configuration is meant to be used in conjunction with
  * the base TypeScript ESLint configuration.
  */
-declare const config: eslint_config0.Config[];
+declare const config: import("eslint/config").Config[];
 //#endregion
 export { config };

package/dist/configs/flavour-nestjs.d.mts

@@ -1,5 +1,3 @@
-import * as eslint_config0 from "eslint/config";
-
 //#region src/configs/flavour-nestjs.d.ts
 /**
  * ESLint configuration tailored for NestJS projects.
@@ -8,6 +6,6 @@ import * as eslint_config0 from "eslint/config";
  * NOTE: This configuration is meant to be used in conjunction with
  * the base TypeScript ESLint configuration.
  */
-declare const config: eslint_config0.Config[];
+declare const config: import("eslint/config").Config[];
 //#endregion
 export { config };

package/dist/configs/flavour-nestjs.mjs

@@ -10,9 +10,33 @@ import { defineConfig } from "eslint/config";
 const config = defineConfig([{
 	files: ["**/*.{ts,js}"],
 	rules: {
+		/**
+		* Enforce a maximum number of parameters in function definitions.
+		* Increased to 8 for NestJS dependency injection patterns.
+		*
+		* @see https://eslint.org/docs/latest/rules/max-params
+		*/
 		"max-params": ["error", 8],
+		/**
+		* Disallow useless constructors.
+		* Disabled for NestJS as DI decorators make constructors appear "useless".
+		*
+		* @see https://typescript-eslint.io/rules/no-useless-constructor
+		*/
 		"@typescript-eslint/no-useless-constructor": "off",
+		/**
+		* Disallow empty functions.
+		* Allow empty constructors for NestJS DI parameter properties.
+		*
+		* @see https://typescript-eslint.io/rules/no-empty-function
+		*/
 		"@typescript-eslint/no-empty-function": ["error", { allow: ["constructors"] }],
+		/**
+		* Require or disallow parameter properties in class constructors.
+		* Enforces NestJS DI pattern using parameter properties.
+		*
+		* @see https://typescript-eslint.io/rules/parameter-properties
+		*/
 		"@typescript-eslint/parameter-properties": ["error", {
 			allow: [
 				"private readonly",

package/dist/configs/flavour-stylistic.cjs

@@ -1,7 +1,7 @@
 const require_runtime = require("../_virtual/_rolldown/runtime.cjs");
 let eslint_config = require("eslint/config");
 let _stylistic_eslint_plugin = require("@stylistic/eslint-plugin");
-_stylistic_eslint_plugin = require_runtime.__toESM(_stylistic_eslint_plugin);
+_stylistic_eslint_plugin = require_runtime.__toESM(_stylistic_eslint_plugin, 1);
 //#region src/configs/flavour-stylistic.ts
 /**
 * ESLint configuration for optional stylistic rules.
@@ -15,9 +15,33 @@ const config = (0, eslint_config.defineConfig)([{
 	files: ["**/*.{ts,tsx,js,jsx}"],
 	plugins: { "@stylistic": _stylistic_eslint_plugin.default },
 	rules: {
+		/**
+		* Enforce block comments to use starred-block style (multiline).
+		* Prevents inline block comments like: /** foo *​/
+		*
+		* @see https://eslint.style/rules/default/multiline-comment-style
+		*/
 		"@stylistic/multiline-comment-style": ["error", "starred-block"],
+		/**
+		* Enforce consistent spacing after // or /* delimiters.
+		*
+		* @see https://eslint.style/rules/default/spaced-comment
+		*/
 		"@stylistic/spaced-comment": ["error", "always"],
+		/**
+		* Enforce line comments to be placed above the code line.
+		*
+		* @see https://eslint.style/rules/default/line-comment-position
+		*/
 		"@stylistic/line-comment-position": ["error", "above"],
+		/**
+		* Require blank lines between specific statement types.
+		* - After block-like statements (if, for, while, try, switch).
+		* - Before return statements.
+		* - After directives ("use strict", etc.).
+		*
+		* @see https://eslint.style/rules/default/padding-line-between-statements
+		*/
 		"@stylistic/padding-line-between-statements": [
 			"error",
 			{
@@ -36,7 +60,20 @@ const config = (0, eslint_config.defineConfig)([{
 				next: "*"
 			}
 		],
+		/**
+		* Disallow padding inside blocks.
+		* No empty lines right after { or before }.
+		*
+		* @see https://eslint.style/rules/default/padded-blocks
+		*/
 		"@stylistic/padded-blocks": ["error", "never"],
+		/**
+		* Require blank lines between class members.
+		* Except after single-line members and TypeScript overloads
+		* to keep compact field declarations readable.
+		*
+		* @see https://eslint.style/rules/default/lines-between-class-members
+		*/
 		"@stylistic/lines-between-class-members": [
 			"error",
 			"always",
@@ -45,6 +82,13 @@ const config = (0, eslint_config.defineConfig)([{
 				exceptAfterOverload: true
 			}
 		],
+		/**
+		* Limit consecutive empty lines.
+		* Prettier already collapses multiple blank lines within code,
+		* but this additionally prevents blank lines at the start of files.
+		*
+		* @see https://eslint.style/rules/default/no-multiple-empty-lines
+		*/
 		"@stylistic/no-multiple-empty-lines": ["error", {
 			max: 1,
 			maxBOF: 0,

package/dist/configs/flavour-stylistic.d.cts

@@ -1,5 +1,3 @@
-import * as eslint_config0 from "eslint/config";
-
 //#region src/configs/flavour-stylistic.d.ts
 /**
  * ESLint configuration for optional stylistic rules.
@@ -9,6 +7,6 @@ import * as eslint_config0 from "eslint/config";
  * NOTE: This configuration is meant to be used in conjunction with
  * the base TypeScript ESLint configuration.
  */
-declare const config: eslint_config0.Config[];
+declare const config: import("eslint/config").Config[];
 //#endregion
 export { config };

package/dist/configs/flavour-stylistic.d.mts

@@ -1,5 +1,3 @@
-import * as eslint_config0 from "eslint/config";
-
 //#region src/configs/flavour-stylistic.d.ts
 /**
  * ESLint configuration for optional stylistic rules.
@@ -9,6 +7,6 @@ import * as eslint_config0 from "eslint/config";
  * NOTE: This configuration is meant to be used in conjunction with
  * the base TypeScript ESLint configuration.
  */
-declare const config: eslint_config0.Config[];
+declare const config: import("eslint/config").Config[];
 //#endregion
 export { config };

package/dist/configs/flavour-stylistic.mjs

@@ -13,9 +13,33 @@ const config = defineConfig([{
 	files: ["**/*.{ts,tsx,js,jsx}"],
 	plugins: { "@stylistic": stylistic },
 	rules: {
+		/**
+		* Enforce block comments to use starred-block style (multiline).
+		* Prevents inline block comments like: /** foo *​/
+		*
+		* @see https://eslint.style/rules/default/multiline-comment-style
+		*/
 		"@stylistic/multiline-comment-style": ["error", "starred-block"],
+		/**
+		* Enforce consistent spacing after // or /* delimiters.
+		*
+		* @see https://eslint.style/rules/default/spaced-comment
+		*/
 		"@stylistic/spaced-comment": ["error", "always"],
+		/**
+		* Enforce line comments to be placed above the code line.
+		*
+		* @see https://eslint.style/rules/default/line-comment-position
+		*/
 		"@stylistic/line-comment-position": ["error", "above"],
+		/**
+		* Require blank lines between specific statement types.
+		* - After block-like statements (if, for, while, try, switch).
+		* - Before return statements.
+		* - After directives ("use strict", etc.).
+		*
+		* @see https://eslint.style/rules/default/padding-line-between-statements
+		*/
 		"@stylistic/padding-line-between-statements": [
 			"error",
 			{
@@ -34,7 +58,20 @@ const config = defineConfig([{
 				next: "*"
 			}
 		],
+		/**
+		* Disallow padding inside blocks.
+		* No empty lines right after { or before }.
+		*
+		* @see https://eslint.style/rules/default/padded-blocks
+		*/
 		"@stylistic/padded-blocks": ["error", "never"],
+		/**
+		* Require blank lines between class members.
+		* Except after single-line members and TypeScript overloads
+		* to keep compact field declarations readable.
+		*
+		* @see https://eslint.style/rules/default/lines-between-class-members
+		*/
 		"@stylistic/lines-between-class-members": [
 			"error",
 			"always",
@@ -43,6 +80,13 @@ const config = defineConfig([{
 				exceptAfterOverload: true
 			}
 		],
+		/**
+		* Limit consecutive empty lines.
+		* Prettier already collapses multiple blank lines within code,
+		* but this additionally prevents blank lines at the start of files.
+		*
+		* @see https://eslint.style/rules/default/no-multiple-empty-lines
+		*/
 		"@stylistic/no-multiple-empty-lines": ["error", {
 			max: 1,
 			maxBOF: 0,

package/dist/configs/flavour-vitest.cjs

@@ -1,7 +1,7 @@
 const require_runtime = require("../_virtual/_rolldown/runtime.cjs");
 let eslint_config = require("eslint/config");
 let _vitest_eslint_plugin = require("@vitest/eslint-plugin");
-_vitest_eslint_plugin = require_runtime.__toESM(_vitest_eslint_plugin);
+_vitest_eslint_plugin = require_runtime.__toESM(_vitest_eslint_plugin, 1);
 //#region src/configs/flavour-vitest.ts
 /**
 * ESLint configuration tailored for Vitest test files.
@@ -23,34 +23,203 @@ const config = (0, eslint_config.defineConfig)([{
 	languageOptions: { globals: { ..._vitest_eslint_plugin.default.environments.env.globals } },
 	settings: { vitest: { typecheck: true } },
 	rules: {
+		/**
+		* Enable Vitest recommended rules.
+		*/
 		..._vitest_eslint_plugin.default.configs.recommended.rules,
+		/**
+		* Enforce a maximum number of parameters in function definitions.
+		* Increased to 5 for test setup functions that receive fixtures and mocks.
+		*
+		* @see https://eslint.org/docs/latest/rules/max-params
+		*/
 		"max-params": ["error", 5],
+		/**
+		* Enforce a maximum depth that callbacks can be nested.
+		* Increased to 5 for describe/it/beforeEach nesting patterns.
+		*
+		* @see https://eslint.org/docs/latest/rules/max-nested-callbacks
+		*/
 		"max-nested-callbacks": ["error", 5],
+		/**
+		* Enforce a maximum cyclomatic complexity allowed in a program.
+		* Increased to 30 and downgraded to warn for complex test scenarios.
+		*
+		* @see https://eslint.org/docs/latest/rules/complexity
+		*/
 		complexity: ["warn", 30],
+		/**
+		* Enforce a maximum number of lines per function.
+		* Disabled for test cases with comprehensive setup and assertions.
+		*
+		* @see https://eslint.org/docs/latest/rules/max-lines-per-function
+		*/
 		"max-lines-per-function": "off",
+		/**
+		* Enforce a maximum number of statements allowed in function blocks.
+		* Disabled for tests with multiple setup and assertion statements.
+		*
+		* @see https://eslint.org/docs/latest/rules/max-statements
+		*/
 		"max-statements": "off",
+		/**
+		* Enforce a maximum number of lines per file.
+		* Disabled for comprehensive test suites.
+		*
+		* @see https://eslint.org/docs/latest/rules/max-lines
+		*/
 		"max-lines": "off",
+		/**
+		* Disallow assigning a value with type any to variables and properties.
+		* Disabled for mock objects and test utilities.
+		*
+		* @see https://typescript-eslint.io/rules/no-unsafe-assignment
+		*/
 		"@typescript-eslint/no-unsafe-assignment": "off",
+		/**
+		* Disallow member access on a value with type any.
+		* Disabled for mock objects.
+		*
+		* @see https://typescript-eslint.io/rules/no-unsafe-member-access
+		*/
 		"@typescript-eslint/no-unsafe-member-access": "off",
+		/**
+		* Disallow calling a value with type any.
+		* Disabled for test utilities like vi.fn().
+		*
+		* @see https://typescript-eslint.io/rules/no-unsafe-call
+		*/
 		"@typescript-eslint/no-unsafe-call": "off",
+		/**
+		* Disallow returning a value with type any from a function.
+		* Disabled for test helper functions.
+		*
+		* @see https://typescript-eslint.io/rules/no-unsafe-return
+		*/
 		"@typescript-eslint/no-unsafe-return": "off",
+		/**
+		* Disallow passing a value with type any to a function parameter.
+		* Disabled for test mock parameters.
+		*
+		* @see https://typescript-eslint.io/rules/no-unsafe-argument
+		*/
 		"@typescript-eslint/no-unsafe-argument": "off",
+		/**
+		* Require unbound methods to be called with correct this context.
+		* Disabled for Vitest expectations like expect(obj.method).toBeCalled().
+		*
+		* @see https://typescript-eslint.io/rules/unbound-method
+		*/
 		"@typescript-eslint/unbound-method": "off",
+		/**
+		* Disallow magic numbers.
+		* Disabled for test assertions with literal values.
+		*
+		* @see https://typescript-eslint.io/rules/no-magic-numbers
+		*/
 		"@typescript-eslint/no-magic-numbers": "off",
+		/**
+		* Require Promise-like statements to be handled appropriately.
+		* Downgraded to warn for test utilities.
+		*
+		* @see https://typescript-eslint.io/rules/no-floating-promises
+		*/
 		"@typescript-eslint/no-floating-promises": "warn",
+		/**
+		* Disallow non-null assertions using the ! postfix operator.
+		* Disabled for tests where values are known to exist.
+		*
+		* @see https://typescript-eslint.io/rules/no-non-null-assertion
+		*/
 		"@typescript-eslint/no-non-null-assertion": "off",
+		/**
+		* Disallow empty functions.
+		* Disabled for test stubs and spies.
+		*
+		* @see https://eslint.org/docs/latest/rules/no-empty-function
+		*/
 		"no-empty-function": "off",
+		/**
+		* Disallow empty functions.
+		* Disabled for test stubs and spies.
+		*
+		* @see https://typescript-eslint.io/rules/no-empty-function
+		*/
 		"@typescript-eslint/no-empty-function": "off",
+		/**
+		* Disallow magic numbers.
+		* Disabled for test assertions.
+		*
+		* @see https://eslint.org/docs/latest/rules/no-magic-numbers
+		*/
 		"no-magic-numbers": "off",
+		/**
+		* Disallow the use of console.
+		* Disabled for test debugging.
+		*
+		* @see https://eslint.org/docs/latest/rules/no-console
+		*/
 		"no-console": "off",
+		/**
+		* Allow importing devDependencies in test files.
+		* Already covered by the base rule's allowlist; kept here as an explicit
+		* override for consumers that overlay this config on different file globs.
+		*
+		* @see https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-extraneous-dependencies.md
+		*/
 		"import/no-extraneous-dependencies": "off",
+		/**
+		* Disallow focused tests.
+		* Prevents .only from being committed.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-focused-tests.md
+		*/
 		"vitest/no-focused-tests": "error",
+		/**
+		* Disallow disabled tests.
+		* Warns about .skip usage.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-disabled-tests.md
+		*/
 		"vitest/no-disabled-tests": "warn",
+		/**
+		* Enforce lowercase test names.
+		* Consistent test naming convention.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-lowercase-title.md
+		*/
 		"vitest/prefer-lowercase-title": "warn",
+		/**
+		* Enforce a maximum depth for nested describe calls.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/max-nested-describe.md
+		*/
 		"vitest/max-nested-describe": ["error", { max: 5 }],
+		/**
+		* Disallow conditional logic in tests.
+		* Tests should be deterministic.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-in-test.md
+		*/
 		"vitest/no-conditional-in-test": "error",
+		/**
+		* Disallow conditional expects.
+		* Expectations should not be inside conditionals.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-expect.md
+		*/
 		"vitest/no-conditional-expect": "error",
+		/**
+		* Enforce consistent hook ordering.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-hooks-in-order.md
+		*/
 		"vitest/prefer-hooks-in-order": "warn",
+		/**
+		* Prefer vi.spyOn over manual mocks.
+		*
+		* @see https://github.com/vitest-dev/eslint-plugin-vitest/blob/main/docs/rules/prefer-spy-on.md
+		*/
 		"vitest/prefer-spy-on": "warn"
 	}
 }]);

package/dist/configs/flavour-vitest.d.cts

@@ -1,5 +1,3 @@
-import * as eslint_config0 from "eslint/config";
-
 //#region src/configs/flavour-vitest.d.ts
 /**
  * ESLint configuration tailored for Vitest test files.
@@ -9,6 +7,6 @@ import * as eslint_config0 from "eslint/config";
  * NOTE: This configuration is meant to be used in conjunction with
  * the base TypeScript ESLint configuration.
  */
-declare const config: eslint_config0.Config[];
+declare const config: import("eslint/config").Config[];
 //#endregion
 export { config };

package/dist/configs/flavour-vitest.d.mts

@@ -1,5 +1,3 @@
-import * as eslint_config0 from "eslint/config";
-
 //#region src/configs/flavour-vitest.d.ts
 /**
  * ESLint configuration tailored for Vitest test files.
@@ -9,6 +7,6 @@ import * as eslint_config0 from "eslint/config";
  * NOTE: This configuration is meant to be used in conjunction with
  * the base TypeScript ESLint configuration.
  */
-declare const config: eslint_config0.Config[];
+declare const config: import("eslint/config").Config[];
 //#endregion
 export { config };