@j-ulrich/release-it-regex-bumper 3.0.2 → 4.1.1

package/README.md

@@ -2,7 +2,7 @@
 
 > Regular expression based version read/write plugin for release-it
 
-![CI](https://github.com/j-ulrich/release-it-regex-bumper/workflows/CI/badge.svg)
+[![CI](https://github.com/j-ulrich/release-it-regex-bumper/actions/workflows/CI.yml/badge.svg)](https://github.com/j-ulrich/release-it-regex-bumper/actions/workflows/CI.yml)
 [![Test Coverage](https://app.codacy.com/project/badge/Coverage/bf3c6e8740a9472b9acd7dac231adf4e)](https://www.codacy.com/gh/j-ulrich/release-it-regex-bumper/dashboard?utm_source=github.com&utm_medium=referral&utm_content=j-ulrich/release-it-regex-bumper&utm_campaign=Badge_Coverage)
 [![Code Quality](https://app.codacy.com/project/badge/Grade/bf3c6e8740a9472b9acd7dac231adf4e)](https://www.codacy.com/gh/j-ulrich/release-it-regex-bumper/dashboard?utm_source=github.com&utm_medium=referral&utm_content=j-ulrich/release-it-regex-bumper&utm_campaign=Badge_Grade)
 
@@ -18,6 +18,10 @@ below for details.
 
 # Installation #
 
+> ⚠️ **Note:**  
+> Version 4 and later of release-it-regex-bumper require version 15 or later of release-it.   
+> When you are using release-it version 14.x or earlier, then use release-it-regex-bumper version 3.x or earlier.
+
 ```
 npm install --save-dev @j-ulrich/release-it-regex-bumper
 ```
@@ -325,7 +329,7 @@ The template string also supports a set of placeholders:
 - `{{prerelease}}` is replaced by the prerelease part of the new version or an empty string if the version does not
   have a prerelease part.    
   Since: 1.2.0
-- `{{prefixedPrerelease}}` is replaced by a dash ('-') followed by the prerelease part of the new version or and empty
+- `{{prefixedPrerelease}}` is replaced by a dash ('-') followed by the prerelease part of the new version or an empty
   string if the version does not have a prerelease part.    
   Since: 3.0.0
 - `{{build}}` is replaced by the build part of the new version or an empty string if the version does not have a

package/index.js

@@ -1,28 +1,19 @@
-'use strict';
-
-const fs = require( 'fs' );
-const assert = require( 'assert' ).strict;
-const util = require( 'util' );
-const glob = require( 'fast-glob' );
-const chalk = require( 'chalk' );
-const _ = {
-	isEmpty: require( 'lodash/isEmpty' ),
-	isNil: require( 'lodash/isNil' ),
-	isNull: require( 'lodash/isNull' ),
-	isString: require( 'lodash/isString' ),
-	isFunction: require( 'lodash/isFunction' ),
-	castArray: require( 'lodash/castArray' ),
-};
-const XRegExp = require( 'xregexp' );
-const semver = require( 'semver' );
-const { Plugin } = require( 'release-it' );
-const dateFormat = require( 'date-fns/format' );
-const dateFormatIso = require( 'date-fns/formatISO' );
-const diff = optionalRequire( 'diff' );
-
-
-const readFile = util.promisify( fs.readFile );
-const writeFile = util.promisify( fs.writeFile );
+
+import { readFile as fsReadFile, writeFile as fsWriteFile } from 'fs';
+import { strict as assert } from 'assert';
+import { promisify } from 'util';
+import glob from 'fast-glob';
+import chalk from 'chalk';
+import _ from 'lodash';
+import XRegExp from 'xregexp';
+import semver from 'semver';
+import { Plugin } from 'release-it';
+import dateFormat from 'date-fns/format/index.js';
+import dateFormatIso from 'date-fns/formatISO/index.js';
+
+
+const readFile = promisify( fsReadFile );
+const writeFile = promisify( fsWriteFile );
 
 const semanticVersionRegex = XRegExp(
 	// eslint-disable-next-line security/detect-unsafe-regex
@@ -40,7 +31,7 @@ const defaultReplace = '{{version}}';
 
 
 
-class RegExBumper extends Plugin {
+export default class RegExBumper extends Plugin {
 
 	constructor( ...args ) {
 		super( ...args );
@@ -120,7 +111,7 @@ class RegExBumper extends Plugin {
 				const fileContent = await readFile( file, { encoding: effectiveEncoding } );
 
 				if ( isDryRun ) {
-					this.loadDiff();
+					await this.loadDiff();
 					if ( this.diff ) {
 						const processedFileContent = replaceVersion( fileContent, replacedSearchRegex,
 						                                             effectiveReplacement, context );
@@ -149,12 +140,21 @@ class RegExBumper extends Plugin {
 		/* eslint-enable no-await-in-loop */
 	}
 
-	loadDiff() {
-		if ( !diff || diff instanceof Error ) {
+	async loadDiff() {
+		if ( this.diff ) {
+			return;
+		}
+		try {
+			const diff = await import( 'diff' );
+			if ( !diff || !diff.structuredPatch ) {
+				throw new Error( 'diff module no available' );
+			}
+			this.diff = diff;
+		}
+		catch ( e ) {
 			this.log.info( 'Optional "diff" package not available' );
-			this.log.verbose( 'Exception was:', diff );
+			this.log.verbose( 'Exception was:', e );
 		}
-		this.diff = diff;
 	}
 
 	diffAndReport( oldContent, newContent, filePath ) {
@@ -250,15 +250,20 @@ function extractVersion( content, versionRegex, versionCaptureGroup ) {
 		throw new Error( 'Could not extract version from file' );
 	}
 	if ( !_.isNil( versionCaptureGroup ) ) {
-		if ( hasOwnProperty( match, versionCaptureGroup ) ) {
+		if ( typeof versionCaptureGroup === 'number' && hasOwnProperty( match, versionCaptureGroup ) ) {
 			// object injection mitigated by checking hasOwnProperty()
 			// eslint-disable-next-line security/detect-object-injection
 			return match[versionCaptureGroup];
 		}
+		if ( match.groups && hasOwnProperty( match.groups, versionCaptureGroup ) ) {
+			// object injection mitigated by checking hasOwnProperty()
+			// eslint-disable-next-line security/detect-object-injection
+			return match.groups[versionCaptureGroup];
+		}
 	}
 	else {
-		if ( hasOwnProperty( match, 'version' ) ) {
-			return match['version'];
+		if ( match.groups && hasOwnProperty( match.groups, 'version' ) ) {
+			return match.groups.version;
 		}
 		if ( hasOwnProperty( match, 1 ) ) {
 			return match[1];
@@ -430,18 +435,6 @@ function replacePlaceholders( template, placeholderMap ) {
 	} );
 }
 
-function optionalRequire( packageName ) {
-	try {
-		// eslint-disable-next-line security/detect-non-literal-require
-		return require( packageName );
-	}
-	/* c8 ignore next 4 */
-	/* rewiremock can't simulate the absence of a package so we can't test this case */
-	catch ( ex ) {
-		return ex;
-	}
-}
-
 function firstNotNil( ...args ) {
 	return args.find( ( ele ) => !_.isNil( ele ) );
 }
@@ -474,4 +467,3 @@ class LineCounter {
 	}
 }
 
-module.exports = RegExBumper;

package/package.json

@@ -1,14 +1,15 @@
 {
 	"name": "@j-ulrich/release-it-regex-bumper",
-	"version": "3.0.2",
+	"version": "4.1.1",
 	"description": "Regular expression based version read/write plugin for release-it",
 	"main": "index.js",
+	"type": "module",
 	"files": [
 		"index.js"
 	],
 	"scripts": {
-		"test": "npx bron test.js",
-		"test+coverage": "npx c8 npx bron test.js",
+		"test": "node --experimental-loader=testdouble  ./node_modules/ava/entrypoints/cli.mjs --serial",
+		"test+coverage": "npx c8 node --experimental-loader=testdouble  ./node_modules/ava/entrypoints/cli.mjs --serial",
 		"lint": "npx eslint .",
 		"release": "npx release-it"
 	},
@@ -38,33 +39,32 @@
 		"name": "Jochen Ulrich"
 	},
 	"dependencies": {
-		"chalk": "^4.0.0",
+		"chalk": "^5.0.0",
 		"date-fns": "^2.8.0",
 		"fast-glob": "^3.2.0",
 		"lodash": "^4.17.20",
 		"semver": "^7.3.0",
-		"xregexp": "^4.3.0"
+		"xregexp": "^5.0.0"
 	},
 	"peerDependencies": {
-		"release-it": "11 - 15"
+		"release-it": "15"
 	},
 	"optionalDependencies": {
-		"diff": "^3.0.0 || ^4.0.0"
+		"diff": "3 - 5"
 	},
 	"devDependencies": {
 		"@j-ulrich/eslint-config": "^1.0.0",
-		"@release-it/keep-a-changelog": "^2.5.0",
-		"bron": "^1.1.0",
+		"@release-it/keep-a-changelog": "^3.0.0",
+		"ava": "^4.0.1",
 		"c8": "^7.3.0",
 		"eslint": "^8.6.0",
 		"eslint-plugin-security": "^1.4.0",
-		"mock-fs": "^5.1.1",
-		"release-it": "^14.0.0",
-		"rewiremock": "^3.14.3",
-		"sinon": "^9.0.3",
-		"temp": "^0.9.4"
+		"release-it": "^15.0.0",
+		"sinon": "^13.0.2",
+		"temp": "^0.9.4",
+		"testdouble": "^3.16.4"
 	},
 	"engines": {
-		"node": ">=10.12.0"
+		"node": ">=14.9"
 	}
 }