@metamask/eslint-config-browser 13.0.0 → 15.0.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -6,32 +7,64 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [15.0.0]
+
+### Changed
+
+- **BREAKING:** Bump peer dependency on `@metamask/eslint-config` from `^14.0.0` to `^15.0.0` ([#431](https://github.com/MetaMask/eslint-config/pull/431))
+
+## [14.0.0]
+
+### Changed
+
+- **BREAKING:** Bump minimum Node.js version from 16 to 18.18 ([#371](https://github.com/MetaMask/eslint-config/pull/371))
+- **BREAKING:** Bump peer dependency on ESLint from `^8.57.0` to `^9.11.0` ([#370](https://github.com/MetaMask/eslint-config/pull/370))
+  - ESLint 9 requires flat configs, so this change also rewrites the configs to
+    use flat configs. The legacy config format is no longer supported.
+- **BREAKING:** Bump peer dependency on `@metamask/eslint-config` from `^13.0.0` to `^14.0.0` ([#377](https://github.com/MetaMask/eslint-config/pull/377))
+- **BREAKING:** Change package to be pure ESM ([#370](https://github.com/MetaMask/eslint-config/pull/370))
+  - ESLint 9 supports ESM out-of-the-box, so this change updates the package to
+    be pure ESM. This means that the package can no longer be used with CommonJS
+    `require` syntax.
+
 ## [13.0.0]
+
 ### Changed
+
 - **BREAKING**: Replace `eslint-plugin-import` with `eslint-plugin-import-x` ([#366](https://github.com/MetaMask/eslint-config/pull/366))
 - **BREAKING**: Bump all ESLint dependencies ([#351](https://github.com/MetaMask/eslint-config/pull/351))
   - Bumps all ESLint dependencies to the latest version compatible with Node.js 16.
 - **BREAKING**: Bump minimum Node.js version from 14 to 16 ([#332](https://github.com/MetaMask/eslint-config/pull/332), [#339](https://github.com/MetaMask/eslint-config/pull/339))
 
 ## [12.1.0]
+
 ### Changed
+
 - Add support for typescript 5.0.x, 5.1.x ([#288](https://github.com/MetaMask/eslint-config/pull/288))
 
 ## [12.0.0]
+
 ### Changed
+
 - **BREAKING:** Update peer dependency `@metamask/eslint-config` to v12
 
 ## [11.1.0]
+
 ### Changed
+
 - Exclude test files from package ([#266](https://github.com/MetaMask/eslint-config/pull/266))
 
 ## [11.0.0]
+
 ### Added
+
 - Initial release of this package.
 
-[Unreleased]: https://github.com/MetaMask/eslint-config/compare/v13.0.0...HEAD
-[13.0.0]: https://github.com/MetaMask/eslint-config/compare/v12.1.0...v13.0.0
-[12.1.0]: https://github.com/MetaMask/eslint-config/compare/v12.0.0...v12.1.0
-[12.0.0]: https://github.com/MetaMask/eslint-config/compare/v11.1.0...v12.0.0
-[11.1.0]: https://github.com/MetaMask/eslint-config/compare/v11.0.0...v11.1.0
-[11.0.0]: https://github.com/MetaMask/eslint-config/releases/tag/v11.0.0
+[Unreleased]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-browser@15.0.0...HEAD
+[15.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-browser@14.0.0...@metamask/eslint-config-browser@15.0.0
+[14.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-browser@13.0.0...@metamask/eslint-config-browser@14.0.0
+[13.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-browser@12.1.0...@metamask/eslint-config-browser@13.0.0
+[12.1.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-browser@12.0.0...@metamask/eslint-config-browser@12.1.0
+[12.0.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-browser@11.1.0...@metamask/eslint-config-browser@12.0.0
+[11.1.0]: https://github.com/MetaMask/eslint-config/compare/@metamask/eslint-config-browser@11.0.0...@metamask/eslint-config-browser@11.1.0
+[11.0.0]: https://github.com/MetaMask/eslint-config/releases/tag/@metamask/eslint-config-browser@11.0.0

package/README.md

@@ -8,30 +8,36 @@ Our default export contains a base set of ESLint rules for ES6+:
 
 ```bash
 yarn add --dev \
-    @metamask/eslint-config@^12.2.0 \
-    @metamask/eslint-config-browser@^12.1.0 \
-    eslint@^8.57.0 \
-    eslint-config-prettier@^8.5.0 \
-    eslint-plugin-import-x@^0.5.1 \
-    eslint-plugin-jsdoc@^47.0.2 \
-    eslint-plugin-prettier@^4.2.1 \
-    eslint-plugin-promise@^6.1.1 \
-    prettier@^2.7.1
+    @metamask/eslint-config@^14.0.0 \
+    @metamask/eslint-config-browser@^14.0.0 \
+    eslint@^9.11.0 \
+    eslint-config-prettier@^9.1.0 \
+    eslint-plugin-import-x@^4.3.0 \
+    eslint-plugin-jsdoc@^50.2.4 \
+    eslint-plugin-prettier@^5.2.1 \
+    eslint-plugin-promise@^7.1.0 \
+    prettier@^3.3.3
 ```
 
 The order in which you extend ESLint rules matters.
-The `@metamask/*` eslint configs should be added to the `extends` array _last_,
+The `@metamask/*` eslint configs should be added to the config array _last_,
 with `@metamask/eslint-config` first, and `@metamask/eslint-config-*` in any
 order thereafter.
 
 ```js
-module.exports = {
-  root: true,
-
-  extends: [
-    // These should be added last unless you know what you're doing.
-    '@metamask/eslint-config',
-    '@metamask/eslint-config-browser',
-  ],
-};
+import base, { createConfig } from '@metamask/eslint-config';
+import browser from '@metamask/eslint-config-browser';
+
+const config = createConfig({
+  {
+    extends: [
+      // Any custom shared config should be added here.
+      // ...
+
+      // This should be added last unless you know what you're doing.
+      base,
+      browser,
+    ],
+  }
+});
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eslint-config-browser",
-  "version": "13.0.0",
+  "version": "15.0.0",
   "description": "Shareable MetaMask ESLint plugin for browser environments.",
   "homepage": "https://github.com/MetaMask/eslint-config#readme",
   "bugs": {
@@ -11,31 +11,48 @@
     "url": "https://github.com/MetaMask/eslint-config.git"
   },
   "license": "MIT",
-  "main": "src/index.js",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./src/index.d.mts",
+        "default": "./src/index.mjs"
+      }
+    }
+  },
+  "main": "./src/index.mjs",
+  "types": "./src/index.d.mts",
   "files": [
     "src/",
-    "!src/**/*.test.js"
+    "!src/**/*.test.mjs"
   ],
   "scripts": {
-    "lint:changelog": "auto-changelog validate",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/eslint-config-browser",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eslint-config-browser",
     "publish": "npm publish",
     "test": "eslint ."
   },
+  "dependencies": {
+    "@eslint/js": "^9.11.0",
+    "globals": "^15.9.0"
+  },
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@metamask/auto-changelog": "^3.4.4",
-    "eslint": "^8.57.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-import-x": "^0.5.1",
-    "eslint-plugin-jsdoc": "^47.0.2",
-    "eslint-plugin-prettier": "^4.2.1",
-    "prettier": "^2.7.1"
+    "eslint": "^9.11.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import-x": "^4.3.0",
+    "eslint-plugin-jsdoc": "^50.2.4",
+    "eslint-plugin-prettier": "^5.2.1",
+    "prettier": "^3.3.3",
+    "vitest": "^2.1.9"
   },
   "peerDependencies": {
-    "@metamask/eslint-config": "^13.0.0",
-    "eslint": "^8.57.0"
+    "@metamask/eslint-config": "^15.0.0",
+    "eslint": "^9.11.0"
   },
   "engines": {
-    "node": "^16.20 || ^18.18 || >=20"
+    "node": "^18.18 || >=20"
   },
   "publishConfig": {
     "access": "public",

package/src/index.d.mts

@@ -0,0 +1,6 @@
+declare module '@metamask/eslint-config-browser' {
+  import type { Linter } from 'eslint';
+
+  const config: Linter.Config[];
+  export default config;
+}

package/src/index.mjs

@@ -0,0 +1,26 @@
+import { createConfig } from '@metamask/eslint-config';
+import globals from 'globals';
+import { createRequire } from 'module';
+
+// TODO: Use import attributes when ESLint supports them.
+const customRequire = createRequire(import.meta.url);
+const environmentRules = customRequire('./environment.json');
+
+/**
+ * @type {import('eslint').Linter.Config[]}
+ */
+const config = createConfig({
+  name: '@metamask/eslint-config-browser',
+
+  languageOptions: {
+    globals: {
+      ...globals.browser,
+    },
+  },
+
+  rules: {
+    ...environmentRules,
+  },
+});
+
+export default config;

package/src/index.js

@@ -1,11 +0,0 @@
-const environmentRules = require('./environment.json');
-
-module.exports = {
-  env: {
-    browser: true,
-  },
-
-  rules: {
-    ...environmentRules,
-  },
-};