@fullstacksjs/eslint-config 14.4.0 → 14.6.0

package/cjs/modules/regex.js

@@ -4,15 +4,17 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
+var _eslintFlatConfigUtils = require("eslint-flat-config-utils");
 var plugin = _interopRequireWildcard(require("eslint-plugin-regexp"));
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 /**
- * @param { import('../index.js').Options } options
+ * @param { import('../types').Options } options
  * @return { Promise<import('eslint').Linter.Config> }
  */
 function regex(options = {}) {
-  return {
+  const regexConfig = {
+    name: 'regex',
     plugins: {
       regexp: plugin
     },
@@ -109,5 +111,6 @@ function regex(options = {}) {
       'no-empty-character-class': 'off'
     }
   };
+  return (0, _eslintFlatConfigUtils.mergeConfigs)(regexConfig, options.regex.overrides ?? {});
 }
 module.exports = regex;

package/cjs/modules/storybook.js

@@ -4,12 +4,17 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
+var _eslintFlatConfigUtils = require("eslint-flat-config-utils");
 var _eslintPluginStorybook = _interopRequireDefault(require("eslint-plugin-storybook"));
 var _globs = require("../utils/globs.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/** @return { import('eslint').Linter.Config } */
-function storybook() {
-  return {
+/**
+ * @param { import('../types').Options } options
+ * @return { Promise<import('eslint').Linter.Config> }
+ */
+function storybook(options = {}) {
+  const storybookConfig = {
+    name: 'storybook',
     files: _globs.globs.storybook,
     plugins: {
       storybook: _eslintPluginStorybook.default
@@ -37,5 +42,6 @@ function storybook() {
       'react-hooks/rules-of-hooks': 'off'
     }
   };
+  return (0, _eslintFlatConfigUtils.mergeConfigs)(storybookConfig, options.storybook.overrides ?? {});
 }
 module.exports = storybook;

package/cjs/modules/stylistic.js

@@ -5,13 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 
 var _eslintPlugin = _interopRequireDefault(require("@stylistic/eslint-plugin"));
+var _eslintFlatConfigUtils = require("eslint-flat-config-utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
- * @param { import('../index.js').Options } options
+ * @param { import('../types').Options } options
  * @return { Promise<import('eslint').Linter.Config> }
  */
-function stylistic() {
-  return {
+function stylistic(options = {}) {
+  const stylisticConfig = {
+    name: 'stylistic',
     plugins: {
       '@stylistic': _eslintPlugin.default
     },
@@ -85,5 +87,6 @@ function stylistic() {
       }]
     }
   };
+  return (0, _eslintFlatConfigUtils.mergeConfigs)(stylisticConfig, options.stylistic.overrides ?? {});
 }
 module.exports = stylistic;

package/cjs/modules/tailwind.js

@@ -4,14 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
+var _eslintFlatConfigUtils = require("eslint-flat-config-utils");
 var _conditions = require("../utils/conditions.js");
 /**
- * @param { import('../index.js').Options } options
+ * @param { import('../types').Options } options
  * @return { Promise<import('eslint').Linter.Config> }
  */
 async function tailwind(options = {}) {
   const plugin = await Promise.resolve().then(() => require('eslint-plugin-better-tailwindcss'));
-  return {
+  const tailwindConfig = {
+    name: 'tailwind',
     plugins: {
       'better-tailwindcss': plugin.default ?? plugin
     },
@@ -41,5 +43,6 @@ async function tailwind(options = {}) {
       'better-tailwindcss/no-unnecessary-whitespace': 'warn'
     }
   };
+  return (0, _eslintFlatConfigUtils.mergeConfigs)(tailwindConfig, options.tailwind.overrides ?? {});
 }
 module.exports = tailwind;

package/cjs/modules/tests.js

@@ -5,17 +5,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 
 var _eslintPlugin = _interopRequireDefault(require("@vitest/eslint-plugin"));
+var _eslintFlatConfigUtils = require("eslint-flat-config-utils");
 var _globals = _interopRequireDefault(require("globals"));
 var _conditions = require("../utils/conditions.js");
 var _globs = require("../utils/globs.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
- * @param { import('../index.js').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
 
 function tests(options = {}) {
-  return {
+  const testsConfug = {
+    name: 'tests',
     files: [..._globs.globs.test, ..._globs.globs.e2e],
     plugins: {
       vitest: _eslintPlugin.default
@@ -43,5 +45,6 @@ function tests(options = {}) {
       })
     }
   };
+  return (0, _eslintFlatConfigUtils.mergeConfigs)(testsConfug, options.test.overrides ?? {});
 }
 module.exports = tests;

package/cjs/modules/typescript.js

@@ -4,17 +4,19 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 
+var _eslintFlatConfigUtils = require("eslint-flat-config-utils");
 var _typescriptEslint = require("typescript-eslint");
 var _conditions = require("../utils/conditions.js");
 var _globs = require("../utils/globs.js");
 var _namingConvention = require("../utils/naming-convention.js");
 /**
- * @param { import('../index.js').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
 function typescript(options = {}) {
   const projectService = options.typescript && options.typescript.tsconfigRootDir && options.typescript.projectService;
-  return {
+  const typescriptConfig = {
+    name: 'typescript',
     files: [_globs.globs.ts, _globs.globs.tsx],
     plugins: {
       '@typescript-eslint': _typescriptEslint.plugin
@@ -278,5 +280,6 @@ function typescript(options = {}) {
       'no-duplicate-imports': 'off'
     }
   };
+  return (0, _eslintFlatConfigUtils.mergeConfigs)(typescriptConfig, options.typescript.overrides ?? {});
 }
 module.exports = typescript;

package/cjs/modules/vitest.js

@@ -5,13 +5,16 @@ Object.defineProperty(exports, "__esModule", {
 });
 
 var _eslintPlugin = _interopRequireDefault(require("@vitest/eslint-plugin"));
+var _eslintFlatConfigUtils = require("eslint-flat-config-utils");
 var _globs = require("../utils/globs.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
-function vitest() {
-  return {
+function vitest(options = {}) {
+  const vitestConfig = {
+    name: 'vitest',
     files: _globs.globs.test,
     plugins: {
       vitest: _eslintPlugin.default
@@ -107,5 +110,6 @@ function vitest() {
       'vitest/warn-todo': 'warn'
     }
   };
+  return (0, _eslintFlatConfigUtils.mergeConfigs)(vitestConfig, options.vitest.overrides ?? {});
 }
 module.exports = vitest;

package/cjs/{index.d.ts → types/index.d.ts}

@@ -1,69 +1,57 @@
 import type { Linter } from 'eslint';
+import type { ConfigWithExtends } from 'eslint-flat-config-utils';
 
-/**
- * Granular options to configure the project service.
- */
-export interface ProjectServiceOptions {
-  /**
-   * Globs of files to allow running with the default project compiler options
-   * despite not being matched by the project service.
-   */
-  allowDefaultProject?: string[];
-
-  /**
-   * Path to a TSConfig to use instead of TypeScript's default project configuration.
-   * @default 'tsconfig.json'
-   */
-  defaultProject?: string;
-
-  /**
-   * Whether to allow TypeScript plugins as configured in the TSConfig.
-   */
-  loadTypeScriptPlugins?: boolean;
+import type { ImportOptions } from './modules/import';
+import type { ReactOptions } from './modules/react';
+import type { RegexOptions } from './modules/regex';
+import type { TailwindOptions } from './modules/tailwind';
+import type { TypeScriptOptions } from './modules/typescript';
 
+interface ConfigWithOverrides {
   /**
-   * The maximum number of files {@link allowDefaultProject} may match.
-   * Each file match slows down linting, so if you do need to use this, please
-   * file an informative issue on typescript-eslint explaining why - so we can
-   * help you avoid using it!
-   * @default 8
+   * Override the configuration.
+   *
+   * The properties of this object are merged with and take precedence over the default configuration.
+   *
+   * There is no guarantee that the resulting configuration works correctly — it depends on the options you provide.
+   *
+   * @see [eslint-flat-config-utils: `mergeConfigs`](https://jsr.io/@antfu/eslint-flat-config-utils/doc/~/mergeConfigs)
    */
-  maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING?: number;
+  overrides?: ConfigWithExtends;
 }
 
-type TailwindConfig = {
-  callees?: string[];
-  variables?: string[];
-  attributes?: string[];
-  tags?: string[];
-} & ({ entryPoint: string; tailwindConfig?: string } | { entryPoint?: string; tailwindConfig: string });
-
 export interface Options extends Linter.Config {
+  /**
+   * Controls Base.
+   * @default true
+   */
+  base?: boolean | ConfigWithOverrides;
   /**
    * Controls React plugin.
    * @default true - If you have `react` or `react-dom` in your dependencies.
    */
-  react?: boolean | { additionalEffectHooks?: string };
+  react?: boolean | ReactOptions;
   /**
+   * Controls [Perfectionist plugin](https://www.npmjs.com/package/eslint-plugin-perfectionist).
    * @default true
    */
-  sort?: boolean;
+  sort?: boolean | ConfigWithOverrides;
   /**
    * Controls Next plugin.
    * @default true - If you have `next` in your dependencies.
    */
-  next?: boolean;
+  next?: boolean | ConfigWithOverrides;
   /**
    * Controls Tailwind plugin.
    * @default false
    * @see https://github.com/schoero/eslint-plugin-better-tailwindcss/blob/main/docs/settings/settings.md
    */
-  tailwind?: false | TailwindConfig;
+  tailwind?: false | TailwindOptions;
   /**
    * Controls [Node plugin](https://www.npmjs.com/package/eslint-plugin-n).
    * @default false
    */
-  node?: boolean;
+  node?: boolean | ConfigWithOverrides;
   /**
    * Enables all strict rules.
    * @default false
@@ -73,7 +61,7 @@ export interface Options extends Linter.Config {
    * Controls [import plugin](https://www.npmjs.com/package/eslint-plugin-import-x).
    * @default true
    */
-  import?: boolean | { internalRegExp?: string; lifetime?: number; projects?: string | string[] };
+  import?: boolean | ImportOptions;
   /**
    * @default true - If you have `type: module` in your `package.json`.
    */
@@ -82,42 +70,57 @@ export interface Options extends Linter.Config {
    * Controls [test plugin](https://www.npmjs.com/package/eslint-plugin-jest-formatting).
    * @default true - If you have one of `jest`, `vitest`, `cypress`, `@playwright/test` in your dependencies.
    */
-  test?: boolean;
+  test?: boolean | ConfigWithOverrides;
   /**
    * Controls [Jest plugin](https://www.npmjs.com/package/eslint-plugin-jest).
    * @default true - If you have `jest` in your dependencies.
    */
-  jest?: boolean;
+  jest?: boolean | ConfigWithOverrides;
   /**
    * Controls [Vitest plugin](https://www.npmjs.com/package/eslint-plugin-vitest).
    * @default true - If you have `vitest` in your dependencies.
    */
-  vitest?: boolean;
+  vitest?: boolean | ConfigWithOverrides;
   /**
    * Controls [Cypress plugin](https://www.npmjs.com/package/eslint-plugin-cypress).
    * @default true - If you have `cypress` in your dependencies.
    */
-  cypress?: boolean;
+  cypress?: boolean | ConfigWithOverrides;
   /**
    * Controls [Storybook plugin](https://www.npmjs.com/package/eslint-plugin-storybook).
    * @default true if you have `storybook` in your dependencies.
    */
-  storybook?: boolean;
+  storybook?: boolean | ConfigWithOverrides;
   /**
    * Controls [Prettier plugin](https://www.npmjs.com/package/eslint-plugin-prettier).
    * @default true - If you have `prettier` in your dependencies.
    */
-  prettier?: boolean;
+  prettier?: boolean | ConfigWithOverrides;
   /**
    * Controls [Playwright plugin](https://www.npmjs.com/package/eslint-plugin-playwright).
    * @default true - If you have `@playwright/test` in your dependencies.
    */
-  playwright?: boolean;
+  playwright?: boolean | ConfigWithOverrides;
+  /**
+   * Controls [Promise plugin](https://www.npmjs.com/package/eslint-plugin-promise).
+   * @default true
+   */
+  promise?: boolean | ConfigWithOverrides;
+  /**
+   * Controls [Stylistic plugin](https://www.npmjs.com/package/@stylistic/eslint-plugin).
+   * @default true
+   */
+  stylistic?: boolean | ConfigWithOverrides;
   /**
    * Controls [TypeScript plugin](https://www.npmjs.com/package/typescript-eslint).
    * @default true - If you have `typescript` in your dependencies.
    */
-  typescript?: boolean | { projectService?: boolean | ProjectServiceOptions; tsconfigRootDir?: string; cacheLifetime?: number };
+  typescript?: boolean | TypeScriptOptions;
+  /**
+   * Controls [Regex plugin](https://www.npmjs.com/package/eslint-plugin-regexp).
+   * @default { allowedCharacterRanges: ['all'] }
+   */
+  regex?: boolean | RegexOptions;
   /**
    * Disables expensive rules.
    * @default false
@@ -133,11 +136,6 @@ export interface Options extends Linter.Config {
    * @default './.gitignore'
    */
   gitignore?: string | false;
-  /**
-   * Controls regex plugin.
-   * @default { allowedCharacterRanges: ['all'] }
-   */
-  regex?: boolean | { allowedCharacterRanges: string[] };
 }
 
 export declare function defineConfig(initOptions?: Options, ...extend: Linter.Config[]): Linter.Config[];

package/cjs/types/modules/import.d.ts

@@ -0,0 +1,7 @@
+import type { ConfigWithOverrides } from '..';
+
+interface ImportOptions extends ConfigWithOverrides {
+  internalRegExp?: string;
+  lifetime?: number;
+  projects?: string | string[];
+}

package/cjs/types/modules/react.d.ts

@@ -0,0 +1,5 @@
+import type { ConfigWithOverrides } from '..';
+
+interface ReactOptions extends ConfigWithOverrides {
+  additionalEffectHooks?: string;
+}

package/cjs/types/modules/regex.d.ts

@@ -0,0 +1,5 @@
+import type { ConfigWithOverrides } from '..';
+
+interface RegexOptions extends ConfigWithOverrides {
+  allowedCharacterRanges: string[];
+}

package/cjs/types/modules/tailwind.d.ts

@@ -0,0 +1,20 @@
+import type { ConfigWithOverrides } from '..';
+
+interface TailwindOptionsBase extends ConfigWithOverrides {
+  callees?: string[];
+  variables?: string[];
+  attributes?: string[];
+  tags?: string[];
+}
+
+interface TailwindOptionsWithEntryPoint extends TailwindOptionsBase {
+  entryPoint: string;
+  tailwindConfig?: string;
+}
+
+interface TailwindOptionsWithConfig extends TailwindOptionsBase {
+  entryPoint?: string;
+  tailwindConfig: string;
+}
+
+type TailwindOptions = TailwindOptionsWithConfig | TailwindOptionsWithEntryPoint;

package/cjs/types/modules/typescript.d.ts

@@ -0,0 +1,38 @@
+import type { ConfigWithOverrides } from '..';
+
+/**
+ * Granular options to configure the project service.
+ */
+interface ProjectServiceOptions {
+  /**
+   * Globs of files to allow running with the default project compiler options
+   * despite not being matched by the project service.
+   */
+  allowDefaultProject?: string[];
+
+  /**
+   * Path to a TSConfig to use instead of TypeScript's default project configuration.
+   * @default 'tsconfig.json'
+   */
+  defaultProject?: string;
+
+  /**
+   * Whether to allow TypeScript plugins as configured in the TSConfig.
+   */
+  loadTypeScriptPlugins?: boolean;
+
+  /**
+   * The maximum number of files {@link allowDefaultProject} may match.
+   * Each file match slows down linting, so if you do need to use this, please
+   * file an informative issue on typescript-eslint explaining why - so we can
+   * help you avoid using it!
+   * @default 8
+   */
+  maximumDefaultProjectFileMatchCount_THIS_WILL_SLOW_DOWN_LINTING?: number;
+}
+
+interface TypeScriptOptions extends ConfigWithOverrides {
+  projectService?: boolean | ProjectServiceOptions;
+  tsconfigRootDir?: string;
+  cacheLifetime?: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "14.4.0",
+  "version": "14.6.0",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",
@@ -34,7 +34,7 @@
     ".": {
       "import": "./src/index.mjs",
       "require": "./cjs/index.js",
-      "types": "./src/index.d.ts"
+      "types": "./src/types/index.d.ts"
     }
   },
   "dependencies": {
@@ -44,6 +44,7 @@
     "@stylistic/eslint-plugin": "5.10.0",
     "@vitest/eslint-plugin": "1.6.17",
     "deepmerge": "4.3.1",
+    "eslint-flat-config-utils": "3.2.0",
     "eslint-plugin-better-tailwindcss": "4.5.0",
     "eslint-plugin-cypress": "6.4.1",
     "eslint-plugin-import-x": "4.16.2",

package/src/index.mjs

@@ -12,6 +12,7 @@ import node from './modules/node.mjs';
 import perfectionist from './modules/perfectionist.mjs';
 import playwright from './modules/playwright.mjs';
 import prettier from './modules/prettier.mjs';
+import promise from './modules/promise.mjs';
 import react from './modules/react.mjs';
 import regex from './modules/regex.mjs';
 import storybook from './modules/storybook.mjs';
@@ -25,11 +26,14 @@ const testPackages = ['jest', 'vitest', 'cypress', '@playwright/test'];
 
 /**
  * @typedef {import('eslint').Linter.Config} Config
- * @typedef {import('.').Options} Options
+ * @typedef {import('./types').Options} Options
  * /
 
 /** @type {Options} */
 const defaultOptions = {
+  base: true,
+  promise: true,
+  stylistic: true,
   cypress: isPackageExists('cypress'),
   disableExpensiveRules: false,
   esm: false,
@@ -74,6 +78,9 @@ export function defineConfig(initOptions = {}, ...extend) {
   }
 
   const {
+    base: enableBase,
+    promise: enablePromise,
+    stylistic: enableStylistic,
     sort: enableSort,
     cypress: enableCypress,
     disableExpensiveRules,
@@ -97,8 +104,11 @@ export function defineConfig(initOptions = {}, ...extend) {
     ...eslintOptions
   } = options;
 
-  const rules = [ignores(options), base(options), stylistic(options)];
+  const rules = [ignores(options)];
 
+  if (enableBase) rules.push(base(options));
+  if (enablePromise) rules.push(promise(options));
+  if (enableStylistic) rules.push(stylistic(options));
   if (enableSort) rules.push(perfectionist(options));
   if (enableImport) rules.push(imports(options));
   if (enableTailwind) rules.push(tailwind(options));

package/src/modules/base.mjs

@@ -1,13 +1,15 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import globals from 'globals';
 
 import { strict } from '../utils/conditions.mjs';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
 function base(options = {}) {
-  return {
+  const baseConfig = {
+    name: 'base',
     languageOptions: {
       ecmaVersion: 'latest',
       sourceType: 'module',
@@ -194,6 +196,8 @@ function base(options = {}) {
       'no-console': strict(options, 'warn'),
     },
   };
+
+  return mergeConfigs(baseConfig, options.base.overrides ?? {});
 }
 
 export default base;

package/src/modules/cypress.mjs

@@ -1,10 +1,15 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-cypress';
 
 import { globs } from '../utils/globs.mjs';
 
-/** @return { import('eslint').Linter.Config } */
-function cypress() {
-  return {
+/**
+ * @param { import('../types').Options } options
+ * @return { import('eslint').Linter.Config }
+ */
+function cypress(options = {}) {
+  const cypressConfig = {
+    name: 'cypress',
     files: globs.e2e,
     plugins: { cypress: plugin },
     rules: {
@@ -20,6 +25,8 @@ function cypress() {
       '@typescript-eslint/no-namespace': 'off',
     },
   };
+
+  return mergeConfigs(cypressConfig, options.cypress.overrides ?? {});
 }
 
 export default cypress;

package/src/modules/ignore.mjs

@@ -4,7 +4,7 @@ import { getGitignorePatterns } from '../utils/getGitignorePatterns.mjs';
 import { ignoreGlobs } from '../utils/globs.mjs';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
 function ignores(options = {}) {

package/src/modules/imports.mjs

@@ -1,3 +1,4 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-import-x';
 
 import { predicate } from '../utils/conditions.mjs';
@@ -7,13 +8,14 @@ const jsExtensions = ['.mjs', '.js', '.jsx', '.cjs'];
 const allExtensions = [...jsExtensions, ...tsExtensions];
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
 function imports(options = {}) {
   const isObject = typeof options.import === 'object';
 
-  const config = {
+  const importsConfig = {
+    name: 'imports',
     plugins: { import: plugin },
     settings: {
       'import-x/extensions': jsExtensions,
@@ -104,7 +106,7 @@ function imports(options = {}) {
     },
   };
 
-  return config;
+  return mergeConfigs(importsConfig, options.import.overrides ?? {});
 }
 
 export default imports;

package/src/modules/jest.mjs

@@ -1,3 +1,4 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-jest';
 import globals from 'globals';
 
@@ -5,12 +6,13 @@ import { predicate } from '../utils/conditions.mjs';
 import { globs } from '../utils/globs.mjs';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config } */
 function jest(options = {}) {
   const projectService = options.typescript && options.typescript.tsconfigRootDir && options.typescript.projectService;
 
-  return {
+  const jestConfig = {
+    name: 'jest',
     files: globs.test,
     plugins: { jest: plugin },
     languageOptions: {
@@ -83,6 +85,8 @@ function jest(options = {}) {
       // }),
     },
   };
+
+  return mergeConfigs(jestConfig, options.jest.overrides ?? {});
 }
 
 export default jest;