@j-ulrich/release-it-regex-bumper 5.4.0 → 5.5.0

package/README.md

@@ -73,7 +73,7 @@ example, the pattern `\d+` needs to be written as `"\\d+"` inside JSON.
 
 ### `in` ###
 
-**Type:** `string|object`    
+**Type:** `string | object`    
 **Default:** `null`
 
 The `in` option defines where and how to read the current version. If this option is defined and not
@@ -102,7 +102,7 @@ If this option is `null` or not defined, the [global `encoding`](#encoding) opti
 
 ### `in.search` ###
 
-**Type:** `string|object`    
+**Type:** `string | object`    
 **Default:** `null`
 
 Defines the regular expression to find the version inside the `in.file`.
@@ -147,7 +147,7 @@ If this option is `null` or not defined, the [global `search.flags`](#searchflag
 
 ### `in.search.versionCaptureGroup` ###
 
-**Type:** `integer|string`    
+**Type:** `integer | string`    
 **Default:** `null`
 
 Defines the capture group from the `in.search.pattern` which matches the version. If the
@@ -165,7 +165,7 @@ capturing group with index 1 is used if it exists. Else the whole match is used.
 
 ### `out` ###
 
-**Type:** `string|object|array<string|object>`    
+**Type:** `string | object | array<string | object>`    
 **Default:** `null`
 
 The `out` option defines where and how to write the new version. If defined and not `null`, the
@@ -208,7 +208,7 @@ If both, this option and `out.files` are given, both are processed.
 
 ### `out.files` ###
 
-**Type:** `string|array<string>`    
+**Type:** `string | array<string>`    
 **Default:** `null` but either this option or `out.file` (or both) must contain a value    
 **Since:** 1.1.0
 
@@ -241,7 +241,7 @@ If this option is `null` or not defined, the [global `encoding`](#encoding) opti
 
 ### `out.search` ###
 
-**Type:** `string|object`    
+**Type:** `string | object`    
 **Default:** `null`
 
 Defines the regular expression to find the text which is replaced with the new version inside
@@ -357,9 +357,27 @@ The template string also supports a set of placeholders:
 The placeholders are replaced before the template string is used in the search and replace and thus
 before the capturing group references are replaced.
 
+### `out.strict` ###
+
+**Type:** `boolean | "off" | "warn" | "errorIfNoMatch" | "errorIfNoChange"`    
+**Default:** `null`
+
+Defines the behavior if an output file was not changed by this output configuration or if the search pattern did not match in an output file.
+
+If this option is `true` or `"warn", a warning is logged if the search pattern was not found in an output file or if a file was not changed by this output configuration.
+
+If this options is `"errorIfNoMatch"`, an `Error` is thrown and the release is aborted if there was no match of the search pattern in an output file. If there was a match but the file did not change, a warning is logged.
+
+If this options is `"errorIfNoChange"`, an `Error` is thrown and the release is aborted if either an output file was not changed by this output configuration or there was no match of the search pattern in an output file.
+
+If this option is `false` or `"off"`, no warning is logged if the search pattern did not match or the file did not change.
+
+If this option is `null` or not defined, the [global `strict`](#strict) is used.
+
+
 ### `search` ###
 
-**Type:** `string|object`    
+**Type:** `string | object`    
 **Default:** An object with the default values as described below.
 
 Defines the default regular expression to be used when no `in.search` or `out.search` is given.
@@ -396,7 +414,7 @@ The default flags for the search pattern which are used when `in.search.flags` o
 
 ### `search.versionCaptureGroup` ###
 
-**Type:** `integer|string`    
+**Type:** `integer | string`    
 **Default:** `null`
 
 Defines the default capture group which is used when `in.search.versionCaptureGroup` is `null` or
@@ -425,6 +443,15 @@ encodings are the ones supported by Node's `fs` module.
 
 If this option is not defined or set to `null`, the default value is used.
 
+### `strict` ###
+
+**Type:** `boolean | "off" | "warn" | "errorIfNoMatch" | "errorIfNoChange"`    
+**Default:** `true`
+
+The default strict mode used when `out.strict` is `null` or not defined.
+
+If this option is not defined or set to `null`, the default value is used.
+
 ## Tips ##
 
 ### Disable Output via Command-Line Parameter ###

package/index.js

@@ -23,11 +23,18 @@ const placeholderRegex = XRegExp( '\\{\\{(?<placeholder>(?:[a-z][a-z0-9_]*|\\{))
 const prereleasePrefix = '-';
 const buildPrefix = '+';
 
+const StrictMode = {
+	Off: 'off',
+	Warn: 'warn',
+	ErrorIfNoMatch: 'errorIfNoMatch',
+	ErrorIfNoChange: 'errorIfNoChange',
+};
+
 const defaultEncoding = 'utf-8';
 const defaultSearchRegex = XRegExp( '{{semver}}' );
 const defaultVersionCaptureGroup = null;
 const defaultReplace = '{{version}}';
-
+const defaultStrictMode = true;
 
 
 export default class RegExBumper extends Plugin {
@@ -74,6 +81,7 @@ export default class RegExBumper extends Plugin {
 			search: globalSearchOptions,
 			replace: globalReplace,
 			encoding: globalEncoding,
+			strict: globalStrict,
 		} = this.options;
 		const { isDryRun } = this.config;
 		if ( _.isNil( outOptions ) ) {
@@ -92,7 +100,7 @@ export default class RegExBumper extends Plugin {
 
 		/* eslint-disable no-await-in-loop */
 		for ( const outOption of expandedOutOptions ) {
-			const { files, encoding, searchRegex, flags: searchFlags, replace } = outOption;
+			const { files, encoding, searchRegex, flags: searchFlags, replace, strict } = outOption;
 
 			const effectiveEncoding = firstNotNil( encoding, globalEncoding, defaultEncoding );
 			const effectiveSearchRegex = mergeSearchRegExes(
@@ -100,6 +108,7 @@ export default class RegExBumper extends Plugin {
 				[ searchFlags, globalSearchFlags ]
 			);
 			const effectiveReplacement = firstNotNil( replace, globalReplace, defaultReplace );
+			const effectiveStrictMode = firstNotNil( strict, globalStrict, defaultStrictMode );
 
 			const replacedSearchRegex = prepareSearch( effectiveSearchRegex, context );
 
@@ -111,13 +120,15 @@ export default class RegExBumper extends Plugin {
 
 				if ( isDryRun ) {
 					await this.loadDiff();
+					const processedFileContent = replaceVersion( fileContent, replacedSearchRegex,
+					                                             effectiveReplacement, context );
+					this.evaluateFileChanges( fileContent, processedFileContent,
+					                          replacedSearchRegex, effectiveStrictMode, file );
 					if ( this.diff ) {
-						const processedFileContent = replaceVersion( fileContent, replacedSearchRegex,
-						                                             effectiveReplacement, context );
-						await this.diffAndReport( fileContent, processedFileContent, file );
+						await this.diffAndReport( fileContent, processedFileContent, effectiveStrictMode, file );
 						continue;
 					}
-					await this.searchAndReport( fileContent, replacedSearchRegex, file );
+					await this.searchAndReport( fileContent, replacedSearchRegex );
 					continue;
 				}
 
@@ -128,10 +139,8 @@ export default class RegExBumper extends Plugin {
 					context
 				);
 
-				if ( processedFileContent === fileContent ) {
-					this.warnNoFileChange( file );
-				}
-				else {
+				if ( this.evaluateFileChanges( fileContent, processedFileContent,
+					                           replacedSearchRegex, effectiveStrictMode, file ) ) {
 					await writeFile( file, processedFileContent, effectiveEncoding );
 				}
 			}
@@ -164,9 +173,6 @@ export default class RegExBumper extends Plugin {
 			}
 		);
 
-		if ( _.isEmpty( diffResult.hunks ) ) {
-			this.warnNoFileChange( filePath );
-		}
 		diffResult.hunks.forEach( ( hunk ) => {
 			this.log.exec(
 				`Replacing at line ${hunk.oldStart}:\n` +
@@ -187,9 +193,8 @@ export default class RegExBumper extends Plugin {
 		} );
 	}
 
-	searchAndReport( content, searchRegex, filePath ) {
+	searchAndReport( content, searchRegex ) {
 		const { isDryRun } = this.config;
-		let foundMatch = false;
 		const lineCounter = new LineCounter( content );
 		XRegExp.forEach( content, searchRegex, ( match ) => {
 			const matchText = match[0];
@@ -200,15 +205,31 @@ export default class RegExBumper extends Plugin {
 					matchText,
 				{ isDryRun }
 			);
-			foundMatch = true;
 		} );
-		if ( !foundMatch ) {
-			this.warnNoFileChange( filePath );
-		}
 	}
 
-	warnNoFileChange( filePath ) {
-		this.log.warn( `File "${filePath}" did not change!` );
+	evaluateFileChanges( originalFileContent, processedFileContent, searchRegex, strictMode, filePath ) {
+		const fileChanged = originalFileContent !== processedFileContent;
+		if ( fileChanged ) {
+			return fileChanged;
+		}
+		if ( strictMode && strictMode !== StrictMode.Off ) {
+			const match = XRegExp.match( originalFileContent, searchRegex, 'one' );
+			if ( match === null ) {
+				const message = `No matches found in file "${filePath}"!`;
+				if ( strictMode === StrictMode.ErrorIfNoMatch || strictMode === StrictMode.ErrorIfNoChange ) {
+					throw new Error( message );
+				}
+				this.log.warn( message );
+				return fileChanged;
+			}
+			const message = `File "${filePath}" did not change!`;
+			if ( strictMode === StrictMode.ErrorIfNoChange ) {
+				throw new Error( message );
+			}
+			this.log.warn( message );
+		}
+		return fileChanged;
 	}
 
 }
@@ -286,13 +307,13 @@ function parseOutOptions( options ) {
 				replace: null,
 			};
 		}
-		const { encoding, replace } = option;
+		const { encoding, replace, strict } = option;
 		const { searchRegex, flags } = parseSearchOptions( option.search );
 		const files = option.files ? _.castArray( option.files ) : [];
 		if ( option.file ) {
 			files.unshift( option.file );
 		}
-		return { files, encoding, searchRegex, flags, replace };
+		return { files, encoding, searchRegex, flags, replace, strict };
 	} );
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@j-ulrich/release-it-regex-bumper",
-	"version": "5.4.0",
+	"version": "5.5.0",
 	"description": "Regular expression based version read/write plugin for release-it",
 	"main": "index.js",
 	"type": "module",
@@ -60,7 +60,7 @@
 		"c8": "^11.0.0",
 		"eslint": "^8.6.0",
 		"eslint-plugin-security": "^1.4.0",
-		"release-it": "^19.2.4",
+		"release-it": "^20.0.0",
 		"sinon": "^21.0.3",
 		"temp": "^0.9.4",
 		"testdouble": "^3.20.2"