@automattic/i18n-check-webpack-plugin 0.1.0 → 1.0.0

package/CHANGELOG.md

@@ -5,6 +5,17 @@ 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.0.0] - 2021-12-22
+### Added
+- Allow specifying the expected textdomain to be used in the output assets.
+
+### Fixed
+- Fix a unit test that broke when we added i18n-loader to the webpack config.
+- Fixed a documentation error.
+- Fix use in Node 14.
+
 ## 0.1.0 - 2021-12-14
 ### Added
 - Initial release.
+
+[1.0.0]: https://github.com/Automattic/i18n-check-webpack-plugin/compare/v0.1.0...v1.0.0

package/README.md

@@ -16,7 +16,7 @@ This goes in the `plugins` section of your Webpack config, e.g.
 ```js
 {
 	plugins: [
-		new I18nLoaderWebpackPlugin(),
+		new I18nCheckWebpackPlugin(),
 	],
 };
 ```
@@ -26,6 +26,7 @@ Parameters recognized by the plugin are:
 - `filter`: Allows for specifying which source modules to process for i18n strings. The default is to process all files with extensions `js`, `jsx`, `ts`, `tsx`, `cjs`, and `mjs`.
 
   The value may be a function, which will be passed the file path relative to [Webpack's context] and which should return true if the file should be processed, or a string or RegExp to be compared with the relative file path, or an array of such strings, RegExps, and/or functions.
+- `expectDomain`: Set to the expected text domain that should be used in the output assets. If the assets use some other domain, an error will be generated.
 - `warnOnly`: Set true to produce warnings rather than errors when issues are found.
 - `extractorOptions`: Supply options for `GettextExtractor`.
    - `babelOptions`: Supply options for Babel.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/i18n-check-webpack-plugin",
-	"version": "0.1.0",
+	"version": "1.0.0",
 	"description": "A Webpack plugin to check that WordPress i18n hasn't been mangled by Webpack optimizations.",
 	"homepage": "https://jetpack.com",
 	"bugs": {

package/src/GettextEntries.js

@@ -1,4 +1,4 @@
-const assert = require( 'assert/strict' );
+const assert = require( 'assert' ).strict;
 const GettextEntry = require( './GettextEntry' );
 const PROJECT_NAME = require( './plugin-name.js' );
 

package/src/GettextEntry.js

@@ -1,4 +1,4 @@
-const assert = require( 'assert/strict' );
+const assert = require( 'assert' ).strict;
 
 class StringSet extends Set {
 	add( v ) {

package/src/I18nCheckPlugin.js

@@ -51,6 +51,10 @@ const schema = {
 			description: 'Set true to produce warnings rather than errors.',
 			type: 'boolean',
 		},
+		expectDomain: {
+			description: 'Set the expected text domain.',
+			type: 'string',
+		},
 		extractorOptions: {
 			description: 'Options for the extractor. Ignored if `extractor` was specified.',
 			type: 'object',
@@ -89,6 +93,7 @@ class I18nCheckPlugin {
 	#extractor;
 	#filter;
 	#reportkey;
+	#expectDomain;
 
 	constructor( options = {} ) {
 		webpack.validateSchema( schema, options, {
@@ -98,6 +103,7 @@ class I18nCheckPlugin {
 
 		this.#extractor = new GettextExtractor( options.extractorOptions );
 		this.#reportkey = options.warnOnly ? 'warnings' : 'errors';
+		this.#expectDomain = options.expectDomain;
 
 		if ( options.filter ) {
 			const filters = ( Array.isArray( options.filter ) ? options.filter : [ options.filter ] ).map(
@@ -334,6 +340,13 @@ class I18nCheckPlugin {
 					`${ filename }: Multiple textdomains are used: ${ Array.from( domains, JSON.stringify ).sort().join( ', ' ) }\nYou may want to use @automattic/babel-plugin-replace-textdomain to fix that.`
 				)
 			);
+		} else if ( this.#expectDomain && domains.size > 0 && ! domains.has( this.#expectDomain ) ) {
+			compilation[ this.#reportkey ].push(
+				new Error(
+					// prettier-ignore
+					`${ filename }: Expected textdomain ${ JSON.stringify( this.#expectDomain ) }, but the asset uses ${ Array.from( domains, JSON.stringify )[ 0 ] } instead.\nYou may want to use @automattic/babel-plugin-replace-textdomain to fix that.`
+				)
+			);
 		}
 	}
 }