@ckeditor/ckeditor5-dev-release-tools 44.0.0-alpha.5 → 44.0.0

package/lib/tasks/updatedependencies.js

@@ -17,16 +17,16 @@ import upath from 'upath';
  * The eligible dependencies are distinguished by the return value from the `options.shouldUpdateVersionCallback` function. Only if this
  * callback returns a truthy value for a given dependency, its version will be updated.
  *
- * @param {Object} options
- * @param {String} options.version Target version or a range version to which all eligible dependencies will be updated.
+ * @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 {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,
+ * @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.
+ * @param {string} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
 export default async function updateDependencies( options ) {
@@ -62,9 +62,9 @@ export default async function updateDependencies( options ) {
 /**
  * Updates the version for each eligible dependency.
  *
- * @param {String} version
- * @param {Function} callback
- * @param {Object} [dependencies]
+ * @param {string} version
+ * @param {function} callback
+ * @param {object} [dependencies]
  */
 function updateVersion( version, callback, dependencies ) {
 	if ( !dependencies ) {
@@ -79,10 +79,10 @@ function updateVersion( version, callback, dependencies ) {
 }
 
 /**
- * @param {String} cwd
- * @param {Array.<String>} globPatterns
+ * @param {string} cwd
+ * @param {Array.<string>} globPatterns
  * @param {UpdateDependenciesPackagesDirectoryFilter|null} packagesDirectoryFilter
- * @returns {Promise.<Array.<String>>}
+ * @returns {Promise.<Array.<string>>}
  */
 async function getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter ) {
 	const globOptions = {
@@ -103,15 +103,15 @@ async function getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter )
 /**
  * @callback UpdateVersionCallback
  *
- * @param {String} packageName A package name.
+ * @param {string} packageName A package name.
  *
- * @returns {Boolean} Whether to update (`true`) or ignore (`false`) bumping the package version.
+ * @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.
+ * @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.
+ * @returns {boolean} Whether to include (`true`) or skip (`false`) processing the given directory/package.
  */

package/lib/tasks/updateversions.js

@@ -22,13 +22,13 @@ const { normalizeTrim, toUnix, dirname, join } = upath;
  *   Exception: passing a version starting with the `0.0.0-nightly` string. It is used for publishing
  *   a nightly release.
  *
- * @param {Object} options
- * @param {String} options.version Version to store in a `package.json` file under the `version` key.
+ * @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,
+ * @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.
+ * @param {string} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
 export default async function updateVersions( options ) {
@@ -66,10 +66,10 @@ export default async function updateVersions( options ) {
 }
 
 /**
- * @param {String} cwd
- * @param {Array.<String>} globPatterns
+ * @param {string} cwd
+ * @param {Array.<string>} globPatterns
  * @param {UpdateVersionsPackagesDirectoryFilter|null} packagesDirectoryFilter
- * @returns {Promise.<Array.<String>>}
+ * @returns {Promise.<Array.<string>>}
  */
 async function getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter ) {
 	const pkgJsonPaths = await glob( globPatterns, {
@@ -86,8 +86,8 @@ async function getPackageJsonPaths( cwd, globPatterns, packagesDirectoryFilter )
 }
 
 /**
- * @param {String} packagesDirectory
- * @returns {Promise.<Object>}
+ * @param {string} packagesDirectory
+ * @returns {Promise.<object>}
  */
 function readPackageJson( packagesDirectory ) {
 	const packageJsonPath = join( packagesDirectory, 'package.json' );
@@ -96,8 +96,8 @@ function readPackageJson( packagesDirectory ) {
 }
 
 /**
- * @param {String|null} packagesDirectory
- * @returns {Array.<String>}
+ * @param {string|null} packagesDirectory
+ * @returns {Array.<string>}
  */
 function getGlobPatterns( packagesDirectory ) {
 	const patterns = [ 'package.json' ];
@@ -110,9 +110,9 @@ function getGlobPatterns( packagesDirectory ) {
 }
 
 /**
- * @param {Array.<String>} pkgJsonPaths
- * @param {String|null} packagesDirectory
- * @returns {Object}
+ * @param {Array.<string>} pkgJsonPaths
+ * @param {string|null} packagesDirectory
+ * @returns {object}
  */
 function getRandomPackagePath( pkgJsonPaths, packagesDirectory ) {
 	const randomPkgJsonPaths = packagesDirectory ?
@@ -128,8 +128,8 @@ function getRandomPackagePath( pkgJsonPaths, packagesDirectory ) {
  *
  * A nightly version is always considered as valid.
  *
- * @param {String} newVersion
- * @param {String} currentVersion
+ * @param {string} newVersion
+ * @param {string} currentVersion
  */
 function checkIfVersionIsValid( newVersion, currentVersion ) {
 	if ( newVersion.startsWith( '0.0.0-nightly' ) ) {
@@ -144,7 +144,7 @@ function checkIfVersionIsValid( newVersion, currentVersion ) {
 /**
  * @callback UpdateVersionsPackagesDirectoryFilter
  *
- * @param {String} packageJsonPath An absolute path to a `package.json` file.
+ * @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.
+ * @returns {boolean} Whether to include (`true`) or skip (`false`) processing the given directory/package.
  */

package/lib/tasks/verifypackagespublishedcorrectly.js

@@ -12,10 +12,10 @@ import checkVersionAvailability from '../utils/checkversionavailability.js';
  * Npm sometimes throws incorrect error 409 while publishing, while the package uploads correctly.
  * The purpose of the script is to validate if packages that threw 409 are uploaded correctly to npm.
  *
- * @param {Object} options
- * @param {String} options.packagesDirectory Relative path to a location of packages to release.
- * @param {String} options.version Version of the current release.
- * @param {Function} options.onSuccess Callback fired when function is successful.
+ * @param {object} options
+ * @param {string} options.packagesDirectory Relative path to a location of packages to release.
+ * @param {string} options.version Version of the current release.
+ * @param {function} options.onSuccess Callback fired when function is successful.
  * @returns {Promise}
  */
 export default async function verifyPackagesPublishedCorrectly( options ) {

package/lib/utils/assertfilestopublish.js

@@ -10,8 +10,8 @@ import { glob } from 'glob';
 /**
  * Checks if all files expected to be released actually exist in the package directory. Verification takes place for all packages.
  *
- * @param {String} packagePaths
- * @param {Object.<String, Array.<String>>|null} optionalEntries
+ * @param {string} packagePaths
+ * @param {Object.<string, Array.<string>>|null} optionalEntries
  * @returns {Promise}
  */
 export default async function assertFilesToPublish( packagePaths, optionalEntries = null ) {
@@ -62,10 +62,10 @@ export default async function assertFilesToPublish( packagePaths, optionalEntrie
 /**
  * Filters out the optional entries from the `files` field and returns only the required ones.
  *
- * @param {Array.<String>} entries
- * @param {String} packageName
- * @param {Object.<String, Array.<String>>|null} optionalEntries
- * @returns {Array.<String>}
+ * @param {Array.<string>} entries
+ * @param {string} packageName
+ * @param {Object.<string, Array.<string>>|null} optionalEntries
+ * @returns {Array.<string>}
  */
 function getRequiredEntries( entries, packageName, optionalEntries ) {
 	if ( !optionalEntries ) {

package/lib/utils/assertnpmauthorization.js

@@ -8,7 +8,7 @@ import { tools } from '@ckeditor/ckeditor5-dev-utils';
 /**
  * Checks whether a user is logged to npm as the provided account name.
  *
- * @param {String} npmOwner Expected npm account name that should be logged into npm.
+ * @param {string} npmOwner Expected npm account name that should be logged into npm.
  * @returns {Promise}
  */
 export default async function assertNpmAuthorization( npmOwner ) {

package/lib/utils/assertnpmtag.js

@@ -10,8 +10,8 @@ import semver from 'semver';
 /**
  * Checks if the npm tag matches the tag calculated from the package version. Verification takes place for all packages.
  *
- * @param {Array.<String>} packagePaths
- * @param {String} npmTag
+ * @param {Array.<string>} packagePaths
+ * @param {string} npmTag
  * @returns {Promise}
  */
 export default async function assertNpmTag( packagePaths, npmTag ) {
@@ -44,8 +44,8 @@ export default async function assertNpmTag( packagePaths, npmTag ) {
  * For the official release, returns the "latest" tag. For a non-official release (pre-release), returns the version tag extracted from
  * the package version.
  *
- * @param {String} version
- * @returns {String}
+ * @param {string} version
+ * @returns {string}
  */
 function getVersionTag( version ) {
 	const [ versionTag ] = semver.prerelease( version ) || [ 'latest' ];

package/lib/utils/assertpackages.js

@@ -9,11 +9,11 @@ import upath from '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,
+ * @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`),
+ * @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}
  */

package/lib/utils/checkversionavailability.js

@@ -12,8 +12,8 @@ import shellEscape from 'shell-escape';
  * Returns a promise that resolves to `true` if the provided version does not exist or resolves the promise to `false` otherwise.
  * If the `npm show` command exits with an error, it is re-thrown.
  *
- * @param {String} version
- * @param {String} packageName
+ * @param {string} version
+ * @param {string} packageName
  * @returns {Promise}
  */
 export default async function checkVersionAvailability( version, packageName ) {

package/lib/utils/configurereleaseoptions.js

@@ -11,7 +11,7 @@ import provideToken from './providetoken.js';
  *
  * If the user choices a GitHub, required token also has to be provided.
  *
- * @returns {Promise.<Object>}
+ * @returns {Promise.<object>}
  */
 export default async function configureReleaseOptions() {
 	const options = {};

package/lib/utils/confirmincludingpackage.js

@@ -8,7 +8,7 @@ import inquirer from 'inquirer';
 /**
  * Asks a user for a confirmation for including a package that does not contain all required files.
  *
- * @returns {Promise.<Boolean>}
+ * @returns {Promise.<boolean>}
  */
 export default async function confirmIncludingPackage() {
 	const confirmQuestion = {

package/lib/utils/confirmnpmtag.js

@@ -9,9 +9,9 @@ import chalk from 'chalk';
 /**
  * Asks a user for a confirmation for updating and tagging versions of the packages.
  *
- * @param {String} versionTag A version tag based on a package version specified in `package.json`.
- * @param {String} npmTag A tag typed by the user when using the release tools.
- * @returns {Promise.<Boolean>}
+ * @param {string} versionTag A version tag based on a package version specified in `package.json`.
+ * @param {string} npmTag A tag typed by the user when using the release tools.
+ * @returns {Promise.<boolean>}
  */
 export default function confirmNpmTag( versionTag, npmTag ) {
 	const areVersionsEqual = versionTag === npmTag;

package/lib/utils/displaycommits.js

@@ -10,9 +10,9 @@ import { CLI_COMMIT_INDENT_SIZE, CLI_INDENT_SIZE } from './constants.js';
 
 /**
  * @param {Array.<Commit>|Set.<Commit>} commits
- * @param {Object} [options={}]
- * @param {Boolean} [options.attachLinkToCommit=false] Whether to attach a link to parsed commit.
- * @param {Number} [options.indentLevel=1] The indent level.
+ * @param {object} [options={}]
+ * @param {boolean} [options.attachLinkToCommit=false] Whether to attach a link to parsed commit.
+ * @param {number} [options.indentLevel=1] The indent level.
  */
 export default function displayCommits( commits, options = {} ) {
 	const log = logger();
@@ -28,7 +28,7 @@ export default function displayCommits( commits, options = {} ) {
 	const COMMITS_SEPARATOR = listIndent + chalk.gray( '-'.repeat( 112 ) );
 
 	// Group of commits by the commit's hash.
-	/** @type {Map.<String, Set.<Commit>>} */
+	/** @type {Map.<string, Set.<Commit>>} */
 	const commitGroups = new Map();
 
 	for ( const singleCommit of commits ) {

package/lib/utils/executeinparallel.js

@@ -23,17 +23,17 @@ const WORKER_SCRIPT = new URL( './parallelworker.js', import.meta.url );
  * Functions cannot be passed to workers. Hence, we store the callback as a Node.js file loaded by workers.
  *
  * @see https://nodejs.org/api/worker_threads.html
- * @param {Object} options
- * @param {String} options.packagesDirectory Relative path to a location of packages to execute a task.
- * @param {Function} options.taskToExecute A callback that is executed on all found packages.
+ * @param {object} options
+ * @param {string} options.packagesDirectory Relative path to a location of packages to execute a task.
+ * @param {function} options.taskToExecute A callback that is executed on all found packages.
  * It receives an absolute path to a package as an argument. It can be synchronous or may return a promise.
  * @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 {object} [options.taskOptions=null] Optional data required by the task.
  * @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.
+ * @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}
  */
 export default async function executeInParallel( options ) {
@@ -48,6 +48,7 @@ export default async function executeInParallel( options ) {
 		concurrency = os.cpus().length / 2
 	} = options;
 
+	const concurrencyAsInteger = Math.floor( concurrency ) || 1;
 	const normalizedCwd = upath.toUnix( cwd );
 	const packages = ( await glob( `${ packagesDirectory }/*/`, {
 		cwd: normalizedCwd,
@@ -58,7 +59,7 @@ export default async function executeInParallel( options ) {
 		packages.filter( packagesDirectoryFilter ) :
 		packages;
 
-	const packagesInThreads = getPackagesGroupedByThreads( packagesToProcess, concurrency );
+	const packagesInThreads = getPackagesGroupedByThreads( packagesToProcess, concurrencyAsInteger );
 
 	const callbackModule = upath.join( cwd, crypto.randomUUID() + '.mjs' );
 	await fs.writeFile( callbackModule, `export default ${ taskToExecute };`, 'utf-8' );
@@ -99,7 +100,7 @@ export default async function executeInParallel( options ) {
 
 /**
  * @param {ListrTaskObject} listrTask
- * @param {Number} total
+ * @param {number} total
  * @returns {Function}
  */
 function progressFactory( listrTask, total ) {
@@ -112,10 +113,10 @@ function progressFactory( listrTask, total ) {
 }
 
 /**
- * @param {Object} options
+ * @param {object} options
  * @param {AbortSignal} options.signal
- * @param {Function} options.onPackageDone
- * @param {Object} options.workerData
+ * @param {function} options.onPackageDone
+ * @param {object} options.workerData
  * @returns {Promise}
  */
 function createWorker( { signal, onPackageDone, workerData } ) {
@@ -149,9 +150,9 @@ function createWorker( { signal, onPackageDone, workerData } ) {
  *
  * To avoid having packages with a common prefix in a single thread, use a loop for attaching packages to threads.
  *
- * @param {Array.<String>} packages An array of absolute paths to packages.
- * @param {Number} concurrency A number of threads.
- * @returns {Array.<Array.<String>>}
+ * @param {Array.<string>} packages An array of absolute paths to packages.
+ * @param {number} concurrency A number of threads.
+ * @returns {Array.<Array.<string>>}
  */
 function getPackagesGroupedByThreads( packages, concurrency ) {
 	return packages.reduce( ( collection, packageItem, index ) => {
@@ -168,19 +169,19 @@ function getPackagesGroupedByThreads( packages, concurrency ) {
 }
 
 /**
- * @typedef {Object} ListrTaskObject
+ * @typedef {object} ListrTaskObject
  *
  * @see https://listr2.kilic.dev/api/classes/ListrTaskObject.html
  *
- * @property {String} title Title of the task.
+ * @property {string} title Title of the task.
  *
- * @property {String} output Update the current output of the task.
+ * @property {string} output Update the current output of the task.
  */
 
 /**
  * @callback ExecuteInParallelPackagesDirectoryFilter
  *
- * @param {String} directoryPath An absolute path to a directory.
+ * @param {string} directoryPath An absolute path to a directory.
  *
- * @returns {Boolean} Whether to include (`true`) or skip (`false`) processing the given directory.
+ * @returns {boolean} Whether to include (`true`) or skip (`false`) processing the given directory.
  */

package/lib/utils/generatechangelog.js

@@ -14,27 +14,27 @@ const UPDATED_TRANSLATION_COMMIT = '* Updated translations.';
  *
  * @param {Array.<Commit>} commits
  *
- * @param {Object} context
- * @param {String} context.version Current version for the release.
- * @param {String} context.repoUrl The repository URL.
- * @param {String} context.currentTag A tag for the current version.
- * @param {String} context.commit Commit keyword in the URL.
- * @param {String} [context.previousTag] A tag for the previous version.
- * @param {Boolean} [context.skipCommitsLink=false] Whether to skip adding links to commit.
- * @param {Boolean} [context.skipCompareLink=false] Whether to remove the compare URL in the header.
+ * @param {object} context
+ * @param {string} context.version Current version for the release.
+ * @param {string} context.repoUrl The repository URL.
+ * @param {string} context.currentTag A tag for the current version.
+ * @param {string} context.commit Commit keyword in the URL.
+ * @param {string} [context.previousTag] A tag for the previous version.
+ * @param {boolean} [context.skipCommitsLink=false] Whether to skip adding links to commit.
+ * @param {boolean} [context.skipCompareLink=false] Whether to remove the compare URL in the header.
  *
- * @param {Object} options
- * @param {Object} options.transform
- * @param {Function} options.transform.hash A function for mapping the commit's hash.
- * @param {Array.<String>|String} options.groupBy A key for grouping the commits.
- * @param {Function} options.commitGroupsSort A sort function for the groups.
- * @param {Function} options.noteGroupsSort A soft function for the notes.
- * @param {String} options.mainTemplate The main template for the changelog.
- * @param {String} options.headerPartial The "header" partial used in the main template.
- * @param {String} options.commitPartial The "commit" partial used in the main template.
- * @param {String} options.footerPartial The "footer" partial used in the main template.
+ * @param {object} options
+ * @param {object} options.transform
+ * @param {function} options.transform.hash A function for mapping the commit's hash.
+ * @param {Array.<string>|string} options.groupBy A key for grouping the commits.
+ * @param {function} options.commitGroupsSort A sort function for the groups.
+ * @param {function} options.noteGroupsSort A soft function for the notes.
+ * @param {string} options.mainTemplate The main template for the changelog.
+ * @param {string} options.headerPartial The "header" partial used in the main template.
+ * @param {string} options.commitPartial The "commit" partial used in the main template.
+ * @param {string} options.footerPartial The "footer" partial used in the main template.
  *
- * @returns {Promise.<String>}
+ * @returns {Promise.<string>}
  */
 export default function generateChangelog( commits, context, options ) {
 	const commitStream = new Readable( { objectMode: true } );
@@ -64,10 +64,10 @@ export default function generateChangelog( commits, context, options ) {
 /**
  * Merges multiple "Updated translations." entries into the single commit.
  *
- * @param {String} changelog Generated changelog.
- * @param {Object} [options={}]
- * @param {Boolean} [options.skipCommitsLink=false] Whether to skip adding links to commit.
- * @returns {String}
+ * @param {string} changelog Generated changelog.
+ * @param {object} [options={}]
+ * @param {boolean} [options.skipCommitsLink=false] Whether to skip adding links to commit.
+ * @returns {string}
  */
 function mergeUpdateTranslationsCommits( changelog, options = {} ) {
 	let foundUpdatedTranslationCommit = false;

package/lib/utils/getchangedfilesforcommit.js

@@ -8,8 +8,8 @@ import { tools } from '@ckeditor/ckeditor5-dev-utils';
 /**
  * Returns an array with paths to changed files for given commit.
  *
- * @param {String} commitId
- * @returns {Array.<String>}
+ * @param {string} commitId
+ * @returns {Array.<string>}
  */
 export default function getChangedFilesForCommit( commitId ) {
 	const gitCommand = `git log -m -1 --name-only --pretty="format:" ${ commitId }`;

package/lib/utils/getchangelog.js

@@ -8,8 +8,8 @@ import path from 'path';
 import { CHANGELOG_FILE } from './constants.js';
 
 /**
- * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
- * @returns {String|null}
+ * @param {string} [cwd=process.cwd()] Where to look for the changelog file.
+ * @returns {string|null}
  */
 export default function getChangelog( cwd = process.cwd() ) {
 	const changelogFile = path.join( cwd, CHANGELOG_FILE );

package/lib/utils/getchangesforversion.js

@@ -9,9 +9,9 @@ import getChangelog from './getchangelog.js';
 /**
  * Retrieves changes from the changelog for the given version (tag).
  *
- * @param {String} version
- * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
- * @returns {String|null}
+ * @param {string} version
+ * @param {string} [cwd=process.cwd()] Where to look for the changelog file.
+ * @returns {string|null}
  */
 export default function getChangesForVersion( version, cwd = process.cwd() ) {
 	version = version.replace( /^v/, '' );

package/lib/utils/getcommits.js

@@ -9,15 +9,16 @@ import { getRawCommitsStream } from 'git-raw-commits';
 import concat from 'concat-stream';
 import parserOptions from './parseroptions.js';
 import { tools } from '@ckeditor/ckeditor5-dev-utils';
+import shellEscape from 'shell-escape';
 
 /**
  * Returns a promise that resolves an array of commits since the last tag specified as `options.from`.
  *
- * @param {Function} transformCommit
- * @param {Object} options
- * @param {String} [options.from] A commit or tag name that will be the first param of the range of commits to collect.
- * @param {String} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
- * @param {String} [options.mainBranch='master'] A name of the main branch in the repository.
+ * @param {function} transformCommit
+ * @param {object} options
+ * @param {string} [options.from] A commit or tag name that will be the first param of the range of commits to collect.
+ * @param {string} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
+ * @param {string} [options.mainBranch='master'] A name of the main branch in the repository.
  * @returns {Promise.<Array.<Commit>>}
  */
 export default function getCommits( transformCommit, options = {} ) {
@@ -39,7 +40,7 @@ export default function getCommits( transformCommit, options = {} ) {
 	} else {
 		// Otherwise, (release branch is other than the main branch) we need to merge arrays of commits.
 		// See: https://github.com/ckeditor/ckeditor5/issues/7492.
-		const baseCommit = exec( `git merge-base ${ releaseBranch } ${ mainBranch }` ).trim();
+		const baseCommit = exec( `git merge-base ${ shellEscape( [ releaseBranch, mainBranch ] ) }` ).trim();
 
 		const commitPromises = [
 			// 1. Commits from the last release and to the point where the release branch was created (the merge-base commit).

package/lib/utils/getformatteddate.js

@@ -6,7 +6,7 @@
 import { format } from 'date-fns';
 
 /**
- * @returns {String}
+ * @returns {string}
  */
 export default function getFormattedDate() {
 	return format( new Date(), 'yyyy-MM-dd' );

package/lib/utils/getnewversiontype.js

@@ -7,7 +7,7 @@
  * Proposes new version based on commits.
  *
  * @param {Array.<Commit>} commits
- * @returns {String|null}
+ * @returns {string|null}
  */
 export default function getNewVersionType( commits ) {
 	// No commits = no changes.

package/lib/utils/getnpmtagfromversion.js

@@ -6,8 +6,8 @@
 import semver from 'semver';
 
 /**
- * @param {String} version
- * @returns {String}
+ * @param {string} version
+ * @returns {string}
  */
 export default function getNpmTagFromVersion( version ) {
 	const [ versionTag ] = semver.prerelease( version ) || [ 'latest' ];

package/lib/utils/getpackagejson.js

@@ -12,8 +12,8 @@ import upath from 'upath';
  * This function is helpful for testing the whole process. Allows mocking the file
  * instead of create the fixtures.
  *
- * @param {String} [cwd=process.cwd()] Where to look for package.json.
- * @returns {Object}
+ * @param {string} [cwd=process.cwd()] Where to look for package.json.
+ * @returns {object}
  */
 export default function getPackageJson( cwd = process.cwd() ) {
 	let pkgJsonPath = cwd;

package/lib/utils/getpackagespaths.js

@@ -17,13 +17,13 @@ import getPackageJson from './getpackagejson.js';
  *   - The second one is marked as `skipped` and means that packages should not be processed. They were listed as packages to skip
  *     (`options.skipPackages` or don't mach to `options.scope`).
  *
- * @param {Object} options
- * @param {String} options.cwd Current work directory.
- * @param {String|null} options.packages Name of directory where to look for packages. If `null`, only repository specified under
+ * @param {object} options
+ * @param {string} options.cwd Current work directory.
+ * @param {string|null} options.packages Name of directory where to look for packages. If `null`, only repository specified under
  * `options.cwd` will be returned.
- * @param {String|Array.<String>} options.skipPackages Glob pattern(s) which describes which packages should be skipped.
- * @param {String} [options.scope] Package names have to match to specified glob pattern.
- * @param {Boolean} [options.skipMainRepository=false] If set on true, package found in `options.cwd` will be skipped.
+ * @param {string|Array.<string>} options.skipPackages Glob pattern(s) which describes which packages should be skipped.
+ * @param {string} [options.scope] Package names have to match to specified glob pattern.
+ * @param {boolean} [options.skipMainRepository=false] If set on true, package found in `options.cwd` will be skipped.
  * @returns {PathsCollection}
  */
 export default function getPackagesPaths( options ) {
@@ -80,9 +80,9 @@ export default function getPackagesPaths( options ) {
 }
 
 /**
- * @typedef {Object} PathsCollection
+ * @typedef {object} PathsCollection
  *
- * @property {Set.<String>} matched Packages that match given criteria.
+ * @property {Set.<string>} matched Packages that match given criteria.
  *
- * @property {Set.<String>} skipped Packages that do not match given criteria.
+ * @property {Set.<string>} skipped Packages that do not match given criteria.
  */

package/lib/utils/getwriteroptions.js

@@ -15,7 +15,7 @@ const templatePath = path.join( __dirname, '..', 'templates' );
 
 /**
  * @param {WriterOptionsTransformCallback} transform
- * @returns {Object}
+ * @returns {object}
  */
 export default function getWriterOptions( transform ) {
 	return {