@automattic/i18n-check-webpack-plugin 1.1.8 → 1.1.10

package/CHANGELOG.md

@@ -5,6 +5,14 @@ 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).
 
+## [1.1.10] - 2024-08-21
+### Changed
+- Internal updates.
+
+## [1.1.9] - 2024-06-12
+### Changed
+- Updated package dependencies. [#37796]
+
 ## [1.1.8] - 2024-05-06
 ### Changed
 - Internal updates.
@@ -206,6 +214,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Initial release.
 
+[1.1.10]: https://github.com/Automattic/i18n-check-webpack-plugin/compare/v1.1.9...v1.1.10
+[1.1.9]: https://github.com/Automattic/i18n-check-webpack-plugin/compare/v1.1.8...v1.1.9
 [1.1.8]: https://github.com/Automattic/i18n-check-webpack-plugin/compare/v1.1.7...v1.1.8
 [1.1.7]: https://github.com/Automattic/i18n-check-webpack-plugin/compare/v1.1.6...v1.1.7
 [1.1.6]: https://github.com/Automattic/i18n-check-webpack-plugin/compare/v1.1.5...v1.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/i18n-check-webpack-plugin",
-	"version": "1.1.8",
+	"version": "1.1.10",
 	"description": "A Webpack plugin to check that WordPress i18n hasn't been mangled by Webpack optimizations.",
 	"homepage": "https://github.com/Automattic/jetpack/tree/HEAD/projects/js-packages/i18n-check-webpack-plugin/#readme",
 	"bugs": {
@@ -21,7 +21,7 @@
 	},
 	"devDependencies": {
 		"@automattic/jetpack-webpack-config": "workspace:*",
-		"@babel/core": "7.24.0",
+		"@babel/core": "7.24.7",
 		"jest": "29.7.0",
 		"webpack": "5.76.0",
 		"webpack-cli": "4.9.1"

package/src/GettextEntry.js

@@ -22,12 +22,12 @@ class GettextEntry {
 	/**
 	 * Constructor.
 	 *
-	 * @param {object} data - Entry data.
-	 * @param {string} data.msgid - Message string.
-	 * @param {string} data.plural - Plural string.
-	 * @param {string} data.context - Context.
-	 * @param {string} data.domain - Text domain.
-	 * @param {Iterable<string>} data.comments - Comments.
+	 * @param {object}           data           - Entry data.
+	 * @param {string}           data.msgid     - Message string.
+	 * @param {string}           data.plural    - Plural string.
+	 * @param {string}           data.context   - Context.
+	 * @param {string}           data.domain    - Text domain.
+	 * @param {Iterable<string>} data.comments  - Comments.
 	 * @param {Iterable<string>} data.locations - Locations.
 	 */
 	constructor( data ) {

package/src/GettextExtractor.js

@@ -38,10 +38,10 @@ class GettextExtractor {
 	/**
 	 * Constructor.
 	 *
-	 * @param {object} options - Configuration options.
-	 * @param {object} options.babelOptions - Options for Babel.
-	 * @param {Object<string, (string | null)[]>} options.functions - Functions to extract. Defaults are available as a static property `defaultFunctions`.
-	 * @param {Function} options.lintLogger - Lint logging callback. See `this.setLintLogger()`.
+	 * @param {object}                            options              - Configuration options.
+	 * @param {object}                            options.babelOptions - Options for Babel.
+	 * @param {Object<string, (string | null)[]>} options.functions    - Functions to extract. Defaults are available as a static property `defaultFunctions`.
+	 * @param {Function}                          options.lintLogger   - Lint logging callback. See `this.setLintLogger()`.
 	 */
 	constructor( options = {} ) {
 		this.#babelOptions = options.babelOptions || {};
@@ -54,7 +54,7 @@ class GettextExtractor {
 	 *
 	 * @param {string} file - File name.
 	 * @param {object} opts - Babel options.
-	 * @returns {GettextEntries} Set of entries.
+	 * @return {GettextEntries} Set of entries.
 	 */
 	async extractFromFile( file, opts = {} ) {
 		const contents = await fs.readFile( file, { encoding: 'utf8' } );
@@ -65,8 +65,8 @@ class GettextExtractor {
 	 * Parse source.
 	 *
 	 * @param {string} source - JavaScript source.
-	 * @param {object} opts - Babel options.
-	 * @returns {babel.File} Babel File object.
+	 * @param {object} opts   - Babel options.
+	 * @return {babel.File} Babel File object.
 	 */
 	async parse( source, opts = {} ) {
 		const options = { ...this.#babelOptions, ...opts };
@@ -79,8 +79,8 @@ class GettextExtractor {
 	 * Extract gettext strings from source.
 	 *
 	 * @param {string} source - JavaScript source.
-	 * @param {object} opts - Babel options.
-	 * @returns {GettextEntries} Set of entries.
+	 * @param {object} opts   - Babel options.
+	 * @return {GettextEntries} Set of entries.
 	 */
 	async extract( source, opts ) {
 		return this.extractFromAst( await this.parse( source, opts ), opts );
@@ -90,8 +90,8 @@ class GettextExtractor {
 	 * Extract gettext strings from a Babel File object.
 	 *
 	 * @param {babel.File} file - Babel File object, e.g. from `this.parse()`.
-	 * @param {object} opts - Babel options.
-	 * @returns {GettextEntries} Set of entries.
+	 * @param {object}     opts - Babel options.
+	 * @return {GettextEntries} Set of entries.
 	 */
 	extractFromAst( file, opts = {} ) {
 		const entries = new GettextEntries();
@@ -101,11 +101,11 @@ class GettextExtractor {
 	/**
 	 * Extract gettext strings from a Babel File object.
 	 *
-	 * @param {babel.File} file - Babel File object, e.g. from `this.parse()`.
-	 * @param {GettextEntries} entries - Entries object to fill in.
-	 * @param {number|false} evalline - If this is a recursive call from an `eval()`, the line of the eval.
-	 * @param {object} opts - Babel options.
-	 * @returns {GettextEntries} `entries`.
+	 * @param {babel.File}     file     - Babel File object, e.g. from `this.parse()`.
+	 * @param {GettextEntries} entries  - Entries object to fill in.
+	 * @param {number|false}   evalline - If this is a recursive call from an `eval()`, the line of the eval.
+	 * @param {object}         opts     - Babel options.
+	 * @return {GettextEntries} `entries`.
 	 */
 	#extractFromAst( file, entries, evalline, opts ) {
 		const options = { ...this.#babelOptions, ...opts };
@@ -311,7 +311,7 @@ class GettextExtractor {
 	 *
 	 * @see https://github.com/wp-cli/i18n-command/blob/e9eef8aab4b5e43c3aa09bf60e1e7a9d6d30d302/src/JsFunctionsScanner.php#L254
 	 * @param {babel.CallExpression} node - CallExpression node.
-	 * @returns {{ name: string, comments: string[] }|undefined} Callee name and comments, or undefined.
+	 * @return {{ name: string, comments: string[] }|undefined} Callee name and comments, or undefined.
 	 */
 	#resolveExpressionCallee( node ) {
 		const callee = node.callee;
@@ -422,8 +422,8 @@ class GettextExtractor {
 	 *
 	 * @see https://github.com/wp-cli/i18n-command/blob/e9eef8aab4b5e43c3aa09bf60e1e7a9d6d30d302/src/JsFunctionsScanner.php#L364
 	 * @param {babel.Comment} comment - Comment.
-	 * @param {babel.Node} node - Node.
-	 * @returns {boolean} Whether the comment comes before the node.
+	 * @param {babel.Node}    node    - Node.
+	 * @return {boolean} Whether the comment comes before the node.
 	 */
 	#commentPrecedesNode( comment, node ) {
 		// Comments should be on the same or an earlier line than the translation.

package/src/I18nCheckPlugin.js

@@ -127,8 +127,8 @@ class I18nCheckPlugin {
 	 * Record the resources for an asset.
 	 *
 	 * @param {webpack.Compilation} compilation - Compilation.
-	 * @param {string} filename - Asset filename.
-	 * @param {webpack.Module[]} modules - Modules in the asset.
+	 * @param {string}              filename    - Asset filename.
+	 * @param {webpack.Module[]}    modules     - Modules in the asset.
 	 */
 	#recordResourcesForAsset( compilation, filename, modules ) {
 		const resources = new Set();
@@ -159,7 +159,7 @@ class I18nCheckPlugin {
 	 * Stringify an entry to msgid + context.
 	 *
 	 * @param {GettextEntry} entry - Entry.
-	 * @returns {string} String.
+	 * @return {string} String.
 	 */
 	#strentry( entry ) {
 		let ret = '"' + entry.msgid.replace( /[\\"]/g, '\\$&' ).replaceAll( '\n', '\\n' ) + '"';
@@ -210,8 +210,8 @@ class I18nCheckPlugin {
 	 * Process an asset.
 	 *
 	 * @param {webpack.Compilation} compilation - Compilation.
-	 * @param {string} filename - Asset filename.
-	 * @param {Map} moduleCache - Cache for processed modules.
+	 * @param {string}              filename    - Asset filename.
+	 * @param {Map}                 moduleCache - Cache for processed modules.
 	 */
 	async #processAsset( compilation, filename, moduleCache ) {
 		const t0 = Date.now();

package/src/I18nSafeMangleExportsPlugin.js

@@ -26,7 +26,7 @@ const { assignDeterministicIds } = require( 'webpack/lib/ids/IdHelpers' );
 /**
  * Determine if we can mangle.
  * @param {ExportsInfo} exportsInfo - exports info
- * @returns {boolean} mangle is possible
+ * @return {boolean} mangle is possible
  */
 const canMangle = exportsInfo => {
 	if ( exportsInfo.otherExportsInfo.getUsed( undefined ) !== UsageState.Unused ) {
@@ -45,10 +45,10 @@ const canMangle = exportsInfo => {
 const comparator = compareSelect( e => e.name, compareStringsNumeric );
 /**
  * Mangle exports.
- * @param {boolean} deterministic - use deterministic names
- * @param {ExportsInfo} exportsInfo - exports info
- * @param {boolean | undefined} isNamespace - is namespace object
- * @returns {void}
+ * @param {boolean}             deterministic - use deterministic names
+ * @param {ExportsInfo}         exportsInfo   - exports info
+ * @param {boolean | undefined} isNamespace   - is namespace object
+ * @return {void}
  */
 const mangleExportsInfo = ( deterministic, exportsInfo, isNamespace ) => {
 	if ( ! canMangle( exportsInfo ) ) {
@@ -153,7 +153,7 @@ class MangleExportsPlugin {
 	/**
 	 * Apply the plugin
 	 * @param {Compiler} compiler - the compiler instance
-	 * @returns {void}
+	 * @return {void}
 	 */
 	apply( compiler ) {
 		const { _deterministic: deterministic } = this;