@ckeditor/ckeditor5-dev-release-tools 39.0.0 → 39.2.0

package/lib/tasks/publishpackages.js

@@ -38,6 +38,10 @@ const publishPackageOnNpmCallback = require( '../utils/publishpackageonnpmcallba
  * packages that do not have own definition.
  * @param {String} [options.confirmationCallback=null] An callback whose response decides to continue the publishing packages. Synchronous
  * and asynchronous callbacks are supported.
+ * @param {Boolean} [options.requireEntryPoint=false] Whether to verify if packages to publish define an entry point. In other words,
+ * whether their `package.json` define the `main` field.
+ * @param {Array.<String>} [options.optionalEntryPointPackages=[]] If the entry point validator is enabled (`requireEntryPoint=true`),
+ * this array contains a list of packages that will not be checked. In other words, they do not have to define the entry point.
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @param {Number} [options.concurrency=4] Number of CPUs that will execute the task.
  * @returns {Promise}
@@ -51,6 +55,8 @@ module.exports = async function publishPackages( options ) {
 		npmTag = 'staging',
 		optionalEntries = null,
 		confirmationCallback = null,
+		requireEntryPoint = false,
+		optionalEntryPointPackages = [],
 		cwd = process.cwd(),
 		concurrency = 4
 	} = options;
@@ -62,7 +68,7 @@ module.exports = async function publishPackages( options ) {
 		absolute: true
 	} );
 
-	await assertPackages( packagePaths );
+	await assertPackages( packagePaths, { requireEntryPoint, optionalEntryPointPackages } );
 	await assertFilesToPublish( packagePaths, optionalEntries );
 	await assertNpmTag( packagePaths, npmTag );
 
@@ -70,6 +76,7 @@ module.exports = async function publishPackages( options ) {
 
 	if ( shouldPublishPackages ) {
 		await executeInParallel( {
+			cwd,
 			packagesDirectory,
 			listrTask,
 			taskToExecute: publishPackageOnNpmCallback,

package/lib/tasks/updatedependencies.js

@@ -22,8 +22,10 @@ const upath = require( 'upath' );
  * @param {Object} options
  * @param {String} options.version Target version or a range version to which all eligible dependencies will be updated.
  * Examples: `1.0.0`, `^1.0.0`, etc.
- * @param {Function} options.shouldUpdateVersionCallback Callback function that decides whether to update a version for a dependency.
- * It receives a package name as an argument and should return a boolean value.
+ * @param {UpdateVersionCallback} options.shouldUpdateVersionCallback Callback function that decides whether to update a version
+ * for a dependency. It receives a package name as an argument and should return a boolean value.
+ * @param {UpdateDependenciesPackagesDirectoryFilter|null} [options.packagesDirectoryFilter=null] An optional callback allowing
+ * filtering out directories/packages that should not be touched by the task.
  * @param {String} [options.packagesDirectory] Relative path to a location of packages to update their dependencies. If not specified,
  * only the root package is checked.
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
@@ -34,15 +36,10 @@ module.exports = async function updateDependencies( options ) {
 		version,
 		packagesDirectory,
 		shouldUpdateVersionCallback,
+		packagesDirectoryFilter = null,
 		cwd = process.cwd()
 	} = options;
 
-	const globOptions = {
-		cwd,
-		nodir: true,
-		absolute: true
-	};
-
 	const globPatterns = [ 'package.json' ];
 
 	if ( packagesDirectory ) {
@@ -51,7 +48,7 @@ module.exports = async function updateDependencies( options ) {
 		globPatterns.push( packagesDirectoryPattern );
 	}
 
-	const pkgJsonPaths = await glob( globPatterns, globOptions );
+	const pkgJsonPaths = await getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter );
 
 	for ( const pkgJsonPath of pkgJsonPaths ) {
 		const pkgJson = await fs.readJson( pkgJsonPath );
@@ -82,3 +79,41 @@ function updateVersion( version, callback, dependencies ) {
 		}
 	}
 }
+
+/**
+ * @param {String} cwd
+ * @param {Array.<String>} globPatterns
+ * @param {UpdateDependenciesPackagesDirectoryFilter|null} packagesDirectoryFilter
+ * @returns {Promise.<Array.<String>>}
+ */
+async function getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter ) {
+	const globOptions = {
+		cwd,
+		nodir: true,
+		absolute: true
+	};
+
+	const pkgJsonPaths = await glob( globPatterns, globOptions );
+
+	if ( !packagesDirectoryFilter ) {
+		return pkgJsonPaths;
+	}
+
+	return pkgJsonPaths.filter( packagesDirectoryFilter );
+}
+
+/**
+ * @callback UpdateVersionCallback
+ *
+ * @param {String} packageName A package name.
+ *
+ * @returns {Boolean} Whether to update (`true`) or ignore (`false`) bumping the package version.
+ */
+
+/**
+ * @callback UpdateDependenciesPackagesDirectoryFilter
+ *
+ * @param {String} packageJsonPath An absolute path to a `package.json` file.
+ *
+ * @returns {Boolean} Whether to include (`true`) or skip (`false`) processing the given directory/package.
+ */

package/lib/tasks/updateversions.js

@@ -24,24 +24,30 @@ const checkVersionAvailability = require( '../utils/checkversionavailability' );
  *
  * @param {Object} options
  * @param {String} options.version Version to store in a `package.json` file under the `version` key.
+ * @param {UpdateVersionsPackagesDirectoryFilter|null} [options.packagesDirectoryFilter=null] An optional callback allowing filtering out
+ * directories/packages that should not be touched by the task.
  * @param {String} [options.packagesDirectory] Relative path to a location of packages to update. If not specified,
  * only the root package is checked.
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
-module.exports = async function updateVersions( { packagesDirectory, version, cwd = process.cwd() } ) {
+module.exports = async function updateVersions( options ) {
+	const {
+		packagesDirectory,
+		version,
+		packagesDirectoryFilter = null,
+		cwd = process.cwd()
+	} = options;
 	const normalizedCwd = toUnix( cwd );
 	const normalizedPackagesDir = packagesDirectory ? normalizeTrim( packagesDirectory ) : null;
 
 	const globPatterns = getGlobPatterns( normalizedPackagesDir );
-	const pkgJsonPaths = await glob( globPatterns, { cwd: normalizedCwd, absolute: true, nodir: true } );
-	const randomPackagePath = getRandomPackagePath( pkgJsonPaths, normalizedPackagesDir );
+	const pkgJsonPaths = await getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter );
 
-	const rootPackageJson = join( normalizedCwd, 'package.json' );
-	const rootPackageVersion = ( await fs.readJson( rootPackageJson ) ).version;
+	const randomPackagePath = getRandomPackagePath( pkgJsonPaths, normalizedPackagesDir );
 
-	const randomPackageJson = join( randomPackagePath, 'package.json' );
-	const randomPackageName = ( await fs.readJson( randomPackageJson ) ).name;
+	const { version: rootPackageVersion } = await readPackageJson( normalizedCwd );
+	const { name: randomPackageName } = await readPackageJson( randomPackagePath );
 
 	checkIfVersionIsValid( version, rootPackageVersion );
 
@@ -59,6 +65,36 @@ module.exports = async function updateVersions( { packagesDirectory, version, cw
 	}
 };
 
+/**
+ * @param {String} cwd
+ * @param {Array.<String>} globPatterns
+ * @param {UpdateVersionsPackagesDirectoryFilter|null} packagesDirectoryFilter
+ * @returns {Promise.<Array.<String>>}
+ */
+async function getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter ) {
+	const pkgJsonPaths = await glob( globPatterns, {
+		cwd,
+		absolute: true,
+		nodir: true
+	} );
+
+	if ( !packagesDirectoryFilter ) {
+		return pkgJsonPaths;
+	}
+
+	return pkgJsonPaths.filter( packagesDirectoryFilter );
+}
+
+/**
+ * @param {String} packagesDirectory
+ * @returns {Promise.<Object>}
+ */
+function readPackageJson( packagesDirectory ) {
+	const packageJsonPath = join( packagesDirectory, 'package.json' );
+
+	return fs.readJson( packageJsonPath );
+}
+
 /**
  * @param {String|null} packagesDirectory
  * @returns {Array.<String>}
@@ -104,3 +140,11 @@ function checkIfVersionIsValid( newVersion, currentVersion ) {
 		throw new Error( `Provided version ${ newVersion } must be greater than ${ currentVersion } or match pattern 0.0.0-nightly.` );
 	}
 }
+
+/**
+ * @callback UpdateVersionsPackagesDirectoryFilter
+ *
+ * @param {String} packageJsonPath An absolute path to a `package.json` file.
+ *
+ * @returns {Boolean} Whether to include (`true`) or skip (`false`) processing the given directory/package.
+ */

package/lib/utils/assertpackages.js

@@ -12,20 +12,38 @@ const upath = require( 'upath' );
  * Checks if all packages in the provided directories contain the `package.json` file.
  *
  * @param {Array.<String>} packagePaths
+ * @param {Object} options
+ * @param {Boolean} options.requireEntryPoint Whether to verify if packages to publish define an entry point. In other words,
+ * whether their `package.json` define the `main` field.
+ * @param {Array.<String>} options.optionalEntryPointPackages If the entry point validator is enabled (`requireEntryPoint=true`),
+ * this array contains a list of packages that will not be checked. In other words, they do not have to define the entry point.
  * @returns {Promise}
  */
-module.exports = async function assertPackages( packagePaths ) {
+module.exports = async function assertPackages( packagePaths, options ) {
 	const errors = [];
+	const { requireEntryPoint, optionalEntryPointPackages } = options;
 
 	for ( const packagePath of packagePaths ) {
 		const packageName = upath.basename( packagePath );
 		const packageJsonPath = upath.join( packagePath, 'package.json' );
 
 		if ( await fs.pathExists( packageJsonPath ) ) {
-			continue;
-		}
+			if ( !requireEntryPoint ) {
+				continue;
+			}
+
+			const { name: packageName, main: entryPoint } = await fs.readJson( packageJsonPath );
 
-		errors.push( `The "package.json" file is missing in the "${ packageName }" package.` );
+			if ( optionalEntryPointPackages.includes( packageName ) ) {
+				continue;
+			}
+
+			if ( !entryPoint ) {
+				errors.push( `The "${ packageName }" package misses the entry point ("main") definition in its "package.json".` );
+			}
+		} else {
+			errors.push( `The "package.json" file is missing in the "${ packageName }" package.` );
+		}
 	}
 
 	if ( errors.length ) {

package/lib/utils/executeinparallel.js

@@ -31,9 +31,8 @@ const WORKER_SCRIPT = upath.join( __dirname, 'parallelworker.js' );
  * @param {ListrTaskObject} [options.listrTask={}] An instance of `ListrTask`.
  * @param {AbortSignal|null} [options.signal=null] Signal to abort the asynchronous process. If not set, default AbortController is created.
  * @param {Object} [options.taskOptions=null] Optional data required by the task.
- * @param {Function} [options.packagesDirectoryFilter=null] A function that is executed for each found package directory to filter out those
- * that do not require executing a task. It should return a truthy value to keep the package and a falsy value to skip the package from
- * processing.
+ * @param {ExecuteInParallelPackagesDirectoryFilter|null} [options.packagesDirectoryFilter=null] An optional callback allowing filtering out
+ * directories/packages that should not be touched by the task.
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @param {Number} [options.concurrency=require( 'os' ).cpus().length / 2] Number of CPUs that will execute the task.
  * @returns {Promise}
@@ -178,3 +177,11 @@ function getPackagesGroupedByThreads( packages, concurrency ) {
  *
  * @property {String} output Update the current output of the task.
  */
+
+/**
+ * @callback ExecuteInParallelPackagesDirectoryFilter
+ *
+ * @param {String} directoryPath An absolute path to a directory.
+ *
+ * @returns {Boolean} Whether to include (`true`) or skip (`false`) processing the given directory.
+ */

package/lib/utils/transformcommitfactory.js

@@ -9,6 +9,9 @@ const { cloneDeepWith } = require( 'lodash' );
 const utils = require( './transformcommitutils' );
 const getChangedFilesForCommit = require( './getchangedfilesforcommit' );
 
+// Squash commit follows the pattern: "A pull request title (#{number})".
+const SQUASH_COMMIT_REGEXP = /^[\W\w]+ \(#\d+\)$/;
+
 /**
  * Factory function.
  *
@@ -26,7 +29,7 @@ const getChangedFilesForCommit = require( './getchangedfilesforcommit' );
  * @param {Boolean} [options.useExplicitBreakingChangeGroups] If set on `true`, notes from parsed commits will be grouped as
  * "MINOR BREAKING CHANGES" and "MAJOR BREAKING CHANGES'. If set on `false` (by default), all breaking changes notes will be treated
  * as "BREAKING CHANGES".
- * @returns {Function}
+ * @returns {TransformCommit}
  */
 module.exports = function transformCommitFactory( options = {} ) {
 	return rawCommit => {
@@ -36,11 +39,29 @@ module.exports = function transformCommitFactory( options = {} ) {
 			return commit;
 		}
 
-		if ( Array.isArray( commit ) ) {
-			return commit.flatMap( splitMultiScopeCommit );
+		// Single commit.
+		if ( !Array.isArray( commit ) ) {
+			return splitMultiScopeCommit( commit );
 		}
 
-		return splitMultiScopeCommit( commit );
+		// For a squash merge commit, the `commit` array contains an additional, invalid entry for the squash itself.
+		// It contains all notes that were not processed. Hence, let's remove it and copy its notes to a first valid commit.
+		// Also, let's update the "merge" field to display a merge commit on the screen,
+		// when passing the commits array through the `displayCommits()` function.
+		if ( isSquashMergeCommit( commit ) ) {
+			const firstCommit = commit.find( c => c.isPublicCommit );
+
+			if ( firstCommit ) {
+				const squashCommit = commit.shift();
+
+				firstCommit.notes = squashCommit.notes;
+				firstCommit.merge = squashCommit.header;
+
+				normalizeNotes( firstCommit );
+			}
+		}
+
+		return commit.flatMap( splitMultiScopeCommit );
 	};
 
 	/**
@@ -449,8 +470,28 @@ module.exports = function transformCommitFactory( options = {} ) {
 			}
 		} ) );
 	}
+
+	/**
+	 * @param {Array.<Commit>} commits
+	 * @returns {Boolean}
+	 */
+	function isSquashMergeCommit( commits ) {
+		const [ squashCommit ] = commits;
+
+		if ( squashCommit.type ) {
+			return false;
+		}
+
+		return !!squashCommit.header.match( SQUASH_COMMIT_REGEXP );
+	}
 };
 
+/**
+ * @callback TransformCommit
+ * @param {Commit} rawCommit
+ * @returns {Commit|Array.<Commit>|undefined}
+ */
+
 /**
  * @typedef {Object} Commit
  *
@@ -458,7 +499,7 @@ module.exports = function transformCommitFactory( options = {} ) {
  *
  * @property {String} rawType Type of the commit without any modifications.
  *
- * @property {String} type Type of the commit (it can be modified).
+ * @property {String|null} type Type of the commit (it can be modified).
  *
  * @property {String} header First line of the commit message.
  *

package/lib/utils/transformcommitutils.js

@@ -79,7 +79,7 @@ const transformCommitUtils = {
 	 * @returns {String}
 	 */
 	linkToGithubIssue( comment ) {
-		return comment.replace( /(\/?[\w-]+\/[\w-]+)?#([\d]+)/ig, ( matchedText, maybeRepository, issueId ) => {
+		return comment.replace( /(\/?[\w-]+\/[\w-]+)?#([\d]+)(?=$|[\s,.)\]])/igm, ( matchedText, maybeRepository, issueId ) => {
 			if ( maybeRepository ) {
 				if ( maybeRepository.startsWith( '/' ) ) {
 					return matchedText;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "39.0.0",
+  "version": "39.2.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "main": "lib/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^39.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^39.2.0",
     "@octokit/rest": "^19.0.0",
     "chalk": "^4.0.0",
     "cli-table": "^0.3.1",