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

package/lib/index.js

@@ -33,3 +33,4 @@ export { default as verifyPackagesPublishedCorrectly } from './tasks/verifypacka
 export { default as getNpmTagFromVersion } from './utils/getnpmtagfromversion.js';
 export { default as isVersionPublishableForTag } from './utils/isversionpublishablefortag.js';
 export { default as provideToken } from './utils/providetoken.js';
+export { default as findPathsToPackages } from './utils/findpathstopackages.js';

package/lib/tasks/cleanuppackages.js

@@ -6,6 +6,7 @@
 import fs from 'fs-extra';
 import upath from 'upath';
 import { glob } from 'glob';
+import findPathsToPackages from '../utils/findpathstopackages.js';
 
 /**
  * The purpose of the script is to clean all packages prepared for the release. The cleaning consists of two stages:
@@ -19,22 +20,17 @@ import { glob } from 'glob';
  *   - file pointed by the `types` field from `package.json`
  * - Removes unnecessary fields from the `package.json` file.
  *
- * @param {Object} options
- * @param {String} options.packagesDirectory Relative path to a location of packages to be cleaned up.
- * @param {Array.<String>|PackageJsonFieldsToRemoveCallback} [options.packageJsonFieldsToRemove] Fields to remove from `package.json`.
+ * @param {object} options
+ * @param {string} options.packagesDirectory Relative path to a location of packages to be cleaned up.
+ * @param {Array.<string>|PackageJsonFieldsToRemoveCallback} [options.packageJsonFieldsToRemove] Fields to remove from `package.json`.
  * If not set, a predefined list is used. If the callback is used, the first argument is the list with defaults.
- * @param {Boolean} [options.preservePostInstallHook] Whether to preserve the postinstall hook in `package.json`.
- * @param {String} [options.cwd] Current working directory from which all paths will be resolved.
+ * @param {boolean} [options.preservePostInstallHook] Whether to preserve the postinstall hook in `package.json`.
+ * @param {string} [options.cwd] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
 export default async function cleanUpPackages( options ) {
 	const { packagesDirectory, packageJsonFieldsToRemove, preservePostInstallHook, cwd } = parseOptions( options );
-
-	const packageJsonPaths = await glob( '*/package.json', {
-		cwd: upath.join( cwd, packagesDirectory ),
-		nodir: true,
-		absolute: true
-	} );
+	const packageJsonPaths = await findPathsToPackages( cwd, packagesDirectory, { includePackageJson: true } );
 
 	for ( const packageJsonPath of packageJsonPaths ) {
 		const packagePath = upath.dirname( packageJsonPath );
@@ -50,12 +46,12 @@ export default async function cleanUpPackages( options ) {
 /**
  * Prepares the configuration options for the script.
  *
- * @param {Object} options
- * @param {String} options.packagesDirectory
- * @param {Array.<String>|PackageJsonFieldsToRemoveCallback} [options.packageJsonFieldsToRemove=DefaultFieldsToRemove]
- * @param {Boolean} [options.preservePostInstallHook]
- * @param {String} [options.cwd=process.cwd()]
- * @returns {Object}
+ * @param {object} options
+ * @param {string} options.packagesDirectory
+ * @param {Array.<string>|PackageJsonFieldsToRemoveCallback} [options.packageJsonFieldsToRemove=DefaultFieldsToRemove]
+ * @param {boolean} [options.preservePostInstallHook]
+ * @param {string} [options.cwd=process.cwd()]
+ * @returns {object}
  */
 function parseOptions( options ) {
 	const defaultPackageJsonFieldsToRemove = [ 'devDependencies', 'depcheckIgnore', 'scripts', 'private' ];
@@ -79,8 +75,8 @@ function parseOptions( options ) {
 /**
  * Removes unnecessary files and directories from the package directory.
  *
- * @param {Object} packageJson
- * @param {String} packagePath
+ * @param {object} packageJson
+ * @param {string} packagePath
  * @returns {Promise}
  */
 async function cleanUpPackageDirectory( packageJson, packagePath ) {
@@ -129,8 +125,8 @@ async function cleanUpPackageDirectory( packageJson, packagePath ) {
 /**
  * Creates an array of patterns to ignore for the `glob` calls.
  *
- * @param {Object} packageJson
- * @returns {Array.<String>}
+ * @param {object} packageJson
+ * @returns {Array.<string>}
  */
 function getIgnoredFilePatterns( packageJson ) {
 	// The patterns supported by `package.json` in the `files` field do not correspond 1:1 to the patterns expected by the `glob`.
@@ -155,9 +151,9 @@ function getIgnoredFilePatterns( packageJson ) {
 /**
  * Removes unnecessary fields from the `package.json`.
  *
- * @param {Object} packageJson
- * @param {Array.<String>} packageJsonFieldsToRemove
- * @param {Boolean} preservePostInstallHook
+ * @param {object} packageJson
+ * @param {Array.<string>} packageJsonFieldsToRemove
+ * @param {boolean} preservePostInstallHook
  */
 function cleanUpPackageJson( packageJson, packageJsonFieldsToRemove, preservePostInstallHook ) {
 	for ( const key of Object.keys( packageJson ) ) {
@@ -176,9 +172,9 @@ function cleanUpPackageJson( packageJson, packageJsonFieldsToRemove, preservePos
 /**
  * Sort function that defines the order of the paths. It sorts paths from the most nested ones first.
  *
- * @param {String} firstPath
- * @param {String} secondPath
- * @returns {Number}
+ * @param {string} firstPath
+ * @param {string} secondPath
+ * @returns {number}
  */
 function sortPathsFromDeepestFirst( firstPath, secondPath ) {
 	const firstPathSegments = firstPath.split( '/' ).length;
@@ -194,5 +190,5 @@ function sortPathsFromDeepestFirst( firstPath, secondPath ) {
 /**
  * @callback PackageJsonFieldsToRemoveCallback
  * @param {DefaultFieldsToRemove} defaults
- * @returns {Array.<String>}
+ * @returns {Array.<string>}
  */

package/lib/tasks/commitandtag.js

@@ -4,19 +4,18 @@
  */
 
 import upath from 'upath';
-import { tools } from '@ckeditor/ckeditor5-dev-utils';
 import { glob } from 'glob';
-import shellEscape from 'shell-escape';
+import { simpleGit } from 'simple-git';
 
 const { toUnix } = upath;
 
 /**
  * Creates a commit and a tag for specified version.
  *
- * @param {Object} options
- * @param {String} options.version The commit will contain this param in its message and the tag will have a `v` prefix.
- * @param {Array.<String>} options.files Array of glob patterns for files to be added to the release commit.
- * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
+ * @param {object} options
+ * @param {string} options.version The commit will contain this param in its message and the tag will have a `v` prefix.
+ * @param {Array.<string>} options.files Array of glob patterns for files to be added to the release commit.
+ * @param {string} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
 export default async function commitAndTag( { version, files, cwd = process.cwd() } ) {
@@ -27,22 +26,18 @@ export default async function commitAndTag( { version, files, cwd = process.cwd(
 		return;
 	}
 
-	const shExecOptions = {
-		cwd: normalizedCwd,
-		async: true,
-		verbosity: 'silent'
-	};
+	const git = simpleGit( {
+		baseDir: normalizedCwd
+	} );
 
-	// Run the command separately for each file to avoid exceeding the maximum command length on Windows, which is 32767 characters.
-	for ( const filePath of filePathsToAdd ) {
-		await tools.shExec( `git add ${ shellEscape( [ filePath ] ) }`, shExecOptions );
-	}
+	const { all: availableTags } = await git.tags();
+	const tagForVersion = availableTags.find( tag => tag.endsWith( version ) );
 
-	const escapedVersion = {
-		commit: shellEscape( [ `Release: v${ version }.` ] ),
-		tag: shellEscape( [ `v${ version }` ] )
-	};
+	// Do not commit and create tags if a tag is already taken. It might happen when a release job is restarted.
+	if ( tagForVersion ) {
+		return;
+	}
 
-	await tools.shExec( `git commit --message ${ escapedVersion.commit } --no-verify`, shExecOptions );
-	await tools.shExec( `git tag ${ escapedVersion.tag }`, shExecOptions );
+	await git.commit( `Release: v${ version }.`, filePathsToAdd );
+	await git.addTag( `v${ version }` );
 }

package/lib/tasks/creategithubrelease.js

@@ -4,20 +4,20 @@
  */
 
 import { Octokit } from '@octokit/rest';
-import semver from 'semver';
 import * as transformCommitUtils from '../utils/transformcommitutils.js';
+import getNpmTagFromVersion from '../utils/getnpmtagfromversion.js';
 
 const { getRepositoryUrl } = transformCommitUtils;
 
 /**
  * Create a GitHub release.
  *
- * @param {Object} options
- * @param {String} options.token Token used to authenticate with GitHub.
- * @param {String} options.version Name of tag connected with the release.
- * @param {String} options.description Description of the release.
- * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
- * @returns {Promise.<String>}
+ * @param {object} options
+ * @param {string} options.token Token used to authenticate with GitHub.
+ * @param {string} options.version Name of tag connected with the release.
+ * @param {string} options.description Description of the release.
+ * @param {string} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
+ * @returns {Promise.<string>}
  */
 export default async function createGithubRelease( options ) {
 	const {
@@ -41,32 +41,20 @@ export default async function createGithubRelease( options ) {
 			owner: repositoryOwner,
 			repo: repositoryName,
 			body: description,
-			prerelease: getVersionTag( version ) !== 'latest'
+			prerelease: getNpmTagFromVersion( version ) !== 'latest'
 		} );
 	}
 
 	return `https://github.com/${ repositoryOwner }/${ repositoryName }/releases/tag/v${ version }`;
 }
 
-/**
- * Returns an npm tag based on the specified release version.
- *
- * @param {String} version
- * @returns {String}
- */
-function getVersionTag( version ) {
-	const [ versionTag ] = semver.prerelease( version ) || [ 'latest' ];
-
-	return versionTag;
-}
-
 /**
  * Resolves a promise containing a flag if the GitHub contains the release page for given version.
  *
  * @param {Octokit} github
- * @param {String} repositoryOwner
- * @param {String} repositoryName
- * @param {String} version
+ * @param {string} repositoryOwner
+ * @param {string} repositoryName
+ * @param {string} version
  * @returns {Promise.<boolean>}
  */
 async function shouldCreateRelease( github, repositoryOwner, repositoryName, version ) {

package/lib/tasks/generatechangelogformonorepository.js

@@ -35,37 +35,37 @@ const noteInfo = `[ℹ️](${ VERSIONING_POLICY_URL }#major-and-minor-breaking-c
  *
  * The typed version will be the same for all packages. See: https://github.com/ckeditor/ckeditor5/issues/7323.
  *
- * @param {Object} options
+ * @param {object} options
  *
- * @param {String} options.cwd Current working directory (packages) from which all paths will be resolved.
+ * @param {string} options.cwd Current working directory (packages) from which all paths will be resolved.
  *
- * @param {String} options.packages Where to look for packages.
+ * @param {string} options.packages Where to look for packages.
  *
- * @param {Function} options.transformScope A function that returns a URL to a package from a scope of a commit.
+ * @param {function} options.transformScope A function that returns a URL to a package from a scope of a commit.
  *
- * @param {String} [options.scope] Package names have to match to specified glob pattern in order to be processed.
+ * @param {string} [options.scope] Package names have to match to specified glob pattern in order to be processed.
  *
- * @param {Array.<String>} [options.skipPackages=[]] Name of packages which won't be touched.
+ * @param {Array.<string>} [options.skipPackages=[]] Name of packages which won't be touched.
  *
- * @param {Boolean} [options.skipLinks=false] If set on true, links to release or commits will be omitted.
+ * @param {boolean} [options.skipLinks=false] If set on true, links to release or commits will be omitted.
  *
- * @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.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.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 {string} [options.mainBranch='master'] A name of the main branch in the repository.
  *
  * @param {Array.<ExternalRepository>} [options.externalRepositories=[]] An array of object with additional repositories
  * that the function takes into consideration while gathering commits. It assumes that those directories are also mono repositories.
  *
- * @param {Boolean} [options.skipFileSave=false] Whether to resolve the changes instead of saving it to a file.
+ * @param {boolean} [options.skipFileSave=false] Whether to resolve the changes instead of saving it to a file.
  *
- * @param {String|null} [options.nextVersion=null] Next version to use. If not provided, a user needs to provide via CLI.
+ * @param {string|null} [options.nextVersion=null] Next version to use. If not provided, a user needs to provide via CLI.
  *
  * @param {FormatDateCallback} [options.formatDate] A callback allowing defining a custom format of the date inserted into the changelog.
  * If not specified, the default date matches the `YYYY-MM-DD` pattern.
  *
- * @returns {Promise.<undefined|String>}
+ * @returns {Promise.<undefined|string>}
  */
 export default async function generateChangelogForMonoRepository( options ) {
 	const log = logger();
@@ -161,11 +161,11 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Returns collections with packages found in the `options.cwd` directory and the external repositories.
 	 *
-	 * @param {Object} options
-	 * @param {String} options.cwd Current working directory (packages) from which all paths will be resolved.
-	 * @param {String} options.packages Where to look for packages.
-	 * @param {String} options.scope Package names have to match to specified glob pattern in order to be processed.
-	 * @param {Array.<String>} options.skipPackages Name of packages which won't be touched.
+	 * @param {object} options
+	 * @param {string} options.cwd Current working directory (packages) from which all paths will be resolved.
+	 * @param {string} options.packages Where to look for packages.
+	 * @param {string} options.scope Package names have to match to specified glob pattern in order to be processed.
+	 * @param {Array.<string>} options.skipPackages Name of packages which won't be touched.
 	 * @param {Array.<ExternalRepository>} options.externalRepositories An array of object with additional repositories
 	 * that the function takes into consideration while gathering packages.
 	 * @returns {PathsCollection}
@@ -210,10 +210,10 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Returns a promise that resolves an array of commits since the last tag specified as `options.from`.
 	 *
-	 * @param {Object} options
-	 * @param {String} options.cwd Current working directory (packages) from which all paths will be resolved.
-	 * @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 A name of the branch that should be used for releasing packages.
+	 * @param {object} options
+	 * @param {string} options.cwd Current working directory (packages) from which all paths will be resolved.
+	 * @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 A name of the branch that should be used for releasing packages.
 	 * @param {Array.<ExternalRepository>} options.externalRepositories An array of object with additional repositories
 	 * that the function takes into consideration while gathering commits.
 	 * @returns {Promise.<Array.<Commit>>}
@@ -301,7 +301,14 @@ export default async function generateChangelogForMonoRepository( options ) {
 			bumpType = 'patch';
 		}
 
-		return provideNewVersionForMonoRepository( highestVersion, packageHighestVersion, bumpType, { indentLevel: 1 } )
+		const provideVersionOptions = {
+			packageName: packageHighestVersion,
+			version: highestVersion,
+			bumpType,
+			indentLevel: 1
+		};
+
+		return provideNewVersionForMonoRepository( provideVersionOptions )
 			.then( version => {
 				nextVersion = version;
 
@@ -378,7 +385,7 @@ export default async function generateChangelogForMonoRepository( options ) {
 	 * Finds commits that touched the package under `packagePath` directory.
 	 *
 	 * @param {Array.<Commit>} commits
-	 * @param {String} packagePath
+	 * @param {string} packagePath
 	 * @returns {Array.<Commit>}
 	 */
 	function filterCommitsByPath( commits, packagePath ) {
@@ -400,7 +407,7 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Generates a list of changes based on the commits in the main repository.
 	 *
-	 * @returns {Promise.<String>}
+	 * @returns {Promise.<string>}
 	 */
 	function generateChangelogFromCommits() {
 		logProcess( 'Generating the changelog...' );
@@ -516,7 +523,7 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Prepares a summary that describes what has changed in all dependencies.
 	 *
-	 * @returns {String}
+	 * @returns {string}
 	 */
 	function generateSummaryOfChangesInPackages() {
 		const dependencies = new Map();
@@ -597,8 +604,8 @@ export default async function generateChangelogForMonoRepository( options ) {
 	}
 
 	/**
-	 * @param {Map.<String, Version>} dependencies
-	 * @returns {Map.<String, Version>}
+	 * @param {Map.<string, Version>} dependencies
+	 * @returns {Map.<string, Version>}
 	 */
 	function getNewPackages( dependencies ) {
 		const packages = new Map();
@@ -616,9 +623,9 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Returns packages where scope of changes described in the commits' notes match to packages' names.
 	 *
-	 * @param {Map.<String, Version>} dependencies
-	 * @param {String} noteTitle
-	 * @returns {Map.<String, Version>}
+	 * @param {Map.<string, Version>} dependencies
+	 * @param {string} noteTitle
+	 * @returns {Map.<string, Version>}
 	 */
 	function getPackagesMatchedToScopesFromNotes( dependencies, noteTitle ) {
 		const packages = new Map();
@@ -649,8 +656,8 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Returns packages that contain new features.
 	 *
-	 * @param {Map.<String, Version>} dependencies
-	 * @returns {Map.<String, Version>}
+	 * @param {Map.<string, Version>} dependencies
+	 * @returns {Map.<string, Version>}
 	 */
 	function getPackagesWithNewFeatures( dependencies ) {
 		const packages = new Map();
@@ -672,10 +679,10 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Returns a formatted entry (string) for the changelog.
 	 *
-	 * @param {String} packageName
-	 * @param {String} nextVersion
-	 * @param {String} currentVersion
-	 * @returns {String}
+	 * @param {string} packageName
+	 * @param {string} nextVersion
+	 * @param {string} currentVersion
+	 * @returns {string}
 	 */
 	function formatChangelogEntry( packageName, nextVersion, currentVersion = null ) {
 		const npmUrl = `https://www.npmjs.com/package/${ packageName }/v/${ nextVersion }`;
@@ -690,7 +697,7 @@ export default async function generateChangelogForMonoRepository( options ) {
 	/**
 	 * Returns a function that is being used when sorting commits.
 	 *
-	 * @param {String} scopeField A name of the field that saves the commit's scope.
+	 * @param {string} scopeField A name of the field that saves the commit's scope.
 	 * @returns {Function}
 	 */
 	function sortFunctionFactory( scopeField ) {
@@ -714,11 +721,11 @@ export default async function generateChangelogForMonoRepository( options ) {
 	}
 
 	/**
-	 * @param {String} message
-	 * @param {Object} [options={}]
-	 * @param {Number} [options.indentLevel=0]
-	 * @param {Boolean} [options.startWithNewLine=false] Whether to append a new line before the message.
-	 * @param {Boolean} [options.isWarning=false] Whether to use `warning` method instead of `log`.
+	 * @param {string} message
+	 * @param {object} [options={}]
+	 * @param {number} [options.indentLevel=0]
+	 * @param {boolean} [options.startWithNewLine=false] Whether to append a new line before the message.
+	 * @param {boolean} [options.isWarning=false] Whether to use `warning` method instead of `log`.
 	 */
 	function logInfo( message, options = {} ) {
 		const indentLevel = options.indentLevel || 0;
@@ -730,30 +737,30 @@ export default async function generateChangelogForMonoRepository( options ) {
 }
 
 /**
- * @typedef {Object} Version
+ * @typedef {object} Version
  *
- * @param {Boolean} current The current version defined in the `package.json` file.
+ * @param {boolean} current The current version defined in the `package.json` file.
  *
- * @param {Boolean} next The next version defined during generating the changelog file.
+ * @param {boolean} next The next version defined during generating the changelog file.
  */
 
 /**
- * @typedef {Object} ExternalRepository
+ * @typedef {object} ExternalRepository
  *
- * @param {String} cwd An absolute path to the repository.
+ * @param {string} cwd An absolute path to the repository.
  *
- * @param {String} packages Subdirectory in a given `cwd` that should searched for packages. E.g. `'packages'`.
+ * @param {string} packages Subdirectory in a given `cwd` that should searched for packages. E.g. `'packages'`.
  *
- * @param {String} [scope] Glob pattern for package names to be processed.
+ * @param {string} [scope] Glob pattern for package names to be processed.
  *
- * @param {Array.<String>} [skipPackages] Name of packages which won't be touched.
+ * @param {Array.<string>} [skipPackages] Name of packages which won't be touched.
  *
- * @param {Boolean} [skipLinks] If set on `true`, a URL to commit (hash) will be omitted.
+ * @param {boolean} [skipLinks] If set on `true`, a URL to commit (hash) will be omitted.
  *
- * @param {String} [from] A commit or tag name that will be the first param of the range of commits to collect. If not specified,
+ * @param {string} [from] A commit or tag name that will be the first param of the range of commits to collect. If not specified,
  * the option will inherit its value from the function's `options` object.
  *
- * @param {String} [releaseBranch] A name of the branch that should be used for releasing packages. If not specified, the branch
+ * @param {string} [releaseBranch] A name of the branch that should be used for releasing packages. If not specified, the branch
  * used for the main repository will be used.
  */
 
@@ -762,5 +769,5 @@ export default async function generateChangelogForMonoRepository( options ) {
  *
  * @param {Date} now The current date.
  *
- * @returns {String} The formatted date inserted into the changelog.
+ * @returns {string} The formatted date inserted into the changelog.
  */

package/lib/tasks/generatechangelogforsinglepackage.js

@@ -28,15 +28,15 @@ const SKIP_GENERATE_CHANGELOG = 'Typed "skip" as a new version. Aborting.';
  *
  * If the package does not have any commit, the user has to confirm whether the changelog should be generated.
  *
- * @param {Object} [options={}] Additional options.
+ * @param {object} [options={}] Additional options.
  *
- * @param {Boolean} [options.skipLinks=false] If set on true, links to release or commits will be omitted.
+ * @param {boolean} [options.skipLinks=false] If set on true, links to release or commits will be omitted.
  *
- * @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.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.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 {string} [options.mainBranch='master'] A name of the main branch in the repository.
  *
  * @param {FormatDateCallback} [options.formatDate] A callback allowing defining a custom format of the date inserted into the changelog.
  * If not specified, the default date matches the `YYYY-MM-DD` pattern.
@@ -79,11 +79,14 @@ export default async function generateChangelogForSinglePackage( options = {} )
 		.then( () => {
 			logProcess( 'Preparing new version for the package...' );
 
-			const releaseType = getNewVersionType( allCommits );
-
 			displayCommits( allCommits, { indentLevel: 1 } );
 
-			return provideVersion( pkgJson.version, releaseType, { indentLevel: 1 } );
+			return provideVersion( {
+				packageName: pkgJson.name,
+				version: pkgJson.version,
+				indentLevel: 1,
+				releaseTypeOrNewVersion: getNewVersionType( allCommits )
+			} );
 		} )
 		.then( version => {
 			if ( version === 'skip' ) {
@@ -186,11 +189,11 @@ export default async function generateChangelogForSinglePackage( options = {} )
 	}
 
 	/**
-	 * @param {String} message
-	 * @param {Object} [options={}]
-	 * @param {Number} [options.indentLevel=0]
-	 * @param {Boolean} [options.startWithNewLine=false] Whether to append a new line before the message.
-	 * @param {Boolean} [options.isWarning=false] Whether to use `warning` method instead of `log`.
+	 * @param {string} message
+	 * @param {object} [options={}]
+	 * @param {number} [options.indentLevel=0]
+	 * @param {boolean} [options.startWithNewLine=false] Whether to append a new line before the message.
+	 * @param {boolean} [options.isWarning=false] Whether to use `warning` method instead of `log`.
 	 */
 	function logInfo( message, options = {} ) {
 		const indentLevel = options.indentLevel || 0;
@@ -206,5 +209,5 @@ export default async function generateChangelogForSinglePackage( options = {} )
  *
  * @param {Date} now The current date.
  *
- * @returns {String} The formatted date inserted into the changelog.
+ * @returns {string} The formatted date inserted into the changelog.
  */

package/lib/tasks/preparerepository.js

@@ -10,12 +10,12 @@ import upath from 'upath';
 /**
  * The goal is to prepare the release directory containing the packages we want to publish.
  *
- * @param {Object} options
- * @param {String} options.outputDirectory Relative path to the destination directory where packages will be stored.
- * @param {String} [options.cwd] Root of the repository to prepare. `process.cwd()` by default.
- * @param {String} [options.packagesDirectory] Relative path to a location of packages.
+ * @param {object} options
+ * @param {string} options.outputDirectory Relative path to the destination directory where packages will be stored.
+ * @param {string} [options.cwd] Root of the repository to prepare. `process.cwd()` by default.
+ * @param {string} [options.packagesDirectory] Relative path to a location of packages.
  * If specified, all of the found packages will be copied.
- * @param {Array.<String>} [options.packagesToCopy] List of packages that should be processed.
+ * @param {Array.<string>} [options.packagesToCopy] List of packages that should be processed.
  * If not specified, all packages found in `packagesDirectory` are considered.
  * @param {RootPackageJson} [options.rootPackageJson] Object containing values to use in the created the `package.json` file.
  * If not specified, the root package will not be created.
@@ -71,9 +71,9 @@ export default async function prepareRepository( options ) {
 }
 
 /**
- * @param {Object} packageJson
- * @param {String} [packageJson.name]
- * @param {Array.<String>} [packageJson.files]
+ * @param {object} packageJson
+ * @param {string} [packageJson.name]
+ * @param {Array.<string>} [packageJson.files]
  */
 function validateRootPackage( packageJson ) {
 	if ( !packageJson.name ) {
@@ -86,10 +86,10 @@ function validateRootPackage( packageJson ) {
 }
 
 /**
- * @param {Object} options
- * @param {String} options.cwd
+ * @param {object} options
+ * @param {string} options.cwd
  * @param {RootPackageJson} options.rootPackageJson
- * @param {String} options.outputDirectoryPath
+ * @param {string} options.outputDirectoryPath
  * @returns {Promise}
  */
 async function processRootPackage( { cwd, rootPackageJson, outputDirectoryPath } ) {
@@ -110,11 +110,11 @@ async function processRootPackage( { cwd, rootPackageJson, outputDirectoryPath }
 }
 
 /**
- * @param {Object} options
- * @param {String} options.cwd
- * @param {String} options.packagesDirectory
- * @param {String} options.outputDirectoryPath
- * @param {Array.<String>} [options.packagesToCopy]
+ * @param {object} options
+ * @param {string} options.cwd
+ * @param {string} options.packagesDirectory
+ * @param {string} options.outputDirectoryPath
+ * @param {Array.<string>} [options.packagesToCopy]
  * @returns {Promise}
  */
 async function processMonorepoPackages( { cwd, packagesDirectory, packagesToCopy, outputDirectoryPath } ) {
@@ -141,9 +141,9 @@ async function processMonorepoPackages( { cwd, packagesDirectory, packagesToCopy
 }
 
 /**
- * @typedef {Object} RootPackageJson
+ * @typedef {object} RootPackageJson
  *
- * @param {String} options.rootPackageJson.name Name of the package. Required value.
+ * @param {string} options.rootPackageJson.name Name of the package. Required value.
  *
- * @param {Array.<String>} options.rootPackageJson.files Array containing a list of files or directories to copy. Required value.
+ * @param {Array.<string>} options.rootPackageJson.files Array containing a list of files or directories to copy. Required value.
  */