@ckeditor/ckeditor5-dev-release-tools 51.0.0 → 52.0.0

package/lib/utils/getcommits.js

@@ -1,103 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-import { parseCommitsStream } from 'conventional-commits-parser';
-import { filterRevertedCommitsSync } from 'conventional-commits-filter';
-import { getRawCommitsStream } from 'git-raw-commits';
-import concat from 'concat-stream';
-import parserOptions from './parseroptions.js';
-import { tools } from '@ckeditor/ckeditor5-dev-utils';
-import shellEscape from 'shell-escape';
-
-/**
- * Returns a promise that resolves an array of commits since the last tag specified as `options.from`.
- *
- * @param {function} transformCommit
- * @param {object} options
- * @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.mainBranch='master'] A name of the main branch in the repository.
- * @returns {Promise.<Array.<Commit>>}
- */
-export default function getCommits( transformCommit, options = {} ) {
-	const releaseBranch = options.releaseBranch || 'master';
-	const mainBranch = options.mainBranch || 'master';
-
-	const currentBranch = exec( 'git rev-parse --abbrev-ref HEAD' ).trim();
-
-	// Check whether current branch is the same as the release branch.
-	if ( currentBranch !== releaseBranch ) {
-		return Promise.reject( new Error(
-			`Expected to be checked out on the release branch ("${ releaseBranch }") instead of "${ currentBranch }". Aborting.`
-		) );
-	}
-
-	// If the release branch is the same as the main branch, we can collect all commits directly from the branch.
-	if ( releaseBranch === mainBranch ) {
-		return findCommits( { from: options.from } );
-	} else {
-		// Otherwise, (release branch is other than the main branch) we need to merge arrays of commits.
-		// See: https://github.com/ckeditor/ckeditor5/issues/7492.
-		const baseCommit = exec( `git merge-base ${ shellEscape( [ releaseBranch, mainBranch ] ) }` ).trim();
-
-		const commitPromises = [
-			// 1. Commits from the last release and to the point where the release branch was created (the merge-base commit).
-			findCommits( { from: options.from, to: baseCommit } ),
-			// 2. Commits from the merge-base commit to HEAD.
-			findCommits( { from: baseCommit, to: 'HEAD' } )
-		];
-
-		return Promise.all( commitPromises )
-			.then( commits => [].concat( ...commits ) );
-	}
-
-	function findCommits( gitRawCommitsOptions ) {
-		const gitRawCommitsOpts = Object.assign( {}, gitRawCommitsOptions, {
-			format: '%B%n-hash-%n%H',
-			merges: undefined,
-			firstParent: true
-		} );
-
-		return new Promise( ( resolve, reject ) => {
-			const stream = getRawCommitsStream( gitRawCommitsOpts )
-				.on( 'error', err => {
-					/* istanbul ignore else */
-					if ( err.message.match( /'HEAD': unknown/ ) ) {
-						reject( new Error( 'Given repository is empty.' ) );
-					} else if ( err.message.match( new RegExp( `'${ options.from }\\.\\.HEAD': unknown` ) ) ) {
-						reject( new Error(
-							`Cannot find tag or commit "${ options.from }" in given repository.`
-						) );
-					} else {
-						reject( err );
-					}
-				} );
-
-			stream.pipe( parseCommitsStream( parserOptions ) )
-				.pipe( concat( data => {
-					const commits = [ ...filterRevertedCommitsSync( data ) ]
-						.map( commit => transformCommit( commit ) )
-						.reduce( ( allCommits, commit ) => {
-							if ( Array.isArray( commit ) ) {
-								allCommits.push( ...commit );
-							} else {
-								allCommits.push( commit );
-							}
-
-							return allCommits;
-						}, [] )
-						.filter( commit => commit );
-
-					stream.destroy();
-
-					return resolve( commits );
-				} ) );
-		} );
-	}
-
-	function exec( command ) {
-		return tools.shExec( command, { verbosity: 'error' } );
-	}
-}

package/lib/utils/getformatteddate.js

@@ -1,13 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, 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

@@ -1,51 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-/**
- * Proposes new version based on commits.
- *
- * @param {Array.<Commit>} commits
- * @returns {string|null}
- */
-export default function getNewVersionType( commits ) {
-	// No commits = no changes.
-	if ( !commits.length ) {
-		return 'skip';
-	}
-
-	const publicCommits = commits.filter( commit => commit.isPublicCommit );
-
-	// No public commits = internal changes.
-	if ( !publicCommits.length ) {
-		return 'internal';
-	}
-
-	let newFeatures = false;
-	let minorBreakingChanges = false;
-
-	for ( const commit of publicCommits ) {
-		for ( const note of commit.notes ) {
-			if ( note.title === 'MAJOR BREAKING CHANGES' || note.title === 'BREAKING CHANGES' ) {
-				return 'major';
-			}
-
-			/* istanbul ignore else */
-			if ( note.title === 'MINOR BREAKING CHANGES' ) {
-				minorBreakingChanges = true;
-			}
-		}
-
-		if ( commit.rawType === 'Feature' ) {
-			newFeatures = true;
-		}
-	}
-
-	// Repository has new features or minor breaking changes.
-	if ( minorBreakingChanges || newFeatures ) {
-		return 'minor';
-	}
-
-	return 'patch';
-}

package/lib/utils/getpackagespaths.js

@@ -1,87 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-import path from 'path';
-import { minimatch } from 'minimatch';
-import { tools, workspaces } from '@ckeditor/ckeditor5-dev-utils';
-
-/**
- * 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.
- *   - 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`).
- *
- * @param {object} options
- * @param {string} options.cwd Current work directory.
- * @param {string|null} options.packages Name of directory where to look for packages. If `null`, only repository specified under
- * `options.cwd` will be returned.
- * @param {string|Array.<string>} options.skipPackages Glob pattern(s) which describes which packages should be skipped.
- * @param {string} [options.scope] Package names have to match to specified glob pattern.
- * @param {boolean} [options.skipMainRepository=false] If set on true, package found in `options.cwd` will be skipped.
- * @returns {PathsCollection}
- */
-export default function getPackagesPaths( options ) {
-	const pathsCollection = {
-		matched: new Set(),
-		skipped: new Set()
-	};
-
-	if ( options.skipMainRepository ) {
-		pathsCollection.skipped.add( options.cwd );
-	} else {
-		pathsCollection.matched.add( options.cwd );
-	}
-
-	if ( !options.packages ) {
-		return pathsCollection;
-	}
-
-	const packagesPath = path.join( options.cwd, options.packages );
-	const skipPackages = Array.isArray( options.skipPackages ) ? options.skipPackages : [ options.skipPackages ];
-
-	for ( const directory of tools.getDirectories( packagesPath ) ) {
-		const dependencyPath = path.join( packagesPath, directory );
-
-		try {
-			const { name: dependencyName } = workspaces.getPackageJson( dependencyPath );
-
-			if ( isValidPackage( dependencyName ) ) {
-				pathsCollection.matched.add( dependencyPath );
-			} else {
-				pathsCollection.skipped.add( dependencyPath );
-			}
-		} catch {
-			/* istanbul ignore next */
-			console.warn( `Missing "package.json file in "${ dependencyPath }". Skipping.` );
-		}
-	}
-
-	return pathsCollection;
-
-	function isValidPackage( packageName ) {
-		for ( const skipPackageGlob of skipPackages ) {
-			if ( minimatch( packageName, skipPackageGlob ) ) {
-				return false;
-			}
-		}
-
-		if ( options.scope ) {
-			return minimatch( packageName, options.scope );
-		}
-
-		return true;
-	}
-}
-
-/**
- * @typedef {object} PathsCollection
- *
- * @property {Set.<string>} matched Packages that match given criteria.
- *
- * @property {Set.<string>} skipped Packages that do not match given criteria.
- */

package/lib/utils/getwriteroptions.js

@@ -1,42 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-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 templatePath = path.join( __dirname, '..', 'templates' );
-
-/**
- * @param {WriterOptionsTransformCallback} transform
- * @returns {object}
- */
-export default function getWriterOptions( transform ) {
-	return {
-		transform,
-		groupBy: 'type',
-		commitGroupsSort: sortFunction,
-		commitsSort: [ 'subject' ],
-		noteGroupsSort: sortFunction,
-		mainTemplate: fs.readFileSync( path.join( templatePath, 'template.hbs' ), 'utf-8' ),
-		headerPartial: fs.readFileSync( path.join( templatePath, 'header.hbs' ), 'utf-8' ),
-		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 );
-}
-
-/**
- * @callback WriterOptionsTransformCallback
- * @param {Commit}
- * @returns {Commit}
- */

package/lib/utils/parseroptions.js

@@ -1,24 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-
-export default {
-	mergePattern: /^Merge .*$/,
-	headerPattern: /^([^:]+): (.*)$/,
-	headerCorrespondence: [
-		'type',
-		'subject'
-	],
-	noteKeywords: [
-		'MAJOR BREAKING CHANGES',
-		'MAJOR BREAKING CHANGE',
-		'MINOR BREAKING CHANGES',
-		'MINOR BREAKING CHANGE',
-		'BREAKING CHANGES', // It will be treated as "MAJOR BREAKING CHANGES"
-		'BREAKING CHANGE' // An alias for "BREAKING CHANGES".
-	],
-	revertPattern: /^Revert:\s([\s\S]*?)\s*This reverts commit (\w*)\./,
-	revertCorrespondence: [ 'header', 'hash' ],
-	referenceActions: []
-};

package/lib/utils/providenewversionformonorepository.js

@@ -1,67 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, 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';
-import { npm } from '@ckeditor/ckeditor5-dev-utils';
-
-/**
- * Asks a user for providing the new version for a major release.
- *
- * @param {object} options
- * @param {string} options.packageName
- * @param {string} options.version
- * @param {string} options.bumpType
- * @param {number} [options.indentLevel=0] The indent level.
- * @returns {Promise.<string>}
- */
-export default async function provideNewVersionForMonoRepository( options ) {
-	const {
-		version,
-		packageName,
-		bumpType,
-		indentLevel = 0
-	} = options;
-
-	const suggestedVersion = semver.inc( version, bumpType );
-	const message = 'Type the new version ' +
-		`(current highest: "${ version }" found in "${ chalk.underline( packageName ) }", suggested: "${ suggestedVersion }"):`;
-
-	const versionQuestion = {
-		type: 'input',
-		name: 'version',
-		default: suggestedVersion,
-		message,
-
-		filter( input ) {
-			return input.trim();
-		},
-
-		async validate( input ) {
-			if ( !semver.valid( input ) ) {
-				return 'Please provide a valid version.';
-			}
-
-			if ( !semver.gt( input, version ) ) {
-				return `Provided version must be higher than "${ version }".`;
-			}
-
-			const isAvailable = await npm.checkVersionAvailability( input, packageName );
-
-			if ( !isAvailable ) {
-				return 'Given version is already taken.';
-			}
-
-			return true;
-		},
-		prefix: ' '.repeat( indentLevel * CLI_INDENT_SIZE ) + chalk.cyan( '?' )
-	};
-
-	const answers = await inquirer.prompt( [ versionQuestion ] );
-
-	return answers.version;
-}

package/lib/utils/provideversion.js

@@ -1,115 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, 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';
-import { npm } from '@ckeditor/ckeditor5-dev-utils';
-
-/**
- * Asks a user for providing the new version.
- *
- * @param {object} options
- * @param {string} options.packageName
- * @param {string} options.version
- * @param {string|null} options.releaseTypeOrNewVersion
- * @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( options ) {
-	const {
-		packageName,
-		version,
-		releaseTypeOrNewVersion,
-		indentLevel = 0
-	} = options;
-
-	const suggestedVersion = getSuggestedVersion( {
-		version,
-		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: "${ version }"):`;
-
-	const versionQuestion = {
-		type: 'input',
-		name: 'version',
-		default: suggestedVersion,
-		message,
-
-		filter( input ) {
-			return input.trim();
-		},
-
-		async validate( input ) {
-			if ( !options.disableSkipVersion && input === 'skip' ) {
-				return true;
-			}
-
-			if ( !options.disableInternalVersion && input === 'internal' ) {
-				return true;
-			}
-
-			if ( !semver.valid( input ) ) {
-				return 'Please provide a valid version.';
-			}
-
-			const isAvailable = await npm.checkVersionAvailability( input, packageName );
-
-			if ( !isAvailable ) {
-				return 'Given version is already taken.';
-			}
-
-			return true;
-		},
-
-		prefix: ' '.repeat( indentLevel * CLI_INDENT_SIZE ) + chalk.cyan( '?' )
-	};
-
-	return inquirer.prompt( [ versionQuestion ] )
-		.then( answers => answers.version );
-}
-
-/**
- * @param {object} options
- * @param {string} options.version
- * @param {string|null} options.releaseTypeOrNewVersion
- * @param {boolean} options.disableInternalVersion
- * @returns {string}
- */
-function getSuggestedVersion( { version, releaseTypeOrNewVersion, disableInternalVersion } ) {
-	if ( !releaseTypeOrNewVersion || releaseTypeOrNewVersion === 'skip' ) {
-		return 'skip';
-	}
-
-	if ( semver.valid( releaseTypeOrNewVersion ) ) {
-		return releaseTypeOrNewVersion;
-	}
-
-	if ( releaseTypeOrNewVersion === 'internal' ) {
-		return disableInternalVersion ? 'skip' : 'internal';
-	}
-
-	if ( semver.prerelease( version ) ) {
-		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', version ) ) {
-		return semver.inc( version, 'minor' );
-	}
-
-	return semver.inc( version, releaseTypeOrNewVersion );
-}

package/lib/utils/savechangelog.js

@@ -1,18 +0,0 @@
-/**
- * @license Copyright (c) 2003-2025, 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' );
-}