@ornikar/eslint-config 22.7.4 → 23.0.0

package/README.md

@@ -15,105 +15,76 @@ 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. In your root `eslint.config.js`:
-
-```js
-const ornikarRoot = require('@ornikar/eslint-config/root');
-
-module.exports = [...ornikarRoot];
-```
+2. Add `"extends": ["@ornikar/eslint-config/root"]` to your eslint config
 
 ### node without babel or typescript
 
 1. `npm install --save-dev eslint @ornikar/eslint-config`
-2. In your source `eslint.config.js`:
-
-```js
-const ornikarNode = require('@ornikar/eslint-config/node');
-
-module.exports = [...ornikarNode];
-```
+2. Add `"extends": ["@ornikar/eslint-config", "@ornikar/eslint-config/node"]` to your eslint config
 
 ### node with babel (deprecated, please use typescript instead)
 
 1. `npm install --save-dev eslint @ornikar/eslint-config @ornikar/eslint-config-babel`
-2. In your source `eslint.config.js`:
-
-```js
-const babelConfig = require('@ornikar/eslint-config-babel');
-
-module.exports = [...babelConfig];
-```
+2. Add `"extends": ["@ornikar/eslint-config-babel", "@ornikar/eslint-config/node""]` to your eslint config
 
 ### node with typescript
 
 1. `npm install --save-dev eslint @ornikar/eslint-config @ornikar/eslint-config-typescript`
-2. In your source `eslint.config.js`:
-
-```js
-const tsNode = require('@ornikar/eslint-config-typescript/node');
-
-module.exports = [...tsNode];
-```
+2. Add `"extends": ["@ornikar/eslint-config-typescript", "@ornikar/eslint-config/node"]` to your eslint config
 
 ### 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],
-  },
-]);
+```json
+{
+  "root": true,
+  "extends": ["@ornikar/eslint-config/root"],
+  "overrides": [
+    {
+      "files": ["test-setup.js"],
+      "extends": ["@ornikar/eslint-config/node-module-override"]
+    }
+  ]
+}
 ```
 
 ## How to configure a project
 
-### Two configuration files
+### Two configurations files
 
-In a project you should have two configuration files:
+In a project you should have two configurations files:
 
-- /eslint.config.js
-- /{src,lib}/eslint.config.js
+- /.eslintrc.json
+- /{src,lib}/.eslintrc.json
 
 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 built with webpack, use `src` for source and `build` or the build directory your tool uses.
+If the project is CRA, next or build with webpack, use `src` for source and `build` or the build directory your tool uses.
 
 Using two config files is important:
 
-- the root config is for config files and scripts. It should allow dev dependencies
-- the source config is for your source and test files
+- the root eslintrc is for config files and scripts. It should allow dev dependencies
+- the source eslintrc is for your source and tests files.
 
-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.
+### Use `"root": true`
 
-### Use `ignores`
+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.
 
-Replace `.eslintignore` with the `ignores` property in your flat config:
+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 !
 
-```js
-module.exports = [{ ignores: ['dist/**', 'coverage/**'] }, ...ornikarRoot];
-```
+### Use `ignorePatterns` in .eslintrc.json
+
+Use `ignorePatterns` instead of .eslintignore file. We have enough configuration files !
 
 ### Use `--report-unused-disable-directives`
 
-Really useful tip — it prevents leaving unused eslint-disable directives.
+Really usefull tip, it prevents leaving unused eslint-disable directives.
 
-### Lerna/Workspaces configuration
+### Lerna/Workspaces Configuration
 
-Assuming your `package.json` has `"workspaces": ["packages/*"]`:
+Assuming your package.json looks like `"workspaces": ["packages/*"]`:
 
-- /eslint.config.js
-- /packages/\*/{src,lib}/eslint.config.js
+- /.eslintrc.json
+- /packages/\*/{src,lib}/.eslintrc.json

package/_shared.js

@@ -1,11 +1,13 @@
 'use strict';
 
-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];
+module.exports = {
+  extends: [
+    './rules/best-practices',
+    './rules/ornikar',
+    './rules/imports',
+    './rules/style',
+    './rules/sort-imports-exports',
+    './rules/security',
+    './rules/unicorn',
+  ].map(require.resolve),
+};

package/graphql.js

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

package/node-module-override.js

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

package/node.js

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

package/package.json

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

package/rollup.js

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

package/root.js

@@ -1,22 +1,19 @@
 'use strict';
 
-const nodeConfig = require('./node');
+module.exports = {
+  extends: ['./node'].map(require.resolve),
 
-module.exports = [
-  ...nodeConfig,
-  {
-    rules: {
-      'no-console': 'off',
-      'import/no-extraneous-dependencies': [
-        'error',
-        {
-          devDependencies: true,
-        },
-      ],
+  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,16 +1,14 @@
 '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,15 +1,13 @@
 '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,16 +1,10 @@
 'use strict';
 
-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',
-    },
+module.exports = {
+  plugins: ['jest'],
+  rules: {
+    'jest/no-disabled-tests': 'error',
+    'jest/no-focused-tests': 'error',
+    'jest/prefer-called-with': 'error',
   },
-];
+};

package/rules/node-override.js

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

package/rules/ornikar.js

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

package/rules/prettier.js

@@ -1,18 +1,15 @@
 'use strict';
 
-const prettierConfig = require('eslint-config-prettier');
+module.exports = {
+  extends: ['eslint-config-prettier'].map(require.resolve),
 
-module.exports = [
-  prettierConfig,
-  {
-    rules: {
-      // https://github.com/prettier/eslint-config-prettier#curly
-      // prettier doesn't enforce {} with multiline
-      curly: ['error', 'multi-line'],
+  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 }],
   },
-];
+};