@abinnovision/eslint-config-base 2.2.0 → 3.0.1

package/dist/index.d.cts

@@ -1,73 +1,48 @@
-import * as eslint from 'eslint';
+import * as eslint_config from 'eslint/config';
 
-declare const config: {
-    files: string[];
-    languageOptions: {
-        ecmaVersion: "latest";
-    };
-    plugins: {
-        /**
-         * eslint-plugin-import is not yet compatible with ESLint v9.
-         * This is a temporary fix to make it compatible in the meantime.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/issues/2948
-         */
-        import: Plugin;
-        "unused-imports": eslint.ESLint.Plugin;
-    };
-    rules: {
-        /**
-         * Enforce a consistent order and grouping of import statements.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
-         */
-        "import/order": ["error", {
-            groups: string[][];
-            "newlines-between": string;
-            alphabetize: {
-                order: string;
-                caseInsensitive: boolean;
-            };
-            warnOnUnassignedImports: boolean;
-        }];
-        /**
-         * Enforce the "export" statement is placed at the end of the file.
-         * This avoids sprinkling export statements throughout the file.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
-         */
-        "import/exports-last": "warn";
-        /**
-         * Import statements should always be the first statements in a file.
-         * This makes it easier to identify the dependencies of a file.
-         *
-         * NOTE: Directives (e.g. "use strict") are allowed to come before import statements.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
-         */
-        "import/first": "error";
-        /**
-         * Enforce a newline after the import statements.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
-         */
-        "import/newline-after-import": "error";
-        /**
-         * Disable the "no-return-await" rule.
-         */
-        "no-return-await": "off";
-        /**
-         * Disable the "no-unused-vars" rule as unused-imports is used instead.
-         */
-        "no-unused-vars": "off";
-        "unused-imports/no-unused-imports": "error";
-        "unused-imports/no-unused-vars": ["warn", {
-            vars: string;
-            varsIgnorePattern: string;
-            args: string;
-            argsIgnorePattern: string;
-        }];
-    };
-}[];
+/**
+ * Base ESLint Configuration
+ */
+declare const config$3: eslint_config.Config[];
 
-export { config as default };
+/**
+ * ESLint configuration for build tool and project configuration files.
+ *
+ * This configuration does not specify file patterns - consumers decide which
+ * files to apply this to (e.g., vite.config.ts, webpack.config.js, etc.).
+ *
+ * Usage example:
+ * ```typescript
+ * import { base, configFiles } from "@abinnovision/eslint-config-base";
+ *
+ * export default [
+ *   { extends: [base] },
+ *   {
+ *     files: ["**\/*.config.{ts,js}", "vite.config.ts"],
+ *     extends: [configFiles],
+ *   }
+ * ];
+ * ```
+ */
+declare const config$2: eslint_config.Config[];
+
+/**
+ * ESLint configuration tailored for NestJS projects.
+ * Adjusts rules to accommodate NestJS patterns, especially for dependency injection.
+ *
+ * NOTE: This configuration is meant to be used in conjunction with
+ * the base TypeScript ESLint configuration.
+ */
+declare const config$1: eslint_config.Config[];
+
+/**
+ * ESLint configuration tailored for Vitest test files.
+ * Relaxes strict rules to accommodate common testing patterns while adding
+ * Vitest-specific linting rules.
+ *
+ * NOTE: This configuration is meant to be used in conjunction with
+ * the base TypeScript ESLint configuration.
+ */
+declare const config: eslint_config.Config[];
+
+export { config$3 as base, config$2 as configFiles, config$1 as nestjs, config as vitest };

package/dist/index.d.ts

@@ -1,73 +1,48 @@
-import * as eslint from 'eslint';
+import * as eslint_config from 'eslint/config';
 
-declare const config: {
-    files: string[];
-    languageOptions: {
-        ecmaVersion: "latest";
-    };
-    plugins: {
-        /**
-         * eslint-plugin-import is not yet compatible with ESLint v9.
-         * This is a temporary fix to make it compatible in the meantime.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/issues/2948
-         */
-        import: Plugin;
-        "unused-imports": eslint.ESLint.Plugin;
-    };
-    rules: {
-        /**
-         * Enforce a consistent order and grouping of import statements.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/order.md
-         */
-        "import/order": ["error", {
-            groups: string[][];
-            "newlines-between": string;
-            alphabetize: {
-                order: string;
-                caseInsensitive: boolean;
-            };
-            warnOnUnassignedImports: boolean;
-        }];
-        /**
-         * Enforce the "export" statement is placed at the end of the file.
-         * This avoids sprinkling export statements throughout the file.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/exports-last.md
-         */
-        "import/exports-last": "warn";
-        /**
-         * Import statements should always be the first statements in a file.
-         * This makes it easier to identify the dependencies of a file.
-         *
-         * NOTE: Directives (e.g. "use strict") are allowed to come before import statements.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/first.md
-         */
-        "import/first": "error";
-        /**
-         * Enforce a newline after the import statements.
-         *
-         * @see https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/newline-after-import.md
-         */
-        "import/newline-after-import": "error";
-        /**
-         * Disable the "no-return-await" rule.
-         */
-        "no-return-await": "off";
-        /**
-         * Disable the "no-unused-vars" rule as unused-imports is used instead.
-         */
-        "no-unused-vars": "off";
-        "unused-imports/no-unused-imports": "error";
-        "unused-imports/no-unused-vars": ["warn", {
-            vars: string;
-            varsIgnorePattern: string;
-            args: string;
-            argsIgnorePattern: string;
-        }];
-    };
-}[];
+/**
+ * Base ESLint Configuration
+ */
+declare const config$3: eslint_config.Config[];
 
-export { config as default };
+/**
+ * ESLint configuration for build tool and project configuration files.
+ *
+ * This configuration does not specify file patterns - consumers decide which
+ * files to apply this to (e.g., vite.config.ts, webpack.config.js, etc.).
+ *
+ * Usage example:
+ * ```typescript
+ * import { base, configFiles } from "@abinnovision/eslint-config-base";
+ *
+ * export default [
+ *   { extends: [base] },
+ *   {
+ *     files: ["**\/*.config.{ts,js}", "vite.config.ts"],
+ *     extends: [configFiles],
+ *   }
+ * ];
+ * ```
+ */
+declare const config$2: eslint_config.Config[];
+
+/**
+ * ESLint configuration tailored for NestJS projects.
+ * Adjusts rules to accommodate NestJS patterns, especially for dependency injection.
+ *
+ * NOTE: This configuration is meant to be used in conjunction with
+ * the base TypeScript ESLint configuration.
+ */
+declare const config$1: eslint_config.Config[];
+
+/**
+ * ESLint configuration tailored for Vitest test files.
+ * Relaxes strict rules to accommodate common testing patterns while adding
+ * Vitest-specific linting rules.
+ *
+ * NOTE: This configuration is meant to be used in conjunction with
+ * the base TypeScript ESLint configuration.
+ */
+declare const config: eslint_config.Config[];
+
+export { config$3 as base, config$2 as configFiles, config$1 as nestjs, config as vitest };