@bonniernews/eslint-config 2.0.4 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # Changelog
 
+## 3.0.0
+
+- Updated all dependencies to latest versions:
+  - `@bonniernews/eslint-plugin-typescript-rules` to ^1.0.2
+  - `@stylistic/eslint-plugin` to ^5.6.1
+  - `@typescript-eslint/eslint-plugin` to ^8.51.0
+  - `@typescript-eslint/parser` to ^8.51.0
+  - `eslint-plugin-chai-friendly` to ^1.1.0
+  - `eslint-plugin-import` to ^2.32.0
+  - `eslint-plugin-n` to ^17.23.1
+  - `eslint-plugin-react` to ^7.37.5
+  - `globals` to ^17.0.0
+  - `chai` to ^6.2.2 (dev)
+  - `eslint` to ^9.39.2 (dev)
+  - `mocha` to ^11.7.5 (dev)
+  - `typescript` to ^5.9.3 (dev)
+- Converted package to ESM (`"type": "module"`); all configs use `import`/`export default`.
+- Converted test setup to ESM (`test/helpers/setup.mjs`) for `chai` v6 compatibility; updated `.mocharc.json` accordingly.
+
+**Breaking change:** This package is now published as an ES Module. CommonJS projects must switch from `require` to `await import`. See [README](./README.md#migrating-from-2x-to-3x).
+
+**Dependency updates impact:**
+- **@stylistic/eslint-plugin (v3 → v5)**: The major version updates were for packaging changes (removing sub-packages), not rule behavior. This package only uses the `@stylistic/no-extra-semi` rule, which has not changed behavior.
+- **@typescript-eslint (8.22 → 8.51)**: Minor version bump with bug fixes and new optional rules. No changes to currently configured rules.
+- **globals (v15 → v17)**: Minor version bump adding more global variable definitions. Existing globals unchanged.
+- **Other plugins**: Bug fixes and minor improvements with no user-facing impact.
+
 ## 2.0.2
 
 - Fixed bad docs.

package/README.md

@@ -7,6 +7,8 @@ and the appropriate setup will be used by looking at the projects `package.json`
 
 For Node versions that support it (version 16 and above), the `es2022` environment will also be activated. Otherwise `es2021` will be used.
 
+> **Note:** As of version 3.X, this package is published as an ES Module. See the [usage examples](#usage) for how to use it in both ESM and CommonJS projects.
+
 ## Table of contents
 
 - [@bonniernews/eslint-config](#bonniernewseslint-config)
@@ -20,6 +22,7 @@ For Node versions that support it (version 16 and above), the `es2022` environme
     - [Typed react configuration](#typed-react-configuration)
     - [Global ignores](#global-ignores)
     - [Globals](#globals)
+  - [Migrating from 2.X to 3.X](#migrating-from-2x-to-3x)
   - [Migrating from 1.X to 2.X](#migrating-from-1x-to-2x)
   - [Running eslint](#running-eslint)
   - [Usage in an existing project](#usage-in-an-existing-project)
@@ -41,72 +44,80 @@ npm install --save-dev eslint @bonniernews/eslint-config
 
 Configures all rules, js, ts, tsx, jsx and test rules.
 
-To activate the config, you need to add the following to your `eslint.config.js`-file:
+**ESM** - for projects with `"type": "module"` in `package.json`:
 
 ```javascript
-"use strict";
+// eslint.config.js
+import config from "@bonniernews/eslint-config";
 
-module.exports = require("@bonniernews/eslint-config");
+export default config;
 ```
 
-### JavaScript configuration
+**CommonJS** - for projects without `"type": "module"`:
 
-To activate the config, you need to add the following to your `eslint.config.js`-file:
+```javascript
+// eslint.config.js
+const { default: config } = await import("@bonniernews/eslint-config");
+
+module.exports = config;
+```
+
+### JavaScript configuration
 
 ```javascript
-"use strict";
+// eslint.config.js
+import config from "@bonniernews/eslint-config/js";
 
-module.exports = require("@bonniernews/eslint-config/js");
+export default [ config ];
 ```
 
 ### TypeScript configuration
 
-To activate the config, you need to add the following to your `eslint.config.js`-file:
-
 ```javascript
-"use strict";
+// eslint.config.js
+import config from "@bonniernews/eslint-config/ts";
 
-module.exports = require("@bonniernews/eslint-config/ts");
+export default [ config ];
 ```
 
 ### React configuration
 
-To activate the config, you need to add the following to your `eslint.config.js`-file:
-
 ```javascript
-"use strict";
+// eslint.config.js
+import config from "@bonniernews/eslint-config/jsx";
 
-module.exports = require("@bonniernews/eslint-config/jsx");
+export default [ config ];
 ```
 
 ### Test configuration
 
 Adds useful plugins and globals for testing with mocha-cakes-2 + chai.
 
-To activate the config, you need to add the following to your `eslint.config.js`-file (for js):
+For JavaScript tests:
 
 ```javascript
-"use strict";
+// eslint.config.js
+import config from "@bonniernews/eslint-config/test-js";
 
-module.exports = require("@bonniernews/eslint-config/test-js");
+export default [ config ];
 ```
 
-or the following (for ts):
+For TypeScript tests:
 
 ```javascript
-"use strict";
+// eslint.config.js
+import config from "@bonniernews/eslint-config/test-ts";
 
-module.exports = require("@bonniernews/eslint-config/test-ts");
+export default [ config ];
 ```
 
 ### Typed react configuration
 
-To activate the config, you need to add the following to your `eslint.config.js`-file:
-
 ```javascript
-"use strict";
+// eslint.config.js
+import config from "@bonniernews/eslint-config/tsx";
 
-module.exports = require("@bonniernews/eslint-config/tsx");
+export default [ config ];
 ```
 
 ### Global ignores
@@ -114,13 +125,13 @@ module.exports = require("@bonniernews/eslint-config/tsx");
 To activate this config (in addition to other config(s), using it alone makes no sense), add the following:
 
 ```javascript
-"use strict";
-
-const ignores = require("@bonniernews/eslint-config/ignores");
+// eslint.config.js
+import ignores from "@bonniernews/eslint-config/ignores";
 
-module.exports = [
+export default [
   ...allYourGoodConfigs,
-  ignores
+  ignores,
+  // your additional config
 ];
 ```
 
@@ -128,15 +139,50 @@ module.exports = [
 
 Globals for browsers, etc. that may be needed.
 
+```javascript
+// eslint.config.js
+import globals from "@bonniernews/eslint-config/globals";
+
+export default [
+  ...allYourGoodConfigs,
+  { files: [ "assets/scripts/**/*.js" ], languageOptions: { globals: globals.browser } },
+];
+```
+
+## Migrating from 2.X to 3.X
+
+Version 3.X is published as an ES Module (ESM).
+
+### For ESM projects using `import`
+
+If your project has `"type": "module"` in `package.json`, and you're already using `import`, then you don't have to make any changes.
+
+### For CommonJS projects using `require`
+
+If your project does not have `"type": "module"`, you need to use dynamic `import()` to import an ESM module, which is an asynchronous function:
+
+**Before (2.X):**
+
 ```javascript
 "use strict";
 
-const globals = require("@bonniernews/eslint-config/globals");
+const config = require("@bonniernews/eslint-config");
 
 module.exports = [
-  ...allYourGoodConfigs,
-  { files: [ "assets/scripts" ], languageOptions: { globals: globals.browser } }
-];
+  ...config,
+  { ignores: [ "dist/**" ] },
+]
+```
+
+**After (3.X):**
+
+```javascript
+const { default: config } = await import("@bonniernews/eslint-config");
+
+module.exports = [
+  ...config,
+  { ignores: [ "dist/**" ] },
+]
 ```
 
 ## Migrating from 1.X to 2.X
@@ -185,7 +231,7 @@ npx eslint .
 - Remove any 'eslint-disable-line no-unused-expressions' directives added because of chai assertions, they are not
   needed anymore (`eslint-plugin-chai-friendly` is used in test).
 - Remove any globals and special rules related to `mocha-cakes-2` in your test configuration, they already exist
-  in the `@bonniernews/eslint-config/test` and `@bonniernews/eslint-config/all` configs.
+  in the `@bonniernews/eslint-config/test-js` and `@bonniernews/eslint-config/test-ts` configs.
 
 Once you complete the steps above run the following:
 
@@ -198,7 +244,7 @@ npx eslint . --fix
 If you want to use _Prettier_, run it before eslint. ESLint should be the final judge, i.e. run:
 
 ```sh
-npx prettier --save .
+npx prettier --write .
 npx eslint . --fix
 ```
 

package/base-config.js

@@ -1,30 +1,38 @@
-"use strict";
+import eslintPluginTypescriptRules from "@bonniernews/eslint-plugin-typescript-rules";
+import eslintPluginImport from "eslint-plugin-import";
+import eslintPluginN from "eslint-plugin-n";
+import fs from "fs";
+import { createRequire } from "module";
+import path from "path";
 
-const path = require("path");
-const fs = require("fs");
-const getRules = require("./rules");
-const globals = require("./globals");
+import globals from "./globals.js";
+import getRules from "./rules.js";
 
-const eslintPluginN = require("eslint-plugin-n");
-const eslintPluginImport = require("eslint-plugin-import");
-const eslintPluginTypescriptRules = require("@bonniernews/eslint-plugin-typescript-rules");
+const require = createRequire(import.meta.url);
 
-function findPackageJson(startDir) {
-  let dir = path.resolve(startDir || process.cwd());
+function findPackageJson() {
+  let dir = process.cwd();
+  const root = path.parse(dir).root;
 
-  do {
+  while (dir !== root) {
     const pkgfile = path.join(dir, "package.json");
 
-    if (!fs.existsSync(pkgfile)) {
-      dir = path.join(dir, "..");
-      continue;
+    if (fs.existsSync(pkgfile)) {
+      return pkgfile;
     }
-    return pkgfile;
-  } while (dir !== path.resolve(dir, "..") && !fs.existsSync(path.resolve(dir, ".git")));
+
+    if (fs.existsSync(path.join(dir, ".git"))) {
+      break;
+    }
+
+    dir = path.join(dir, "..");
+  }
+
   return null;
 }
 
-const isModuleProject = require(findPackageJson(fs.realpathSync(process.cwd()))).type === "module";
+// eslint-disable-next-line import/no-dynamic-require
+const isModuleProject = require(findPackageJson()).type === "module";
 const hasES2022Support = parseInt(process.versions.node.split(".").shift(), 10) >= 16;
 
 const moduleConfig = {
@@ -57,4 +65,4 @@ const baseConfig = {
   rules: getRules(isModuleProject),
 };
 
-module.exports = baseConfig;
+export default baseConfig;

package/globals.js

@@ -1,3 +1,3 @@
-"use strict";
+import globals from "globals";
 
-module.exports = require("globals");
+export default globals;

package/ignores.js

@@ -1,5 +1,4 @@
-"use strict";
-module.exports = {
+export default {
   ignores: [
     "tmp/",
     "public/",

package/index.js

@@ -1,14 +1,12 @@
-"use strict";
+import baseConfig from "./base-config.js";
+import ignoresConfig from "./ignores.js";
+import jsxConfig from "./jsx.js";
+import testJsConfig from "./test-js.js";
+import testTsConfig from "./test-ts.js";
+import tsConfig from "./ts.js";
+import tsxConfig from "./tsx.js";
 
-const baseConfig = require("./base-config");
-const jsxConfig = require("./jsx");
-const tsConfig = require("./ts");
-const tsxConfig = require("./tsx");
-const testJsConfig = require("./test-js");
-const testTsConfig = require("./test-ts");
-const ignoresConfig = require("./ignores");
-
-module.exports = [
+export default [
   baseConfig,
   jsxConfig,
   tsConfig,

package/js.js

@@ -1,3 +1,3 @@
-"use strict";
+import baseConfig from "./base-config.js";
 
-module.exports = require("./base-config");
+export default baseConfig;

package/jsx.js

@@ -1,10 +1,9 @@
-"use strict";
+import reactPlugin from "eslint-plugin-react";
 
-const reactPlugin = require("eslint-plugin-react");
-const reactRules = require("./react-rules");
-const baseConfig = require("./base-config");
+import baseConfig from "./base-config.js";
+import reactRules from "./react-rules.js";
 
-module.exports = {
+export default {
   ...baseConfig,
   files: [ "**/*.jsx" ],
   languageOptions: {

package/package.json

@@ -1,10 +1,13 @@
 {
   "name": "@bonniernews/eslint-config",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "ESLint config",
+  "type": "module",
   "main": "index.js",
   "scripts": {
-    "test": "mocha && eslint ."
+    "test-esm": "mocha",
+    "test-cjs": "cd test/commonjs && mocha",
+    "test": "npm run test-esm && npm run test-cjs && eslint ."
   },
   "repository": {
     "type": "git",
@@ -20,11 +23,12 @@
   ],
   "contributors": [],
   "devDependencies": {
-    "chai": "^4.3.10",
-    "eslint": "^9.19.0",
-    "mocha": "^11.3.0",
+    "chai": "^6.2.2",
+    "eslint": "^9.39.2",
+    "mocha": "^11.7.5",
     "mocha-cakes-2": "^3.3.0",
-    "typescript": "^5.7.3"
+    "preact": "^10.29.0",
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
     "eslint": ">=9.19.0",
@@ -40,16 +44,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@bonniernews/eslint-plugin-typescript-rules": "^1.0.0",
-    "@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",
+    "@bonniernews/eslint-plugin-typescript-rules": "^1.0.2",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "@typescript-eslint/eslint-plugin": "^8.51.0",
+    "@typescript-eslint/parser": "^8.51.0",
+    "eslint-plugin-chai-friendly": "^1.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-n": "^17.23.1",
     "eslint-plugin-no-only-tests": "^3.3.0",
-    "eslint-plugin-react": "^7.37.4",
-    "globals": "^15.15.0"
+    "eslint-plugin-react": "^7.37.5",
+    "globals": "^17.0.0"
   },
   "files": [
     "index.js",

package/react-rules.js

@@ -1,5 +1,3 @@
-"use strict";
-
 const eslintReactRecommendedRules = {
   "react/display-name": 2,
   "react/jsx-key": 2,
@@ -24,7 +22,7 @@ const eslintReactRecommendedRules = {
   "react/require-render-return": 2,
 };
 
-module.exports = {
+export default {
   ...eslintReactRecommendedRules,
   "react/prop-types": 0,
   "react/jsx-first-prop-new-line": [ 2, "multiline" ],

package/rules.js

@@ -1,5 +1,3 @@
-"use strict";
-
 const eslintRecommendedRules = {
   "constructor-super": "error",
   "for-direction": "error",
@@ -229,7 +227,7 @@ const importRules = {
   "import/newline-after-import": "error",
 };
 
-module.exports = function getRules(isModuleProject) {
+export default function getRules(isModuleProject) {
   return {
     ...eslintRecommendedRules,
     ...nodeRecommendedRules,
@@ -284,4 +282,4 @@ module.exports = function getRules(isModuleProject) {
     "object-curly-newline": [ "error", { multiline: true } ],
     "object-property-newline": [ "error", { allowAllPropertiesOnSameLine: true } ],
   };
-};
+}

package/test-base.js

@@ -1,8 +1,7 @@
-"use strict";
+import chaiFriendly from "eslint-plugin-chai-friendly";
+import noOnlyTests from "eslint-plugin-no-only-tests";
 
-const noOnlyTests = require("eslint-plugin-no-only-tests");
-const chaiFriendly = require("eslint-plugin-chai-friendly");
-const globals = require("./globals");
+import globals from "./globals.js";
 
 const mochaCakes2Globals = {
   And: "readonly",
@@ -40,7 +39,7 @@ const mochaCakes2Rules = {
   ],
 };
 
-module.exports = {
+export default {
   languageOptions: { globals: { ...mochaCakes2Globals } },
   files: [ "**/test/**/*.js", "**/test/**/*.ts" ],
   plugins: {

package/test-js.js

@@ -1,9 +1,7 @@
-"use strict";
+import baseConfig from "./base-config.js";
+import testBase from "./test-base.js";
 
-const baseConfig = require("./base-config");
-const testBase = require("./test-base");
-
-module.exports = {
+export default {
   ...baseConfig,
   ...testBase,
   rules: {

package/test-ts.js

@@ -1,9 +1,7 @@
-"use strict";
+import testBase from "./test-base.js";
+import tsConfig from "./ts.js";
 
-const tsConfig = require("./ts");
-const testBase = require("./test-base");
-
-module.exports = {
+export default {
   ...tsConfig,
   ...testBase,
   languageOptions: {

package/ts.js

@@ -1,11 +1,12 @@
-"use strict";
+import bnTypescriptRules from "@bonniernews/eslint-plugin-typescript-rules";
+import stylistic from "@stylistic/eslint-plugin";
+// eslint-disable-next-line import/no-unresolved
+import typeScriptPlugin from "@typescript-eslint/eslint-plugin";
+// eslint-disable-next-line import/no-unresolved
+import typeScriptParser from "@typescript-eslint/parser";
 
-const baseConfig = require("./base-config");
-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");
+import baseConfig from "./base-config.js";
+import typescriptRules from "./typescript-rules.js";
 
 const typescriptBase = {
   plugins: {
@@ -23,4 +24,4 @@ const typescriptBase = {
   settings: { "import/resolver": { node: { extensions: [ ".ts", ".js" ] } } },
 };
 
-module.exports = typescriptBase;
+export default typescriptBase;

package/tsx.js

@@ -1,10 +1,9 @@
-"use strict";
+import reactPlugin from "eslint-plugin-react";
 
-const typescriptBase = require("./ts");
-const reactPlugin = require("eslint-plugin-react");
-const reactRules = require("./react-rules");
+import reactRules from "./react-rules.js";
+import typescriptBase from "./ts.js";
 
-module.exports = {
+export default {
   ...typescriptBase,
   plugins: { ...typescriptBase.plugins, react: reactPlugin },
   files: [ "**/*.tsx" ],

package/typescript-rules.js

@@ -1,5 +1,3 @@
-"use strict";
-
 const typescriptEslintRecommended = {
   "@typescript-eslint/adjacent-overload-signatures": "error",
   "@typescript-eslint/ban-ts-comment": "error",
@@ -55,7 +53,7 @@ const eslitRecommendedTs = {
 
 const importRules = { "import/named": "off" };
 
-module.exports = {
+export default {
   ...typescriptEslintRecommended,
   ...eslitRecommendedTs,
   ...importRules,