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

package/CHANGELOG.md

@@ -5,6 +5,24 @@ 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.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]
+- Support for more complex MDN data:
+  * Multiple support statements are now all checked. Previously only the first (most recent) was, which may have missed cases where support was backported.
+  * `version_removed` is now checked.
+  * Ranged versions (≤) are now handled.
+  * `prefix`, `alternative_name`, and `flags` now indicate (possible) lack of support. [#31658]
+
+### Changed
+- Updated package dependencies.
+
+### Deprecated
+- Deprecated `getBrowsers` function in favor of the new `getAllBrowsers`. [#31658]
+
+### Fixed
+- Apparently MDN data considers "preview" a version, but didn't think that worth documenting. Handle it. [#31816]
+
 ## [2.0.0] - 2023-06-26
 ### Changed
 - As `eslint-plugin-es` appears to be abandoned, change to using `eslint-plugin-es-x`. [#31556]
@@ -41,6 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release.
 
+[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
 [1.0.5]: https://github.com/Automattic/eslint-config-target-es/compare/1.0.4...1.0.5

package/README.md

@@ -61,10 +61,14 @@ to avoid your standard eslintrc and eslintignore and to avoid errors from any in
 
 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.
 
-As browserslist and MDN use different browser codes, `getBrowsers( { query: } )` will take a browserslist query and return an object with the MDN browser codes and the minimum matched version for each.
+As browserslist and MDN use different browser codes, `getAllBrowsers( { query: } )` will take a browserslist query and return an object with the MDN browser codes and the matched versions for each.
 
 `getRules( { query:, builtins: } )` will return the rules config. Set `builtins` true for "builtins", false for "language", or null/undefined for "all".
 
+### Caveats
+
+Some browsers supported by browserslist are not availble in the MDN data (e.g. Opera Mini) or are no longer being updated (e.g. Internet Explorer). In cases like these where no data is available, features are assumed to be supported. Set the environment variable `DEBUG=@automattic/eslint-config-target-es:warn` to generate messages when this happens.
+
 ## Security
 
 Need to report a security vulnerability? Go to [https://automattic.com/security/](https://automattic.com/security/) or directly to our security bug bounty site [https://hackerone.com/automattic](https://hackerone.com/automattic).

package/SECURITY.md

@@ -4,11 +4,20 @@ Full details of the Automattic Security Policy can be found on [automattic.com](
 
 ## Supported Versions
 
-Generally, only the latest version of Jetpack has continued support. If a critical vulnerability is found in the current version of Jetpack, we may opt to backport any patches to previous versions. 
+Generally, only the latest version of Jetpack and its associated plugins have continued support. If a critical vulnerability is found in the current version of a plugin, we may opt to backport any patches to previous versions. 
 
 ## Reporting a Vulnerability
 
-[Jetpack](https://jetpack.com/) is an open-source plugin for WordPress. Our HackerOne program covers the plugin software, as well as a variety of related projects and infrastructure.
+Our HackerOne program covers the below plugin software, as well as a variety of related projects and infrastructure:
+
+* [Jetpack](https://jetpack.com/)
+* Jetpack Backup
+* Jetpack Boost
+* Jetpack CRM
+* Jetpack Protect
+* Jetpack Search
+* Jetpack Social
+* Jetpack VideoPress
 
 **For responsible disclosure of security issues and to be eligible for our bug bounty program, please submit your report via the [HackerOne](https://hackerone.com/automattic) portal.**
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/eslint-config-target-es",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"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": {
@@ -17,16 +17,16 @@
 		"test": "jest tests"
 	},
 	"dependencies": {
-		"@mdn/browser-compat-data": "5.2.66",
+		"@mdn/browser-compat-data": "5.3.28",
 		"browserslist": "^4.17.6",
 		"debug": "^4.3.2",
 		"semver": "^7.3.5"
 	},
 	"devDependencies": {
-		"@wordpress/browserslist-config": "5.18.0",
-		"eslint": "8.39.0",
-		"eslint-plugin-es-x": "7.1.0",
-		"jest": "29.4.3"
+		"@wordpress/browserslist-config": "5.33.0",
+		"eslint": "8.51.0",
+		"eslint-plugin-es-x": "7.2.0",
+		"jest": "29.7.0"
 	},
 	"peerDependencies": {
 		"eslint": ">=4.19.1",

package/src/funcs.js

@@ -1,22 +1,20 @@
-const mdn = require( '@mdn/browser-compat-data' );
 const browserslist = require( 'browserslist' );
 const debug = require( 'debug' );
 const { rules: esRules } = require( 'eslint-plugin-es-x' );
 const semver = require( 'semver' );
 const browsersMap = require( './browsersMap.js' );
-const rulesMap = require( './rulesMap.js' );
+const { needsCheck } = require( './needsCheck.js' );
 
 const warn = debug( '@automattic/eslint-config-target-es:warn' );
-const debuglog = debug( '@automattic/eslint-config-target-es:debug' );
 
 /**
  * Get the list of supported browsers.
  *
  * @param {object} options - Options.
  * @param {string} options.query - Browserslist query.
- * @returns {object} Browsers mapped to versions.
+ * @returns {object} Browsers mapped to arrays of versions.
  */
-function getBrowsers( options = {} ) {
+function getAllBrowsers( options = {} ) {
 	const browsers = {};
 	for ( const b of browserslist( options.query ) ) {
 		const m = b.match( /^([a-z_]+) (all|[0-9.]+)(-.*)?$/ );
@@ -33,92 +31,29 @@ function getBrowsers( options = {} ) {
 			continue;
 		}
 		const ver = m[ 2 ] === 'all' ? '0.0.0' : semver.coerce( m[ 2 ] ).version;
-		if ( typeof browsers[ browser ] === 'undefined' || semver.lt( ver, browsers[ browser ] ) ) {
-			browsers[ browser ] = ver;
-		}
+		browsers[ browser ] ||= [];
+		browsers[ browser ].push( ver );
+		browsers[ browser ].sort( semver.compare );
 	}
 	return browsers;
 }
 
 /**
- * Test if a rule needs to be checked.
+ * Get the list of supported browsers.
  *
- * @param {string} rule - Rule.
- * @param {object} browsers - Browsers targeted.
+ * @deprecated since 2.1.0. Use getAllBrowsers instead.
  * @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.
+ * @param {string} options.query - Browserslist query.
+ * @returns {object} Browsers mapped to minimum versions.
  */
-// eslint-disable-next-line no-unused-vars
-function needsCheck( rule, browsers, options = {} ) {
-	let paths = rulesMap[ rule ];
-	if ( paths === true || paths === false ) {
-		return paths;
-	}
-	if ( ! Array.isArray( paths ) ) {
-		paths = [ paths ];
-	}
-
-	if (
-		options.builtins === false &&
-		paths.some( path => path.startsWith( 'javascript.builtins.' ) )
-	) {
-		return false;
-	}
-	if (
-		options.builtins === true &&
-		! paths.some( path => path.startsWith( 'javascript.builtins.' ) )
-	) {
-		return false;
-	}
-
-	path: for ( const path of paths ) {
-		let data = mdn;
-		for ( const k of path.split( '.' ) ) {
-			data = data[ k ];
-			if ( ! data ) {
-				warn( `Invalid feature map for rule ${ rule }: ${ path } does not exist` );
-				continue path;
-			}
-		}
-		if ( ! data.__compat || ! data.__compat.support ) {
-			warn( `Invalid feature map for rule ${ rule }: No data at ${ path }` );
-			continue path;
-		}
-
-		browser: for ( const browser of Object.keys( browsers ) ) {
-			if ( ! data.__compat.support[ browser ] ) {
-				debuglog( `No support data for ${ browser } for rule ${ rule } (${ path }), skipping` );
-				continue browser;
-			}
-			let support = data.__compat.support[ browser ];
-			if ( Array.isArray( support ) ) {
-				support = support[ 0 ];
-			}
-
-			if ( support.version_added === null ) {
-				debuglog( `No support data for ${ browser } for rule ${ rule } (${ path }), skipping` );
-				continue browser;
-			} else if ( support.version_added === false ) {
-				debuglog( `${ browser } needs check for ${ rule } (${ path })` );
-				return true;
-			} else if ( support.version_added === true ) {
-				continue browser;
-			} else if ( semver.gt( semver.coerce( support.version_added ), browsers[ browser ] ) ) {
-				debuglog(
-					`${ browser } < ${ support.version_added } needs check for ${ rule } (${ path }); we have ${ browsers[ browser ] }`
-				);
-				return true;
-			} else if ( support.partial_implementation ) {
-				debuglog(
-					`${ browser } needs check for ${ rule } (${ path }) due to partial implementation`
-				);
-				return true;
-			}
-		}
+function getBrowsers( options = {} ) {
+	warn( 'getBrowsers is deprecated. Use getAllBrowsers instead.' );
+	const browsers = getAllBrowsers( options );
+	const ret = {};
+	for ( const k of Object.keys( browsers ) ) {
+		ret[ k ] = browsers[ k ][ 0 ];
 	}
-
-	return false;
+	return ret;
 }
 
 /**
@@ -130,7 +65,7 @@ function needsCheck( rule, browsers, options = {} ) {
  * @returns {object} Rules configuration.
  */
 function getRules( options = {} ) {
-	const browsers = getBrowsers( options );
+	const browsers = getAllBrowsers( options );
 	const ret = {};
 	for ( const rule of Object.keys( esRules ) ) {
 		ret[ `es-x/${ rule }` ] = needsCheck( rule, browsers, options ) ? 2 : 0;
@@ -139,6 +74,7 @@ function getRules( options = {} ) {
 }
 
 module.exports = {
+	getAllBrowsers,
 	getBrowsers,
 	getRules,
 };

package/src/needsCheck.js

@@ -0,0 +1,151 @@
+const mdn = require( '@mdn/browser-compat-data' );
+const debug = require( 'debug' );
+const semver = require( 'semver' );
+const rulesMap = require( './rulesMap.js' );
+
+const warn = debug( '@automattic/eslint-config-target-es:warn' );
+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 {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.
+ */
+function needsCheck( rule, browsers, options = {} ) {
+	let paths = rulesMap[ rule ];
+	if ( paths === true || paths === false ) {
+		return paths;
+	}
+	if ( paths === undefined ) {
+		warn( `No feature map for rule ${ rule }` );
+		return false;
+	}
+	if ( ! Array.isArray( paths ) ) {
+		paths = [ paths ];
+	}
+
+	if (
+		options.builtins === false &&
+		paths.some( path => path.startsWith( 'javascript.builtins.' ) )
+	) {
+		return false;
+	}
+	if (
+		options.builtins === true &&
+		! paths.some( path => path.startsWith( 'javascript.builtins.' ) )
+	) {
+		return false;
+	}
+
+	const semver000 = semver.coerce( '0.0.0' );
+
+	path: for ( const path of paths ) {
+		let data = mdn;
+		for ( const k of path.split( '.' ) ) {
+			data = data[ k ];
+			if ( ! data ) {
+				warn( `Invalid feature map for rule ${ rule }: ${ path } does not exist` );
+				continue path;
+			}
+		}
+		if ( ! data.__compat || ! data.__compat.support ) {
+			warn( `Invalid feature map for rule ${ rule }: No data at ${ path }` );
+			continue path;
+		}
+
+		browser: for ( const browser of Object.keys( browsers ) ) {
+			if ( ! data.__compat.support[ browser ] ) {
+				warn( `No support data for ${ browser } for rule ${ rule } (${ path }), skipping` );
+				continue browser;
+			}
+
+			const supports = Array.isArray( data.__compat.support[ browser ] )
+				? data.__compat.support[ browser ]
+				: [ data.__compat.support[ browser ] ];
+			const vers = Array.isArray( browsers[ browser ] )
+				? browsers[ browser ]
+				: [ browsers[ browser ] ];
+
+			version: for ( const ver of vers ) {
+				const results = [];
+				support: for ( const support of supports ) {
+					if ( support.version_added === null ) {
+						continue support;
+					}
+
+					if ( support.version_added === false ) {
+						results.push( 'no support' );
+						continue support;
+					}
+					if ( support.version_added === 'preview' ) {
+						results.push( 'added version is "preview"' );
+						continue support;
+					}
+
+					let added, removed;
+					if ( support.version_added === true ) {
+						added = semver000;
+					} else {
+						added = support.version_added.startsWith( '≤' )
+							? semver000
+							: semver.coerce( support.version_added );
+					}
+					if ( support.version_removed === true ) {
+						removed = semver000;
+					} else if (
+						typeof support.version_removed === 'string' &&
+						support.version_removed !== 'preview'
+					) {
+						removed = support.version_removed.startsWith( '≤' )
+							? semver000
+							: semver.coerce( support.version_removed );
+					}
+
+					const range = removed ? `${ added } – <${ removed }` : `>= ${ added }`;
+
+					if ( semver.gt( added, ver ) || ( removed && semver.lte( removed, ver ) ) ) {
+						results.push( `outside range ${ range }` );
+					} else if ( support.partial_implementation ) {
+						results.push( `partial implementation for ${ range }` );
+					} else if ( support.prefix ) {
+						results.push( `prefixed implementation for ${ range }` );
+					} else if ( support.alternative_name ) {
+						results.push( `alternatively named implementation for ${ range }` );
+					} else if ( support.flags ) {
+						results.push( `flagged implementation for ${ range }` );
+					} else {
+						// It's good! Check the next version.
+						continue version;
+					}
+				}
+
+				// If there was no support data at all...
+				if ( results.length === 0 ) {
+					warn( `No support data for ${ browser } for rule ${ rule } (${ path }), skipping` );
+					continue browser;
+				}
+
+				// If no support entry hit the "It's good" case, it's no good. Log the reasons.
+				// If there are reasons other than "outside range", skip any "outside range" as irrelevant.
+				let results2 = results.filter( v => ! v.startsWith( 'outside range' ) );
+				if ( results2.length === 0 ) {
+					results2 = results;
+				}
+				debuglog(
+					`${ browser } ${ ver } needs check for ${ rule } (${ path }); ${ results2.join( '; ' ) }`
+				);
+				return true;
+			}
+		}
+	}
+
+	return false;
+}
+
+module.exports = {
+	needsCheck,
+};

package/src/rulesMap.js

@@ -3,6 +3,7 @@
 module.exports = {
 	// ?
 	'no-atomics-waitasync': 'javascript.builtins.Atomics.waitAsync',
+	'no-regexp-v-flag': 'javascript.builtins.RegExp.unicodeSets',
 	'no-string-prototype-iswellformed-towellformed': [
 		'javascript.builtins.String.isWellFormed',
 		'javascript.builtins.String.toWellFormed',