eslint-config-any 3.0.0-beta.2 → 3.0.0-beta.3

package/README.md

@@ -25,62 +25,62 @@ Requires **ESLint 10+** and **Node 22+**.
    ```
 
 2. Create a `eslint.config.mjs` file at project root.
-3. Write some boilerplate like below, selecting the presets you need:
+3. Write some boilerplate like below, selecting the configs you need:
 
    ```js
    // eslint.config.mjs
    import anyConfig from 'eslint-config-any';
 
    export default [
-     ...anyConfig.react,
-     ...anyConfig.vitest,
+     ...anyConfig.react(),
+     ...anyConfig.vitest(),
    ];
    ```
 
-## Which Presets I Can Pick?
+## Which configs can I pick?
 
 This package is designed to make you write the less code as possible, so you don't need to deal with scaffold-hell and learning how to setup a ESlint or Prettier configuration.
 
 With ESLint 10+ and its [Flat Configuration](https://eslint.org/blog/2022/08/new-config-system-part-1/), things got a little more complicated to setup, specially if you seek stricter rules for linting and formatting (like I do). However, things got way more flexible, allowing plugins and configs to apply only to certain files that actually use them for linting. For example, you'll only need `eslint-plugin-vue` for `*.vue` files, ot TypeScript-specific rules in files that actually use TS, and so on.
 
-So you'll' just need to select one generalized preset and make small compositions in a few cases.
+So you'll' just need to select one generalized config and make small compositions in a few cases.
 
-The current presets available are:
+The current configs available are:
 
 - `react`: for React projects, adding support not only for basic JS files but also TS, JSX and TSX extensions, as well as providing browser's global variables.
 - `next`: for Next.js projects. Includes the full `react` stack plus `@next/eslint-plugin-next` (`core-web-vitals`). **Don't select both `react` and `next`, as they overlap**.
 - `vue`: for Vue 3 projects, adding support not only for basic JS files but also TS and VUE extensions, as well as providing browser's global variables.
-- `vue2`: similar to `vue` option, except it contains some specific rules for Vue v2 only. **Don't select both presets, as they may conflict with each other**.
+- `vue2`: similar to `vue` option, except it contains some specific rules for Vue v2 only. **Don't select both configs, as they may conflict with each other**.
 - `browser`: if your project does not use nay of the previous frameworks and is meant to run in the client-side, that's the one to go with. It lints files with JS and TS extensions and provides browser's global variables.
-- `node`: if you're writing code for the server-side, use this preset to lint JS and TS files, as well as providing Node's global variables.
+- `node`: if you're writing code for the server-side, use this config to lint JS and TS files, as well as providing Node's global variables.
 - `sharedNodeAndBrowser`: if you're project targets browser and node environments, this not only lints JS and TS files, but also ensure you only use global variables that are available in both environments.
-- `commonjs`: all the presets above consider projects using ES Modules. But if you're using CommonJS, combine this option to make this standard compatible.
-- `jest`: if you're using Jest as test runner, add this preset in combination of another to allow Jest variables.
-- `vitest`: if you're using Vitest as test runner, add this preset in combination of another to allow Vitest variables.
+- `commonjs`: all the configs above consider projects using ES Modules. But if you're using CommonJS, combine this option to make this standard compatible.
+- `jest`: if you're using Jest as test runner, add this config in combination of another to allow Jest variables.
+- `vitest`: if you're using Vitest as test runner, add this config in combination of another to allow Vitest variables.
 
 ## Customization
 
-Not everyone follow the same rules. Uf you're project is one of these, you can enable disable rules by adding a new object to the configs array:
+Not everyone follow the same rules. If your project is one of these, pass overrides into a config factory or add a new object to your flat config array:
 
 ```js
 // eslint.config.mjs
 import anyConfig from 'eslint-config-any';
 
 export default [
-  ...anyConfig.node,
-  ...anyConfig.commonjs,
-  ...anyConfig.jest,
-  {
+  ...anyConfig.node({
     rules: {
       '@typescript-eslint/explicit-function-return-type': 'off',
       'no-console': 'off',
       'import-x/no-duplicates': 'off',
-      'jsx-a11y-x/no-autofocus': 'error',
     },
-  },
+  }),
+  ...anyConfig.commonjs(),
+  ...anyConfig.jest(),
 ];
 ```
 
+Config factories accept `{ files, ignores, rules, languageOptions, settings }`. Building blocks (`files`, `environments`, `plugins`, `rules`) are also on the default export if you want to compose your own stack.
+
 React/import/a11y/Next overrides use `@eslint-react/*`, `import-x/*`, `jsx-a11y-x/*`, and `@next/next/*` (not `react/*`, `react-hooks/*`, `import/*`, or `jsx-a11y/*`).
 
 If the Next app is not at the ESLint cwd (monorepo), set `settings.next.rootDir` in your config.
@@ -88,7 +88,7 @@ If the Next app is not at the ESLint cwd (monorepo), set `settings.next.rootDir`
 ## ESLint 10 notes
 
 - `eslint:recommended` now includes `no-unassigned-vars`, `no-useless-assignment`, and `preserve-caught-error`. This package leaves them on.
-- `/* eslint-env */` comments are errors; use `languageOptions.globals` or these presets.
+- `/* eslint-env */` comments are errors; use `languageOptions.globals` or these configs.
 - Config files are resolved from each linted file upward (monorepos: put `eslint.config.*` where the files live, or pass `--config`).
 - `.eslintignore` is gone; if you need gitignore-driven ignores, use `includeIgnoreFile()` from `eslint/config` in **your** config.
 - JSX components count as variable references (`no-unused-vars` / `no-undef`).

package/dist/index.js

@@ -1 +1,2 @@
-export { default } from '../src/configs/index.js';
+export { default } from '../src/index.js';
+export * from '../src/index.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-config-any",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.3",
   "description": "ESLint configuration for JavaScript, TypeScript, React, Next.js & Vue projects, by Julio L. Muller",
   "license": "MIT",
   "author": {
@@ -59,8 +59,8 @@
   },
   "dependencies": {
     "@eslint-community/eslint-plugin-eslint-comments": "~4.8.1",
-    "@eslint-react/eslint-plugin": "~5.20.8",
-    "@eslint-react/kit": "~5.20.8",
+    "@eslint-react/eslint-plugin": "~5.21.1",
+    "@eslint-react/kit": "~5.21.1",
     "@eslint/js": "^10.0.1",
     "@eslint/json": "~2.1.0",
     "@eslint/markdown": "~8.0.3",
@@ -86,10 +86,9 @@
     "@commitlint/config-conventional": "^21.2.3",
     "@commitlint/prompt-cli": "^21.2.3",
     "@types/bun": "^1.4.2",
-    "conventional-changelog-conventionalcommits": "^10.4.0",
     "eslint": "^10.11.0",
     "husky": "^9.1.7",
-    "lint-staged": "^17.5.1",
+    "lint-staged": "^17.6.0",
     "typescript": "~6.0.3"
   }
 }

package/src/configs/browser.js

@@ -0,0 +1,7 @@
+import * as environments from '../environments/index.js';
+import { createConfig } from './create-config.js';
+
+export default createConfig({
+  name: 'any/browser',
+  extends: [environments.browser],
+});

package/src/configs/commonjs.js

@@ -0,0 +1,11 @@
+import * as environments from '../environments/index.js';
+import * as files from '../files/index.js';
+import * as rules from '../rules/index.js';
+import { createAddonConfig } from './create-config.js';
+
+export default createAddonConfig({
+  name: 'any/commonjs',
+  files: files.cjs,
+  extends: [environments.commonjs],
+  rules: rules.commonjs,
+});

package/src/configs/create-config.js

@@ -0,0 +1,186 @@
+import { defineConfig, globalIgnores } from 'eslint/config';
+
+import * as environments from '../environments/index.js';
+import * as files from '../files/index.js';
+import * as plugins from '../plugins/index.js';
+import * as rules from '../rules/index.js';
+
+/**
+ * @typedef {import('eslint').Linter.Config} EslintConfig
+ *
+ * @typedef {import('eslint').Linter.RulesRecord} EslintRules
+ *
+ * @typedef {Object} ConfigOptions
+ * @property {string[]} [files]
+ * @property {string[]} [ignores]
+ * @property {EslintRules} [rules]
+ * @property {EslintConfig['languageOptions']} [languageOptions]
+ * @property {Record<string, unknown>} [settings]
+ *
+ * @typedef {Object} CreateConfigInput
+ * @property {string} name
+ * @property {string[]} [files]
+ * @property {string[]} [typescriptFiles]
+ * @property {EslintConfig[]} [extends]
+ * @property {EslintRules} [rules]
+ * @property {EslintConfig[]} [extraLayers]
+ *
+ * @typedef {Object} CreateAddonConfigInput
+ * @property {string} name
+ * @property {string[]} files
+ * @property {EslintConfig[]} extends
+ * @property {EslintRules} [rules]
+ */
+
+export const basePlugins = [
+  plugins.jsConfigs,
+  plugins.eslintCommentsConfigs,
+  plugins.arrayFuncConfigs,
+  plugins.importXConfigs,
+  plugins.importHelpersConfigs,
+  plugins.perfectionistConfigs,
+  plugins.regexpConfigs,
+  plugins.stylisticConfigs,
+];
+
+export const baseRules = {
+  ...rules.js,
+  ...rules.arrayFunc,
+  ...rules.importX,
+  ...rules.importHelpers,
+  ...rules.perfectionist,
+  ...rules.stylistic,
+};
+
+/**
+ * @param {EslintConfig} config
+ * @param {ConfigOptions} options
+ * @returns {EslintConfig}
+ */
+function applyOverrides(config, options) {
+  const nextConfig = { ...config };
+
+  if (options.languageOptions) {
+    nextConfig.languageOptions = options.languageOptions;
+  }
+
+  if (options.settings) {
+    nextConfig.settings = options.settings;
+  }
+
+  return nextConfig;
+}
+
+/**
+ * @param {CreateConfigInput} input
+ * @returns {(options?: ConfigOptions) => ReturnType<typeof defineConfig>}
+ */
+export function createConfig({
+  name,
+  files: defaultFiles = files.scripts,
+  typescriptFiles = files.typescript,
+  extends: extraExtends = [],
+  rules: extraRules = {},
+  extraLayers = [],
+}) {
+  /**
+   * @param {ConfigOptions} [options]
+   */
+  return function config(options = {}) {
+    const scriptFiles = options.files ?? defaultFiles;
+    const scriptLayer = applyOverrides(
+      {
+        name,
+        files: scriptFiles,
+        extends: [...basePlugins, ...extraExtends],
+        rules: { ...baseRules, ...extraRules },
+      },
+      options,
+    );
+
+    const configs = [
+      globalIgnores(options.ignores ?? files.ignores),
+      {
+        name: 'any/json',
+        files: files.json,
+        extends: [plugins.jsonConfigs.json],
+      },
+      {
+        name: 'any/jsonc',
+        files: files.jsonc,
+        extends: [plugins.jsonConfigs.jsonc],
+      },
+      {
+        name: 'any/json5',
+        files: files.json5,
+        extends: [plugins.jsonConfigs.json5],
+      },
+      {
+        name: 'any/markdown',
+        files: files.markdown,
+        extends: [plugins.markdownConfigs],
+      },
+      scriptLayer,
+      {
+        name: 'any/typescript',
+        files: typescriptFiles,
+        extends: [plugins.typescriptConfigs],
+        rules: rules.typescript,
+      },
+      ...extraLayers,
+      {
+        name: 'any/cjs',
+        files: ['**/*.cjs'],
+        extends: [environments.commonjs],
+        rules: rules.commonjs,
+      },
+      {
+        name: 'any/prettier',
+        extends: [plugins.prettierConfigs],
+        rules: rules.prettier,
+      },
+    ];
+
+    if (options.rules) {
+      configs.push({
+        name: `${name}/overrides`,
+        files: scriptFiles,
+        rules: options.rules,
+      });
+    }
+
+    return defineConfig(configs);
+  };
+}
+
+/**
+ * @param {CreateAddonConfigInput} input
+ * @returns {(options?: ConfigOptions) => ReturnType<typeof defineConfig>}
+ */
+export function createAddonConfig({
+  name,
+  files: defaultFiles,
+  extends: addonExtends,
+  rules: addonRules = {},
+}) {
+  /**
+   * @param {ConfigOptions} [options]
+   */
+  return function config(options = {}) {
+    const config = applyOverrides(
+      {
+        name,
+        files: options.files ?? defaultFiles,
+        extends: addonExtends,
+        rules: { ...addonRules, ...options.rules },
+      },
+      options,
+    );
+
+    if (options.ignores) {
+      return defineConfig([globalIgnores(options.ignores), config]);
+    }
+
+    return defineConfig(config);
+  };
+}

package/src/configs/index.js

@@ -1,47 +1,25 @@
-import jsConfigs from './base/index.js';
-import envConfigs from './env/index.js';
-import nextConfigs from './next/index.js';
-import prettierConfigs from './prettier/index.js';
-import reactConfigs from './react/index.js';
-import tsConfigs from './typescript/index.js';
-import vueConfigs from './vue/index.js';
+import browser from './browser.js';
+import commonjs from './commonjs.js';
+import jest from './jest.js';
+import next from './next.js';
+import node from './node.js';
+import react from './react.js';
+import sharedNodeAndBrowser from './sharedNodeAndBrowser.js';
+import vitest from './vitest.js';
+import vue from './vue.js';
+import vue2 from './vue2.js';
 
-/**
- * @typedef {import('eslint/config').ConfigObject[]} EslintFlatConfig
- *
- * @typedef {Object} EslintFlatConfigSetup
- * @property {EslintFlatConfig} commonjs
- * @property {EslintFlatConfig} jest
- * @property {EslintFlatConfig} vitest
- * @property {EslintFlatConfig} node
- * @property {EslintFlatConfig} browser
- * @property {EslintFlatConfig} sharedNodeAndBrowser
- * @property {EslintFlatConfig} react
- * @property {EslintFlatConfig} next
- * @property {EslintFlatConfig} vue
- * @property {EslintFlatConfig} vue2
- */
+export { browser, commonjs, jest, next, node, react, sharedNodeAndBrowser, vitest, vue, vue2 };
 
-/**
- * @param {EslintFlatConfig} otherConfigs
- * @returns {EslintFlatConfig}
- */
-function mergeConfigs(otherConfigs) {
-  return [...jsConfigs, ...tsConfigs, ...otherConfigs, ...prettierConfigs];
-}
-
-/**
- * @type {EslintFlatConfigSetup}
- */
 export default {
-  commonjs: envConfigs.commonjs,
-  jest: envConfigs.jest,
-  vitest: envConfigs.vitest,
-  node: mergeConfigs(envConfigs.node),
-  browser: mergeConfigs(envConfigs.browser),
-  sharedNodeAndBrowser: mergeConfigs(envConfigs.sharedNodeAndBrowser),
-  react: mergeConfigs(reactConfigs),
-  next: mergeConfigs(nextConfigs),
-  vue: mergeConfigs(vueConfigs.vue3),
-  vue2: mergeConfigs(vueConfigs.vue2),
+  browser,
+  commonjs,
+  jest,
+  next,
+  node,
+  react,
+  sharedNodeAndBrowser,
+  vitest,
+  vue,
+  vue2,
 };

package/src/configs/jest.js

@@ -0,0 +1,9 @@
+import * as environments from '../environments/index.js';
+import * as files from '../files/index.js';
+import { createAddonConfig } from './create-config.js';
+
+export default createAddonConfig({
+  name: 'any/jest',
+  files: files.test,
+  extends: [environments.jest],
+});

package/src/configs/next.js

@@ -0,0 +1,17 @@
+import * as environments from '../environments/index.js';
+import * as plugins from '../plugins/index.js';
+import { createConfig } from './create-config.js';
+import { reactExtraLayers, reactScriptFiles } from './react.js';
+
+export default createConfig({
+  name: 'any/next',
+  extends: [environments.browser],
+  extraLayers: [
+    ...reactExtraLayers,
+    {
+      name: 'any/next',
+      files: reactScriptFiles,
+      extends: [plugins.nextConfigs],
+    },
+  ],
+});

package/src/configs/node.js

@@ -0,0 +1,7 @@
+import * as environments from '../environments/index.js';
+import { createConfig } from './create-config.js';
+
+export default createConfig({
+  name: 'any/node',
+  extends: [environments.node],
+});

package/src/configs/react.js

@@ -0,0 +1,32 @@
+import * as environments from '../environments/index.js';
+import * as files from '../files/index.js';
+import * as plugins from '../plugins/index.js';
+import * as rules from '../rules/index.js';
+import { createConfig } from './create-config.js';
+
+export const reactScriptFiles = [...files.js, ...files.ts];
+
+export const reactExtraLayers = [
+  {
+    name: 'any/react/js',
+    files: files.js,
+    extends: [plugins.reactConfigs.strict],
+  },
+  {
+    name: 'any/react/ts',
+    files: files.ts,
+    extends: [plugins.reactConfigs.strictTypeChecked],
+  },
+  {
+    name: 'any/react/shared',
+    files: reactScriptFiles,
+    extends: [plugins.reactConfigs.kit, plugins.jsxA11yXConfigs],
+    rules: rules.react,
+  },
+];
+
+export default createConfig({
+  name: 'any/react',
+  extends: [environments.browser],
+  extraLayers: reactExtraLayers,
+});

package/src/configs/sharedNodeAndBrowser.js

@@ -0,0 +1,7 @@
+import * as environments from '../environments/index.js';
+import { createConfig } from './create-config.js';
+
+export default createConfig({
+  name: 'any/shared-node-and-browser',
+  extends: [environments.sharedNodeAndBrowser],
+});

package/src/configs/vitest.js

@@ -0,0 +1,9 @@
+import * as environments from '../environments/index.js';
+import * as files from '../files/index.js';
+import { createAddonConfig } from './create-config.js';
+
+export default createAddonConfig({
+  name: 'any/vitest',
+  files: files.test,
+  extends: [environments.vitest],
+});

package/src/configs/vue.js

@@ -0,0 +1,19 @@
+import * as environments from '../environments/index.js';
+import * as files from '../files/index.js';
+import * as plugins from '../plugins/index.js';
+import * as rules from '../rules/index.js';
+import { createConfig } from './create-config.js';
+
+export default createConfig({
+  name: 'any/vue',
+  files: files.scriptsAndVue,
+  typescriptFiles: files.typescriptAndVue,
+  extraLayers: [
+    {
+      name: 'any/vue',
+      files: files.vue,
+      extends: [environments.browser, plugins.Configs.parser, plugins.Configs.vue3],
+      rules: { ...rules.vue, ...rules.vue3 },
+    },
+  ],
+});

package/src/configs/vue2.js

@@ -0,0 +1,19 @@
+import * as environments from '../environments/index.js';
+import * as files from '../files/index.js';
+import * as plugins from '../plugins/index.js';
+import * as rules from '../rules/index.js';
+import { createConfig } from './create-config.js';
+
+export default createConfig({
+  name: 'any/vue2',
+  files: files.scriptsAndVue,
+  typescriptFiles: files.typescriptAndVue,
+  extraLayers: [
+    {
+      name: 'any/vue2',
+      files: files.vue,
+      extends: [environments.browser, plugins.Configs.parser, plugins.Configs.vue2],
+      rules: { ...rules.vue, ...rules.vue2 },
+    },
+  ],
+});

package/src/environments/browser.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig({
+  languageOptions: {
+    globals: globals.browser,
+  },
+});

package/src/environments/commonjs.js

@@ -0,0 +1,7 @@
+import { defineConfig } from 'eslint/config';
+
+export default defineConfig({
+  languageOptions: {
+    sourceType: 'commonjs',
+  },
+});

package/src/environments/index.js

@@ -0,0 +1,17 @@
+import browser from './browser.js';
+import commonjs from './commonjs.js';
+import jest from './jest.js';
+import node from './node.js';
+import sharedNodeAndBrowser from './sharedNodeAndBrowser.js';
+import vitest from './vitest.js';
+
+export { browser, commonjs, jest, node, sharedNodeAndBrowser, vitest };
+
+export default {
+  browser,
+  commonjs,
+  jest,
+  node,
+  sharedNodeAndBrowser,
+  vitest,
+};

package/src/environments/jest.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig({
+  languageOptions: {
+    globals: globals.jest,
+  },
+});

package/src/environments/node.js

@@ -0,0 +1,11 @@
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig({
+  languageOptions: {
+    globals: {
+      ...globals.node,
+      Bun: true,
+    },
+  },
+});

package/src/environments/sharedNodeAndBrowser.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig({
+  languageOptions: {
+    globals: globals['shared-node-browser'],
+  },
+});

package/src/environments/vitest.js

@@ -0,0 +1,8 @@
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig({
+  languageOptions: {
+    globals: globals.vitest,
+  },
+});

package/src/files/ignores.js

@@ -0,0 +1,10 @@
+export default [
+  '**/node_modules/**',
+  '**/build/**',
+  '**/dist/**',
+  '**/out/**',
+  '**/coverage/**',
+  '**/*.min.js',
+  '**/.next/**',
+  '**/next-env.d.ts',
+];

package/src/files/index.js

@@ -0,0 +1,34 @@
+import { CJS, DTS, JS, JSON, JSON5, JSONC, TEST, TS, VUE } from './extensions.js';
+import { FileExtensionsSet } from './file-extensions-set.js';
+import { toBlob, toDotted } from './helpers.js';
+import ignores from './ignores.js';
+
+export {
+  CJS,
+  DTS,
+  FileExtensionsSet,
+  ignores,
+  JS,
+  JSON,
+  JSON5,
+  JSONC,
+  TEST,
+  toBlob,
+  toDotted,
+  TS,
+  VUE,
+};
+
+export const scripts = toBlob(JS, TS, DTS);
+export const scriptsAndVue = toBlob(JS, TS, DTS, VUE);
+export const typescript = toBlob(TS, DTS);
+export const typescriptAndVue = toBlob(TS, DTS, VUE);
+export const js = JS.toBlobArray();
+export const ts = TS.toBlobArray();
+export const vue = VUE.toBlobArray();
+export const json = JSON.toBlobArray();
+export const jsonc = JSONC.toBlobArray();
+export const json5 = JSON5.toBlobArray();
+export const markdown = ['**/*.md'];
+export const test = toBlob(TEST);
+export const cjs = toBlob(CJS);