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

package/lib/tasks/cleanuppackages.js

@@ -19,12 +19,12 @@ 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 ) {
@@ -50,12 +50,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 +79,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 +129,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 +155,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 +176,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 +194,5 @@ function sortPathsFromDeepestFirst( firstPath, secondPath ) {
 /**
  * @callback PackageJsonFieldsToRemoveCallback
  * @param {DefaultFieldsToRemove} defaults
- * @returns {Array.<String>}
+ * @returns {Array.<string>}
  */

package/lib/tasks/commitandtag.js

@@ -13,10 +13,10 @@ 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() } ) {

package/lib/tasks/creategithubrelease.js

@@ -12,12 +12,12 @@ 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 {
@@ -51,8 +51,8 @@ export default async function createGithubRelease( options ) {
 /**
  * Returns an npm tag based on the specified release version.
  *
- * @param {String} version
- * @returns {String}
+ * @param {string} version
+ * @returns {string}
  */
 function getVersionTag( version ) {
 	const [ versionTag ] = semver.prerelease( version ) || [ 'latest' ];
@@ -64,9 +64,9 @@ function getVersionTag( version ) {
  * 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>>}
@@ -378,7 +378,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 +400,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 +516,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 +597,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 +616,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 +649,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 +672,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 +690,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 +714,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 +730,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 +762,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.
@@ -186,11 +186,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 +206,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.
  */

package/lib/tasks/publishpackages.js

@@ -24,24 +24,24 @@ import publishPackageOnNpmCallback from '../utils/publishpackageonnpmcallback.js
  * When the validation for each package passes, packages are published on npm. Optional callback is called for confirmation whether to
  * continue.
  *
- * @param {Object} options
- * @param {String} options.packagesDirectory Relative path to a location of packages to release.
- * @param {String} options.npmOwner The account name on npm, which should be used to publish the packages.
+ * @param {object} options
+ * @param {string} options.packagesDirectory Relative path to a location of packages to release.
+ * @param {string} options.npmOwner The account name on npm, which should be used to publish the packages.
  * @param {ListrTaskObject} options.listrTask An instance of `ListrTask`.
  * @param {AbortSignal|null} [options.signal=null] Signal to abort the asynchronous process.
- * @param {String} [options.npmTag='staging'] The npm distribution tag.
- * @param {Object.<String, Array.<String>>|null} [options.optionalEntries=null] Specifies which entries from the `files` field in the
+ * @param {string} [options.npmTag='staging'] The npm distribution tag.
+ * @param {Object.<string, Array.<string>>|null} [options.optionalEntries=null] Specifies which entries from the `files` field in the
  * `package.json` are optional. The key is a package name, and its value is an array of optional entries from the `files` field, for which
  * it is allowed not to match any file. The `options.optionalEntries` object may also contain the `default` key, which is used for all
  * packages that do not have own definition.
- * @param {String} [options.confirmationCallback=null] An callback whose response decides to continue the publishing packages. Synchronous
+ * @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,
+ * @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`),
+ * @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.
+ * @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}
  */
 export default async function publishPackages( options ) {

package/lib/tasks/push.js

@@ -9,10 +9,10 @@ import shellEscape from 'shell-escape';
 /**
  * Push the local changes to a remote server.
  *
- * @param {Object} options
- * @param {String} options.releaseBranch A name of the branch that should be used for releasing packages.
- * @param {String} options.version Name of tag connected with the release.
- * @param {String} [options.cwd] Root of the repository to prepare. `process.cwd()` by default.
+ * @param {object} options
+ * @param {string} options.releaseBranch A name of the branch that should be used for releasing packages.
+ * @param {string} options.version Name of tag connected with the release.
+ * @param {string} [options.cwd] Root of the repository to prepare. `process.cwd()` by default.
  * @returns {Promise}
  */
 export default async function push( options ) {

package/lib/tasks/reassignnpmtags.js

@@ -19,10 +19,10 @@ const execPromise = util.promisify( exec );
  * Used to switch the tags from `staging` to `latest` for specified array of packages.
  * Each operation will be retried up to 3 times in case of failure.
  *
- * @param {Object} options
- * @param {String} options.npmOwner User that is authorized to release packages.
- * @param {String} options.version Specifies the version of packages to reassign the tags for.
- * @param {Array.<String>} options.packages Array of packages' names to reassign tags for.
+ * @param {object} options
+ * @param {string} options.npmOwner User that is authorized to release packages.
+ * @param {string} options.version Specifies the version of packages to reassign the tags for.
+ * @param {Array.<string>} options.packages Array of packages' names to reassign tags for.
  * @returns {Promise}
  */
 export default async function reassignNpmTags( { npmOwner, version, packages } ) {
@@ -79,16 +79,16 @@ export default async function reassignNpmTags( { npmOwner, version, packages } )
 }
 
 /**
- * @param {String} message
- * @returns {String}
+ * @param {string} message
+ * @returns {string}
  */
 function trimErrorMessage( message ) {
 	return message.replace( /npm ERR!.*\n/g, '' ).trim();
 }
 
 /**
- * @param {Function} callback
- * @param {Number} times
+ * @param {function} callback
+ * @param {number} times
  * @returns {RetryCallback}
  */
 function retry( callback, times = 3 ) {