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

package/lib/utils/isversionpublishablefortag.js

@@ -10,10 +10,10 @@ import shellEscape from 'shell-escape';
 /**
  * This util aims to verify if the given `packageName` can be published with the given `version` on the `npmTag`.
  *
- * @param {String} packageName
- * @param {String} version
- * @param {String} npmTag
- * @return {Promise.<Boolean>}
+ * @param {string} packageName
+ * @param {string} version
+ * @param {string} npmTag
+ * @returns {Promise.<boolean>}
  */
 export default async function isVersionPublishableForTag( packageName, version, npmTag ) {
 	const command = `npm view ${ shellEscape( [ packageName ] ) }@${ shellEscape( [ npmTag ] ) } version --silent`;

package/lib/utils/parallelworker.js

@@ -10,8 +10,8 @@ import { parentPort, workerData } from 'worker_threads';
 // Required due to top-level await.
 ( async () => {
 	/**
-	 * @param {String} callbackModule
-	 * @param {Array.<String>} packages
+	 * @param {string} callbackModule
+	 * @param {Array.<string>} packages
 	 */
 	const { default: callback } = await import( workerData.callbackModule );
 

package/lib/utils/providenewversionformonorepository.js

@@ -11,12 +11,12 @@ import { CLI_INDENT_SIZE } from './constants.js';
 /**
  * Asks a user for providing the new version for a major release.
  *
- * @param {String} version
- * @param {String} foundPackage
- * @param {String} bumpType
- * @param {Object} [options={}]
- * @param {Number} [options.indentLevel=0] The indent level.
- * @returns {Promise.<String>}
+ * @param {string} version
+ * @param {string} foundPackage
+ * @param {string} bumpType
+ * @param {object} [options={}]
+ * @param {number} [options.indentLevel=0] The indent level.
+ * @returns {Promise.<string>}
  */
 export default async function provideNewVersionForMonoRepository( version, foundPackage, bumpType, options = {} ) {
 	const indentLevel = options.indentLevel || 0;

package/lib/utils/providetoken.js

@@ -8,7 +8,7 @@ import inquirer from 'inquirer';
 /**
  * Asks a user for providing the GitHub token.
  *
- * @returns {Promise.<String>}
+ * @returns {Promise.<string>}
  */
 export default async function provideToken() {
 	const tokenQuestion = {

package/lib/utils/provideversion.js

@@ -11,13 +11,13 @@ import { CLI_INDENT_SIZE } from './constants.js';
 /**
  * Asks a user for providing the new version.
  *
- * @param {String} packageVersion
- * @param {String|null} releaseTypeOrNewVersion
- * @param {Object} [options]
- * @param {Boolean} [options.disableInternalVersion=false] Whether to "internal" version is enabled.
- * @param {Boolean} [options.disableSkipVersion=false] Whether to "skip" version is enabled.
- * @param {Number} [options.indentLevel=0] The indent level.
- * @returns {Promise.<String>}
+ * @param {string} packageVersion
+ * @param {string|null} releaseTypeOrNewVersion
+ * @param {object} [options]
+ * @param {boolean} [options.disableInternalVersion=false] Whether to "internal" version is enabled.
+ * @param {boolean} [options.disableSkipVersion=false] Whether to "skip" version is enabled.
+ * @param {number} [options.indentLevel=0] The indent level.
+ * @returns {Promise.<string>}
  */
 export default function provideVersion( packageVersion, releaseTypeOrNewVersion, options = {} ) {
 	const indentLevel = options.indentLevel || 0;
@@ -66,11 +66,11 @@ export default function provideVersion( packageVersion, releaseTypeOrNewVersion,
 }
 
 /**
- * @param {Object} options
- * @param {String} options.packageVersion
- * @param {String|null} options.releaseTypeOrNewVersion
- * @param {Boolean} options.disableInternalVersion
- * @return {String}
+ * @param {object} options
+ * @param {string} options.packageVersion
+ * @param {string|null} options.releaseTypeOrNewVersion
+ * @param {boolean} options.disableInternalVersion
+ * @returns {string}
  */
 function getSuggestedVersion( { packageVersion, releaseTypeOrNewVersion, disableInternalVersion } ) {
 	if ( !releaseTypeOrNewVersion || releaseTypeOrNewVersion === 'skip' ) {

package/lib/utils/publishpackageonnpmcallback.js

@@ -6,9 +6,9 @@
 /**
  * Calls the npm command to publish the package. When a package is successfully published, it is removed from the filesystem.
  *
- * @param {String} packagePath
- * @param {Object} taskOptions
- * @param {String} taskOptions.npmTag
+ * @param {string} packagePath
+ * @param {object} taskOptions
+ * @param {string} taskOptions.npmTag
  * @returns {Promise}
  */
 export default async function publishPackageOnNpmCallback( packagePath, taskOptions ) {

package/lib/utils/savechangelog.js

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

package/lib/utils/transformcommitfactory.js

@@ -20,11 +20,11 @@ const SQUASH_COMMIT_REGEXP = /^[\W\w]+ \(#\d+\)$/;
  *   - normalizes notes (e.g. "MAJOR BREAKING CHANGE" will be replaced with "MAJOR BREAKING CHANGES"),
  *   - the commit is always being returned. Even, if it should not be added to the changelog.
  *
- * @param {Object} [options={}]
- * @param {Boolean} [options.treatMajorAsMinorBreakingChange=false] If set on true, all "MAJOR BREAKING CHANGES" notes will be replaced
+ * @param {object} [options={}]
+ * @param {boolean} [options.treatMajorAsMinorBreakingChange=false] If set on true, all "MAJOR BREAKING CHANGES" notes will be replaced
  * with "MINOR BREAKING CHANGES". This behaviour is being disabled automatically if `options.useExplicitBreakingChangeGroups` is
  * set on `false` because all commits will be treated as "BREAKING CHANGES".
- * @param {Boolean} [options.useExplicitBreakingChangeGroups] If set on `true`, notes from parsed commits will be grouped as
+ * @param {boolean} [options.useExplicitBreakingChangeGroups] If set on `true`, notes from parsed commits will be grouped as
  * "MINOR BREAKING CHANGES" and "MAJOR BREAKING CHANGES'. If set on `false` (by default), all breaking changes notes will be treated
  * as "BREAKING CHANGES".
  * @returns {TransformCommit}
@@ -262,8 +262,8 @@ export default function transformCommitFactory( options = {} ) {
 	/**
 	 * Merges multiple "Closes #x" references as "Closes #x, #y.".
 	 *
-	 * @param {String} subject
-	 * @returns {String}
+	 * @param {string} subject
+	 * @returns {string}
 	 */
 	function mergeCloseReferences( subject ) {
 		const refs = [];
@@ -353,8 +353,8 @@ export default function transformCommitFactory( options = {} ) {
 	 *
 	 * For commits with no scope, `null` will be returned instead of the array (as `scope`).
 	 *
-	 * @param {String} type First line from the commit message.
-	 * @returns {Object}
+	 * @param {string} type First line from the commit message.
+	 * @returns {object}
 	 */
 	function extractScopeFromPrefix( type ) {
 		if ( !type ) {
@@ -387,8 +387,8 @@ export default function transformCommitFactory( options = {} ) {
 	 *
 	 * For notes with no scope, `null` will be returned instead of the array (as `scope`).
 	 *
-	 * @param {String} text A text that describes a note.
-	 * @returns {Object}
+	 * @param {string} text A text that describes a note.
+	 * @returns {object}
 	 */
 	function extractScopeFromNote( text ) {
 		const scopeAsText = text.match( /\(([^)]+)\):/ );
@@ -471,7 +471,7 @@ export default function transformCommitFactory( options = {} ) {
 
 	/**
 	 * @param {Array.<Commit>} commits
-	 * @returns {Boolean}
+	 * @returns {boolean}
 	 */
 	function isSquashMergeCommit( commits ) {
 		const [ squashCommit ] = commits;
@@ -491,41 +491,41 @@ export default function transformCommitFactory( options = {} ) {
  */
 
 /**
- * @typedef {Object} Commit
+ * @typedef {object} Commit
  *
- * @property {Boolean} isPublicCommit Whether the commit should be added in the changelog.
+ * @property {boolean} isPublicCommit Whether the commit should be added in the changelog.
  *
- * @property {String} rawType Type of the commit without any modifications.
+ * @property {string} rawType Type of the commit without any modifications.
  *
- * @property {String|null} type Type of the commit (it can be modified).
+ * @property {string|null} type Type of the commit (it can be modified).
  *
- * @property {String} header First line of the commit message.
+ * @property {string} header First line of the commit message.
  *
- * @property {String} subject Subject of the commit. It's the header without the type.
+ * @property {string} subject Subject of the commit. It's the header without the type.
  *
- * @property {Array.<String>|null} scope Scope of the changes.
+ * @property {Array.<string>|null} scope Scope of the changes.
  *
- * @property {Array.<String>} files A list of files tha the commit modified.
+ * @property {Array.<string>} files A list of files tha the commit modified.
  *
- * @property {String} hash The full commit SHA-1 id.
+ * @property {string} hash The full commit SHA-1 id.
  *
- * @property {String} repositoryUrl The URL to the repository where the parsed commit has been done.
+ * @property {string} repositoryUrl The URL to the repository where the parsed commit has been done.
  **
- * @property {String|null} [body] Body of the commit message.
+ * @property {string|null} [body] Body of the commit message.
  *
- * @property {String|null} [footer] Footer of the commit message.
+ * @property {string|null} [footer] Footer of the commit message.
  *
  * @property {Array.<CommitNote>} [notes] Notes for the commit.
  *
- * @property {Boolean} [skipCommitsLink] Whether to skip generating a URL to the commit by the generator.
+ * @property {boolean} [skipCommitsLink] Whether to skip generating a URL to the commit by the generator.
  */
 
 /**
- * @typedef {Object} CommitNote
+ * @typedef {object} CommitNote
  *
- * @property {String} title Type of the note.
+ * @property {string} title Type of the note.
  *
- * @property {String} text Text of the note.
+ * @property {string} text Text of the note.
  *
- * @property {Array.<String>} scope Scope of the note.
+ * @property {Array.<string>} scope Scope of the note.
  */

package/lib/utils/transformcommitutils.js

@@ -43,8 +43,8 @@ export const typesOrder = {
 /**
  * Returns an order of a message in the changelog.
  *
- * @param {String} title
- * @returns {Number}
+ * @param {string} title
+ * @returns {number}
  */
 export function getTypeOrder( title ) {
 	for ( const typeTitle of Object.keys( typesOrder ) ) {
@@ -59,8 +59,8 @@ export function getTypeOrder( title ) {
 /**
  * Replaces reference to the user (`@name`) with a link to the user's profile.
  *
- * @param {String} comment
- * @returns {String}
+ * @param {string} comment
+ * @returns {string}
  */
 export function linkToGithubUser( comment ) {
 	return comment.replace( /(^|[\s(])@([\w-]+)(?![/\w-])/ig, ( matchedText, charBefore, nickName ) => {
@@ -72,8 +72,8 @@ export function linkToGithubUser( comment ) {
  * Replaces reference to issue (#ID) with a link to the issue.
  * If comment matches to "organization/repository#ID", link will lead to the specified repository.
  *
- * @param {String} comment
- * @returns {String}
+ * @param {string} comment
+ * @returns {string}
  */
 export function linkToGithubIssue( comment ) {
 	return comment.replace( /(\/?[\w-]+\/[\w-]+)?#([\d]+)(?=$|[\s,.)\]])/igm, ( matchedText, maybeRepository, issueId ) => {
@@ -97,8 +97,8 @@ export function linkToGithubIssue( comment ) {
  *
  * The switch cases must be synchronized with the `MULTI_ENTRIES_COMMIT_REGEXP` regexp.
  *
- * @param {String} commitType
- * @returns {String}
+ * @param {string} commitType
+ * @returns {string}
  */
 export function getCommitType( commitType ) {
 	switch ( commitType ) {
@@ -117,9 +117,9 @@ export function getCommitType( commitType ) {
 }
 
 /**
- * @param {String} sentence
- * @param {Number} length
- * @returns {String}
+ * @param {string} sentence
+ * @param {number} length
+ * @returns {string}
  */
 export function truncate( sentence, length ) {
 	if ( sentence.length <= length ) {
@@ -132,8 +132,8 @@ export function truncate( sentence, length ) {
 /**
  * Returns a URL to the repository whether the commit is being parsed.
  *
- * @param {String} [cwd=process.cwd()]
- * @returns {String}
+ * @param {string} [cwd=process.cwd()]
+ * @returns {string}
  */
 export function getRepositoryUrl( cwd = process.cwd() ) {
 	const packageJson = getPackageJson( cwd );

package/lib/utils/truncatechangelog.js

@@ -9,8 +9,8 @@ import saveChangelog from './savechangelog.js';
 import getChangelog from './getchangelog.js';
 
 /**
- * @param {Number} length
- * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
+ * @param {number} length
+ * @param {string} [cwd=process.cwd()] Where to look for the changelog file.
  */
 export default function truncateChangelog( length, cwd = process.cwd() ) {
 	const changelog = getChangelog( cwd );

package/lib/utils/validaterepositorytorelease.js

@@ -6,12 +6,12 @@
 import { tools } from '@ckeditor/ckeditor5-dev-utils';
 
 /**
- * @param {Object} options
- * @param {String|null} options.version Version of the current release.
- * @param {String} options.changes Changelog entries for the current release.
- * @param {Boolean} [options.ignoreBranchCheck=false] If set on true, branch checking will be skipped.
- * @param {String} [options.branch='master'] A name of the branch that should be used for releasing packages.
- * @returns {Promise.<Array.<String>>}
+ * @param {object} options
+ * @param {string|null} options.version Version of the current release.
+ * @param {string} options.changes Changelog entries for the current release.
+ * @param {boolean} [options.ignoreBranchCheck=false] If set on true, branch checking will be skipped.
+ * @param {string} [options.branch='master'] A name of the branch that should be used for releasing packages.
+ * @returns {Promise.<Array.<string>>}
  */
 export default async function validateRepositoryToRelease( options ) {
 	const {

package/lib/utils/versions.js

@@ -10,8 +10,8 @@ import getPackageJson from './getpackagejson.js';
 /**
  * Returns a last created version in changelog file.
  *
- * @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 function getLastFromChangelog( cwd = process.cwd() ) {
 	const changelog = getChangelog( cwd );
@@ -31,8 +31,8 @@ export function getLastFromChangelog( cwd = process.cwd() ) {
  * If the package does not have any pre-releases with the provided identifier yet, `null` is returned.
  *
  * @param {ReleaseIdentifier} releaseIdentifier
- * @param {String} [cwd=process.cwd()]
- * @returns {Promise.<String|null>}
+ * @param {string} [cwd=process.cwd()]
+ * @returns {Promise.<string|null>}
  */
 export function getLastPreRelease( releaseIdentifier, cwd = process.cwd() ) {
 	const packageName = getPackageJson( cwd ).name;
@@ -54,8 +54,8 @@ export function getLastPreRelease( releaseIdentifier, cwd = process.cwd() ) {
  * last nightly release and the "X" is the sequential number starting from 0. If the package does not have any nightly releases yet,
  * `null` is returned.
  *
- * @param {String} [cwd=process.cwd()]
- * @returns {Promise.<String|null>}
+ * @param {string} [cwd=process.cwd()]
+ * @returns {Promise.<string|null>}
  */
 export function getLastNightly( cwd = process.cwd() ) {
 	return getLastPreRelease( '0.0.0-nightly', cwd );
@@ -66,8 +66,8 @@ export function getLastNightly( cwd = process.cwd() ) {
  * next available pre-release sequential number starting from 0.
  *
  * @param {ReleaseIdentifier} releaseIdentifier
- * @param {String} [cwd=process.cwd()]
- * @returns {Promise<String>}
+ * @param {string} [cwd=process.cwd()]
+ * @returns {Promise<string>}
  */
 export async function getNextPreRelease( releaseIdentifier, cwd = process.cwd() ) {
 	const currentPreReleaseVersion = await getLastPreRelease( releaseIdentifier, cwd );
@@ -88,8 +88,8 @@ export async function getNextPreRelease( releaseIdentifier, cwd = process.cwd()
  * Returns the next available nightly version in the format of "0.0.0-nightly-YYYYMMDD.X", where the "YYYYMMDD" is the current date for
  * the nightly release and the "X" is the sequential number starting from 0.
  *
- * @param {String} [cwd=process.cwd()]
- * @returns {Promise<String>}
+ * @param {string} [cwd=process.cwd()]
+ * @returns {Promise<string>}
  */
 export async function getNextNightly( cwd = process.cwd() ) {
 	const today = new Date();
@@ -105,7 +105,7 @@ export async function getNextNightly( cwd = process.cwd() ) {
 /**
  * Returns a name of the last created tag.
  *
- * @returns {String|null}
+ * @returns {string|null}
  */
 export function getLastTagFromGit() {
 	try {
@@ -121,15 +121,15 @@ export function getLastTagFromGit() {
 /**
  * Returns version of current package from `package.json`.
  *
- * @param {String} [cwd=process.cwd()] Current work directory.
- * @returns {String}
+ * @param {string} [cwd=process.cwd()] Current work directory.
+ * @returns {string}
  */
 export function getCurrent( cwd = process.cwd() ) {
 	return getPackageJson( cwd ).version;
 }
 
 /**
- * @typedef {String} ReleaseIdentifier The pre-release identifier without the last dynamic part (the pre-release sequential number).
+ * @typedef {string} ReleaseIdentifier The pre-release identifier without the last dynamic part (the pre-release sequential number).
  * It consists of the core base version ("<major>.<minor>.<path>"), a hyphen ("-"), and a pre-release identifier name (e.g. "alpha").
  *
  * Examples:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "44.0.0-alpha.4",
+  "version": "44.0.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -22,7 +22,7 @@
     "lib"
   ],
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^44.0.0-alpha.4",
+    "@ckeditor/ckeditor5-dev-utils": "^44.0.0",
     "@octokit/rest": "^21.0.0",
     "chalk": "^5.0.0",
     "cli-columns": "^4.0.0",