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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "43.0.0",
+  "version": "44.0.0-alpha.1",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -16,28 +16,29 @@
     "node": ">=18.0.0",
     "npm": ">=5.7.1"
   },
+  "type": "module",
   "main": "lib/index.js",
   "files": [
     "lib"
   ],
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^43.0.0",
-    "@octokit/rest": "^19.0.0",
-    "chalk": "^4.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^44.0.0-alpha.1",
+    "@octokit/rest": "^21.0.0",
+    "chalk": "^5.0.0",
     "cli-columns": "^4.0.0",
     "compare-func": "^2.0.0",
     "concat-stream": "^2.0.0",
-    "conventional-changelog-writer": "^6.0.0",
-    "conventional-commits-filter": "^3.0.0",
-    "conventional-commits-parser": "^4.0.0",
-    "date-fns": "^2.30.0",
-    "fs-extra": "^11.2.0",
-    "git-raw-commits": "^3.0.0",
-    "glob": "^10.2.5",
-    "inquirer": "^7.1.0",
-    "lodash": "^4.17.15",
-    "minimatch": "^3.0.4",
-    "semver": "^7.5.3",
+    "conventional-changelog-writer": "^8.0.0",
+    "conventional-commits-filter": "^5.0.0",
+    "conventional-commits-parser": "^6.0.0",
+    "date-fns": "^4.0.0",
+    "fs-extra": "^11.0.0",
+    "git-raw-commits": "^5.0.0",
+    "glob": "^10.0.0",
+    "inquirer": "^11.0.0",
+    "lodash-es": "^4.17.21",
+    "minimatch": "^9.0.0",
+    "semver": "^7.6.3",
     "shell-escape": "^0.2.0",
     "upath": "^2.0.1"
   }

package/lib/utils/changelog.js

@@ -1,109 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-'use strict';
-
-const fs = require( 'fs' );
-const path = require( 'path' );
-const { format } = require( 'date-fns' );
-const { getRepositoryUrl } = require( './transformcommitutils' );
-
-const utils = {
-	/**
-	 * Changelog file name.
-	 */
-	changelogFile: 'CHANGELOG.md',
-
-	/**
-	 * Changelog header.
-	 */
-	changelogHeader: 'Changelog\n=========\n\n',
-
-	/**
-	 * 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}
-	 */
-	getChangesForVersion( version, cwd = process.cwd() ) {
-		version = version.replace( /^v/, '' );
-
-		const changelog = utils.getChangelog( cwd ).replace( utils.changelogHeader, '\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();
-	},
-
-	/**
-	 * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
-	 * @returns {String|null}
-	 */
-	getChangelog( cwd = process.cwd() ) {
-		const changelogFile = path.join( cwd, utils.changelogFile );
-
-		if ( !fs.existsSync( changelogFile ) ) {
-			return null;
-		}
-
-		return fs.readFileSync( changelogFile, 'utf-8' );
-	},
-
-	/**
-	 * @param {String} content
-	 * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
-	 */
-	saveChangelog( content, cwd = process.cwd() ) {
-		const changelogFile = path.join( cwd, utils.changelogFile );
-
-		fs.writeFileSync( changelogFile, content, 'utf-8' );
-	},
-
-	/**
-	 * @param {Number} length
-	 * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
-	 */
-	truncateChangelog( length, cwd = process.cwd() ) {
-		const changelog = utils.getChangelog( cwd );
-
-		if ( !changelog ) {
-			return;
-		}
-
-		const entryHeader = '## [\\s\\S]+?';
-		const entryHeaderRegexp = new RegExp( `\\n(${ entryHeader })(?=\\n${ entryHeader }|$)`, 'g' );
-
-		const entries = [ ...changelog.matchAll( entryHeaderRegexp ) ]
-			.filter( match => match && match[ 1 ] )
-			.map( match => match[ 1 ] );
-
-		if ( !entries.length ) {
-			return;
-		}
-
-		const truncatedEntries = entries.slice( 0, length );
-
-		const changelogFooter = entries.length > truncatedEntries.length ?
-			`\n\n---\n\nTo see all releases, visit the [release page](${ getRepositoryUrl( cwd ) }/releases).\n` :
-			'\n';
-
-		const truncatedChangelog = utils.changelogHeader + truncatedEntries.join( '\n' ).trim() + changelogFooter;
-
-		utils.saveChangelog( truncatedChangelog, cwd );
-	},
-
-	/**
-	 * @returns {String}
-	 */
-	getFormattedDate() {
-		return format( new Date(), 'yyyy-MM-dd' );
-	}
-};
-
-module.exports = utils;

package/lib/utils/cli.js

@@ -1,349 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-'use strict';
-
-const inquirer = require( 'inquirer' );
-const semver = require( 'semver' );
-const chalk = require( 'chalk' );
-
-const QUESTION_MARK = chalk.cyan( '?' );
-
-const cli = {
-	/**
-	 * A size of default indent for a log.
-	 */
-	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`.
-	 */
-	COMMIT_INDENT_SIZE: 10,
-
-	/**
-	 * Asks a user for a confirmation for updating and tagging versions of the packages.
-	 *
-	 * @param {Map} packages Packages to release.
-	 * @returns {Promise.<Boolean>}
-	 */
-	confirmUpdatingVersions( packages ) {
-		let message = 'Packages and their old and new versions:\n';
-
-		for ( const packageName of Array.from( packages.keys() ).sort() ) {
-			const packageDetails = packages.get( packageName );
-
-			message += `  * "${ packageName }": v${ packageDetails.previousVersion } => v${ packageDetails.version }\n`;
-		}
-
-		message += 'Continue?';
-
-		const confirmQuestion = {
-			message,
-			type: 'confirm',
-			name: 'confirm',
-			default: true
-		};
-
-		return inquirer.prompt( [ confirmQuestion ] )
-			.then( answers => answers.confirm );
-	},
-
-	/**
-	 * Asks a user for a confirmation for publishing changes.
-	 *
-	 * @param {Map} packages Packages to release.
-	 * @returns {Promise.<Boolean>}
-	 */
-	confirmPublishing( packages ) {
-		let message = 'Services where the release will be created:\n';
-
-		for ( const packageName of Array.from( packages.keys() ).sort() ) {
-			const packageDetails = packages.get( packageName );
-
-			let packageMessage = `  * "${ packageName }" - version: ${ packageDetails.version }`;
-
-			const services = [];
-
-			if ( packageDetails.shouldReleaseOnNpm ) {
-				services.push( 'NPM' );
-			}
-
-			if ( packageDetails.shouldReleaseOnGithub ) {
-				services.push( 'GitHub' );
-			}
-
-			let color;
-
-			if ( services.length ) {
-				color = chalk.magenta;
-				packageMessage += ` - services: ${ services.join( ', ' ) } `;
-			} else {
-				color = chalk.gray;
-				packageMessage += ' - nothing to release';
-			}
-
-			message += color( packageMessage ) + '\n';
-		}
-
-		message += 'Continue?';
-
-		const confirmQuestion = {
-			message,
-			type: 'confirm',
-			name: 'confirm',
-			default: true
-		};
-
-		return inquirer.prompt( [ confirmQuestion ] )
-			.then( answers => answers.confirm );
-	},
-
-	/**
-	 * Asks a user for a confirmation for removing archives created by `npm pack` command.
-	 *
-	 * @returns {Promise.<Boolean>}
-	 */
-	confirmRemovingFiles() {
-		const confirmQuestion = {
-			message: 'Remove created archives?',
-			type: 'confirm',
-			name: 'confirm',
-			default: true
-		};
-
-		return inquirer.prompt( [ confirmQuestion ] )
-			.then( answers => answers.confirm );
-	},
-
-	/**
-	 * Asks a user for a confirmation for including a package that does not contain all required files.
-	 *
-	 * @returns {Promise.<Boolean>}
-	 */
-	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
-		};
-
-		return inquirer.prompt( [ confirmQuestion ] )
-			.then( answers => answers.confirm );
-	},
-
-	/**
-	 * 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>}
-	 */
-	provideVersion( packageVersion, releaseTypeOrNewVersion, options = {} ) {
-		const indentLevel = options.indentLevel || 0;
-		const suggestedVersion = getSuggestedVersion();
-
-		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: getPrefix( indentLevel )
-		};
-
-		return inquirer.prompt( [ versionQuestion ] )
-			.then( answers => answers.version );
-
-		function getSuggestedVersion() {
-			if ( !releaseTypeOrNewVersion || releaseTypeOrNewVersion === 'skip' ) {
-				return 'skip';
-			}
-
-			if ( semver.valid( releaseTypeOrNewVersion ) ) {
-				return releaseTypeOrNewVersion;
-			}
-
-			if ( releaseTypeOrNewVersion === 'internal' ) {
-				return options.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 );
-		}
-	},
-
-	/**
-	 * 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>}
-	 */
-	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: getPrefix( indentLevel )
-		};
-
-		return inquirer.prompt( [ versionQuestion ] )
-			.then( answers => answers.version );
-	},
-
-	/**
-	 * Asks a user for providing the GitHub token.
-	 *
-	 * @returns {Promise.<String>}
-	 */
-	provideToken() {
-		const tokenQuestion = {
-			type: 'password',
-			name: 'token',
-			message: 'Provide the GitHub token:',
-			validate( input ) {
-				return input.length === 40 ? true : 'Please provide a valid token.';
-			}
-		};
-
-		return inquirer.prompt( [ tokenQuestion ] )
-			.then( answers => answers.token );
-	},
-
-	/**
-	 * 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>}
-	 */
-	configureReleaseOptions() {
-		const options = {};
-
-		const servicesQuestion = {
-			type: 'checkbox',
-			name: 'services',
-			message: 'Select services where packages will be released:',
-			choices: [
-				'npm',
-				'GitHub'
-			],
-			default: [
-				'npm',
-				'GitHub'
-			]
-		};
-
-		return inquirer.prompt( [ servicesQuestion ] )
-			.then( answers => {
-				options.npm = answers.services.includes( 'npm' );
-				options.github = answers.services.includes( 'GitHub' );
-
-				if ( !options.github ) {
-					return options;
-				}
-
-				return cli.provideToken()
-					.then( token => {
-						options.token = token;
-
-						return options;
-					} );
-			} );
-	},
-
-	/**
-	 * 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>}
-	 */
-	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 );
-	}
-};
-
-module.exports = cli;
-
-function getPrefix( indent ) {
-	return ' '.repeat( indent * cli.INDENT_SIZE ) + QUESTION_MARK;
-}