@bonniernews/eslint-config 1.2.0 → 2.0.0-alpha.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.0.0
+
+- Breaking change: switch to eslint 8 to eslint 9 and adapt to the new flat file config format.
+- Breaking change: removed `all`, `react`, `test` and `typescript-react` configs. Replaced with the default config (js) and
+  just one for typescript `typescript` which includes react and test rules.
+
 ## 1.2.0
 
 - Bumped `typescript` to 5.4.3 and `@typescript-eslint` to 7.4.0.

package/README.md

@@ -15,71 +15,41 @@ Install `eslint` and `@bonniernews/eslint-config`:
 npm install --save-dev eslint @bonniernews/eslint-config
 ```
 
-### Base configuration
+## Migrating from 1.X to 2.X
 
-To activate the config, you need to add the following to your `.eslintrc.json`-file:
+2.X introduces eslint 9 which has a different configuration format. It is recommended to read the [eslint migration guide](https://eslint.org/docs/latest/use/configure/migration-guide).
 
-```json
-{
-  "root": true,
-  "extends": [ "@bonniernews" ]
-}
-```
+A major change from eslint 8 is that only one `eslint.config.js` file will be used, placing a specific configuration file in a folder will not behave in the same
+way as in 8 where it would inherit the configuration from files from the root folder, and the new recommendation is to just have one `eslint.config.js` at the root
+of the repository.
 
-### React configuration
+As well as changing the configuration format to adapt to eslint 9, @bonniernews/eslint-config has removed some of the previous configuration options `all`, `test`, `react`
+and `typescript-react` have all been removed. Now there are only two, the base (js only) and `typescript` which is the base with added support for `ts` and `tsx`.
 
-To activate the config, you need to add the following to your `.eslintrc.json`-file:
+### JavaScript configuration
 
-```json
-{
-  "root": true,
-  "extends": [ "@bonniernews/eslint-config/react" ]
-}
-```
+This config includes support for `js`, `jsx` and tests written using `mocha-cakes-2` and `chai`.
 
-This will enable the react plugin for `*.jsx`-files.
+To activate the config, you need to add the following to your `eslint.config.js`-file:
 
-### TypeScript configuration
-
-To activate the config, you need to add the following to your `.eslintrc.json`-file:
+```javascript
+"use strict";
 
-```json
-{
-  "root": true,
-  "extends": [ "@bonniernews/eslint-config/typescript" ]
-}
+module.exports = require("@bonniernews/eslint-config");
 ```
 
-This will enable the typescript plugin for `*.ts`-files.
+### TypeScript configuration
 
-### React with TypeScript configuration
+This config includes support for `js`, `jsx`, `ts`, `tsx` and and tests written using `mocha-cakes-2` and `chai`.
 
 To activate the config, you need to add the following to your `.eslintrc.json`-file:
 
-```json
-{
-  "root": true,
-  "extends": [ "@bonniernews/eslint-config/typescript-react" ]
-}
-```
-
-This will enable the typescript and react plugin for `*.tsx`-files.
+```javascript
+"use strict";
 
-### Test configuration
-
-You can also choose to use the test config, which is adapted to testing using `mocha`, `mocha-cakes-2` and `chai`. To also enable this,
-either add a separate test configuration file extending from `"@bonniernews/eslint-config/test"`, or use the `"@bonniernews/eslint-config/all"`
-in your root configuration to activate everything together:
-
-```json
-{
-  "root": true,
-  "extends": [ "@bonniernews/eslint-config/all" ]
-}
+module.exports = require("@bonniernews/eslint-config/typescript");
 ```
 
-This will activate the test configuration for all files inside directories named `test` or `tests`.
-
 ### Running eslint
 
 Run with:

package/base-config.js

@@ -0,0 +1,55 @@
+"use strict";
+
+const path = require("path");
+const fs = require("fs");
+const getRules = require("./rules");
+const globals = require("globals");
+
+const eslintPluginN = require("eslint-plugin-n");
+const eslintPluginImport = require("eslint-plugin-import");
+const eslintPluginTypescriptRules = require("@bonniernews/eslint-plugin-typescript-rules");
+
+// This will take care of potential symlinks
+const appDir = fs.realpathSync(process.cwd());
+
+const isModuleProject = require(path.resolve(appDir, "package.json")).type === "module";
+const hasES2022Support = parseInt(process.versions.node.split(".").shift(), 10) >= 16;
+
+const moduleConfig = {
+  languageOptions: {
+    ecmaVersion: hasES2022Support ? 2022 : 2021,
+    globals: { ...globals.node },
+    sourceType: "module",
+  },
+  plugins: {
+    n: eslintPluginN,
+    import: eslintPluginImport,
+    "@bonniernews/typescript-rules": eslintPluginTypescriptRules,
+  },
+};
+
+const commonjsConfig = {
+  languageOptions: {
+    ecmaVersion: 2021,
+    sourceType: "commonjs",
+    globals: { ...globals.node },
+  },
+  plugins: {
+    n: eslintPluginN,
+    "@bonniernews/typescript-rules": eslintPluginTypescriptRules,
+  },
+};
+
+const baseConfig = {
+  ignores: [
+    "tmp/",
+    "public/",
+    "submodule/**",
+    "logs/",
+    "docs/",
+  ],
+  ...(isModuleProject ? moduleConfig : commonjsConfig),
+  rules: getRules(isModuleProject),
+};
+
+module.exports = baseConfig;

package/index.js

@@ -1,44 +1,27 @@
 "use strict";
 
-const path = require("path");
-const fs = require("fs");
-const getRules = require("./rules");
+const reactPlugin = require("eslint-plugin-react");
+const reactRules = require("./react-rules");
+const baseConfig = require("./base-config");
+const testConfig = require("./test");
 
-// This will take care of potential symlinks
-const appDir = fs.realpathSync(process.cwd());
-
-const isModuleProject = require(path.resolve(appDir, "package.json")).type === "module";
-const hasES2022Support = parseInt(process.versions.node.split(".").shift(), 10) >= 16;
-
-const moduleConfig = {
-  parserOptions: {
-    ecmaVersion: hasES2022Support ? 2022 : 2021,
-    sourceType: "module",
+module.exports = [
+  baseConfig,
+  {
+    ...baseConfig,
+    files: [ "**/*.jsx" ],
+    languageOptions: {
+      ...baseConfig.languageOptions,
+      parserOptions: { ecmaFeatures: { jsx: true } },
+    },
+    plugins: { ...baseConfig.plugins, react: reactPlugin },
+    rules: { ...baseConfig.rules, ...reactRules },
   },
-  env: {
-    node: true,
-    ...(hasES2022Support ? { es2022: true } : { es6: true }),
+  {
+    ...baseConfig,
+    languageOptions: { ...baseConfig.languageOptions, ...testConfig.languageOptions },
+    plugins: { ...baseConfig.plugins, ...testConfig.plugins },
+    rules: { ...baseConfig.rules, ...testConfig.rules },
+    files: [ "test/**/*.js" ],
   },
-  plugins: [ "eslint-plugin-n", "import", "@bonniernews/typescript-rules" ],
-};
-
-const commonjsConfig = {
-  parserOptions: { ecmaVersion: 2021 },
-  env: {
-    node: true,
-    es6: true,
-  },
-  plugins: [ "eslint-plugin-n", "@bonniernews/typescript-rules" ],
-};
-
-module.exports = {
-  ignorePatterns: [
-    "tmp/",
-    "public/",
-    "submodule/**",
-    "logs/",
-    "docs/",
-  ],
-  ...(isModuleProject ? moduleConfig : commonjsConfig),
-  rules: getRules(isModuleProject),
-};
+];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bonniernews/eslint-config",
-  "version": "1.2.0",
+  "version": "2.0.0-alpha.0",
   "description": "ESLint config",
   "main": "index.js",
   "scripts": {
@@ -8,7 +8,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/BonnierNews/eslint-config"
+    "url": "git+https://github.com/BonnierNews/eslint-config.git"
   },
   "keywords": [
     "eslint",
@@ -21,14 +21,14 @@
   "contributors": [],
   "devDependencies": {
     "chai": "^4.3.10",
-    "eslint": "^8.53.0",
-    "mocha": "^10.2.0",
+    "eslint": "^9.19.0",
+    "mocha": "^11.1.0",
     "mocha-cakes-2": "^3.3.0",
-    "typescript": "^5.4.3"
+    "typescript": "^5.7.3"
   },
   "peerDependencies": {
-    "eslint": ">=8.3.0",
-    "typescript": ">=5.1.0"
+    "eslint": ">=9.19.0",
+    "typescript": ">=5.7.3"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -36,27 +36,26 @@
     }
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "license": "MIT",
   "dependencies": {
     "@bonniernews/eslint-plugin-typescript-rules": "^0.9.0",
-    "@typescript-eslint/eslint-plugin": "^7.4.0",
-    "@typescript-eslint/parser": "^7.4.0",
-    "eslint-plugin-chai-friendly": "^0.7.2",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-n": "^16.3.1",
-    "eslint-plugin-no-only-tests": "^3.1.0",
-    "eslint-plugin-react": "^7.33.2"
+    "@stylistic/eslint-plugin": "^3.1.0",
+    "@typescript-eslint/eslint-plugin": "^8.22.0",
+    "@typescript-eslint/parser": "^8.22.0",
+    "eslint-plugin-chai-friendly": "^1.0.1",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-n": "^17.15.1",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-react": "^7.37.4"
   },
   "files": [
-    "all.js",
     "index.js",
+    "base-config.js",
     "react-rules.js",
-    "react.js",
     "rules.js",
     "test.js",
-    "typescript-react.js",
     "typescript-rules.js",
     "typescript.js",
     "README.md",

package/test.js

@@ -1,5 +1,8 @@
 "use strict";
 
+const noOnlyTests = require("eslint-plugin-no-only-tests");
+const chaiFriendly = require("eslint-plugin-chai-friendly");
+
 const mochaCakes2Globals = {
   And: "readonly",
   But: "readonly",
@@ -37,9 +40,11 @@ const mochaCakes2Rules = {
 };
 
 module.exports = {
-  env: { mocha: true },
-  globals: { ...mochaCakes2Globals },
-  plugins: [ "no-only-tests", "chai-friendly" ],
+  languageOptions: { globals: { ...mochaCakes2Globals } },
+  plugins: {
+    "no-only-tests": noOnlyTests,
+    "chai-friendly": chaiFriendly,
+  },
   rules: {
     ...mochaCakes2Rules,
     // no only in tests

package/typescript-rules.js

@@ -3,7 +3,7 @@
 const typescriptEslintRecommended = {
   "@typescript-eslint/adjacent-overload-signatures": "error",
   "@typescript-eslint/ban-ts-comment": "error",
-  "@typescript-eslint/ban-types": "error",
+  "@typescript-eslint/no-restricted-types": "error",
   "no-array-constructor": "off",
   "@typescript-eslint/no-array-constructor": "error",
   "no-empty-function": "off",
@@ -11,8 +11,7 @@ const typescriptEslintRecommended = {
   "@typescript-eslint/no-empty-interface": "error",
   "@typescript-eslint/no-explicit-any": "off",
   "@typescript-eslint/no-extra-non-null-assertion": "error",
-  "no-extra-semi": "off",
-  "@typescript-eslint/no-extra-semi": "error",
+  "@stylistic/no-extra-semi": "error",
   "@typescript-eslint/no-inferrable-types": "error",
   "no-loss-of-precision": "off",
   "@typescript-eslint/no-loss-of-precision": "error",
@@ -62,4 +61,5 @@ module.exports = {
   ...importRules,
   "@bonniernews/typescript-rules/disallow-abstract-class": "error",
   "@bonniernews/typescript-rules/disallow-non-es-compatible": "error",
+  "@bonniernews/typescript-rules/disallow-class-extends": "error",
 };

package/typescript.js

@@ -2,19 +2,36 @@
 
 const baseConfig = require(".");
 const typescriptRules = require("./typescript-rules");
+const typeScriptPlugin = require("@typescript-eslint/eslint-plugin");
+const typeScriptParser = require("@typescript-eslint/parser");
+const stylistic = require("@stylistic/eslint-plugin");
+const bnTypescriptRules = require("@bonniernews/eslint-plugin-typescript-rules");
+const reactPlugin = require("eslint-plugin-react");
+const reactRules = require("./react-rules");
 
-module.exports = {
-  ...baseConfig,
-  overrides: [
-    {
-      parser: "@typescript-eslint/parser",
-      parserOptions: { sourceType: "module" },
-      settings: { "import/resolver": { node: { extensions: [ ".ts", ".js" ] } } },
-      plugins: [
-        "@typescript-eslint",
-      ],
-      files: [ "*.ts" ],
-      rules: typescriptRules,
-    },
-  ],
+const typescriptBase = {
+  plugins: {
+    "@typescript-eslint": typeScriptPlugin,
+    "@stylistic": stylistic,
+    "@bonniernews/typescript-rules": bnTypescriptRules,
+  },
+  languageOptions: {
+    sourceType: "module",
+    parser: typeScriptParser,
+  },
+  files: [ "**/*.ts" ],
+  rules: typescriptRules,
+  settings: { "import/resolver": { node: { extensions: [ ".ts", ".js" ] } } },
 };
+
+module.exports = [
+  ...baseConfig,
+  typescriptBase,
+  {
+    ...typescriptBase,
+    plugins: { ...typescriptBase.plugins, react: reactPlugin },
+    files: [ "**/*.tsx" ],
+    settings: { "import/resolver": { node: { extensions: [ ".ts", ".js", ".tsx", ".jsx" ] } } },
+    rules: { ...typescriptBase.rules, ...reactRules },
+  },
+];

package/all.js

@@ -1,14 +0,0 @@
-"use strict";
-
-const baseConfig = require(".");
-const testConfig = require("./test");
-
-module.exports = {
-  ...baseConfig,
-  overrides: [
-    {
-      files: [ "**/test?(s)/**/*" ],
-      ...testConfig,
-    },
-  ],
-};

package/react.js

@@ -1,18 +0,0 @@
-"use strict";
-
-const baseConfig = require(".");
-const reactRules = require("./react-rules");
-
-module.exports = {
-  ...baseConfig,
-  overrides: [
-    {
-      plugins: [
-        "react",
-      ],
-      parserOptions: { ecmaFeatures: { jsx: true } },
-      files: [ "*.jsx" ],
-      rules: reactRules,
-    },
-  ],
-};

package/typescript-react.js

@@ -1,45 +0,0 @@
-"use strict";
-
-const baseConfig = require(".");
-const typescriptRules = require("./typescript-rules");
-const reactRules = require("./react-rules");
-const settings = { "import/resolver": { node: { extensions: [ ".ts", ".js", ".tsx", ".jsx" ] } } };
-
-module.exports = {
-  ...baseConfig,
-  overrides: [
-    {
-      parser: "@typescript-eslint/parser",
-      parserOptions: { sourceType: "module", ecmaFeatures: { jsx: true } },
-      plugins: [
-        "react",
-        "@typescript-eslint",
-      ],
-      settings,
-      files: [ "*.tsx" ],
-      rules: {
-        ...typescriptRules,
-        ...reactRules,
-      },
-    },
-    {
-      parser: "@typescript-eslint/parser",
-      parserOptions: { sourceType: "module" },
-      settings,
-      plugins: [
-        "@typescript-eslint",
-      ],
-      files: [ "*.ts" ],
-      rules: typescriptRules,
-    },
-    {
-      plugins: [
-        "react",
-      ],
-      settings,
-      parserOptions: { ecmaFeatures: { jsx: true } },
-      files: [ "*.jsx" ],
-      rules: reactRules,
-    },
-  ],
-};