@automattic/eslint-config-target-es 2.1.0 → 2.2.1

package/CHANGELOG.md

@@ -5,6 +5,22 @@ 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/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.1] - 2024-12-04
+### Added
+- Enable test coverage. [#39961]
+
+### Changed
+- Updated package dependencies. [#39176] [#39177] [#39302] [#39594] [#39707] [#39898] [#39999] [#40288] [#40363]
+
+## [2.2.0] - 2024-08-29
+### Added
+- Add mapping for `es-x/no-regexp-duplicate-named-capturing-groups`. [#39005]
+- Support eslint flat configs (`eslint.config.js`). [#37855]
+- Updated `eslint-plugin-es-x` adds additional rules: `es-x/no-arraybuffer-prototype-transfer`, `es-x/no-object-map-groupby`, `es-x/no-promise-withresolvers`, `es-x/no-resizable-and-growable-arraybuffers`, `es-x/no-set-prototype-difference`, `es-x/no-set-prototype-intersection`, `es-x/no-set-prototype-isdisjointfrom`, `es-x/no-set-prototype-issubsetof`, `es-x/no-set-prototype-issupersetof`, `es-x/no-set-prototype-symmetricdifference`, and `es-x/no-set-prototype-union`. [#37830]
+
+### Changed
+- Updated package dependencies. [#35608] [#36095] [#36325] [#36585] [#36760] [#37147] [#37379] [#37669] [#37828] [#37830] [#38132] [#38662] [#39002]
+
 ## [2.1.0] - 2024-02-07
 ### Added
 - All versions indicated by browserslist are now checked, not just the lowest. Added `getAllBrowsers` function to support this. [#31658]
@@ -59,6 +75,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release.
 
+[2.2.1]: https://github.com/Automattic/eslint-config-target-es/compare/2.2.0...2.2.1
+[2.2.0]: https://github.com/Automattic/eslint-config-target-es/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/Automattic/eslint-config-target-es/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/Automattic/eslint-config-target-es/compare/1.0.6...2.0.0
 [1.0.6]: https://github.com/Automattic/eslint-config-target-es/compare/1.0.5...1.0.6

package/README.md

@@ -14,30 +14,30 @@ npm install --save-dev eslint eslint-plugin-es-x @automattic/eslint-config-targe
 
 First, you'll probably want to set up a [browserslist] configuration.
 
-Then you can use this like any other sharable config in your `.eslintrc.*` file. Three configurations are offered.
+Then you can use this like any other sharable config in your `eslint.config.js` or `.eslintrc.*` file. Three configurations are offered.
 
-To check only for language features, such as nullish coalescing, your eslintrc might look like
-```js
-{
-	extends: [ '@automattic/eslint-config-target-es/language' ],
-}
-```
+* To check only for language features, such as nullish coalescing, use the 'language' config.
+* To check only for builtins, such as Promise, WeakRef, and various features of RegExp, use the 'builtins' config.
+* To check both, use the 'all' config.
 
-To check only for builtins, such as Promise, WeakRef, and various features of RegExp, your eslintrc might look like
+For `eslint.config.js`, that might look like this:
 ```js
-{
-	extends: [ '@automattic/eslint-config-target-es/builtins' ],
-}
+import eslintConfigTargetEs from '@automattic/eslint-config-target-es/flat/language';
+
+export default [
+	eslintConfigTargetEs,
+	// etc
+];
 ```
 
-To check both, your eslintrc might look like
+while for eslintrc you'd do like
 ```js
 {
-	extends: [ '@automattic/eslint-config-target-es/all' ],
+	extends: [ '@automattic/eslint-config-target-es/rc/language' ],
 }
 ```
 
-For least surprise, omitting any suffix is the same as `/all`.
+For backwards compatibility, the eslintrc configs may also be accessed without the `/rc/` path component (e.g. as `@automattic/eslint-config-target-es/language`), and `@automattic/eslint-config-target-es` is equivalent to `@automattic/eslint-config-target-es/rc/all`.
 
 ### Checking built files
 
@@ -45,7 +45,7 @@ If you want to check your built files to make sure you didn't omit transpiling a
 ```js
 module.exports = {
 	root: true,
-	extends: [ '@automattic/eslint-config-target-es/language' ],
+	extends: [ '@automattic/eslint-config-target-es/rc/language' ],
 	env: {
 		// Whatever environments you need.
 	},
@@ -57,6 +57,8 @@ eslint --no-eslintrc --no-inline-config --config validate-es.config.js --no-igno
 ```
 to avoid your standard eslintrc and eslintignore and to avoid errors from any inline directives.
 
+Something similar can be done for flat config.
+
 ### Advanced usage
 
 You can import or require `@automattic/eslint-config-target-es/functions` to gain access to some functions that can be used to build your own configuration.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/eslint-config-target-es",
-	"version": "2.1.0",
+	"version": "2.2.1",
 	"description": "ESLint sharable config to activate eslint-plugin-es checks based on browserslist targets.",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/eslint-config-target-es/README.md#readme",
 	"bugs": {
@@ -14,29 +14,43 @@
 	"license": "GPL-2.0-or-later",
 	"author": "Automattic",
 	"scripts": {
-		"test": "jest tests"
+		"test": "jest --config=tests/jest.config.cjs",
+		"test-coverage": "pnpm run test --coverage"
 	},
 	"dependencies": {
-		"@mdn/browser-compat-data": "5.3.28",
+		"@mdn/browser-compat-data": "5.5.49",
 		"browserslist": "^4.17.6",
 		"debug": "^4.3.2",
 		"semver": "^7.3.5"
 	},
 	"devDependencies": {
-		"@wordpress/browserslist-config": "5.33.0",
-		"eslint": "8.51.0",
-		"eslint-plugin-es-x": "7.2.0",
+		"@wordpress/browserslist-config": "6.13.0",
+		"eslint": "8.57.1",
+		"eslint-plugin-es-x": "7.8.0",
+		"globals": "15.4.0",
 		"jest": "29.7.0"
 	},
 	"peerDependencies": {
 		"eslint": ">=4.19.1",
-		"eslint-plugin-es-x": "^7.1.0"
+		"eslint-plugin-es-x": "^7.6.0",
+		"globals": ">=15.4.0"
+	},
+	"peerDependenciesMeta": {
+		"globals": {
+			"optional": true
+		}
 	},
 	"exports": {
-		".": "./src/configs/all.js",
-		"./language": "./src/configs/language.js",
-		"./builtins": "./src/configs/builtins.js",
-		"./all": "./src/configs/all.js",
+		".": "./src/eslintrc/all.js",
+		"./language": "./src/eslintrc/language.js",
+		"./builtins": "./src/eslintrc/builtins.js",
+		"./all": "./src/eslintrc/all.js",
+		"./rc/language": "./src/eslintrc/language.js",
+		"./rc/builtins": "./src/eslintrc/builtins.js",
+		"./rc/all": "./src/eslintrc/all.js",
+		"./flat/language": "./src/flatconfig/language.js",
+		"./flat/builtins": "./src/flatconfig/builtins.js",
+		"./flat/all": "./src/flatconfig/all.js",
 		"./functions": "./src/funcs.js"
 	}
 }

package/src/flatconfig/all.js

@@ -0,0 +1,6 @@
+const { getRules } = require( '../funcs' );
+
+module.exports = {
+	...require( './base' ),
+	rules: getRules(),
+};

package/src/flatconfig/base.js

@@ -0,0 +1,21 @@
+const esx = require( 'eslint-plugin-es-x' );
+
+const flatBase = {
+	plugins: {
+		'es-x': esx,
+	},
+	languageOptions: {
+		ecmaVersion: 2022,
+	},
+};
+
+try {
+	const globals = require( 'globals' );
+	if ( globals?.es2022 ) {
+		flatBase.languageOptions.globals = globals.es2022;
+	}
+} catch ( e ) {
+	// `globals` is optional.
+}
+
+module.exports = flatBase;

package/src/flatconfig/builtins.js

@@ -0,0 +1,6 @@
+const { getRules } = require( '../funcs' );
+
+module.exports = {
+	...require( './base' ),
+	rules: getRules( { builtins: true } ),
+};

package/src/flatconfig/language.js

@@ -0,0 +1,6 @@
+const { getRules } = require( '../funcs' );
+
+module.exports = {
+	...require( './base' ),
+	rules: getRules( { builtins: false } ),
+};

package/src/funcs.js

@@ -10,9 +10,9 @@ const warn = debug( '@automattic/eslint-config-target-es:warn' );
 /**
  * Get the list of supported browsers.
  *
- * @param {object} options - Options.
+ * @param {object} options       - Options.
  * @param {string} options.query - Browserslist query.
- * @returns {object} Browsers mapped to arrays of versions.
+ * @return {object} Browsers mapped to arrays of versions.
  */
 function getAllBrowsers( options = {} ) {
 	const browsers = {};
@@ -42,9 +42,9 @@ function getAllBrowsers( options = {} ) {
  * Get the list of supported browsers.
  *
  * @deprecated since 2.1.0. Use getAllBrowsers instead.
- * @param {object} options - Options.
+ * @param {object} options       - Options.
  * @param {string} options.query - Browserslist query.
- * @returns {object} Browsers mapped to minimum versions.
+ * @return {object} Browsers mapped to minimum versions.
  */
 function getBrowsers( options = {} ) {
 	warn( 'getBrowsers is deprecated. Use getAllBrowsers instead.' );
@@ -59,10 +59,10 @@ function getBrowsers( options = {} ) {
 /**
  * Get the es-x rule configurations.
  *
- * @param {object} options - Options.
+ * @param {object}       options          - Options.
  * @param {boolean|null} options.builtins - If true, only rules with "javascript.builtins" paths are checked. If false, such rules are not checked. If null/undefined, all may be checked.
- * @param {string} options.query - Browserslist query.
- * @returns {object} Rules configuration.
+ * @param {string}       options.query    - Browserslist query.
+ * @return {object} Rules configuration.
  */
 function getRules( options = {} ) {
 	const browsers = getAllBrowsers( options );

package/src/needsCheck.js

@@ -9,11 +9,11 @@ const debuglog = debug( '@automattic/eslint-config-target-es:debug' );
 /**
  * Test if a rule needs to be checked.
  *
- * @param {string} rule - Rule.
- * @param {object} browsers - Browsers targeted.
- * @param {object} options - Options.
+ * @param {string}       rule             - Rule.
+ * @param {object}       browsers         - Browsers targeted.
+ * @param {object}       options          - Options.
  * @param {boolean|null} options.builtins - If true, only rules with "javascript.builtins" paths are checked. If false, such rules are not checked. If null/undefined, all may be checked.
- * @returns {boolean} Whether the rule needs to be checked.
+ * @return {boolean} Whether the rule needs to be checked.
  */
 function needsCheck( rule, browsers, options = {} ) {
 	let paths = rulesMap[ rule ];

package/src/rulesMap.js

@@ -1,9 +1,36 @@
 // Map of eslint-plugin-es-x rules to MDN compat-data paths.
 // Values are either a path, an array of paths, true to always enable the rule, or false to always disable it.
 module.exports = {
-	// ?
+	// ES2025
+	'no-regexp-duplicate-named-capturing-groups':
+		'javascript.regular_expressions.named_capturing_group.duplicate_named_capturing_groups',
+
+	// ES2024
+	'no-arraybuffer-prototype-transfer': 'javascript.builtins.ArrayBuffer.transfer',
 	'no-atomics-waitasync': 'javascript.builtins.Atomics.waitAsync',
+	'no-object-map-groupby': [
+		'javascript.builtins.Map.groupBy',
+		'javascript.builtins.Object.groupBy',
+	],
+	'no-promise-withresolvers': 'javascript.builtins.Promise.withResolvers',
 	'no-regexp-v-flag': 'javascript.builtins.RegExp.unicodeSets',
+	'no-resizable-and-growable-arraybuffers': [
+		'javascript.builtins.ArrayBuffer.ArrayBuffer.maxByteLength_option',
+		'javascript.builtins.ArrayBuffer.maxByteLength',
+		'javascript.builtins.ArrayBuffer.resizable',
+		'javascript.builtins.ArrayBuffer.resize',
+		'javascript.builtins.SharedArrayBuffer.SharedArrayBuffer.maxByteLength_option',
+		'javascript.builtins.SharedArrayBuffer.grow',
+		'javascript.builtins.SharedArrayBuffer.growable',
+		'javascript.builtins.SharedArrayBuffer.maxByteLength',
+	],
+	'no-set-prototype-difference': 'javascript.builtins.Set.difference',
+	'no-set-prototype-intersection': 'javascript.builtins.Set.intersection',
+	'no-set-prototype-isdisjointfrom': 'javascript.builtins.Set.isDisjointFrom',
+	'no-set-prototype-issubsetof': 'javascript.builtins.Set.isSubsetOf',
+	'no-set-prototype-issupersetof': 'javascript.builtins.Set.isSupersetOf',
+	'no-set-prototype-symmetricdifference': 'javascript.builtins.Set.symmetricDifference',
+	'no-set-prototype-union': 'javascript.builtins.Set.union',
 	'no-string-prototype-iswellformed-towellformed': [
 		'javascript.builtins.String.isWellFormed',
 		'javascript.builtins.String.toWellFormed',