@ornikar/eslint-config 22.7.3 → 22.7.4

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## <small>22.7.4 (2026-05-28)</small>
+
+* feat!: ESLint flat-config migration [OSE-20589] (#820) ([6c7897b](https://github.com/ornikar/eslint-configs/commit/6c7897b)), closes [#820](https://github.com/ornikar/eslint-configs/issues/820)
+
+
+
+
+
 ## <small>22.7.3 (2026-05-26)</small>
 
 * feat!: ESLint v9 engine bump (legacy .eslintrc preserved) [OSE-20589] (#818) ([9683864](https://github.com/ornikar/eslint-configs/commit/9683864)), closes [#818](https://github.com/ornikar/eslint-configs/issues/818)

package/README.md

@@ -15,76 +15,105 @@ Also see:
 
 ## How to install
 
+These configs ship as flat-config arrays. Require the subpath you need and spread it into your `eslint.config.js`.
+
 ### root
 
 1. `npm install --save-dev eslint @ornikar/eslint-config`
-2. Add `"extends": ["@ornikar/eslint-config/root"]` to your eslint config
+2. In your root `eslint.config.js`:
+
+```js
+const ornikarRoot = require('@ornikar/eslint-config/root');
+
+module.exports = [...ornikarRoot];
+```
 
 ### node without babel or typescript
 
 1. `npm install --save-dev eslint @ornikar/eslint-config`
-2. Add `"extends": ["@ornikar/eslint-config", "@ornikar/eslint-config/node"]` to your eslint config
+2. In your source `eslint.config.js`:
+
+```js
+const ornikarNode = require('@ornikar/eslint-config/node');
+
+module.exports = [...ornikarNode];
+```
 
 ### node with babel (deprecated, please use typescript instead)
 
 1. `npm install --save-dev eslint @ornikar/eslint-config @ornikar/eslint-config-babel`
-2. Add `"extends": ["@ornikar/eslint-config-babel", "@ornikar/eslint-config/node""]` to your eslint config
+2. In your source `eslint.config.js`:
+
+```js
+const babelConfig = require('@ornikar/eslint-config-babel');
+
+module.exports = [...babelConfig];
+```
 
 ### node with typescript
 
 1. `npm install --save-dev eslint @ornikar/eslint-config @ornikar/eslint-config-typescript`
-2. Add `"extends": ["@ornikar/eslint-config-typescript", "@ornikar/eslint-config/node"]` to your eslint config
+2. In your source `eslint.config.js`:
+
+```js
+const tsNode = require('@ornikar/eslint-config-typescript/node');
+
+module.exports = [...tsNode];
+```
 
 ### module override
 
-```json
-{
-  "root": true,
-  "extends": ["@ornikar/eslint-config/root"],
-  "overrides": [
-    {
-      "files": ["test-setup.js"],
-      "extends": ["@ornikar/eslint-config/node-module-override"]
-    }
-  ]
-}
+In flat config, file-specific overrides are separate entries with `files:`. Use `defineConfig` from `eslint/config` so the `extends:` keyword works:
+
+```js
+const { defineConfig } = require('eslint/config');
+const ornikarRoot = require('@ornikar/eslint-config/root');
+const nodeModuleOverride = require('@ornikar/eslint-config/node-module-override');
+
+module.exports = defineConfig([
+  ...ornikarRoot,
+  {
+    files: ['test-setup.js'],
+    extends: [nodeModuleOverride],
+  },
+]);
 ```
 
 ## How to configure a project
 
-### Two configurations files
+### Two configuration files
 
-In a project you should have two configurations files:
+In a project you should have two configuration files:
 
-- /.eslintrc.json
-- /{src,lib}/.eslintrc.json
+- /eslint.config.js
+- /{src,lib}/eslint.config.js
 
 If the project is compiled, use `src` for source and `dist` for compilation with rollup.
 If the project is not compiled, use `lib`.
-If the project is CRA, next or build with webpack, use `src` for source and `build` or the build directory your tool uses.
+If the project is CRA, next or built with webpack, use `src` for source and `build` or the build directory your tool uses.
 
 Using two config files is important:
 
-- the root eslintrc is for config files and scripts. It should allow dev dependencies
-- the source eslintrc is for your source and tests files.
+- the root config is for config files and scripts. It should allow dev dependencies
+- the source config is for your source and test files
 
-### Use `"root": true`
+ESLint v9 flat config does not cascade like legacy `.eslintrc` did — only the nearest `eslint.config.js` to the file being linted is used. Compose what you need at each location.
 
-Both the configuration shoud set `"root": true` to prevent eslint to merge the config file with other higher eslintrc configs. See [Cascading and hierarchy](https://eslint.org/docs/user-guide/configuring/configuration-files#cascading-and-hierarchy) in eslint config documentation.
+### Use `ignores`
 
-The advantage of using 2 config files is to avoid overriding rules set for root. For example, root config should use plugin node, but not always your source config !
+Replace `.eslintignore` with the `ignores` property in your flat config:
 
-### Use `ignorePatterns` in .eslintrc.json
-
-Use `ignorePatterns` instead of .eslintignore file. We have enough configuration files !
+```js
+module.exports = [{ ignores: ['dist/**', 'coverage/**'] }, ...ornikarRoot];
+```
 
 ### Use `--report-unused-disable-directives`
 
-Really usefull tip, it prevents leaving unused eslint-disable directives.
+Really useful tip — it prevents leaving unused eslint-disable directives.
 
-### Lerna/Workspaces Configuration
+### Lerna/Workspaces configuration
 
-Assuming your package.json looks like `"workspaces": ["packages/*"]`:
+Assuming your `package.json` has `"workspaces": ["packages/*"]`:
 
-- /.eslintrc.json
-- /packages/\*/{src,lib}/.eslintrc.json
+- /eslint.config.js
+- /packages/\*/{src,lib}/eslint.config.js

package/_shared.js

@@ -1,13 +1,11 @@
 'use strict';
 
-module.exports = {
-  extends: [
-    './rules/best-practices',
-    './rules/ornikar',
-    './rules/imports',
-    './rules/style',
-    './rules/sort-imports-exports',
-    './rules/security',
-    './rules/unicorn',
-  ].map(require.resolve),
-};
+const bestPractices = require('./rules/best-practices');
+const imports = require('./rules/imports');
+const ornikar = require('./rules/ornikar');
+const security = require('./rules/security');
+const sortImportsExports = require('./rules/sort-imports-exports');
+const style = require('./rules/style');
+const unicorn = require('./rules/unicorn');
+
+module.exports = [...bestPractices, ...ornikar, ...imports, ...style, ...sortImportsExports, ...security, ...unicorn];

package/graphql.js

@@ -1,13 +1,15 @@
 'use strict';
 
-module.exports = {
-  rules: {
-    // https://eslint.org/docs/rules/no-underscore-dangle
-    'no-underscore-dangle': [
-      'error',
-      {
-        allow: ['__typename'],
-      },
-    ],
+module.exports = [
+  {
+    rules: {
+      // https://eslint.org/docs/rules/no-underscore-dangle
+      'no-underscore-dangle': [
+        'error',
+        {
+          allow: ['__typename'],
+        },
+      ],
+    },
   },
-};
+];

package/index.js

@@ -1,21 +1,29 @@
 'use strict';
 
-module.exports = {
-  extends: ['eslint-config-airbnb-base', './_shared', './rules/prettier'].map(require.resolve),
+const { FlatCompat } = require('@eslint/eslintrc');
+const sharedConfig = require('./_shared');
+const prettierConfig = require('./rules/prettier');
 
-  parserOptions: {
-    sourceType: 'script',
-    ecmaVersion: 2021,
-  },
+const compat = new FlatCompat({ baseDirectory: __dirname });
 
-  rules: {
-    strict: ['error', 'safe'],
-    'import/extensions': [
-      'error',
-      'ignorePackages',
-      {
-        js: 'never',
-      },
-    ],
+module.exports = [
+  ...compat.extends('eslint-config-airbnb-base'),
+  ...sharedConfig,
+  ...prettierConfig,
+  {
+    languageOptions: {
+      sourceType: 'script',
+      ecmaVersion: 2021,
+    },
+    rules: {
+      strict: ['error', 'safe'],
+      'import/extensions': [
+        'error',
+        'ignorePackages',
+        {
+          js: 'never',
+        },
+      ],
+    },
   },
-};
+];

package/node-module-override.js

@@ -1,10 +1,16 @@
 'use strict';
 
+const nPlugin = require('eslint-plugin-n');
+const nodeOverride = require('./rules/node-override');
+
 /* prefer usage of .mjs files over this override */
-module.exports = {
-  extends: ['plugin:n/recommended-module', require.resolve('./rules/node-override')],
-  parserOptions: {
-    // top level await is introduced in ecmaVersion: 2022 but supported since node 14
-    ecmaVersion: 2022,
+module.exports = [
+  nPlugin.configs['flat/recommended-module'],
+  ...nodeOverride,
+  {
+    languageOptions: {
+      // top level await is introduced in ecmaVersion: 2022 but supported since node 14
+      ecmaVersion: 2022,
+    },
   },
-};
+];

package/node.js

@@ -1,5 +1,7 @@
 'use strict';
 
-module.exports = {
-  extends: ['.', './rules/node', './rules/prettier'].map(require.resolve),
-};
+const nodeRules = require('./rules/node');
+const prettierConfig = require('./rules/prettier');
+const indexConfig = require('.');
+
+module.exports = [...indexConfig, ...nodeRules, ...prettierConfig];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ornikar/eslint-config",
-  "version": "22.7.3",
+  "version": "22.7.4",
   "description": "eslint config files",
   "repository": {
     "directory": "@ornikar/eslint-config",
@@ -16,7 +16,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@ornikar/eslint-plugin-ornikar": "22.7.3",
+    "@eslint/eslintrc": "^3.3.5",
+    "@ornikar/eslint-plugin-ornikar": "22.7.4",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^10.0.0",
     "eslint-import-resolver-typescript": "^4.4.4",
@@ -37,6 +38,6 @@
     "prettier": "2.8.8"
   },
   "scripts": {
-    "lint:eslint": "ESLINT_USE_FLAT_CONFIG=false yarn ../.. eslint --report-unused-disable-directives --quiet @ornikar/eslint-config"
+    "lint:eslint": "yarn ../.. eslint --report-unused-disable-directives --quiet @ornikar/eslint-config"
   }
 }

package/rollup.js

@@ -1,9 +1,13 @@
 'use strict';
 
 // See https://github.com/ornikar/shared-configs/tree/master/%40ornikar/rollup-config
-module.exports = {
-  globals: {
-    __DEV__: true,
-    __TARGET__: true,
+module.exports = [
+  {
+    languageOptions: {
+      globals: {
+        __DEV__: 'writable',
+        __TARGET__: 'writable',
+      },
+    },
   },
-};
+];

package/root.js

@@ -1,19 +1,22 @@
 'use strict';
 
-module.exports = {
-  extends: ['./node'].map(require.resolve),
+const nodeConfig = require('./node');
 
-  rules: {
-    'no-console': 'off',
-    'import/no-extraneous-dependencies': [
-      'error',
-      {
-        devDependencies: true,
-      },
-    ],
+module.exports = [
+  ...nodeConfig,
+  {
+    rules: {
+      'no-console': 'off',
+      'import/no-extraneous-dependencies': [
+        'error',
+        {
+          devDependencies: true,
+        },
+      ],
 
-    // Allow non-literal fs filename for dev scripts
-    'security/detect-non-literal-fs-filename': 'off',
-    'security/detect-non-literal-require': 'off',
+      // Allow non-literal fs filename for dev scripts
+      'security/detect-non-literal-fs-filename': 'off',
+      'security/detect-non-literal-require': 'off',
+    },
   },
-};
+];

package/rules/best-practices.js

@@ -1,14 +1,16 @@
 'use strict';
 
-module.exports = {
-  rules: {
-    // https://eslint.org/docs/rules/require-await
-    'require-await': 'error',
+module.exports = [
+  {
+    rules: {
+      // https://eslint.org/docs/rules/require-await
+      'require-await': 'error',
 
-    // https://eslint.org/docs/rules/no-warning-comments
-    'no-warning-comments': ['error', { terms: ['fixme', 'xxx', 'console.'], location: 'start' }],
+      // https://eslint.org/docs/rules/no-warning-comments
+      'no-warning-comments': ['error', { terms: ['fixme', 'xxx', 'console.'], location: 'start' }],
 
-    // https://eslint.org/docs/rules/max-depth
-    'max-depth': ['warn', 6],
+      // https://eslint.org/docs/rules/max-depth
+      'max-depth': ['warn', 6],
+    },
   },
-};
+];

package/rules/imports.js

@@ -1,13 +1,15 @@
 'use strict';
 
-module.exports = {
-  rules: {
-    /* https://ornikar.atlassian.net/wiki/spaces/TECH/pages/2670330094/Avoid+default+export */
+module.exports = [
+  {
+    rules: {
+      /* https://ornikar.atlassian.net/wiki/spaces/TECH/pages/2670330094/Avoid+default+export */
 
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
-    'import/prefer-default-export': 'off',
+      // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
+      'import/prefer-default-export': 'off',
 
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-default-export.md
-    'import/no-default-export': 'error',
+      // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-default-export.md
+      'import/no-default-export': 'error',
+    },
   },
-};
+];

package/rules/jest.js

@@ -1,10 +1,16 @@
 'use strict';
 
-module.exports = {
-  plugins: ['jest'],
-  rules: {
-    'jest/no-disabled-tests': 'error',
-    'jest/no-focused-tests': 'error',
-    'jest/prefer-called-with': 'error',
+const jestPlugin = require('eslint-plugin-jest');
+
+module.exports = [
+  {
+    plugins: { jest: jestPlugin },
+    // `eslint-plugin-jest` ships the Jest test globals (describe/it/expect/…) here.
+    languageOptions: jestPlugin.configs['flat/recommended'].languageOptions,
+    rules: {
+      'jest/no-disabled-tests': 'error',
+      'jest/no-focused-tests': 'error',
+      'jest/prefer-called-with': 'error',
+    },
   },
-};
+];

package/rules/node-override.js

@@ -2,31 +2,33 @@
 
 const airbnbStyleRules = require('eslint-config-airbnb-base/rules/style');
 
-module.exports = {
-  rules: {
-    // already checked by import plugin
-    'n/no-unpublished-require': 'off',
-    'n/no-unpublished-import': 'off',
-    'n/no-extraneous-require': 'off',
-    'n/no-extraneous-import': 'off',
-    'n/no-missing-require': 'off',
-    'n/no-missing-import': 'off',
+module.exports = [
+  {
+    rules: {
+      // already checked by import plugin
+      'n/no-unpublished-require': 'off',
+      'n/no-unpublished-import': 'off',
+      'n/no-extraneous-require': 'off',
+      'n/no-extraneous-import': 'off',
+      'n/no-missing-require': 'off',
+      'n/no-missing-import': 'off',
 
-    // Use for-of instead of for
-    'unicorn/no-for-loop': 'error',
+      // Use for-of instead of for
+      'unicorn/no-for-loop': 'error',
 
-    // allow process.exit, disallowed when not used in script via https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-process-exit.md
-    'no-process-exit': 'off',
-    'n/no-process-exit': 'off',
+      // allow process.exit, disallowed when not used in script via https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-process-exit.md
+      'no-process-exit': 'off',
+      'n/no-process-exit': 'off',
 
-    // Allow for-of, now supported by node 6
-    'no-restricted-syntax': [
-      'error',
-      ...airbnbStyleRules.rules['no-restricted-syntax']
-        .slice(1)
-        .filter(({ selector }) => selector !== 'ForOfStatement'),
-    ],
+      // Allow for-of, now supported by node 6
+      'no-restricted-syntax': [
+        'error',
+        ...airbnbStyleRules.rules['no-restricted-syntax']
+          .slice(1)
+          .filter(({ selector }) => selector !== 'ForOfStatement'),
+      ],
 
-    'unicorn/prefer-at': 'error',
+      'unicorn/prefer-at': 'error',
+    },
   },
-};
+];

package/rules/node.js

@@ -1,38 +1,34 @@
 'use strict';
 
-module.exports = {
-  plugins: ['n'],
-  extends: ['plugin:n/recommended', require.resolve('./node-override')],
+const nPlugin = require('eslint-plugin-n');
+const nodeOverride = require('./node-override');
 
-  parserOptions: {
-    // top level await is introduced in ecmaVersion: 2022 but supported since node 14
-    ecmaVersion: 2022,
+module.exports = [
+  // `eslint-plugin-n`'s flat/recommended ships the Node globals and sourceType.
+  nPlugin.configs['flat/recommended'],
+  ...nodeOverride,
+  {
+    languageOptions: {
+      // top level await is introduced in ecmaVersion: 2022 but supported since node 14
+      ecmaVersion: 2022,
+    },
   },
-
-  env: {
-    browser: false,
-    node: true,
-    es6: true,
+  {
+    ...nPlugin.configs['flat/recommended-script'],
+    files: ['**/*.cjs'],
   },
-
-  overrides: [
-    {
-      files: ['*.cjs'],
-      extends: ['plugin:n/recommended-script', require.resolve('./node-override')],
-    },
-    {
-      files: ['*.mjs'],
-      extends: ['plugin:n/recommended-module', require.resolve('./node-override')],
-      parserOptions: {
-        // top level await is introduced in ecmaVersion: 2022 but supported since node 14
-        ecmaVersion: 2022,
-      },
+  ...nodeOverride.map((entry) => ({ ...entry, files: ['**/*.cjs'] })),
+  {
+    ...nPlugin.configs['flat/recommended-module'],
+    files: ['**/*.mjs'],
+    languageOptions: {
+      ...nPlugin.configs['flat/recommended-module'].languageOptions,
+      ecmaVersion: 2022,
     },
-    {
-      files: ['scripts/**'],
-      rules: {
-        'n/hashbang': 'off',
-      },
-    },
-  ],
-};
+  },
+  ...nodeOverride.map((entry) => ({ ...entry, files: ['**/*.mjs'] })),
+  {
+    files: ['**/scripts/**'],
+    rules: { 'n/hashbang': 'off' },
+  },
+];

package/rules/ornikar.js

@@ -1,6 +1,10 @@
 'use strict';
 
-module.exports = {
-  plugins: ['@ornikar/ornikar'],
-  extends: ['plugin:@ornikar/ornikar/recommended'],
-};
+const ornikarPlugin = require('@ornikar/eslint-plugin-ornikar');
+
+module.exports = [
+  {
+    plugins: { '@ornikar/ornikar': ornikarPlugin },
+    rules: ornikarPlugin.configs.recommended.rules,
+  },
+];

package/rules/prettier.js

@@ -1,15 +1,18 @@
 'use strict';
 
-module.exports = {
-  extends: ['eslint-config-prettier'].map(require.resolve),
+const prettierConfig = require('eslint-config-prettier');
 
-  rules: {
-    // https://github.com/prettier/eslint-config-prettier#curly
-    // prettier doesn't enforce {} with multiline
-    curly: ['error', 'multi-line'],
+module.exports = [
+  prettierConfig,
+  {
+    rules: {
+      // https://github.com/prettier/eslint-config-prettier#curly
+      // prettier doesn't enforce {} with multiline
+      curly: ['error', 'multi-line'],
 
-    // https://github.com/prettier/eslint-config-prettier#quotes
-    // prettier doesn't change backtick to single
-    quotes: ['error', 'single', { avoidEscape: true }],
+      // https://github.com/prettier/eslint-config-prettier#quotes
+      // prettier doesn't change backtick to single
+      quotes: ['error', 'single', { avoidEscape: true }],
+    },
   },
-};
+];