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

package/lib/utils/getchangesforversion.js

@@ -0,0 +1,28 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import { CHANGELOG_HEADER } from './constants.js';
+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}
+ */
+export default function getChangesForVersion( version, cwd = process.cwd() ) {
+	version = version.replace( /^v/, '' );
+
+	const changelog = getChangelog( cwd ).replace( CHANGELOG_HEADER, '\n' );
+
+	const match = changelog.match( new RegExp( `\\n(## \\[?${ version }\\]?[\\s\\S]+?)(?:\\n## \\[?|$)` ) );
+
+	if ( !match || !match[ 1 ] ) {
+		return null;
+	}
+
+	return match[ 1 ].replace( /##[^\n]+\n/, '' ).trim();
+}

package/lib/utils/getcommits.js

@@ -3,14 +3,12 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const conventionalCommitsParser = require( 'conventional-commits-parser' );
-const conventionalCommitsFilter = require( 'conventional-commits-filter' );
-const gitRawCommits = require( 'git-raw-commits' );
-const concat = require( 'concat-stream' );
-const parserOptions = require( './parseroptions' );
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+import conventionalCommitsParser from 'conventional-commits-parser';
+import conventionalCommitsFilter from 'conventional-commits-filter';
+import gitRawCommits from 'git-raw-commits';
+import concat from 'concat-stream';
+import parserOptions from './parseroptions.js';
+import { tools } from '@ckeditor/ckeditor5-dev-utils';
 
 /**
  * Returns a promise that resolves an array of commits since the last tag specified as `options.from`.
@@ -22,7 +20,7 @@ const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
  * @param {String} [options.mainBranch='master'] A name of the main branch in the repository.
  * @returns {Promise.<Array.<Commit>>}
  */
-module.exports = function getCommits( transformCommit, options = {} ) {
+export default function getCommits( transformCommit, options = {} ) {
 	const releaseBranch = options.releaseBranch || 'master';
 	const mainBranch = options.mainBranch || 'master';
 
@@ -101,4 +99,4 @@ module.exports = function getCommits( transformCommit, options = {} ) {
 	function exec( command ) {
 		return tools.shExec( command, { verbosity: 'error' } );
 	}
-};
+}

package/lib/utils/getformatteddate.js

@@ -0,0 +1,13 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import { format } from 'date-fns';
+
+/**
+ * @returns {String}
+ */
+export default function getFormattedDate() {
+	return format( new Date(), 'yyyy-MM-dd' );
+}

package/lib/utils/getnewversiontype.js

@@ -3,15 +3,13 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 /**
  * Proposes new version based on commits.
  *
  * @param {Array.<Commit>} commits
  * @returns {String|null}
  */
-module.exports = function getNewVersionType( commits ) {
+export default function getNewVersionType( commits ) {
 	// No commits = no changes.
 	if ( !commits.length ) {
 		return 'skip';
@@ -50,4 +48,4 @@ module.exports = function getNewVersionType( commits ) {
 	}
 
 	return 'patch';
-};
+}

package/lib/utils/getnpmtagfromversion.js

@@ -3,16 +3,14 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const semver = require( 'semver' );
+import semver from 'semver';
 
 /**
  * @param {String} version
  * @returns {String}
  */
-module.exports = function getNpmTagFromVersion( version ) {
+export default function getNpmTagFromVersion( version ) {
 	const [ versionTag ] = semver.prerelease( version ) || [ 'latest' ];
 
 	return versionTag;
-};
+}

package/lib/utils/getpackagejson.js

@@ -3,10 +3,8 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const fs = require( 'fs' );
-const upath = require( 'upath' );
+import fs from 'fs';
+import upath from 'upath';
 
 /**
  * Returns object from `package.json`.
@@ -17,7 +15,7 @@ const upath = require( 'upath' );
  * @param {String} [cwd=process.cwd()] Where to look for package.json.
  * @returns {Object}
  */
-module.exports = function getPackageJson( cwd = process.cwd() ) {
+export default function getPackageJson( cwd = process.cwd() ) {
 	let pkgJsonPath = cwd;
 
 	if ( !pkgJsonPath.endsWith( 'package.json' ) ) {
@@ -25,4 +23,4 @@ module.exports = function getPackageJson( cwd = process.cwd() ) {
 	}
 
 	return JSON.parse( fs.readFileSync( pkgJsonPath, 'utf-8' ) );
-};
+}

package/lib/utils/getpackagespaths.js

@@ -3,19 +3,17 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const path = require( 'path' );
-const minimatch = require( 'minimatch' );
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-const getPackageJson = require( './getpackagejson' );
+import path from 'path';
+import minimatch from 'minimatch';
+import { tools } from '@ckeditor/ckeditor5-dev-utils';
+import getPackageJson from './getpackagejson.js';
 
 /**
  * Returns an object with two collections of paths to packages which are located in single repository.
  * Those packages must be defined as dependencies in the repository found in `options.cwd`.
  *
  *   - The first one is marked as `matched` and means that packages specified in a path (which is a combination of values specified as
- *     `options.cwd` and  `options.packages`) match to given criteria.
+ *     `options.cwd` and `options.packages`) match to given criteria.
  *   - 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`).
  *
@@ -28,7 +26,7 @@ const getPackageJson = require( './getpackagejson' );
  * @param {Boolean} [options.skipMainRepository=false] If set on true, package found in `options.cwd` will be skipped.
  * @returns {PathsCollection}
  */
-module.exports = function getPackagesPaths( options ) {
+export default function getPackagesPaths( options ) {
 	const pathsCollection = {
 		matched: new Set(),
 		skipped: new Set()
@@ -79,7 +77,7 @@ module.exports = function getPackagesPaths( options ) {
 
 		return true;
 	}
-};
+}
 
 /**
  * @typedef {Object} PathsCollection

package/lib/utils/getwriteroptions.js

@@ -3,18 +3,21 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { getTypeOrder } from './transformcommitutils.js';
+
+const __filename = fileURLToPath( import.meta.url );
+const __dirname = path.dirname( __filename );
 
-const fs = require( 'fs' );
-const path = require( 'path' );
 const templatePath = path.join( __dirname, '..', 'templates' );
-const { getTypeOrder } = require( './transformcommitutils' );
 
 /**
  * @param {Function|Object} transform
  * @returns {Object}
  */
-module.exports = function getWriterOptions( transform ) {
+export default function getWriterOptions( transform ) {
 	return {
 		transform,
 		groupBy: 'type',
@@ -26,7 +29,7 @@ module.exports = function getWriterOptions( transform ) {
 		commitPartial: fs.readFileSync( path.join( templatePath, 'commit.hbs' ), 'utf-8' ),
 		footerPartial: fs.readFileSync( path.join( templatePath, 'footer.hbs' ), 'utf-8' )
 	};
-};
+}
 
 function sortFunction( a, b ) {
 	return getTypeOrder( a.title ) - getTypeOrder( b.title );

package/lib/utils/isversionpublishablefortag.js

@@ -3,9 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-const semver = require( 'semver' );
-const shellEscape = require( 'shell-escape' );
+import { tools } from '@ckeditor/ckeditor5-dev-utils';
+import semver from 'semver';
+import shellEscape from 'shell-escape';
 
 /**
  * This util aims to verify if the given `packageName` can be published with the given `version` on the `npmTag`.
@@ -15,7 +15,7 @@ const shellEscape = require( 'shell-escape' );
  * @param {String} npmTag
  * @return {Promise.<Boolean>}
  */
-module.exports = async function isVersionPublishableForTag( packageName, version, npmTag ) {
+export default async function isVersionPublishableForTag( packageName, version, npmTag ) {
 	const command = `npm view ${ shellEscape( [ packageName ] ) }@${ shellEscape( [ npmTag ] ) } version --silent`;
 	const npmVersion = await tools.shExec( command, { async: true, verbosity: 'silent' } )
 		.then( value => value.trim() )
@@ -27,4 +27,4 @@ module.exports = async function isVersionPublishableForTag( packageName, version
 	}
 
 	return true;
-};
+}

package/lib/utils/{parallelworker.cjs → parallelworker.js}

@@ -3,18 +3,17 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
 // This file is covered by the "executeInParallel() - integration" test cases.
 
+import { parentPort, workerData } from 'worker_threads';
+
 // Required due to top-level await.
 ( async () => {
 	/**
 	 * @param {String} callbackModule
 	 * @param {Array.<String>} packages
 	 */
-	const { parentPort, workerData } = require( 'worker_threads' );
-	const callback = require( workerData.callbackModule );
+	const { default: callback } = await import( workerData.callbackModule );
 
 	for ( const packagePath of workerData.packages ) {
 		await callback( packagePath, workerData.taskOptions );

package/lib/utils/parseroptions.js

@@ -3,9 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-module.exports = {
+export default {
 	mergePattern: /^Merge .*$/,
 	headerPattern: /^([^:]+): (.*)$/,
 	headerCorrespondence: [

package/lib/utils/providenewversionformonorepository.js

@@ -0,0 +1,51 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import inquirer from 'inquirer';
+import semver from 'semver';
+import chalk from 'chalk';
+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>}
+ */
+export default async function provideNewVersionForMonoRepository( version, foundPackage, bumpType, options = {} ) {
+	const indentLevel = options.indentLevel || 0;
+	const suggestedVersion = semver.inc( version, bumpType );
+
+	const message = 'Type the new version ' +
+		`(current highest: "${ version }" found in "${ chalk.underline( foundPackage ) }", suggested: "${ suggestedVersion }"):`;
+
+	const versionQuestion = {
+		type: 'input',
+		name: 'version',
+		default: suggestedVersion,
+		message,
+
+		filter( input ) {
+			return input.trim();
+		},
+
+		validate( input ) {
+			if ( !semver.valid( input ) ) {
+				return 'Please provide a valid version.';
+			}
+
+			return semver.gt( input, version ) ? true : `Provided version must be higher than "${ version }".`;
+		},
+		prefix: ' '.repeat( indentLevel * CLI_INDENT_SIZE ) + chalk.cyan( '?' )
+	};
+
+	const answers = await inquirer.prompt( [ versionQuestion ] );
+
+	return answers.version;
+}

package/lib/utils/providetoken.js

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import inquirer from 'inquirer';
+
+/**
+ * Asks a user for providing the GitHub token.
+ *
+ * @returns {Promise.<String>}
+ */
+export default async function provideToken() {
+	const tokenQuestion = {
+		type: 'password',
+		name: 'token',
+		message: 'Provide the GitHub token:',
+		validate( input ) {
+			return input.length === 40 ? true : 'Please provide a valid token.';
+		}
+	};
+
+	const { token } = await inquirer.prompt( [ tokenQuestion ] );
+
+	return token;
+}

package/lib/utils/provideversion.js

@@ -0,0 +1,98 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import inquirer from 'inquirer';
+import semver from 'semver';
+import chalk from 'chalk';
+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>}
+ */
+export default function provideVersion( packageVersion, releaseTypeOrNewVersion, options = {} ) {
+	const indentLevel = options.indentLevel || 0;
+	const suggestedVersion = getSuggestedVersion( {
+		packageVersion,
+		releaseTypeOrNewVersion,
+		disableInternalVersion: options.disableInternalVersion
+	} );
+
+	let message = 'Type the new version, "skip" or "internal"';
+
+	if ( options.disableInternalVersion ) {
+		message = 'Type the new version or "skip"';
+	}
+
+	message += ` (suggested: "${ suggestedVersion }", current: "${ packageVersion }"):`;
+
+	const versionQuestion = {
+		type: 'input',
+		name: 'version',
+		default: suggestedVersion,
+		message,
+
+		filter( input ) {
+			return input.trim();
+		},
+
+		validate( input ) {
+			if ( !options.disableSkipVersion && input === 'skip' ) {
+				return true;
+			}
+
+			if ( !options.disableInternalVersion && input === 'internal' ) {
+				return true;
+			}
+
+			// TODO: Check whether provided version is available.
+			return semver.valid( input ) ? true : 'Please provide a valid version.';
+		},
+
+		prefix: ' '.repeat( indentLevel * CLI_INDENT_SIZE ) + chalk.cyan( '?' )
+	};
+
+	return inquirer.prompt( [ versionQuestion ] )
+		.then( answers => answers.version );
+}
+
+/**
+ * @param {Object} options
+ * @param {String} options.packageVersion
+ * @param {String|null} options.releaseTypeOrNewVersion
+ * @param {Boolean} options.disableInternalVersion
+ * @return {String}
+ */
+function getSuggestedVersion( { packageVersion, releaseTypeOrNewVersion, disableInternalVersion } ) {
+	if ( !releaseTypeOrNewVersion || releaseTypeOrNewVersion === 'skip' ) {
+		return 'skip';
+	}
+
+	if ( semver.valid( releaseTypeOrNewVersion ) ) {
+		return releaseTypeOrNewVersion;
+	}
+
+	if ( releaseTypeOrNewVersion === 'internal' ) {
+		return disableInternalVersion ? 'skip' : 'internal';
+	}
+
+	if ( semver.prerelease( packageVersion ) ) {
+		releaseTypeOrNewVersion = 'prerelease';
+	}
+
+	// If package's version is below the '1.0.0', bump the 'minor' instead of 'major'
+	if ( releaseTypeOrNewVersion === 'major' && semver.gt( '1.0.0', packageVersion ) ) {
+		return semver.inc( packageVersion, 'minor' );
+	}
+
+	return semver.inc( packageVersion, releaseTypeOrNewVersion );
+}

package/lib/utils/publishpackageonnpmcallback.js

@@ -3,10 +3,6 @@
  * For licensing, see LICENSE.md.
  */
 
-/* eslint-env node */
-
-'use strict';
-
 /**
  * Calls the npm command to publish the package. When a package is successfully published, it is removed from the filesystem.
  *
@@ -15,18 +11,20 @@
  * @param {String} taskOptions.npmTag
  * @returns {Promise}
  */
-module.exports = async function publishPackageOnNpmCallback( packagePath, taskOptions ) {
-	const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-	const upath = require( 'upath' );
-	const fs = require( 'fs-extra' );
+export default async function publishPackageOnNpmCallback( packagePath, taskOptions ) {
+	const { tools } = await import( '@ckeditor/ckeditor5-dev-utils' );
+	const { default: fs } = await import( 'fs-extra' );
+	const { default: path } = await import( 'upath' );
 
-	const result = await tools.shExec( `npm publish --access=public --tag ${ taskOptions.npmTag }`, {
+	const options = {
 		cwd: packagePath,
 		async: true,
 		verbosity: 'error'
-	} )
+	};
+
+	const result = await tools.shExec( `npm publish --access=public --tag ${ taskOptions.npmTag }`, options )
 		.catch( e => {
-			const packageName = upath.basename( packagePath );
+			const packageName = path.basename( packagePath );
 
 			if ( e.toString().includes( 'code E409' ) ) {
 				return { shouldKeepDirectory: true };
@@ -38,4 +36,4 @@ module.exports = async function publishPackageOnNpmCallback( packagePath, taskOp
 	if ( !result || !result.shouldKeepDirectory ) {
 		await fs.remove( packagePath );
 	}
-};
+}

package/lib/utils/savechangelog.js

@@ -0,0 +1,18 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import fs from 'fs';
+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.
+ */
+export default function saveChangelog( content, cwd = process.cwd() ) {
+	const changelogFile = path.join( cwd, CHANGELOG_FILE );
+
+	fs.writeFileSync( changelogFile, content, 'utf-8' );
+}

package/lib/utils/transformcommitfactory.js

@@ -3,11 +3,11 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import lodash from 'lodash';
+import * as utils from './transformcommitutils.js';
+import getChangedFilesForCommit from './getchangedfilesforcommit.js';
 
-const { cloneDeepWith } = require( 'lodash' );
-const utils = require( './transformcommitutils' );
-const getChangedFilesForCommit = require( './getchangedfilesforcommit' );
+const { cloneDeepWith } = lodash;
 
 // Squash commit follows the pattern: "A pull request title (#{number})".
 const SQUASH_COMMIT_REGEXP = /^[\W\w]+ \(#\d+\)$/;
@@ -31,7 +31,7 @@ const SQUASH_COMMIT_REGEXP = /^[\W\w]+ \(#\d+\)$/;
  * as "BREAKING CHANGES".
  * @returns {TransformCommit}
  */
-module.exports = function transformCommitFactory( options = {} ) {
+export default function transformCommitFactory( options = {} ) {
 	return rawCommit => {
 		const commit = transformCommit( rawCommit );
 
@@ -484,7 +484,7 @@ module.exports = function transformCommitFactory( options = {} ) {
 
 		return !!squashCommit.header.match( SQUASH_COMMIT_REGEXP );
 	}
-};
+}
 
 /**
  * @callback TransformCommit