@abinnovision/eslint-config-base 3.4.1 → 3.4.2-beta.1

package/dist/configs/flavour-vitest.mjs

@@ -21,34 +21,203 @@ const config = defineConfig([{
 	languageOptions: { globals: { ...vitest.environments.env.globals } },
 	settings: { vitest: { typecheck: true } },
 	rules: {
+		/**
+		* Enable Vitest recommended rules.
+		*/
 		...vitest.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/index.cjs

@@ -1,5 +1,10 @@
-require("./base.cjs");
-require("./flavour-config-files.cjs");
-require("./flavour-nestjs.cjs");
-require("./flavour-stylistic.cjs");
-require("./flavour-vitest.cjs");
+const require_base = require("./base.cjs");
+const require_flavour_config_files = require("./flavour-config-files.cjs");
+const require_flavour_nestjs = require("./flavour-nestjs.cjs");
+const require_flavour_stylistic = require("./flavour-stylistic.cjs");
+const require_flavour_vitest = require("./flavour-vitest.cjs");
+exports.base = require_base.config;
+exports.configFiles = require_flavour_config_files.config;
+exports.nestjs = require_flavour_nestjs.config;
+exports.stylistic = require_flavour_stylistic.config;
+exports.vitest = require_flavour_vitest.config;

package/dist/configs/index.mjs

@@ -1,6 +1,6 @@
-import "./base.mjs";
-import "./flavour-config-files.mjs";
-import "./flavour-nestjs.mjs";
-import "./flavour-stylistic.mjs";
-import "./flavour-vitest.mjs";
-export {};
+import { config } from "./base.mjs";
+import { config as config$1 } from "./flavour-config-files.mjs";
+import { config as config$2 } from "./flavour-nestjs.mjs";
+import { config as config$3 } from "./flavour-stylistic.mjs";
+import { config as config$4 } from "./flavour-vitest.mjs";
+export { config as base, config$1 as configFiles, config$2 as nestjs, config$3 as stylistic, config$4 as vitest };

package/package.json

@@ -1,8 +1,21 @@
 {
   "name": "@abinnovision/eslint-config-base",
-  "version": "3.4.1",
+  "version": "3.4.2-beta.1",
+  "description": "Shared ESLint configuration for JavaScript and TypeScript projects.",
+  "keywords": [
+    "eslint",
+    "eslint-config",
+    "typescript",
+    "javascript"
+  ],
+  "homepage": "https://github.com/abinnovision/js-commons",
+  "bugs": {
+    "url": "https://github.com/abinnovision/js-commons/issues"
+  },
   "repository": {
-    "url": "https://github.com/abinnovision/js-commons"
+    "type": "git",
+    "url": "git+https://github.com/abinnovision/js-commons.git",
+    "directory": "packages/eslint-config-base"
   },
   "license": "Apache-2.0",
   "author": {
@@ -46,20 +59,20 @@
   },
   "prettier": "@abinnovision/prettier-config",
   "dependencies": {
-    "@eslint/js": "^10.0.0",
+    "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.10.0",
-    "@vitest/eslint-plugin": "^1.6.9",
-    "eslint-plugin-import-x": "^4.16.2",
+    "@vitest/eslint-plugin": "^1.6.23",
+    "eslint-plugin-import-x": "^4.17.1",
     "eslint-plugin-unused-imports": "^4.4.1",
-    "globals": "^17.3.0",
-    "typescript-eslint": "^8.56.0"
+    "globals": "^17.7.0",
+    "typescript-eslint": "^8.63.0"
   },
   "devDependencies": {
     "@abinnovision/prettier-config": "^2.2.0",
     "@internal/tsconfig": "^1.0.0",
-    "eslint": "^10.0.0",
-    "prettier": "^3.4.2",
-    "tsdown": "^0.21.3",
+    "eslint": "^10.7.0",
+    "prettier": "^3.9.5",
+    "tsdown": "^0.22.5",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {

package/dist/configs/index.d.mts

@@ -1,5 +0,0 @@
-import { config } from "./base.mjs";
-import { config as config$1 } from "./flavour-config-files.mjs";
-import { config as config$2 } from "./flavour-nestjs.mjs";
-import { config as config$3 } from "./flavour-stylistic.mjs";
-import { config as config$4 } from "./flavour-vitest.mjs";