@ololoepepe/eslint-config 0.0.21 → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,52 @@
+# Changelog
+
+All notable changes to this project are documented in this file. The format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this
+project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-06-30
+
+A major modernization of the config. **This release contains breaking changes.**
+
+### Changed
+
+- **BREAKING:** The package is now **ESM** (`"type": "module"`). Use an ESM
+  `eslint.config.js`. CommonJS consumers on Node.js ≥ 22 can still load it via
+  `require()` (`require(ESM)` support).
+- **BREAKING:** Migrated to ESLint's **flat config** format; the legacy
+  `.eslintrc` format is no longer supported.
+- **BREAKING:** Now requires **ESLint ≥ 10** and **Node.js ≥ 24.11**.
+- Formatting rules are now provided by
+  [`@stylistic/eslint-plugin`](https://eslint.style/) (they were removed from
+  ESLint core).
+- Import rules now come from
+  [`eslint-plugin-import-x`](https://github.com/un-ts/eslint-plugin-import-x)
+  (a maintained, ESLint-10-compatible fork of `eslint-plugin-import`).
+- Updated all dependencies to their latest major versions.
+
+### Added
+
+- **`@ololoepepe/eslint-config/node`** entry point — the base plus Node globals
+  and [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n).
+- **`@ololoepepe/eslint-config/react`** entry point — the base plus
+  [`@eslint-react`](https://eslint-react.xyz/),
+  [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks),
+  and JSX formatting via `@stylistic`. This supersedes the standalone
+  `@ololoepepe/eslint-config-react` package and targets modern function
+  components. (`eslint-plugin-react` was dropped: it does not support ESLint 10,
+  whereas `@eslint-react` is flat-config/v10-native.)
+- New plugins on the base layer:
+  [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn),
+  [`eslint-plugin-regexp`](https://github.com/ota-meshi/eslint-plugin-regexp),
+  [`eslint-plugin-promise`](https://github.com/eslint-community/eslint-plugin-promise),
+  and
+  [`@eslint-community/eslint-plugin-eslint-comments`](https://github.com/eslint-community/eslint-plugin-eslint-comments).
+- A rule-audit script and generated positive/negative test fixtures that
+  exercise the configured rules across the base, node, and react layers.
+
+### Fixed
+
+- JSX parsing in the base config: `@babel/eslint-parser@8` no longer enables JSX
+  via `ecmaFeatures.jsx` alone; it now uses `babelOptions.parserOpts.plugins`.
+
+[0.1.0]: https://gitlab.void-walkers.com/libs/eslint-config/-/releases/v0.1.0

package/README.md

@@ -1 +1,127 @@
-# ESLint config
+# @ololoepepe/eslint-config
+
+A shareable [ESLint](https://eslint.org/) configuration for JavaScript projects.
+
+It aims to **cover as many cases as possible** and to enforce a **single,
+unambiguous code style** wherever a clear "right answer" exists — leaving a rule
+off only when the preferred style genuinely depends on context, or when a
+compromise is worth it for ergonomics.
+
+The config is heavily inspired by [XO](https://github.com/xojs/xo), but it is
+more explicit (every available rule is configured, including the ones turned
+off) and it differs from XO in a number of opinionated choices.
+
+## Highlights
+
+- **Flat config** (ESLint's modern format) — exported as a config array.
+- **ESLint 10** with all formatting rules provided by
+  [`@stylistic/eslint-plugin`](https://eslint.style/).
+- **Import hygiene** via
+  [`eslint-plugin-import-x`](https://github.com/un-ts/eslint-plugin-import-x).
+- **Promise / async correctness** via
+  [`eslint-plugin-promise`](https://github.com/eslint-community/eslint-plugin-promise).
+- **Regex correctness & style** via
+  [`eslint-plugin-regexp`](https://github.com/ota-meshi/eslint-plugin-regexp).
+- **Modern idioms & a large catch-all of correctness rules** via
+  [`eslint-plugin-unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn).
+- **React** (opt-in `/react` layer) via
+  [`@eslint-react`](https://eslint-react.xyz/) and the official
+  [`eslint-plugin-react-hooks`](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks).
+- **Disciplined `eslint-disable` comments** via
+  [`@eslint-community/eslint-plugin-eslint-comments`](https://github.com/eslint-community/eslint-plugin-eslint-comments).
+- **Sorted object keys** via
+  [`eslint-plugin-sort-keys-shorthand`](https://github.com/leonardovillela/eslint-plugin-sort-keys-shorthand).
+- **Modern + JSX syntax** parsing via
+  [`@babel/eslint-parser`](https://github.com/babel/babel/tree/main/eslint/babel-eslint-parser),
+  so the config works as a base for frontend (JSX) configs as well.
+
+## Config entry points
+
+The package is **environment-neutral by default** and ships environment layers
+on top of it:
+
+- **`@ololoepepe/eslint-config`** — the base config. Language + style + import +
+  promise + correctness rules. No environment globals beyond standard ES, no
+  Node- or browser-specific rules. Use this directly for environment-agnostic
+  code, or as the base for an environment-specific config (e.g. a frontend/JSX
+  config that adds browser globals and React rules).
+- **`@ololoepepe/eslint-config/node`** — the base **plus** a Node layer: Node
+  globals and [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n).
+  Use this for Node.js libraries and applications.
+- **`@ololoepepe/eslint-config/react`** — the base **plus** a React layer:
+  browser globals, [`@eslint-react`](https://eslint-react.xyz/),
+  `eslint-plugin-react-hooks`, and JSX formatting via `@stylistic`. Targets
+  modern function components and lints `.jsx` files. (TypeScript / `.tsx` is a
+  separate config; `@eslint-react` pulls in `typescript` as a peer dependency.)
+
+## Requirements
+
+- ESLint `>= 10`
+- Node.js `>= 24.11`
+
+## Installation
+
+```sh
+npm install --save-dev @ololoepepe/eslint-config
+```
+
+## Usage
+
+This package is **ESM**. Each entry point exports a flat-config array — spread it
+into your own `eslint.config.js` and add any project-specific overrides
+afterwards.
+
+For a **Node.js** project:
+
+```js
+// eslint.config.js
+import ololoepepe from '@ololoepepe/eslint-config/node';
+
+export default [
+  ...ololoepepe,
+  {
+    // Your project-specific overrides.
+    rules: {}
+  }
+];
+```
+
+For a **React** project:
+
+```js
+// eslint.config.js
+import ololoepepe from '@ololoepepe/eslint-config/react';
+
+export default [
+  ...ololoepepe,
+  {
+    // Your project-specific overrides.
+    rules: {}
+  }
+];
+```
+
+For an **environment-agnostic** project, or as the base for another config,
+import `@ololoepepe/eslint-config` instead and add the environment globals and
+rules your project needs.
+
+> CommonJS consumers on Node.js ≥ 22 can still load it via `require()`
+> (`require(ESM)` is supported), but an ESM `eslint.config.js` is recommended.
+
+## Conventions
+
+A few of the style choices the config enforces:
+
+- 2-space indentation, Unix line endings, semicolons always, single quotes.
+- Max line length of 120.
+- Object keys sorted (natural, case-insensitive, shorthand first).
+- Imports ordered and grouped, no duplicates, no unresolved.
+- `const` over `let`, never `var`; arrow callbacks; template strings over
+  concatenation.
+
+JSX-specific layout rules and TypeScript-specific rules are intentionally left
+off here — they belong in the downstream configs that build on this base.
+
+## License
+
+UNLICENSED — private package.

package/package.json

@@ -1,10 +1,21 @@
 {
   "name": "@ololoepepe/eslint-config",
-  "version": "0.0.21",
+  "version": "0.1.0",
   "description": "ESLint config",
+  "type": "module",
   "main": "src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./node": "./src/node.js",
+    "./react": "./src/react.js"
+  },
+  "imports": {
+    "#src/*": "./src/*"
+  },
+  "engines": {
+    "node": ">=24.11"
+  },
   "scripts": {
-    "find-rules": "eslint-find-rules --unused ./src/index.js",
     "lint": "eslint ./src",
     "test": "mocha ./test/*"
   },
@@ -14,7 +25,8 @@
   "files": [
     "src",
     "package.json",
-    "README.md"
+    "README.md",
+    "CHANGELOG.md"
   ],
   "repository": {
     "type": "git",
@@ -27,14 +39,22 @@
   },
   "homepage": "https://gitlab.void-walkers.com/libs/eslint-config#README",
   "dependencies": {
-    "@babel/core": "7.27.1",
-    "@babel/eslint-parser": "^7.27.1",
-    "eslint": "^8.57.1",
-    "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-sort-keys-shorthand": "^2.3.0"
+    "@babel/core": "^8.0.1",
+    "@babel/eslint-parser": "^8.0.1",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
+    "@eslint-react/eslint-plugin": "^5.10.0",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint": "^10.6.0",
+    "eslint-plugin-import-x": "^4.17.1",
+    "eslint-plugin-n": "^18.2.1",
+    "eslint-plugin-promise": "^7.3.0",
+    "eslint-plugin-react-hooks": "^7.1.1",
+    "eslint-plugin-regexp": "^3.1.1",
+    "eslint-plugin-sort-keys-shorthand": "^5.1.0",
+    "eslint-plugin-unicorn": "^69.0.0",
+    "globals": "^17.7.0"
   },
   "devDependencies": {
-    "eslint-find-rules": "^5.0.0",
-    "mocha": "^11.4.0"
+    "mocha": "^11.7.6"
   }
 }

package/src/index.js

@@ -1,304 +1,65 @@
-const {rules: pluginImportRules} = require('./plugins/import');
-const {rules: pluginSortKeysShorthandRules} = require('./plugins/sort-keys-shorthand');
-const rulesNo = require('./rules/no');
+import babelParser from '@babel/eslint-parser';
+import eslintComments from '@eslint-community/eslint-plugin-eslint-comments';
+import stylistic from '@stylistic/eslint-plugin';
+import importPlugin from 'eslint-plugin-import-x';
+import promise from 'eslint-plugin-promise';
+import regexp from 'eslint-plugin-regexp';
+import sortKeysShorthand from 'eslint-plugin-sort-keys-shorthand';
+import unicorn from 'eslint-plugin-unicorn';
+import globals from 'globals';
 
-module.exports = {
-  env: {
-    es2021: true,
-    node: true
-  },
-  parser: '@babel/eslint-parser',
-  parserOptions: {
-    ecmaFeatures: {
-      jsx: true
-    },
+import {rules as pluginEslintCommentsRules} from '#src/plugins/eslint-comments.js';
+import {rules as pluginImportXRules} from '#src/plugins/import-x.js';
+import {rules as pluginPromiseRules} from '#src/plugins/promise.js';
+import {rules as pluginRegexpRules} from '#src/plugins/regexp.js';
+import {rules as pluginSortKeysShorthandRules} from '#src/plugins/sort-keys-shorthand.js';
+import {rules as pluginStylisticRules} from '#src/plugins/stylistic.js';
+import {rules as pluginUnicornRules} from '#src/plugins/unicorn.js';
+import {rules as rulesCore} from '#src/rules/core.js';
+import {rules as rulesNo} from '#src/rules/no.js';
+
+export default [{
+  languageOptions: {
     ecmaVersion: 'latest',
-    requireConfigFile: false,
+    globals: {
+      ...globals.es2021
+    },
+    parser: babelParser,
+    parserOptions: {
+      babelOptions: {
+        parserOpts: {
+          plugins: ['jsx']
+        }
+      },
+      ecmaFeatures: {
+        jsx: true
+      },
+      requireConfigFile: false
+    },
     sourceType: 'module'
   },
-  plugins: ['import', 'sort-keys-shorthand'],
+  linterOptions: {
+    reportUnusedDisableDirectives: 'error'
+  },
+  name: '@ololoepepe/eslint-config',
+  plugins: {
+    promise,
+    regexp,
+    unicorn,
+    '@eslint-community/eslint-comments': eslintComments,
+    '@stylistic': stylistic,
+    'import-x': importPlugin,
+    'sort-keys-shorthand': sortKeysShorthand
+  },
   rules: {
-    'accessor-pairs': ['warn', {
-      enforceForClassMembers: true,
-      getWithoutSet: false,
-      setWithoutGet: true
-    }],
-    'array-bracket-newline': ['error', 'consistent'],
-    'array-bracket-spacing': ['error', 'never', {
-      arraysInArrays: false,
-      objectsInArrays: false,
-      singleValue: false
-    }],
-    'array-callback-return': ['error', {
-      allowImplicit: false,
-      checkForEach: false
-    }],
-    'array-element-newline': ['error', 'consistent'],
-    'arrow-body-style': ['error', 'as-needed'],
-    'arrow-parens': ['error', 'as-needed', {
-      requireForBlockBody: false
-    }],
-    'arrow-spacing': ['error', {
-      after: true,
-      before: true
-    }],
-    'block-scoped-var': 'error',
-    'block-spacing': ['error', 'always'],
-    'brace-style': ['error', '1tbs', {
-      allowSingleLine: false
-    }],
-    camelcase: ['error', {
-      ignoreDestructuring: false,
-      ignoreGlobals: true,
-      ignoreImports: false,
-      properties: 'never'
-    }],
-    'capitalized-comments': ['error', 'always', {
-      ignoreConsecutiveComments: true,
-      ignoreInlineComments: false,
-      ignorePattern: 'webpackChunkName'
-    }],
-    'class-methods-use-this': 'off',
-    'comma-dangle': ['error', 'never'],
-    'comma-spacing': ['error', {
-      after: true,
-      before: false
-    }],
-    'comma-style': ['error', 'last'],
-    complexity: ['warn', 20],
-    'computed-property-spacing': ['error', 'never', {
-      enforceForClassMembers: true
-    }],
-    'consistent-return': 'off',
-    'consistent-this': ['error', 'self'],
-    'constructor-super': 'error',
-    curly: ['error', 'all'],
-    'default-case': ['error', {
-      commentPattern: '^skip\\sdefault'
-    }],
-    'default-case-last': 'error',
-    'default-param-last': 'error',
-    'dot-location': ['error', 'property'],
-    'dot-notation': ['error', {
-      allowKeywords: true
-    }],
-    'eol-last': ['error', 'always'],
-    eqeqeq: ['error', 'always'],
-    'for-direction': 'error',
-    'func-call-spacing': ['error', 'never'],
-    'func-name-matching': ['warn', 'always'],
-    'func-names': ['error', 'never', {
-      generators: 'never'
-    }],
-    'func-style': ['error', 'declaration', {
-      allowArrowFunctions: true
-    }],
-    'function-call-argument-newline': ['error', 'consistent'],
-    'function-paren-newline': ['error', 'multiline-arguments'],
-    'generator-star-spacing': ['error', {
-      after: true,
-      before: true
-    }],
-    'getter-return': ['error', {
-      allowImplicit: false
-    }],
-    'grouped-accessor-pairs': ['error', 'getBeforeSet'],
-    'guard-for-in': 'error',
-    'id-denylist': 'off',
-    'id-length': 'off',
-    'id-match': 'off',
-    'implicit-arrow-linebreak': ['error', 'beside'],
-    indent: ['error', 2],
-    'init-declarations': ['error', 'always'],
-    'jsx-quotes': ['error', 'prefer-double'],
-    'key-spacing': ['error', {
-      afterColon: true,
-      beforeColon: false
-    }],
-    'keyword-spacing': ['error', {
-      after: true,
-      before: true
-    }],
-    'line-comment-position': 'off',
-    'linebreak-style': ['error', 'unix'],
-    'lines-around-comment': 'off',
-    'lines-between-class-members': ['error', 'always', {
-      exceptAfterSingleLine: true
-    }],
-    'logical-assignment-operators': ['error', 'always', {
-      enforceForIfStatements: false
-    }],
-    'max-classes-per-file': 'off',
-    'max-depth': ['warn', 5],
-    'max-len': ['error', {
-      code: 120,
-      comments: 120,
-      ignoreComments: false,
-      ignoreRegExpLiterals: false,
-      ignoreStrings: false,
-      ignoreTemplateLiterals: false,
-      ignoreTrailingComments: false,
-      ignoreUrls: false,
-      tabWidth: 2
-    }],
-    'max-lines': ['warn', {
-      max: 500,
-      skipBlankLines: true,
-      skipComments: true
-    }],
-    'max-lines-per-function': ['warn', {
-      IIFEs: true,
-      max: 100,
-      skipBlankLines: true,
-      skipComments: true
-    }],
-    'max-nested-callbacks': ['warn', 5],
-    'max-params': ['warn', 4],
-    'max-statements': 'off',
-    'max-statements-per-line': ['error', {
-      max: 1
-    }],
-    'multiline-comment-style': 'off',
-    'multiline-ternary': 'off',
-    'new-cap': ['error', {
-      capIsNew: true,
-      newIsCap: true,
-      properties: true
-    }],
-    'new-parens': ['error', 'always'],
-    'newline-per-chained-call': ['error', {
-      ignoreChainWithDepth: 3
-    }],
-    'nonblock-statement-body-position': 'off',
-    'object-curly-newline': 'off',
-    'object-curly-spacing': ['error', 'never', {
-      arraysInObjects: false,
-      objectsInObjects: false
-    }],
-    'object-property-newline': 'off', // Reconsider
-    'object-shorthand': ['error', 'always', {
-      avoidExplicitReturnArrows: false,
-      avoidQuotes: true,
-      ignoreConstructors: false
-    }],
-    'one-var': ['error', 'never'],
-    'one-var-declaration-per-line': 'off',
-    'operator-assignment': ['error', 'always'],
-    'operator-linebreak': ['error', 'after'],
-    'padded-blocks': ['error', 'never', {
-      allowSingleLineBlocks: false
-    }],
-    'padding-line-between-statements': ['error', {
-      blankLine: 'always',
-      next: '*',
-      prev: 'multiline-block-like'
-    }],
-    'prefer-arrow-callback': ['error', {
-      allowNamedFunctions: false,
-      allowUnboundThis: true
-    }],
-    'prefer-const': ['error', {
-      destructuring: 'all',
-      ignoreReadBeforeAssign: true
-    }],
-    'prefer-destructuring': ['error', {
-      array: true,
-      object: true
-    }, {
-      enforceForRenamedProperties: false
-    }],
-    'prefer-exponentiation-operator': 'error',
-    'prefer-named-capture-group': 'warn',
-    'prefer-numeric-literals': 'error',
-    'prefer-object-has-own': 'off',
-    'prefer-object-spread': 'error',
-    'prefer-promise-reject-errors': ['error', {
-      allowEmptyReject: false
-    }],
-    'prefer-regex-literals': ['error', {
-      disallowRedundantWrapping: true
-    }],
-    'prefer-rest-params': 'error',
-    'prefer-spread': 'error',
-    'prefer-template': 'error',
-    'quote-props': ['error', 'as-needed', {
-      keywords: false,
-      numbers: true,
-      unnecessary: true
-    }],
-    quotes: ['error', 'single', {
-      allowTemplateLiterals: false,
-      avoidEscape: true
-    }],
-    radix: ['error', 'as-needed'],
-    'require-atomic-updates': 'error',
-    'require-await': 'error',
-    'require-unicode-regexp': 'error',
-    'require-yield': 'off',
-    'rest-spread-spacing': ['error', 'never'],
-    semi: ['error', 'always', {
-      omitLastInOneLineBlock: false
-    }],
-    'semi-spacing': ['error', {
-      after: true,
-      before: false
-    }],
-    'semi-style': ['error', 'last'],
-    'sort-imports': 'off',
-    'sort-keys': 'off',
-    'sort-vars': ['error', {
-      ignoreCase: true
-    }],
-    'space-before-blocks': ['error', 'always'],
-    'space-before-function-paren': ['error', {
-      anonymous: 'always',
-      asyncArrow: 'always',
-      named: 'never'
-    }],
-    'space-in-parens': ['error', 'never'],
-    'space-infix-ops': ['error', {
-      int32Hint: false
-    }],
-    'space-unary-ops': ['error', {
-      nonwords: false,
-      words: true
-    }],
-    'spaced-comment': ['error', 'always', {
-      block: {
-        balanced: true,
-        exceptions: ['-', '+', '*'],
-        markers: ['!', '*']
-      },
-      line: {
-        exceptions: ['-', '+', '*'],
-        markers: ['!', '/', '=>']
-      }
-    }],
-    strict: ['error', 'never'],
-    'switch-colon-spacing': ['error', {
-      after: true,
-      before: false
-    }],
-    'symbol-description': 'error',
-    'template-curly-spacing': ['error', 'never'],
-    'template-tag-spacing': ['error', 'never'],
-    'unicode-bom': ['error', 'never'],
-    'use-isnan': ['error', {
-      enforceForIndexOf: true,
-      enforceForSwitchCase: true
-    }],
-    'valid-typeof': ['error', {
-      requireStringLiterals: false
-    }],
-    'vars-on-top': 'error',
-    'wrap-iife': ['error', 'inside', {
-      functionPrototypeMethods: true
-    }],
-    'wrap-regex': 'off',
-    'yield-star-spacing': ['error', 'both'],
-    yoda: ['error', 'never'],
+    ...rulesCore,
     ...rulesNo,
-    ...pluginImportRules,
-    ...pluginSortKeysShorthandRules
+    ...pluginEslintCommentsRules,
+    ...pluginStylisticRules,
+    ...pluginImportXRules,
+    ...pluginPromiseRules,
+    ...pluginRegexpRules,
+    ...pluginSortKeysShorthandRules,
+    ...pluginUnicornRules
   }
-};
+}];

package/src/node.js

@@ -0,0 +1,23 @@
+import n from 'eslint-plugin-n';
+import globals from 'globals';
+
+import base from '#src/index.js';
+import {rules as pluginNRules} from '#src/plugins/n.js';
+
+export default [
+  ...base,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node
+      }
+    },
+    name: '@ololoepepe/eslint-config/node',
+    plugins: {
+      n
+    },
+    rules: {
+      ...pluginNRules
+    }
+  }
+];

package/src/plugins/eslint-comments.js

@@ -0,0 +1,12 @@
+export const rules = {
+  '@eslint-community/eslint-comments/disable-enable-pair': ['error', {
+    allowWholeFile: true
+  }],
+  '@eslint-community/eslint-comments/no-aggregating-enable': 'error',
+  '@eslint-community/eslint-comments/no-duplicate-disable': 'error',
+  '@eslint-community/eslint-comments/no-restricted-disable': 'off',
+  '@eslint-community/eslint-comments/no-unlimited-disable': 'error',
+  '@eslint-community/eslint-comments/no-unused-enable': 'error',
+  '@eslint-community/eslint-comments/no-use': 'off',
+  '@eslint-community/eslint-comments/require-description': 'error'
+};