ESLint migration to v9

.gitignore

@@ -41,7 +41,6 @@ bower_components/
 # VSCode
 .vscode/
 
-dist/
 es2015/
 dev-build/
 # Local env variables

.prettierignore

@@ -1,2 +1,3 @@
 /node_modules
+/dist
 *.d.ts

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.0.0] - 2025-01-21
+
+- Migration to [flat configs](https://eslint.org/docs/latest/use/configure/configuration-files)
+- Migrate the code to es6
+- Add new compilation process to build the lib to es6 and common-js
+- Add new recommended rules.
+
 ## [2.1.4] - 2024-09-12
 
 - Fixing dependencies not published properly in `v2.1.3`.

README.md

@@ -24,15 +24,16 @@ yarn add --dev @cabify/eslint-config eslint prettier
 
 ## Usage
 
-1. Create a `.eslintrc` file at the root of your project:
+1. Create a `.eslint.config.js` file at the root of your project:
 
-```json
-{
-  "extends": ["@cabify/eslint-config/recommended"],
-  "rules": {
-    // Additional, per-project rules...
-  }
-}
+```js
+import recommended from '@cabify/eslint-config';
+/* Define an object for local configuration. 
+/ You can add your custom configuration and override existing rules here before exporting it.
+const localConfig = {};
+export default [...recommended, localConfig];
+*/
+export default [...recommended];
 ```
 
 2. Add the lint task into your `package.json`:
@@ -41,15 +42,29 @@ yarn add --dev @cabify/eslint-config eslint prettier
 ...
 "scripts": {
   ...
-  "lint": "eslint .",
-  "lint:fix": "eslint . --fix",
+  "lint:fix": "eslint ./ --fix",
+  "lint": "eslint ./",
   ...
 }
 ```
 
-3. Add a `.eslintignore` file to avoid checking unwanted files:
+3. Add a `.globalIgnores` in your `eslint.config.js` to avoid checking unwanted files:
 
-https://eslint.org/docs/user-guide/configuring/ignoring-code#the-eslintignore-file
+```js
+// https://eslint.org/docs/latest/use/configure/configuration-files#globally-ignoring-files-with-ignores
+const globalIgnores = {
+  ignores: [
+    'dist',
+    'node_modules/*',
+    'storybook-static/*',
+    'test/*',
+    'build',
+    'scripts',
+    'webpack',
+  ],
+};
+export default [...recommended, globalIgnores];
+```
 
 ### Formatting
 
@@ -66,67 +81,27 @@ To format the files from your app a and checking them are properly formatted you
 }
 ```
 
-### Setup for Babel
-
-If you use non-standard features in your JS code (like decorators),
-or custom configs to import files you'll need to use `babel-eslint` as parser.
-To do so, install the following dependencies and modify your `.eslintrc` file accordingly:
-
-```sh
-yarn add --dev babel-eslint eslint-import-resolver-babel-module
-```
-
-or
-
-```sh
-yarn add --dev babel-eslint eslint-import-resolver-babel-module
-```
-
-Modify `.eslintrc`:
-
-```json
-{
-  ...
-  "parser": "babel-eslint",
-  "settings": {
-    ...
-    "import/resolver": {
-      "babel-module": {}
-    }
-  }
-}
-```
-
 ### Setup for TypeScript
 
-1.  Install the following dependencies:
-
-```sh
-npm i -D eslint-import-resolver-typescript
-```
-
-or
-
-```sh
-yarn add --dev eslint-import-resolver-typescript
-```
-
-2. Modify `.eslintrc`:
-
-```json
-{
-  ...
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "project": "./tsconfig.eslint.json"
+```js
+const localConfigs = {
+  languageOptions: {
+    parserOptions: {
+      project: './tsconfig.json',
+      ecmaVersion: 2020,
+    },
   },
-  "settings": {
-    ...
-    "import/resolver": {
-      "typescript": {}
-    }
-  }
-}
+  settings: {
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true, // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
+        project: '<root>/tsconfig.json',
+      },
+    },
+  },
+};
+
+export default [...recommended, localConfigs];
 ```
 
 3.  Add a `./tsconfig.eslint.json` to the root of your project.
@@ -165,69 +140,6 @@ some rules. If you can live without them, just make these changes in your `.esli
 }
 ```
 
-### Setup for Jest
-
-If you use Jest, installing its import resolver into your project is encouraged.
-
-1.  Install the following dependencies:
-
-```sh
-npm i -D eslint-import-resolver-jest
-```
-
-or
-
-```sh
-yarn add --dev eslint-import-resolver-jest
-```
-
-2. Modify `.eslintrc`:
-
-```json
-{
-  ...
-  "settings": {
-    ...
-    "import/resolver": {
-      ...
-      "jest": {
-      "jestConfigFile": "./jest.config.js"
-      }
-    }
-  }
-}
-```
-
-If you want to ensure that this resolver only applies to your test files, you can use ESLint's overrides configuration option:
-
-```json
-"overrides": [
-  {
-    "files": ["**/__tests__/**/*.js"],
-    "settings": {
-      "import/resolver": {
-        "jest": {
-          "jestConfigFile": "./jest.config.js"
-        }
-      }
-    }
-  }
-]
-```
-
-3. Make sure that you have set up your jest config file (e.g., `./jest.config.js` )
-
-## Legacy
-
-If you want to maintain the formatting within ESLint, you can opt to extend the `@cabify/eslint-config/legacy` configuration instead of `@cabify/eslint-config/recommended`:
-
-```json
-{
-  "extends": ["@cabify/eslint-config/legacy"],
-  ...
-}
-```
-
 ### Publish a new version
 
 - Update [CHANGELOG](./CHANGELOG.md) with new features, breaking changes, etc

configs/base.js

@@ -1,52 +1,80 @@
-const { isPackageAvailable } = require('../utils');
+/* eslint-disable prefer-destructuring */
+/* eslint-disable global-require */
 
-const isTSAvailable = isPackageAvailable('typescript');
-const isJestAvailable = isPackageAvailable('jest');
+/* eslint-disable import/extensions */
+import eslintConfigPrettier from 'eslint-config-prettier';
+import globals from 'globals';
+
+import bestPractices from './best-practices.js';
+import errors from './errors.js';
+import es6 from './es6.js';
+import formats from './formats.js';
+import imports from './imports.js';
+import lodash from './lodash.js';
+import node from './node.js';
+import postcss from './postcss.js';
+import promises from './promises.js';
+import react from './react.js';
+import reactA11y from './react-a11y.js';
+import storybook from './storybook.js';
+import strict from './strict.js';
+import style from './style.js';
+import variables from './variables.js';
+
+let jestConfigs = {};
+let tsConfigs = [];
+
+if (process.env.BUILD_FORMAT === 'es') {
+  const { getConditionalPackages } = await import('./conditionalPackages.js');
+  const packages = await getConditionalPackages();
+  jestConfigs = packages.jestConfigs;
+  tsConfigs = packages.tsConfigs;
+}
+
+if (process.env.BUILD_FORMAT === 'cjs') {
+  const { getConditionalPackages } = require('./conditionalPackagesLegacy.cjs');
+  const packages = getConditionalPackages();
+  jestConfigs = packages.jestConfigs;
+  tsConfigs = packages.tsConfigs;
+}
 
 const configs = [
-  './best-practices',
-  './errors',
-  './es6',
-  './imports',
-  './node',
-  './promises',
-  './strict',
-  './style',
-  './variables',
-  './react',
-  './lodash',
-  './react-a11y',
-  isJestAvailable && './jest',
+  bestPractices,
+  errors,
+  es6,
+  ...imports,
+  postcss,
+  node,
+  promises,
+  strict,
+  style,
+  variables,
+  react,
+  reactA11y,
+  formats,
+  storybook,
+  lodash,
 ].filter(Boolean);
-
-const overrides = [
-  isTSAvailable && {
-    files: ['**/*.ts', '**/*.tsx'],
-    excludedFiles: '*.d.ts',
-    extends: ['./ts'],
-  },
+const rules = [
+  ...configs,
+  {},
   {
-    files: ['*.story.tsx', '*.stories.tsx'],
-    extends: ['./storybook'],
+    name: 'base-cabify-eslint-config',
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+    },
+    rules: {
+      strict: 'error',
+    },
   },
-  {
-    files: ['postcss.config.js'],
-    extends: ['./postcss'],
-  },
-].filter(Boolean);
+  { ...jestConfigs },
+  ...tsConfigs,
+  eslintConfigPrettier,
+];
 
-module.exports = {
-  env: {
-    browser: true,
-    node: true,
-  },
-  extends: configs,
-  parserOptions: {
-    ecmaVersion: 2018,
-    sourceType: 'module',
-  },
-  rules: {
-    strict: 'error',
-  },
-  overrides,
-};
+export default rules;

configs/best-practices.js

@@ -1,4 +1,5 @@
-module.exports = {
+export default {
+  name: 'best-practices-cabify-eslint-config',
   rules: {
     // enforces getter/setter pairs in objects
     'accessor-pairs': 'off',