@fullstacksjs/eslint-config 14.4.0 → 14.6.0

package/src/modules/next.mjs

@@ -1,8 +1,13 @@
 import plugin from '@next/eslint-plugin-next';
+import { mergeConfigs } from 'eslint-flat-config-utils';
 
-/** @type { import('eslint').Linter.Config } */
-function next() {
-  return {
+/**
+ * @param { import('../types').Options } options
+ * @return { import('eslint').Linter.Config }
+ */
+function next(options = {}) {
+  const nextConfig = {
+    name: 'next',
     plugins: { next: plugin },
     rules: {
       'next/google-font-display': 'warn',
@@ -28,6 +33,8 @@ function next() {
       'next/no-unwanted-polyfillio': 'warn',
     },
   };
+
+  return mergeConfigs(nextConfig, options.next.overrides ?? {});
 }
 
 export default next;

package/src/modules/node.mjs

@@ -1,13 +1,15 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-n';
 
 import { strict } from '../utils/conditions.mjs';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
 function node(options = {}) {
-  return {
+  const nodeConfig = {
+    name: 'node',
     plugins: { n: plugin },
     rules: {
       'n/callback-return': 'off',
@@ -55,6 +57,8 @@ function node(options = {}) {
       'n/no-missing-require': 'off',
     },
   };
+
+  return mergeConfigs(nodeConfig, options.node.overrides ?? {});
 }
 
 export default node;

package/src/modules/perfectionist.mjs

@@ -1,10 +1,13 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-perfectionist';
 
 /**
- * @return { import('eslint').Linter.Config }
+ * @param { import('../types').Options } options
+ * @return { Promise<import('eslint').Linter.Config> }
  */
-function perfectionist() {
-  return {
+function perfectionist(options = {}) {
+  const perfectionistConfig = {
+    name: 'perfectionist',
     plugins: { perfectionist: plugin },
     rules: {
       'perfectionist/sort-array-includes': 'warn',
@@ -68,6 +71,8 @@ function perfectionist() {
       'perfectionist/sort-variable-declarations': 'warn',
     },
   };
+
+  return mergeConfigs(perfectionistConfig, options.sort.overrides ?? {});
 }
 
 export default perfectionist;

package/src/modules/playwright.mjs

@@ -1,10 +1,15 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-playwright';
 
 import { globs } from '../utils/globs.mjs';
 
-/** @return { import('eslint').Linter.Config } */
-function playwright() {
-  return {
+/**
+ * @param { import('../types').Options } options
+ * @return { Promise<import('eslint').Linter.Config> }
+ */
+function playwright(options = {}) {
+  const playwrightConfig = {
+    name: 'playwright',
     plugins: { playwright: plugin },
     files: globs.e2e,
     rules: {
@@ -68,6 +73,8 @@ function playwright() {
       'playwright/valid-title': 'warn',
     },
   };
+
+  return mergeConfigs(playwrightConfig, options.playwright.overrides ?? {});
 }
 
 export default playwright;

package/src/modules/prettier.mjs

@@ -1,8 +1,13 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-prettier';
 
-/** @return { import('eslint').Linter.Config } */
-function prettier() {
-  return {
+/**
+ * @param { import('../types').Options } options
+ * @return { Promise<import('eslint').Linter.Config> }
+ */
+function prettier(options = {}) {
+  const prettierConfig = {
+    name: 'prettier',
     plugins: { prettier: plugin },
     rules: {
       'prettier/prettier': 'error',
@@ -87,6 +92,8 @@ function prettier() {
       'vue/template-curly-spacing': 'off',
     },
   };
+
+  return mergeConfigs(prettierConfig, options.prettier.overrides ?? {});
 }
 
 export default prettier;

package/src/modules/promise.mjs

@@ -1,10 +1,15 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-promise';
 
 import { strict } from '../utils/conditions.mjs';
 
-/** @return { import('eslint').Linter.Config } */
+/**
+ * @param { import('../types').Options } options
+ * @return { Promise<import('eslint').Linter.Config> }
+ */
 function promise(options = {}) {
-  return {
+  const promiseConfig = {
+    name: 'promise',
     plugins: { promise: plugin },
     rules: {
       'promise/always-return': 'off',
@@ -26,6 +31,8 @@ function promise(options = {}) {
       'promise/spec-only': 'warn',
     },
   };
+
+  return mergeConfigs(promiseConfig, options.promise.overrides ?? {});
 }
 
 export default promise;

package/src/modules/react.mjs

@@ -1,4 +1,5 @@
 import reactPlugin from '@eslint-react/eslint-plugin';
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import a11yPlugin from 'eslint-plugin-jsx-a11y';
 import hooksPlugin from 'eslint-plugin-react-hooks';
 import { parser } from 'typescript-eslint';
@@ -6,11 +7,15 @@ import { parser } from 'typescript-eslint';
 import { predicate, strict } from '../utils/conditions.mjs';
 import { globs } from '../utils/globs.mjs';
 
-/** @return { import('eslint').Linter.Config } */
+/**
+ * @param { import('../types').Options } options
+ * @return { Promise<import('eslint').Linter.Config> }
+ */
 function react(options = {}) {
   const projectService = options.typescript && options.typescript.tsconfigRootDir && options.typescript.projectService;
 
-  return {
+  const reactConfig = {
+    name: 'react',
     files: [globs.js, globs.jsx, globs.ts, globs.tsx],
     plugins: {
       ...reactPlugin.configs.all.plugins,
@@ -170,6 +175,8 @@ function react(options = {}) {
       'jsx-a11y/prefer-tag-over-role': 'off',
     },
   };
+
+  return mergeConfigs(reactConfig, options.react.overrides ?? {});
 }
 
 export default react;

package/src/modules/regex.mjs

@@ -1,11 +1,13 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import * as plugin from 'eslint-plugin-regexp';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { Promise<import('eslint').Linter.Config> }
  */
 function regex(options = {}) {
-  return {
+  const regexConfig = {
+    name: 'regex',
     plugins: { regexp: plugin },
     settings: {
       regexp: {
@@ -101,6 +103,8 @@ function regex(options = {}) {
       'no-empty-character-class': 'off',
     },
   };
+
+  return mergeConfigs(regexConfig, options.regex.overrides ?? {});
 }
 
 export default regex;

package/src/modules/storybook.mjs

@@ -1,10 +1,15 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-storybook';
 
 import { globs } from '../utils/globs.mjs';
 
-/** @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.storybook,
     plugins: { storybook: plugin },
     rules: {
@@ -32,6 +37,8 @@ function storybook() {
       'react-hooks/rules-of-hooks': 'off',
     },
   };
+
+  return mergeConfigs(storybookConfig, options.storybook.overrides ?? {});
 }
 
 export default storybook;

package/src/modules/stylistic.mjs

@@ -1,11 +1,13 @@
 import stylisticPlugin from '@stylistic/eslint-plugin';
+import { mergeConfigs } from 'eslint-flat-config-utils';
 
 /**
- * @param { import('..').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': stylisticPlugin },
     rules: {
       '@stylistic/jsx-curly-brace-presence': ['warn', { props: 'never', children: 'never', propElementValues: 'always' }],
@@ -42,6 +44,7 @@ function stylistic() {
       ],
     },
   };
+  return mergeConfigs(stylisticConfig, options.stylistic.overrides ?? {});
 }
 
 export default stylistic;

package/src/modules/tailwind.mjs

@@ -1,12 +1,15 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
+
 import { strict } from '../utils/conditions.mjs';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { Promise<import('eslint').Linter.Config> }
  */
 async function tailwind(options = {}) {
   const plugin = await import('eslint-plugin-better-tailwindcss');
-  return {
+  const tailwindConfig = {
+    name: 'tailwind',
     plugins: { 'better-tailwindcss': plugin.default ?? plugin },
     settings: {
       'better-tailwindcss': {
@@ -34,6 +37,8 @@ async function tailwind(options = {}) {
       'better-tailwindcss/no-unnecessary-whitespace': 'warn',
     },
   };
+
+  return mergeConfigs(tailwindConfig, options.tailwind.overrides ?? {});
 }
 
 export default tailwind;

package/src/modules/tests.mjs

@@ -1,16 +1,18 @@
 import plugin from '@vitest/eslint-plugin';
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import globals from 'globals';
 
 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 tests(options = {}) {
-  return {
+  const testsConfug = {
+    name: 'tests',
     files: [...globs.test, ...globs.e2e],
     plugins: { vitest: plugin },
     languageOptions: {
@@ -37,6 +39,8 @@ function tests(options = {}) {
       }),
     },
   };
+
+  return mergeConfigs(testsConfug, options.test.overrides ?? {});
 }
 
 export default tests;

package/src/modules/typescript.mjs

@@ -1,3 +1,4 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import { parser, plugin } from 'typescript-eslint';
 
 import { predicate, strict } from '../utils/conditions.mjs';
@@ -5,13 +6,14 @@ import { globs } from '../utils/globs.mjs';
 import { namingConvention } from '../utils/naming-convention.mjs';
 
 /**
- * @param { import('..').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.ts, globs.tsx],
     plugins: { '@typescript-eslint': plugin },
     languageOptions: {
@@ -247,6 +249,8 @@ function typescript(options = {}) {
       'no-duplicate-imports': 'off',
     },
   };
+
+  return mergeConfigs(typescriptConfig, options.typescript.overrides ?? {});
 }
 
 export default typescript;

package/src/modules/vitest.mjs

@@ -1,12 +1,15 @@
 import plugin from '@vitest/eslint-plugin';
+import { mergeConfigs } from 'eslint-flat-config-utils';
 
 import { globs } from '../utils/globs.mjs';
 
 /**
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
-function vitest() {
-  return {
+function vitest(options = {}) {
+  const vitestConfig = {
+    name: 'vitest',
     files: globs.test,
     plugins: { vitest: plugin },
     languageOptions: {
@@ -99,6 +102,8 @@ function vitest() {
       'vitest/warn-todo': 'warn',
     },
   };
+
+  return mergeConfigs(vitestConfig, options.vitest.overrides ?? {});
 }
 
 export default vitest;

package/src/{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/src/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/src/types/modules/react.d.ts

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

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

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

package/src/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/src/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;
+}