@fullstacksjs/eslint-config 14.5.0 → 14.7.0

package/src/modules/regex.mjs

@@ -1,16 +1,25 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import * as plugin from 'eslint-plugin-regexp';
 
+import { predicate } from '../utils/conditions.mjs';
+import { objectOrEmpty } from '../utils/objectOrEmpty.mjs';
+
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { Promise<import('eslint').Linter.Config> }
  */
 function regex(options = {}) {
-  return {
+  const isObject = typeof options.regex === 'object';
+  const overrides = objectOrEmpty(options.regex.overrides);
+
+  const regexConfig = {
     name: 'regex',
     plugins: { regexp: plugin },
     settings: {
       regexp: {
-        allowedCharacterRanges: options.regex.allowedCharacterRanges,
+        ...predicate(isObject && 'allowedCharacterRanges' in options.regex, {
+          allowedCharacterRanges: options.regex.allowedCharacterRanges,
+        }),
       },
     },
     rules: {
@@ -102,6 +111,8 @@ function regex(options = {}) {
       'no-empty-character-class': 'off',
     },
   };
+
+  return mergeConfigs(regexConfig, overrides);
 }
 
 export default regex;

package/src/modules/storybook.mjs

@@ -1,10 +1,17 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import plugin from 'eslint-plugin-storybook';
 
 import { globs } from '../utils/globs.mjs';
+import { objectOrEmpty } from '../utils/objectOrEmpty.mjs';
 
-/** @return { import('eslint').Linter.Config } */
-function storybook() {
-  return {
+/**
+ * @param { import('../types').Options } options
+ * @return { Promise<import('eslint').Linter.Config> }
+ */
+function storybook(options = {}) {
+  const overrides = objectOrEmpty(options.storybook.overrides);
+
+  const storybookConfig = {
     name: 'storybook',
     files: globs.storybook,
     plugins: { storybook: plugin },
@@ -33,6 +40,8 @@ function storybook() {
       'react-hooks/rules-of-hooks': 'off',
     },
   };
+
+  return mergeConfigs(storybookConfig, overrides);
 }
 
 export default storybook;

package/src/modules/stylistic.mjs

@@ -1,11 +1,16 @@
 import stylisticPlugin from '@stylistic/eslint-plugin';
+import { mergeConfigs } from 'eslint-flat-config-utils';
+
+import { objectOrEmpty } from '../utils/objectOrEmpty.mjs';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { Promise<import('eslint').Linter.Config> }
  */
-function stylistic() {
-  return {
+function stylistic(options = {}) {
+  const overrides = objectOrEmpty(options.stylistic.overrides);
+
+  const stylisticConfig = {
     name: 'stylistic',
     plugins: { '@stylistic': stylisticPlugin },
     rules: {
@@ -43,6 +48,7 @@ function stylistic() {
       ],
     },
   };
+  return mergeConfigs(stylisticConfig, overrides);
 }
 
 export default stylistic;

package/src/modules/tailwind.mjs

@@ -1,18 +1,28 @@
-import { strict } from '../utils/conditions.mjs';
+import { mergeConfigs } from 'eslint-flat-config-utils';
+
+import { predicate, strict } from '../utils/conditions.mjs';
+import { objectOrEmpty } from '../utils/objectOrEmpty.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 isObject = typeof options.tailwind === 'object';
+  const overrides = objectOrEmpty(options.tailwind.overrides);
+
+  const tailwindConfig = {
     name: 'tailwind',
     plugins: { 'better-tailwindcss': plugin.default ?? plugin },
     settings: {
       'better-tailwindcss': {
-        entryPoint: options.tailwind.entryPoint,
-        tailwindConfig: options.tailwind.tailwindConfig,
+        ...predicate(isObject && 'entryPoint' in options.tailwind, {
+          entryPoint: options.tailwind.entryPoint,
+        }),
+        ...predicate(isObject && 'tailwindConfig' in options.tailwind, {
+          tailwindConfig: options.tailwind.tailwindConfig,
+        }),
         callees: [
           ['^class|classnames|classNames|cva|ctl|clsx|cn|cns|cx|cc|clb|cnb|dcnb|objstr|tv|twJoin|twMerge$', [{ match: 'strings' }]],
         ],
@@ -35,6 +45,8 @@ async function tailwind(options = {}) {
       'better-tailwindcss/no-unnecessary-whitespace': 'warn',
     },
   };
+
+  return mergeConfigs(tailwindConfig, overrides);
 }
 
 export default tailwind;

package/src/modules/tests.mjs

@@ -1,16 +1,20 @@
 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';
+import { objectOrEmpty } from '../utils/objectOrEmpty.mjs';
 
 /**
- * @param { import('..').Options } options
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
 
 function tests(options = {}) {
-  return {
+  const overrides = objectOrEmpty(options.test.overrides);
+
+  const testsConfug = {
     name: 'tests',
     files: [...globs.test, ...globs.e2e],
     plugins: { vitest: plugin },
@@ -38,6 +42,8 @@ function tests(options = {}) {
       }),
     },
   };
+
+  return mergeConfigs(testsConfug, overrides);
 }
 
 export default tests;

package/src/modules/typescript.mjs

@@ -1,17 +1,20 @@
+import { mergeConfigs } from 'eslint-flat-config-utils';
 import { parser, plugin } from 'typescript-eslint';
 
 import { predicate, strict } from '../utils/conditions.mjs';
 import { globs } from '../utils/globs.mjs';
 import { namingConvention } from '../utils/naming-convention.mjs';
+import { objectOrEmpty } from '../utils/objectOrEmpty.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;
+  const overrides = objectOrEmpty(options.typescript.overrides);
 
-  return {
+  const typescriptConfig = {
     name: 'typescript',
     files: [globs.ts, globs.tsx],
     plugins: { '@typescript-eslint': plugin },
@@ -136,12 +139,9 @@ function typescript(options = {}) {
       '@typescript-eslint/promise-function-async': 'off', // Breaks react component when return type is React.ReactNode
       '@typescript-eslint/restrict-plus-operands': 'warn',
       '@typescript-eslint/strict-boolean-expressions': 'off', // Annoying
-      '@typescript-eslint/space-before-blocks': 'off',
 
       '@typescript-eslint/triple-slash-reference': 'error',
-      '@typescript-eslint/typedef': ['error', { parameter: false, arrowParameter: false, variableDeclaration: false }],
       '@typescript-eslint/unified-signatures': 'error',
-      '@typescript-eslint/key-spacing': 'off',
 
       ...predicate(projectService, {
         '@typescript-eslint/await-thenable': 'error',
@@ -226,7 +226,6 @@ function typescript(options = {}) {
       'import/namespace': 'off',
       'import/default': 'off',
       'import/no-named-as-default-member': 'off',
-      'key-spacing': 'off',
       'camelcase': 'off',
       'default-param-last': 'off',
       'init-declarations': 'off',
@@ -238,9 +237,6 @@ function typescript(options = {}) {
       'no-unused-vars': 'off',
       'no-use-before-define': 'off',
       'no-useless-constructor': 'off',
-      'object-curly-spacing': 'off',
-      'padding-line-between-statements': 'off',
-      'space-before-blocks': 'off',
       'dot-notation': 'off',
       'no-throw-literal': 'off',
       'require-await': 'off',
@@ -248,6 +244,8 @@ function typescript(options = {}) {
       'no-duplicate-imports': 'off',
     },
   };
+
+  return mergeConfigs(typescriptConfig, overrides);
 }
 
 export default typescript;

package/src/modules/vitest.mjs

@@ -1,12 +1,17 @@
 import plugin from '@vitest/eslint-plugin';
+import { mergeConfigs } from 'eslint-flat-config-utils';
 
 import { globs } from '../utils/globs.mjs';
+import { objectOrEmpty } from '../utils/objectOrEmpty.mjs';
 
 /**
+ * @param { import('../types').Options } options
  * @return { import('eslint').Linter.Config }
  */
-function vitest() {
-  return {
+function vitest(options = {}) {
+  const overrides = objectOrEmpty(options.vitest.overrides);
+
+  const vitestConfig = {
     name: 'vitest',
     files: globs.test,
     plugins: { vitest: plugin },
@@ -44,7 +49,6 @@ function vitest() {
       'vitest/no-conditional-in-test': 'off',
       'vitest/no-conditional-tests': 'warn',
       'vitest/no-disabled-tests': 'warn',
-      'vitest/no-done-callback': 'off',
       'vitest/no-duplicate-hooks': 'error',
       'vitest/no-focused-tests': 'warn',
       'vitest/no-hooks': 'off',
@@ -100,6 +104,8 @@ function vitest() {
       'vitest/warn-todo': 'warn',
     },
   };
+
+  return mergeConfigs(vitestConfig, 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,10 @@
+import type { ConfigWithOverrides } from '..';
+
+interface ReactOptions extends ConfigWithOverrides {
+  version?: string;
+  importSource?: string;
+  compilationMode?: 'all' | 'annotation' | 'infer' | 'syntax'; // Use the same compilationMode as the React Compiler config for consistent analysis
+  polymorphicPropName?: string;
+  additionalStateHooks?: string;
+  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,13 @@
+import type { ConfigWithOverrides } from '..';
+
+interface TailwindOptionsWithEntryPoint extends ConfigWithOverrides {
+  entryPoint: string;
+  tailwindConfig?: string;
+}
+
+interface TailwindOptionsWithConfig extends ConfigWithOverrides {
+  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;
+}

package/src/utils/nextAllowExportNames.mjs

@@ -0,0 +1,17 @@
+export const nextAllowExportNames = [
+  'experimental_ppr',
+  'dynamic',
+  'dynamicParams',
+  'revalidate',
+  'fetchCache',
+  'runtime',
+  'preferredRegion',
+  'maxDuration',
+  'metadata',
+  'generateMetadata',
+  'viewport',
+  'generateViewport',
+  'generateImageMetadata',
+  'generateSitemaps',
+  'generateStaticParams',
+];

package/src/utils/objectOrEmpty.mjs

@@ -0,0 +1,8 @@
+/**
+ * @template T
+ * @param {T | null | undefined} value
+ * @returns {T | {}}
+ */
+export function objectOrEmpty(value) {
+  return typeof value === 'object' && value !== null ? value : {};
+}