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

package/lib/tasks/updatedependencies.js

@@ -3,11 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const fs = require( 'fs-extra' );
-const { glob } = require( 'glob' );
-const upath = require( 'upath' );
+import fs from 'fs-extra';
+import { glob } from 'glob';
+import upath from 'upath';
 
 /**
  * The purpose of this script is to update all eligible dependencies to a version specified in the `options.version`. The following packages
@@ -31,7 +29,7 @@ const upath = require( 'upath' );
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
-module.exports = async function updateDependencies( options ) {
+export default async function updateDependencies( options ) {
 	const {
 		version,
 		packagesDirectory,
@@ -59,7 +57,7 @@ module.exports = async function updateDependencies( options ) {
 
 		await fs.writeJson( pkgJsonPath, pkgJson, { spaces: 2 } );
 	}
-};
+}
 
 /**
  * Updates the version for each eligible dependency.

package/lib/tasks/updateversions.js

@@ -3,13 +3,13 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
+import upath from 'upath';
+import fs from 'fs-extra';
+import { glob } from 'glob';
+import semver from 'semver';
+import checkVersionAvailability from '../utils/checkversionavailability.js';
 
-const { glob } = require( 'glob' );
-const fs = require( 'fs-extra' );
-const semver = require( 'semver' );
-const { normalizeTrim, toUnix, dirname, join } = require( 'upath' );
-const checkVersionAvailability = require( '../utils/checkversionavailability' );
+const { normalizeTrim, toUnix, dirname, join } = upath;
 
 /**
  * The purpose of the script is to update the version of a root package found in the current working
@@ -31,7 +31,7 @@ const checkVersionAvailability = require( '../utils/checkversionavailability' );
  * @param {String} [options.cwd=process.cwd()] Current working directory from which all paths will be resolved.
  * @returns {Promise}
  */
-module.exports = async function updateVersions( options ) {
+export default async function updateVersions( options ) {
 	const {
 		packagesDirectory,
 		version,
@@ -63,7 +63,7 @@ module.exports = async function updateVersions( options ) {
 		pkgJson.version = version;
 		await fs.writeJson( pkgJsonPath, pkgJson, { spaces: 2 } );
 	}
-};
+}
 
 /**
  * @param {String} cwd

package/lib/tasks/verifypackagespublishedcorrectly.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const upath = require( 'upath' );
-const { glob } = require( 'glob' );
-const fs = require( 'fs-extra' );
-const { checkVersionAvailability } = require( '../utils/checkversionavailability' );
+import upath from 'upath';
+import { glob } from 'glob';
+import fs from 'fs-extra';
+import checkVersionAvailability from '../utils/checkversionavailability.js';
 
 /**
  * Npm sometimes throws incorrect error 409 while publishing, while the package uploads correctly.
@@ -20,7 +18,7 @@ const { checkVersionAvailability } = require( '../utils/checkversionavailability
  * @param {Function} options.onSuccess Callback fired when function is successful.
  * @returns {Promise}
  */
-module.exports = async function verifyPackagesPublishedCorrectly( options ) {
+export default async function verifyPackagesPublishedCorrectly( options ) {
 	const { packagesDirectory, version, onSuccess } = options;
 	const packagesToVerify = await glob( upath.join( packagesDirectory, '*' ), { absolute: true } );
 	const errors = [];
@@ -52,4 +50,4 @@ module.exports = async function verifyPackagesPublishedCorrectly( options ) {
 	}
 
 	onSuccess( 'All packages that returned 409 were uploaded correctly.' );
-};
+}

package/lib/utils/abortcontroller.js

@@ -3,16 +3,12 @@
  * For licensing, see LICENSE.md.
  */
 
-/* eslint-env node */
-
-'use strict';
-
 /**
  * Creates an AbortController instance and registers the listener function on SIGINT event that aborts the asynchronous process.
  *
  * @returns {AbortController}
  */
-function registerAbortController() {
+export function registerAbortController() {
 	const abortController = new AbortController();
 
 	const listener = () => {
@@ -33,15 +29,10 @@ function registerAbortController() {
  *
  * @param {AbortController} abortController
  */
-function deregisterAbortController( abortController ) {
+export function deregisterAbortController( abortController = undefined ) {
 	if ( !abortController || !abortController._listener ) {
 		return;
 	}
 
 	process.removeListener( 'SIGINT', abortController._listener );
 }
-
-module.exports = {
-	registerAbortController,
-	deregisterAbortController
-};

package/lib/utils/assertfilestopublish.js

@@ -3,11 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const fs = require( 'fs-extra' );
-const upath = require( 'upath' );
-const { glob } = require( 'glob' );
+import fs from 'fs-extra';
+import upath from 'upath';
+import { glob } from 'glob';
 
 /**
  * Checks if all files expected to be released actually exist in the package directory. Verification takes place for all packages.
@@ -16,7 +14,7 @@ const { glob } = require( 'glob' );
  * @param {Object.<String, Array.<String>>|null} optionalEntries
  * @returns {Promise}
  */
-module.exports = async function assertFilesToPublish( packagePaths, optionalEntries ) {
+export default async function assertFilesToPublish( packagePaths, optionalEntries = null ) {
 	const errors = [];
 
 	for ( const packagePath of packagePaths ) {
@@ -59,7 +57,7 @@ module.exports = async function assertFilesToPublish( packagePaths, optionalEntr
 	if ( errors.length ) {
 		throw new Error( errors.join( '\n' ) );
 	}
-};
+}
 
 /**
  * Filters out the optional entries from the `files` field and returns only the required ones.

package/lib/utils/assertnpmauthorization.js

@@ -3,9 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+import { tools } from '@ckeditor/ckeditor5-dev-utils';
 
 /**
  * Checks whether a user is logged to npm as the provided account name.
@@ -13,7 +11,7 @@ const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
  * @param {String} npmOwner Expected npm account name that should be logged into npm.
  * @returns {Promise}
  */
-module.exports = async function assertNpmAuthorization( npmOwner ) {
+export default async function assertNpmAuthorization( npmOwner ) {
 	return tools.shExec( 'npm whoami', { verbosity: 'error', async: true } )
 		.then( npmCurrentUser => {
 			if ( npmOwner !== npmCurrentUser.trim() ) {
@@ -23,4 +21,4 @@ module.exports = async function assertNpmAuthorization( npmOwner ) {
 		.catch( () => {
 			throw new Error( `You must be logged to npm as "${ npmOwner }" to execute this release step.` );
 		} );
-};
+}

package/lib/utils/assertnpmtag.js

@@ -3,11 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const fs = require( 'fs-extra' );
-const upath = require( 'upath' );
-const semver = require( 'semver' );
+import fs from 'fs-extra';
+import upath from 'upath';
+import semver from 'semver';
 
 /**
  * Checks if the npm tag matches the tag calculated from the package version. Verification takes place for all packages.
@@ -16,7 +14,7 @@ const semver = require( 'semver' );
  * @param {String} npmTag
  * @returns {Promise}
  */
-module.exports = async function assertNpmTag( packagePaths, npmTag ) {
+export default async function assertNpmTag( packagePaths, npmTag ) {
 	const errors = [];
 
 	for ( const packagePath of packagePaths ) {
@@ -38,7 +36,7 @@ module.exports = async function assertNpmTag( packagePaths, npmTag ) {
 	if ( errors.length ) {
 		throw new Error( errors.join( '\n' ) );
 	}
-};
+}
 
 /**
  * Returns the version tag for the package.

package/lib/utils/assertpackages.js

@@ -3,10 +3,8 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const fs = require( 'fs-extra' );
-const upath = require( 'upath' );
+import fs from 'fs-extra';
+import upath from 'upath';
 
 /**
  * Checks if all packages in the provided directories contain the `package.json` file.
@@ -19,7 +17,7 @@ const upath = require( 'upath' );
  * this array contains a list of packages that will not be checked. In other words, they do not have to define the entry point.
  * @returns {Promise}
  */
-module.exports = async function assertPackages( packagePaths, options ) {
+export default async function assertPackages( packagePaths, options ) {
 	const errors = [];
 	const { requireEntryPoint, optionalEntryPointPackages } = options;
 
@@ -49,4 +47,4 @@ module.exports = async function assertPackages( packagePaths, options ) {
 	if ( errors.length ) {
 		throw new Error( errors.join( '\n' ) );
 	}
-};
+}

package/lib/utils/checkversionavailability.js

@@ -3,10 +3,8 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-const shellEscape = require( 'shell-escape' );
+import { tools } from '@ckeditor/ckeditor5-dev-utils';
+import shellEscape from 'shell-escape';
 
 /**
  * Checks if the provided version for the package exists in the npm registry.
@@ -18,7 +16,7 @@ const shellEscape = require( 'shell-escape' );
  * @param {String} packageName
  * @returns {Promise}
  */
-module.exports = async function checkVersionAvailability( version, packageName ) {
+export default async function checkVersionAvailability( version, packageName ) {
 	const command = `npm show ${ shellEscape( [ packageName ] ) }@${ shellEscape( [ version ] ) } version`;
 
 	return tools.shExec( command, { verbosity: 'silent', async: true } )
@@ -42,4 +40,4 @@ module.exports = async function checkVersionAvailability( version, packageName )
 			// Npm < 8.13.0 should never reach this line.
 			return true;
 		} );
-};
+}

package/lib/utils/configurereleaseoptions.js

@@ -0,0 +1,43 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import inquirer from 'inquirer';
+import provideToken from './providetoken.js';
+
+/**
+ * Asks a user for selecting services where packages will be released.
+ *
+ * If the user choices a GitHub, required token also has to be provided.
+ *
+ * @returns {Promise.<Object>}
+ */
+export default async function configureReleaseOptions() {
+	const options = {};
+
+	const servicesQuestion = {
+		type: 'checkbox',
+		name: 'services',
+		message: 'Select services where packages will be released:',
+		choices: [
+			'npm',
+			'GitHub'
+		],
+		default: [
+			'npm',
+			'GitHub'
+		]
+	};
+
+	const answers = await inquirer.prompt( [ servicesQuestion ] );
+
+	options.npm = answers.services.includes( 'npm' );
+	options.github = answers.services.includes( 'GitHub' );
+
+	if ( options.github ) {
+		options.token = await provideToken();
+	}
+
+	return options;
+}

package/lib/utils/confirmincludingpackage.js

@@ -0,0 +1,24 @@
+/**
+ * @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 a confirmation for including a package that does not contain all required files.
+ *
+ * @returns {Promise.<Boolean>}
+ */
+export default async function confirmIncludingPackage() {
+	const confirmQuestion = {
+		message: 'Package does not contain all required files to publish. Include this package in the release and continue?',
+		type: 'confirm',
+		name: 'confirm',
+		default: true
+	};
+
+	const { confirm } = await inquirer.prompt( [ confirmQuestion ] );
+
+	return confirm;
+}

package/lib/utils/confirmnpmtag.js

@@ -0,0 +1,32 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+
+/**
+ * Asks a user for a confirmation for updating and tagging versions of the packages.
+ *
+ * @param {String} versionTag A version tag based on a package version specified in `package.json`.
+ * @param {String} npmTag A tag typed by the user when using the release tools.
+ * @returns {Promise.<Boolean>}
+ */
+export default function confirmNpmTag( versionTag, npmTag ) {
+	const areVersionsEqual = versionTag === npmTag;
+	const color = areVersionsEqual ? chalk.magenta : chalk.red;
+
+	// eslint-disable-next-line max-len
+	const message = `The next release bumps the "${ color( versionTag ) }" version. Should it be published to npm as "${ color( npmTag ) }"?`;
+
+	const confirmQuestion = {
+		message,
+		type: 'confirm',
+		name: 'confirm',
+		default: areVersionsEqual
+	};
+
+	return inquirer.prompt( [ confirmQuestion ] )
+		.then( answers => answers.confirm );
+}

package/lib/utils/constants.js

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md.
+ */
+
+/**
+ * Changelog file name.
+ */
+export const CHANGELOG_FILE = 'CHANGELOG.md';
+
+/**
+ * Changelog header.
+ */
+export const CHANGELOG_HEADER = 'Changelog\n=========\n\n';
+
+/**
+ * A size of default indent for a log.
+ */
+export const CLI_INDENT_SIZE = 3;
+
+/**
+ * A size of indent for a second and next lines in a log. The number is equal to length of the log string:
+ * '* 1234567 ', where '1234567' is a short commit id.
+ * It does not include a value from `cli.INDENT_SIZE`.
+ */
+export const CLI_COMMIT_INDENT_SIZE = 10;

package/lib/utils/displaycommits.js

@@ -3,12 +3,10 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const chalk = require( 'chalk' );
-const { logger } = require( '@ckeditor/ckeditor5-dev-utils' );
-const utils = require( './transformcommitutils' );
-const { INDENT_SIZE, COMMIT_INDENT_SIZE } = require( './cli' );
+import chalk from 'chalk';
+import { logger } from '@ckeditor/ckeditor5-dev-utils';
+import * as utils from './transformcommitutils.js';
+import { CLI_COMMIT_INDENT_SIZE, CLI_INDENT_SIZE } from './constants.js';
 
 /**
  * @param {Array.<Commit>|Set.<Commit>} commits
@@ -16,12 +14,12 @@ const { INDENT_SIZE, COMMIT_INDENT_SIZE } = require( './cli' );
  * @param {Boolean} [options.attachLinkToCommit=false] Whether to attach a link to parsed commit.
  * @param {Number} [options.indentLevel=1] The indent level.
  */
-module.exports = function displayCommits( commits, options = {} ) {
+export default function displayCommits( commits, options = {} ) {
 	const log = logger();
 
 	const attachLinkToCommit = options.attachLinkToCommit || false;
 	const indentLevel = options.indentLevel || 1;
-	const listIndent = ' '.repeat( INDENT_SIZE * indentLevel );
+	const listIndent = ' '.repeat( CLI_INDENT_SIZE * indentLevel );
 
 	if ( !( commits.length || commits.size ) ) {
 		log.info( listIndent + chalk.italic( 'No commits to display.' ) );
@@ -51,14 +49,14 @@ module.exports = function displayCommits( commits, options = {} ) {
 			const isCommitIncluded = utils.availableCommitTypes.get( singleCommit.rawType );
 
 			const indent = commits.size > 1 ? listIndent.slice( 0, listIndent.length - 1 ) + chalk.gray( '|' ) : listIndent;
-			const noteIndent = indent + ' '.repeat( COMMIT_INDENT_SIZE );
+			const noteIndent = indent + ' '.repeat( CLI_COMMIT_INDENT_SIZE );
 
 			let logMessage = `${ indent }* ${ chalk.yellow( hash.slice( 0, 7 ) ) } "${ utils.truncate( singleCommit.header, 100 ) }" `;
 
 			if ( hasCorrectType && isCommitIncluded ) {
 				logMessage += chalk.green( 'INCLUDED' );
 			} else if ( hasCorrectType && !isCommitIncluded ) {
-				logMessage += chalk.grey( 'SKIPPED' );
+				logMessage += chalk.gray( 'SKIPPED' );
 			} else {
 				logMessage += chalk.red( 'INVALID' );
 			}
@@ -102,4 +100,4 @@ module.exports = function displayCommits( commits, options = {} ) {
 
 		return commitGroups.get( commit.hash );
 	}
-};
+}

package/lib/utils/displayskippedpackages.js

@@ -3,24 +3,22 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const chalk = require( 'chalk' );
-const { logger } = require( '@ckeditor/ckeditor5-dev-utils' );
-const getPackageJson = require( './getpackagejson' );
-const { INDENT_SIZE } = require( './cli' );
+import chalk from 'chalk';
+import { logger } from '@ckeditor/ckeditor5-dev-utils';
+import getPackageJson from './getpackagejson.js';
+import { CLI_INDENT_SIZE } from './constants.js';
 
 /**
  * Displays skipped packages.
  *
  * @param {Set} skippedPackagesPaths
  */
-module.exports = function displaySkippedPackages( skippedPackagesPaths ) {
+export default function displaySkippedPackages( skippedPackagesPaths ) {
 	if ( !skippedPackagesPaths.size ) {
 		return;
 	}
 
-	const indent = ' '.repeat( INDENT_SIZE );
+	const indent = ' '.repeat( CLI_INDENT_SIZE );
 
 	const packageNames = Array.from( skippedPackagesPaths )
 		.map( packagePath => getPackageJson( packagePath ).name );
@@ -29,4 +27,4 @@ module.exports = function displaySkippedPackages( skippedPackagesPaths ) {
 	message += packageNames.map( line => indent + `  * ${ line }` ).join( '\n' );
 
 	logger().info( message );
-};
+}

package/lib/utils/executeinparallel.js

@@ -5,16 +5,15 @@
 
 /* eslint-env node */
 
-'use strict';
+import crypto from 'crypto';
+import upath from 'upath';
+import os from 'os';
+import fs from 'fs/promises';
+import { Worker } from 'worker_threads';
+import { glob } from 'glob';
+import { registerAbortController, deregisterAbortController } from './abortcontroller.js';
 
-const crypto = require( 'crypto' );
-const upath = require( 'upath' );
-const fs = require( 'fs/promises' );
-const { Worker } = require( 'worker_threads' );
-const { glob } = require( 'glob' );
-const { registerAbortController, deregisterAbortController } = require( './abortcontroller' );
-
-const WORKER_SCRIPT = upath.join( __dirname, 'parallelworker.cjs' );
+const WORKER_SCRIPT = new URL( './parallelworker.js', import.meta.url );
 
 /**
  * This util allows executing a specified task in parallel using Workers. It can be helpful when executing a not resource-consuming
@@ -37,7 +36,7 @@ const WORKER_SCRIPT = upath.join( __dirname, 'parallelworker.cjs' );
  * @param {Number} [options.concurrency=require( 'os' ).cpus().length / 2] Number of CPUs that will execute the task.
  * @returns {Promise}
  */
-module.exports = async function executeInParallel( options ) {
+export default async function executeInParallel( options ) {
 	const {
 		packagesDirectory,
 		taskToExecute,
@@ -46,7 +45,7 @@ module.exports = async function executeInParallel( options ) {
 		taskOptions = null,
 		packagesDirectoryFilter = null,
 		cwd = process.cwd(),
-		concurrency = require( 'os' ).cpus().length / 2
+		concurrency = os.cpus().length / 2
 	} = options;
 
 	const normalizedCwd = upath.toUnix( cwd );
@@ -61,8 +60,8 @@ module.exports = async function executeInParallel( options ) {
 
 	const packagesInThreads = getPackagesGroupedByThreads( packagesToProcess, concurrency );
 
-	const callbackModule = upath.join( cwd, crypto.randomUUID() + '.cjs' );
-	await fs.writeFile( callbackModule, `'use strict';\nmodule.exports = ${ taskToExecute };`, 'utf-8' );
+	const callbackModule = upath.join( cwd, crypto.randomUUID() + '.mjs' );
+	await fs.writeFile( callbackModule, `export default ${ taskToExecute };`, 'utf-8' );
 
 	const onPackageDone = progressFactory( listrTask, packagesToProcess.length );
 
@@ -96,7 +95,7 @@ module.exports = async function executeInParallel( options ) {
 				deregisterAbortController( defaultAbortController );
 			}
 		} );
-};
+}
 
 /**
  * @param {ListrTaskObject} listrTask

package/lib/utils/generatechangelog.js

@@ -3,11 +3,9 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const { Readable } = require( 'stream' );
-const { stream } = require( '@ckeditor/ckeditor5-dev-utils' );
-const conventionalChangelogWriter = require( 'conventional-changelog-writer' );
+import { Readable } from 'stream';
+import { stream } from '@ckeditor/ckeditor5-dev-utils';
+import conventionalChangelogWriter from 'conventional-changelog-writer';
 
 const UPDATED_TRANSLATION_COMMIT = '* Updated translations.';
 
@@ -38,7 +36,7 @@ const UPDATED_TRANSLATION_COMMIT = '* Updated translations.';
  *
  * @returns {Promise.<String>}
  */
-module.exports = function generateChangelog( commits, context, options ) {
+export default function generateChangelog( commits, context, options ) {
 	const commitStream = new Readable( { objectMode: true } );
 	/* istanbul ignore next */
 	commitStream._read = function() {};
@@ -61,7 +59,7 @@ module.exports = function generateChangelog( commits, context, options ) {
 			} ) )
 			.on( 'error', reject );
 	} );
-};
+}
 
 /**
  * Merges multiple "Updated translations." entries into the single commit.

package/lib/utils/getchangedfilesforcommit.js

@@ -3,9 +3,7 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
+import { tools } from '@ckeditor/ckeditor5-dev-utils';
 
 /**
  * Returns an array with paths to changed files for given commit.
@@ -13,7 +11,7 @@ const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
  * @param {String} commitId
  * @returns {Array.<String>}
  */
-module.exports = function getChangedFilesForCommit( commitId ) {
+export default function getChangedFilesForCommit( commitId ) {
 	const gitCommand = `git log -m -1 --name-only --pretty="format:" ${ commitId }`;
 	const changedFiles = tools.shExec( gitCommand, { verbosity: 'error' } ).trim();
 
@@ -30,4 +28,4 @@ module.exports = function getChangedFilesForCommit( commitId ) {
 		.split( '\n' )
 		.map( file => file.trim() )
 		.filter( item => item );
-};
+}

package/lib/utils/getchangelog.js

@@ -0,0 +1,22 @@
+/**
+ * @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} [cwd=process.cwd()] Where to look for the changelog file.
+ * @returns {String|null}
+ */
+export default function getChangelog( cwd = process.cwd() ) {
+	const changelogFile = path.join( cwd, CHANGELOG_FILE );
+
+	if ( !fs.existsSync( changelogFile ) ) {
+		return null;
+	}
+
+	return fs.readFileSync( changelogFile, 'utf-8' );
+}