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

package/lib/utils/transformcommitutils.js

@@ -3,161 +3,156 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const getPackageJson = require( './getpackagejson' );
-
-const transformCommitUtils = {
-	/**
-	 * A regexp for extracting additional changelog entries from the single commit.
-	 * Prefixes of the commit must be synchronized the `getCommitType()` util.
-	 */
-	MULTI_ENTRIES_COMMIT_REGEXP: /(?:Feature|Other|Fix|Docs|Internal|Tests|Revert|Release)(?: \([\w\-, ]+?\))?:/g,
-
-	/**
-	 * Map of available types of the commits.
-	 * Types marked as `false` will be ignored during generating the changelog.
-	 */
-	availableCommitTypes: new Map( [
-		[ 'Fix', true ],
-		[ 'Feature', true ],
-		[ 'Other', true ],
-
-		[ 'Docs', false ],
-		[ 'Internal', false ],
-		[ 'Tests', false ],
-		[ 'Revert', false ],
-		[ 'Release', false ]
-	] ),
-
-	/**
-	 * Order of messages generated in changelog.
-	 */
-	typesOrder: {
-		'Features': 1,
-		'Bug fixes': 2,
-		'Other changes': 3,
-
-		'MAJOR BREAKING CHANGES': 1,
-		'MINOR BREAKING CHANGES': 2,
-		'BREAKING CHANGES': 3
-	},
-
-	/**
-	 * Returns an order of a message in the changelog.
-	 *
-	 * @param {String} title
-	 * @returns {Number}
-	 */
-	getTypeOrder( title ) {
-		for ( const typeTitle of Object.keys( transformCommitUtils.typesOrder ) ) {
-			if ( title.startsWith( typeTitle ) ) {
-				return transformCommitUtils.typesOrder[ typeTitle ];
-			}
+import getPackageJson from './getpackagejson.js';
+
+/**
+ * A regexp for extracting additional changelog entries from the single commit.
+ * Prefixes of the commit must be synchronized the `getCommitType()` util.
+ */
+export const MULTI_ENTRIES_COMMIT_REGEXP = /(?:Feature|Other|Fix|Docs|Internal|Tests|Revert|Release)(?: \([\w\-, ]+?\))?:/g;
+
+/**
+ * Map of available types of the commits.
+ * Types marked as `false` will be ignored during generating the changelog.
+ */
+export const availableCommitTypes = new Map( [
+	[ 'Fix', true ],
+	[ 'Feature', true ],
+	[ 'Other', true ],
+
+	[ 'Docs', false ],
+	[ 'Internal', false ],
+	[ 'Tests', false ],
+	[ 'Revert', false ],
+	[ 'Release', false ]
+] );
+
+/**
+ * Order of messages generated in changelog.
+ */
+export const typesOrder = {
+	'Features': 1,
+	'Bug fixes': 2,
+	'Other changes': 3,
+
+	'MAJOR BREAKING CHANGES': 1,
+	'MINOR BREAKING CHANGES': 2,
+	'BREAKING CHANGES': 3
+};
+
+/**
+ * Returns an order of a message in the changelog.
+ *
+ * @param {String} title
+ * @returns {Number}
+ */
+export function getTypeOrder( title ) {
+	for ( const typeTitle of Object.keys( typesOrder ) ) {
+		if ( title.startsWith( typeTitle ) ) {
+			return typesOrder[ typeTitle ];
 		}
+	}
+
+	return 10;
+}
 
-		return 10;
-	},
-
-	/**
-	 * Replaces reference to the user (`@name`) with a link to the user's profile.
-	 *
-	 * @param {String} comment
-	 * @returns {String}
-	 */
-	linkToGithubUser( comment ) {
-		return comment.replace( /(^|[\s(])@([\w-]+)(?![/\w-])/ig, ( matchedText, charBefore, nickName ) => {
-			return `${ charBefore }[@${ nickName }](https://github.com/${ nickName })`;
-		} );
-	},
-
-	/**
-	 * 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}
-	 */
-	linkToGithubIssue( comment ) {
-		return comment.replace( /(\/?[\w-]+\/[\w-]+)?#([\d]+)(?=$|[\s,.)\]])/igm, ( matchedText, maybeRepository, issueId ) => {
-			if ( maybeRepository ) {
-				if ( maybeRepository.startsWith( '/' ) ) {
-					return matchedText;
-				}
-
-				return `[${ maybeRepository }#${ issueId }](https://github.com/${ maybeRepository }/issues/${ issueId })`;
+/**
+ * Replaces reference to the user (`@name`) with a link to the user's profile.
+ *
+ * @param {String} comment
+ * @returns {String}
+ */
+export function linkToGithubUser( comment ) {
+	return comment.replace( /(^|[\s(])@([\w-]+)(?![/\w-])/ig, ( matchedText, charBefore, nickName ) => {
+		return `${ charBefore }[@${ nickName }](https://github.com/${ nickName })`;
+	} );
+}
+
+/**
+ * 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}
+ */
+export function linkToGithubIssue( comment ) {
+	return comment.replace( /(\/?[\w-]+\/[\w-]+)?#([\d]+)(?=$|[\s,.)\]])/igm, ( matchedText, maybeRepository, issueId ) => {
+		if ( maybeRepository ) {
+			if ( maybeRepository.startsWith( '/' ) ) {
+				return matchedText;
 			}
 
-			const repositoryUrl = transformCommitUtils.getRepositoryUrl();
-
-			// But if doesn't, let's add it.
-			return `[#${ issueId }](${ repositoryUrl }/issues/${ issueId })`;
-		} );
-	},
-
-	/**
-	 * Changes a singular type of commit to plural which will be displayed in a changelog.
-	 *
-	 * The switch cases must be synchronized with the `MULTI_ENTRIES_COMMIT_REGEXP` regexp.
-	 *
-	 * @param {String} commitType
-	 * @returns {String}
-	 */
-	getCommitType( commitType ) {
-		switch ( commitType ) {
-			case 'Feature':
-				return 'Features';
-
-			case 'Fix':
-				return 'Bug fixes';
-
-			case 'Other':
-				return 'Other changes';
-
-			default:
-				throw new Error( `Given invalid type of commit ("${ commitType }").` );
-		}
-	},
-
-	/**
-	 * @param {String} sentence
-	 * @param {Number} length
-	 * @returns {String}
-	 */
-	truncate( sentence, length ) {
-		if ( sentence.length <= length ) {
-			return sentence;
+			return `[${ maybeRepository }#${ issueId }](https://github.com/${ maybeRepository }/issues/${ issueId })`;
 		}
 
-		return sentence.slice( 0, length - 3 ).trim() + '...';
-	},
-
-	/**
-	 * Returns a URL to the repository whether the commit is being parsed.
-	 *
-	 * @param {String} [cwd=process.cwd()]
-	 * @returns {String}
-	 */
-	getRepositoryUrl( cwd = process.cwd() ) {
-		const packageJson = getPackageJson( cwd );
-
-		// Due to merging our issue trackers, `packageJson.bugs` will point to the same place for every package.
-		// We cannot rely on this value anymore. See: https://github.com/ckeditor/ckeditor5/issues/1988.
-		// Instead of we can take a value from `packageJson.repository` and adjust it to match to our requirements.
-		let repositoryUrl = ( typeof packageJson.repository === 'object' ) ? packageJson.repository.url : packageJson.repository;
-
-		if ( !repositoryUrl ) {
-			throw new Error( `The package.json for "${ packageJson.name }" must contain the "repository" property.` );
-		}
+		const repositoryUrl = getRepositoryUrl();
+
+		// But if doesn't, let's add it.
+		return `[#${ issueId }](${ repositoryUrl }/issues/${ issueId })`;
+	} );
+}
+
+/**
+ * Changes a singular type of commit to plural which will be displayed in a changelog.
+ *
+ * The switch cases must be synchronized with the `MULTI_ENTRIES_COMMIT_REGEXP` regexp.
+ *
+ * @param {String} commitType
+ * @returns {String}
+ */
+export function getCommitType( commitType ) {
+	switch ( commitType ) {
+		case 'Feature':
+			return 'Features';
 
-		// If the value ends with ".git", we need to remove it.
-		repositoryUrl = repositoryUrl.replace( /\.git$/, '' );
+		case 'Fix':
+			return 'Bug fixes';
 
-		// Remove "/issues" suffix as well.
-		repositoryUrl = repositoryUrl.replace( /\/issues/, '' );
+		case 'Other':
+			return 'Other changes';
 
-		return repositoryUrl;
+		default:
+			throw new Error( `Given invalid type of commit ("${ commitType }").` );
 	}
-};
+}
+
+/**
+ * @param {String} sentence
+ * @param {Number} length
+ * @returns {String}
+ */
+export function truncate( sentence, length ) {
+	if ( sentence.length <= length ) {
+		return sentence;
+	}
+
+	return sentence.slice( 0, length - 3 ).trim() + '...';
+}
+
+/**
+ * Returns a URL to the repository whether the commit is being parsed.
+ *
+ * @param {String} [cwd=process.cwd()]
+ * @returns {String}
+ */
+export function getRepositoryUrl( cwd = process.cwd() ) {
+	const packageJson = getPackageJson( cwd );
+
+	// Due to merging our issue trackers, `packageJson.bugs` will point to the same place for every package.
+	// We cannot rely on this value anymore. See: https://github.com/ckeditor/ckeditor5/issues/1988.
+	// Instead of we can take a value from `packageJson.repository` and adjust it to match to our requirements.
+	let repositoryUrl = ( typeof packageJson.repository === 'object' ) ? packageJson.repository.url : packageJson.repository;
+
+	if ( !repositoryUrl ) {
+		throw new Error( `The package.json for "${ packageJson.name }" must contain the "repository" property.` );
+	}
+
+	// If the value ends with ".git", we need to remove it.
+	repositoryUrl = repositoryUrl.replace( /\.git$/, '' );
+
+	// Remove "/issues" suffix as well.
+	repositoryUrl = repositoryUrl.replace( /\/issues/, '' );
+
+	return repositoryUrl;
+}
 
-module.exports = transformCommitUtils;

package/lib/utils/truncatechangelog.js

@@ -0,0 +1,42 @@
+/**
+ * @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 { getRepositoryUrl } from './transformcommitutils.js';
+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.
+ */
+export default function truncateChangelog( length, cwd = process.cwd() ) {
+	const changelog = 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 = CHANGELOG_HEADER + truncatedEntries.join( '\n' ).trim() + changelogFooter;
+
+	saveChangelog( truncatedChangelog, cwd );
+}

package/lib/utils/validaterepositorytorelease.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';
 
 /**
  * @param {Object} options
@@ -15,7 +13,7 @@ const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
  * @param {String} [options.branch='master'] A name of the branch that should be used for releasing packages.
  * @returns {Promise.<Array.<String>>}
  */
-module.exports = async function validateRepositoryToRelease( options ) {
+export default async function validateRepositoryToRelease( options ) {
 	const {
 		version,
 		changes,
@@ -56,4 +54,4 @@ module.exports = async function validateRepositoryToRelease( options ) {
 	async function exec( command ) {
 		return tools.shExec( command, { verbosity: 'error', async: true } );
 	}
-};
+}

package/lib/utils/versions.js

@@ -3,136 +3,130 @@
  * For licensing, see LICENSE.md.
  */
 
-'use strict';
-
-const { tools } = require( '@ckeditor/ckeditor5-dev-utils' );
-const changelogUtils = require( './changelog' );
-const getPackageJson = require( './getpackagejson' );
-
-const versions = {
-	/**
-	 * Returns a last created version in changelog file.
-	 *
-	 * @param {String} [cwd=process.cwd()] Where to look for the changelog file.
-	 * @returns {String|null}
-	 */
-	getLastFromChangelog( cwd = process.cwd() ) {
-		const changelog = changelogUtils.getChangelog( cwd );
-
-		if ( !changelog ) {
-			return null;
-		}
-
-		const regexp = /\n## \[?([\da-z.\-+]+)/i;
-		const matches = changelog.match( regexp );
-
-		return matches ? matches[ 1 ] : null;
-	},
-
-	/**
-	 * Returns the current (latest) pre-release version that matches the provided release identifier.
-	 * 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>}
-	 */
-	getLastPreRelease( releaseIdentifier, cwd = process.cwd() ) {
-		const packageName = getPackageJson( cwd ).name;
-
-		return tools.shExec( `npm view ${ packageName } versions --json`, { verbosity: 'silent', async: true } )
-			.then( result => {
-				const lastVersion = JSON.parse( result )
-					.filter( version => version.startsWith( releaseIdentifier ) )
-					.sort( ( a, b ) => a.localeCompare( b, undefined, { numeric: true } ) )
-					.pop();
-
-				return lastVersion || null;
-			} )
-			.catch( () => null );
-	},
-
-	/**
-	 * Returns the current (latest) nightly version in the format of "0.0.0-nightly-YYYYMMDD.X", where the "YYYYMMDD" is the date of the
-	 * 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>}
-	 */
-	getLastNightly( cwd = process.cwd() ) {
-		return versions.getLastPreRelease( '0.0.0-nightly', cwd );
-	},
-
-	/**
-	 * Returns the next available pre-release version that matches the following format: "<releaseIdentifier>.X", where "X" is the
-	 * next available pre-release sequential number starting from 0.
-	 *
-	 * @param {ReleaseIdentifier} releaseIdentifier
-	 * @param {String} [cwd=process.cwd()]
-	 * @returns {Promise<String>}
-	 */
-	async getNextPreRelease( releaseIdentifier, cwd = process.cwd() ) {
-		const currentPreReleaseVersion = await versions.getLastPreRelease( releaseIdentifier, cwd );
-
-		if ( !currentPreReleaseVersion ) {
-			return `${ releaseIdentifier }.0`;
-		}
-
-		const currentPreReleaseVersionTokens = currentPreReleaseVersion.split( '.' );
-		const currentPreReleaseSequenceNumber = currentPreReleaseVersionTokens.pop();
-		const currentPreReleaseIdentifier = currentPreReleaseVersionTokens.join( '.' );
-		const nextPreReleaseSequenceNumber = Number( currentPreReleaseSequenceNumber ) + 1;
-
-		return `${ currentPreReleaseIdentifier }.${ nextPreReleaseSequenceNumber }`;
-	},
-
-	/**
-	 * 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>}
-	 */
-	async getNextNightly( cwd = process.cwd() ) {
-		const today = new Date();
-		const year = today.getFullYear().toString();
-		const month = ( today.getMonth() + 1 ).toString().padStart( 2, '0' );
-		const day = today.getDate().toString().padStart( 2, '0' );
-
-		const nextNightlyReleaseIdentifier = `0.0.0-nightly-${ year }${ month }${ day }`;
-
-		return versions.getNextPreRelease( nextNightlyReleaseIdentifier, cwd );
-	},
-
-	/**
-	 * Returns a name of the last created tag.
-	 *
-	 * @returns {String|null}
-	 */
-	getLastTagFromGit() {
-		try {
-			const lastTag = tools.shExec( 'git describe --abbrev=0 --tags 2> /dev/null', { verbosity: 'error' } );
-
-			return lastTag.trim().replace( /^v/, '' ) || null;
-		} catch ( err ) {
-			/* istanbul ignore next */
-			return null;
-		}
-	},
-
-	/**
-	 * Returns version of current package from `package.json`.
-	 *
-	 * @param {String} [cwd=process.cwd()] Current work directory.
-	 * @returns {String}
-	 */
-	getCurrent( cwd = process.cwd() ) {
-		return getPackageJson( cwd ).version;
+import { tools } from '@ckeditor/ckeditor5-dev-utils';
+import getChangelog from './getchangelog.js';
+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}
+ */
+export function getLastFromChangelog( cwd = process.cwd() ) {
+	const changelog = getChangelog( cwd );
+
+	if ( !changelog ) {
+		return null;
 	}
-};
 
-module.exports = versions;
+	const regexp = /\n## \[?([\da-z.\-+]+)/i;
+	const matches = changelog.match( regexp );
+
+	return matches ? matches[ 1 ] : null;
+}
+
+/**
+ * Returns the current (latest) pre-release version that matches the provided release identifier.
+ * 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>}
+ */
+export function getLastPreRelease( releaseIdentifier, cwd = process.cwd() ) {
+	const packageName = getPackageJson( cwd ).name;
+
+	return tools.shExec( `npm view ${ packageName } versions --json`, { verbosity: 'silent', async: true } )
+		.then( result => {
+			const lastVersion = JSON.parse( result )
+				.filter( version => version.startsWith( releaseIdentifier ) )
+				.sort( ( a, b ) => a.localeCompare( b, undefined, { numeric: true } ) )
+				.pop();
+
+			return lastVersion || null;
+		} )
+		.catch( () => null );
+}
+
+/**
+ * Returns the current (latest) nightly version in the format of "0.0.0-nightly-YYYYMMDD.X", where the "YYYYMMDD" is the date of the
+ * 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>}
+ */
+export function getLastNightly( cwd = process.cwd() ) {
+	return getLastPreRelease( '0.0.0-nightly', cwd );
+}
+
+/**
+ * Returns the next available pre-release version that matches the following format: "<releaseIdentifier>.X", where "X" is the
+ * next available pre-release sequential number starting from 0.
+ *
+ * @param {ReleaseIdentifier} releaseIdentifier
+ * @param {String} [cwd=process.cwd()]
+ * @returns {Promise<String>}
+ */
+export async function getNextPreRelease( releaseIdentifier, cwd = process.cwd() ) {
+	const currentPreReleaseVersion = await getLastPreRelease( releaseIdentifier, cwd );
+
+	if ( !currentPreReleaseVersion ) {
+		return `${ releaseIdentifier }.0`;
+	}
+
+	const currentPreReleaseVersionTokens = currentPreReleaseVersion.split( '.' );
+	const currentPreReleaseSequenceNumber = currentPreReleaseVersionTokens.pop();
+	const currentPreReleaseIdentifier = currentPreReleaseVersionTokens.join( '.' );
+	const nextPreReleaseSequenceNumber = Number( currentPreReleaseSequenceNumber ) + 1;
+
+	return `${ currentPreReleaseIdentifier }.${ nextPreReleaseSequenceNumber }`;
+}
+
+/**
+ * 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>}
+ */
+export async function getNextNightly( cwd = process.cwd() ) {
+	const today = new Date();
+	const year = today.getFullYear().toString();
+	const month = ( today.getMonth() + 1 ).toString().padStart( 2, '0' );
+	const day = today.getDate().toString().padStart( 2, '0' );
+
+	const nextNightlyReleaseIdentifier = `0.0.0-nightly-${ year }${ month }${ day }`;
+
+	return getNextPreRelease( nextNightlyReleaseIdentifier, cwd );
+}
+
+/**
+ * Returns a name of the last created tag.
+ *
+ * @returns {String|null}
+ */
+export function getLastTagFromGit() {
+	try {
+		const lastTag = tools.shExec( 'git describe --abbrev=0 --tags 2> /dev/null', { verbosity: 'error' } );
+
+		return lastTag.trim().replace( /^v/, '' ) || null;
+	} catch ( err ) {
+		/* istanbul ignore next */
+		return null;
+	}
+}
+
+/**
+ * Returns version of current package from `package.json`.
+ *
+ * @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).