@ckeditor/ckeditor5-dev-changelog 54.0.0 → 54.2.0

package/dist/index.js

@@ -1,8 +1,8 @@
-import chalk from 'chalk';
+import { styleText } from 'util';
 import { parse, isValid, format } from 'date-fns';
 import { workspaces, npm, tools } from '@ckeditor/ckeditor5-dev-utils';
 import upath from 'upath';
-import fs$1 from 'fs-extra';
+import fs$1 from 'fs/promises';
 import fs from 'fs';
 import semver from 'semver';
 import inquirer from 'inquirer';
@@ -369,12 +369,12 @@ function logInfo(text, { indent } = { indent: 0 }) {
 function displayChanges(options) {
     const { sections, isSinglePackage, transformScope } = options;
     let numberOfEntries = 0;
-    logInfo(`○ ${chalk.cyan('Listing the changes...')}`);
+    logInfo(`○ ${styleText('cyan', 'Listing the changes...')}`);
     const nonEmptySections = Object.entries(sections)
         .filter(([, section]) => section.entries.length);
     for (const [sectionName, section] of nonEmptySections) {
         const color = getTitleColor(sectionName);
-        logInfo('◌ ' + color(chalk.underline(`${section.titleInLogs || section.title}:`)), { indent: 1 });
+        logInfo('◌ ' + color(styleText('underline', `${section.titleInLogs || section.title}:`)), { indent: 1 });
         const displayCallback = sectionName === 'invalid' || sectionName === 'warning' ?
             displayWarningEntry :
             displayValidEntry;
@@ -384,9 +384,9 @@ function displayChanges(options) {
         section.entries.forEach(entry => displayCallback(entry, sectionName, isSinglePackage, transformScope));
         logInfo('');
     }
-    logInfo('◌ ' + chalk.underline('Legend:'), { indent: 1 });
-    logInfo(`- Entries marked with ${chalk.green('+')} symbol are included in the changelog.`, { indent: 2 });
-    logInfo('- Entries marked with ' + chalk.yellow('x') + ' symbol include invalid references (see and/or closes) ' +
+    logInfo('◌ ' + styleText('underline', 'Legend:'), { indent: 1 });
+    logInfo(`- Entries marked with ${styleText('green', '+')} symbol are included in the changelog.`, { indent: 2 });
+    logInfo('- Entries marked with ' + styleText('yellow', 'x') + ' symbol include invalid references (see and/or closes) ' +
         'or scope definitions. Please ensure that:', { indent: 2 });
     logInfo('* Reference entries match one of the following formats:', { indent: 3 });
     logInfo('1. An issue number (e.g., 1000)', { indent: 4 });
@@ -399,17 +399,15 @@ function displayChanges(options) {
 }
 function getTitleColor(sectionName) {
     if (sectionName === 'warning') {
-        return chalk.yellow;
+        return (text) => styleText('yellow', text);
     }
     if (sectionName === 'invalid') {
-        return chalk.red;
+        return (text) => styleText('red', text);
     }
-    let defaultColor = chalk.blue;
+    let defaultColor = (text) => styleText('blue', text);
     if (isBreakingChangeSection(sectionName)) {
         // To avoid tricks in tests, let's simplify the implementation.
-        defaultColor = (value) => {
-            return chalk.bold(chalk.blue(value));
-        };
+        defaultColor = (value) => styleText(['bold', 'blue'], value);
     }
     return defaultColor;
 }
@@ -428,9 +426,9 @@ function displayValidEntry(entry, sectionName, isSinglePackage, transformScope)
         entry.data.scope.map(scope => transformScope(scope).displayName) :
         entry.data.scope;
     const scope = entry.data.scope.length ?
-        chalk.grey(scopeFormatted?.join(', ')) :
-        `${chalk.italic(chalk.grey('(no scope)'))}`;
-    const validationIndicator = isEntryFullyValid ? chalk.green('+') : chalk.yellow('x');
+        styleText('grey', scopeFormatted?.join(', ')) :
+        `${styleText(['italic', 'gray'], '(no scope)')}`;
+    const validationIndicator = isEntryFullyValid ? styleText('green', '+') : styleText('yellow', 'x');
     const shouldTrimMessage = String(entry.data.mainContent).length > 100;
     const trimmedMessageContent = shouldTrimMessage ? entry.data.mainContent?.slice(0, 100) + '...' : entry.data.mainContent;
     if (isSinglePackage) {
@@ -504,7 +502,7 @@ async function modifyChangelog(newChangelog, cwd) {
     const changelogPath = upath.join(cwd, CHANGELOG_FILE);
     const existingChangelog = await readExistingChangelog(changelogPath);
     const updatedChangelog = prepareChangelogContent(existingChangelog, newChangelog);
-    logInfo(`○ ${chalk.cyan('Appending changes to the existing changelog...')}`);
+    logInfo(`○ ${styleText('cyan', 'Appending changes to the existing changelog...')}`);
     await fs$1.writeFile(changelogPath, updatedChangelog, 'utf-8');
     await truncateChangelog(5, cwd);
 }
@@ -516,7 +514,7 @@ async function readExistingChangelog(changelogPath) {
         return await fs$1.readFile(changelogPath, 'utf-8');
     }
     catch {
-        logInfo(`○ ${chalk.yellow('CHANGELOG.md not found.')}`);
+        logInfo(`○ ${styleText('yellow', 'CHANGELOG.md not found.')}`);
         return '';
     }
 }
@@ -608,18 +606,18 @@ async function provideNewVersion(options) {
         }
     }
     const question = createVersionQuestion(options);
-    const answers = await inquirer.prompt(question);
-    return answers.version;
+    const { customVersion, version } = await inquirer.prompt(question);
+    return customVersion || version;
 }
 /**
  * Displays a warning message about invalid changes in a visible color.
  */
 function displayInvalidChangesWarning() {
     logInfo('');
-    logInfo(chalk.yellow(chalk.bold(`⚠️  ${chalk.underline('WARNING: Invalid changes detected!')}`)));
+    logInfo(styleText(['yellow', 'bold'], `⚠️  ${styleText('underline', 'WARNING: Invalid changes detected!')}`));
     logInfo('');
-    logInfo(chalk.yellow('You can cancel the process, fix the invalid files, and run the tool again.'));
-    logInfo(chalk.yellow('Alternatively, you can continue - but invalid values will be lost.'));
+    logInfo(styleText('yellow', 'You can cancel the process, fix the invalid files, and run the tool again.'));
+    logInfo(styleText('yellow', 'Alternatively, you can continue - but invalid values will be lost.'));
     logInfo('');
 }
 /**
@@ -631,7 +629,7 @@ async function askContinueConfirmation(indentLevel = 0) {
         name: 'continue',
         message: 'Should continue?',
         default: false,
-        prefix: ' '.repeat(indentLevel * CLI_INDENT_SIZE) + chalk.cyan('?')
+        prefix: ' '.repeat(indentLevel * CLI_INDENT_SIZE) + styleText('cyan', '?')
     };
     const answers = await inquirer.prompt(question);
     return answers.continue;
@@ -642,16 +640,26 @@ async function askContinueConfirmation(indentLevel = 0) {
 function createVersionQuestion(options) {
     const { version, packageName, bumpType, releaseChannel, releaseType, indentLevel = 0 } = options;
     const suggestedVersion = getSuggestedVersion(bumpType, version, releaseChannel) || version;
-    const message = 'Type the new version ' +
-        `(current: "${version}", suggested: "${suggestedVersion}":`;
+    const message = [
+        'Select the new version.',
+        `Current version: ${styleText('cyan', version)}.`,
+        `Suggested version: ${styleText('cyan', suggestedVersion)}.`
+    ].join(' ');
     return [{
-            type: 'input',
+            type: 'list',
             name: 'version',
             default: suggestedVersion,
             message,
+            prefix: ' '.repeat(indentLevel * CLI_INDENT_SIZE) + styleText('cyan', '?'),
+            choices: getChoices$1({ version, bumpType, releaseChannel, releaseType })
+        }, {
+            type: 'input',
+            name: 'customVersion',
+            message: 'Enter your custom version:',
+            when: ({ version }) => version === 'custom',
             filter: (newVersion) => newVersion.trim(),
             validate: (newVersion) => validateInputVersion({ newVersion, version, releaseType, packageName, suggestedVersion }),
-            prefix: ' '.repeat(indentLevel * CLI_INDENT_SIZE) + chalk.cyan('?')
+            prefix: ' '.repeat(indentLevel * CLI_INDENT_SIZE) + styleText('cyan', '?')
         }];
 }
 function getSuggestedVersion(bumpType, version, releaseChannel) {
@@ -667,6 +675,35 @@ function getSuggestedVersion(bumpType, version, releaseChannel) {
         return semver.inc(version, bumpType);
     }
 }
+function getChoices$1({ version, bumpType, releaseChannel, releaseType }) {
+    const proposedVersions = [];
+    const preReleaseChannels = ['alpha', 'beta', 'rc'];
+    const validPromotionChannels = preReleaseChannels.filter((value, index, array) => index >= array.indexOf(releaseChannel));
+    // 6.0.0 => Latest (stable) release (7.0.0 | 6.1.0 | 6.0.1)
+    if (bumpType !== 'prerelease' && releaseType === 'latest' && releaseChannel === 'latest') {
+        proposedVersions.push(semver.inc(version, 'major'), semver.inc(version, 'minor'), semver.inc(version, 'patch'));
+    }
+    // 6.0.0 => Pre-release (7.0.0-alpha.0 | 6.1.0-alpha.0 | 6.0.1-alpha.0)
+    if (bumpType === 'prerelease' && releaseType === 'prerelease' && releaseChannel === 'latest') {
+        proposedVersions.push(semver.inc(version, 'premajor', 'alpha'), semver.inc(version, 'preminor', 'alpha'), semver.inc(version, 'prepatch', 'alpha'));
+    }
+    // 6.0.0-alpha.0 => Latest (stable) release (6.0.0)
+    if (bumpType !== 'prerelease' && releaseType === 'latest' && preReleaseChannels.includes(releaseChannel)) {
+        proposedVersions.push(semver.inc(version, 'release'));
+    }
+    // 6.0.0-alpha.0 => Pre-release continuation (6.0.0-alpha.1)
+    if (bumpType === 'prerelease' && releaseType === 'prerelease' && preReleaseChannels.includes(releaseChannel)) {
+        proposedVersions.push(semver.inc(version, 'prerelease', releaseChannel));
+    }
+    // 6.0.0-alpha.0 => Pre-release promotion (6.0.0-beta.0 | 6.0.0-rc.0)
+    if (bumpType === 'prerelease' && releaseType === 'prerelease-promote' && preReleaseChannels.includes(releaseChannel)) {
+        proposedVersions.push(...validPromotionChannels.map(channel => semver.inc(version, 'prerelease', channel)));
+    }
+    return [
+        ...proposedVersions.map(proposedVersion => ({ name: proposedVersion, value: proposedVersion })),
+        { name: 'Custom...', value: 'custom' }
+    ];
+}
 
 /**
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
@@ -688,7 +725,7 @@ function detectReleaseChannel(version, promotePrerelease = false) {
         if (currentChannel === 'beta') {
             return 'rc';
         }
-        logInfo(chalk.yellow(`Warning! Unknown release channel to promote from ${currentChannel}.`));
+        logInfo(styleText('yellow', `Warning! Unknown release channel to promote from ${currentChannel}.`));
         return 'alpha';
     }
     return currentChannel;
@@ -720,7 +757,7 @@ class InternalError extends Error {
 async function determineNextVersion(options) {
     const { sections, currentVersion, packageName, nextVersion, releaseType } = options;
     if (nextVersion) {
-        logInfo(`○ ${chalk.cyan(`Determined the next version to be ${nextVersion}.`)}`);
+        logInfo(`○ ${styleText('cyan', `Determined the next version to be ${nextVersion}.`)}`);
         const isNightlyVersion = nextVersion.startsWith('0.0.0-');
         if (isNightlyVersion) {
             return nextVersion;
@@ -737,7 +774,7 @@ async function determineNextVersion(options) {
         }
         return nextVersion;
     }
-    logInfo(`○ ${chalk.cyan('Determining the new version...')}`);
+    logInfo(`○ ${styleText('cyan', 'Determining the new version...')}`);
     let bumpType = 'patch';
     if (releaseType === 'prerelease' || releaseType === 'prerelease-promote') {
         bumpType = 'prerelease';
@@ -833,7 +870,8 @@ async function findPackages(options) {
     ]);
     return AsyncArray.from(promise)
         .flat()
-        .map(packagePath => fs$1.readJson(packagePath))
+        .map(packagePath => fs.readFileSync(packagePath, 'utf-8'))
+        .map(packageJson => JSON.parse(packageJson))
         .map(({ name, version }) => [name, version])
         .then(entries => new Map(entries.sort(([a], [b]) => a.localeCompare(b))));
 }
@@ -1183,7 +1221,7 @@ async function composeChangelog(options) {
  * and removing any resulting empty directories both in the current repository and in any external repositories.
  */
 async function removeChangelogEntryFiles(entryPaths) {
-    logInfo(`○ ${chalk.cyan('Removing the changeset files...')}`);
+    logInfo(`○ ${styleText('cyan', 'Removing the changeset files...')}`);
     await Promise.all(entryPaths
         .flatMap(repo => repo.filePaths)
         .map(file => fs$1.unlink(file)));
@@ -1201,12 +1239,12 @@ async function removeChangelogEntryFiles(entryPaths) {
 async function moveChangelogEntryFiles(entryPaths) {
     const targetDir = PRE_RELEASE_DIRECTORY;
     const modifiedEntryPaths = [];
-    logInfo(`○ ${chalk.cyan(`Moving changelog entries to ${targetDir}/ directory...`)}`);
+    logInfo(`○ ${styleText('cyan', `Moving changelog entries to ${targetDir}/ directory...`)}`);
     for (const repo of entryPaths) {
         const { cwd, filePaths } = repo;
         const changelogDir = upath.join(cwd, CHANGESET_DIRECTORY);
         const targetPath = upath.join(changelogDir, targetDir);
-        await fs$1.ensureDir(targetPath);
+        await fs$1.mkdir(targetPath, { recursive: true });
         const modifiedFilePaths = [];
         for (const filePath of filePaths) {
             const fileName = upath.basename(filePath);
@@ -1229,7 +1267,7 @@ async function moveChangelogEntryFiles(entryPaths) {
  */
 async function commitChanges(version, repositories) {
     const message = `Changelog for v${version}. [skip ci]`;
-    logInfo(`○ ${chalk.cyan('Committing changes...')}`);
+    logInfo(`○ ${styleText('cyan', 'Committing changes...')}`);
     for (const { cwd, isRoot, filePaths } of repositories) {
         // Copy to avoid modifying the original array.
         const files = filePaths.slice(0);
@@ -1240,7 +1278,7 @@ async function commitChanges(version, repositories) {
         await tools.commit({ cwd, message, files })
             .catch(error => {
             logInfo('An error occurred while committing changes.', { indent: 2 });
-            logInfo(chalk.red(error.message), { indent: 2 });
+            logInfo(styleText('red', error.message), { indent: 2 });
         });
     }
 }
@@ -1257,31 +1295,48 @@ async function promptReleaseType(currentVersion) {
         {
             type: 'list',
             name: 'releaseType',
-            message: 'Please select the release type.',
-            choices: getQuestions(currentVersion)
+            message: `Select the release type. Current version: ${styleText('cyan', currentVersion)}.`,
+            choices: getChoices(currentVersion)
         }
     ]);
     return releaseType;
 }
-function getQuestions(currentVersion) {
+function getChoices(currentVersion) {
     const currentVersionPrerelease = semver.prerelease(currentVersion);
     if (!currentVersionPrerelease) {
+        const possibleStableVersions = [
+            semver.inc(currentVersion, 'major'),
+            semver.inc(currentVersion, 'minor'),
+            semver.inc(currentVersion, 'patch')
+        ].join(' | ');
+        const possiblePrereleaseVersions = [
+            semver.inc(currentVersion, 'premajor', 'alpha'),
+            semver.inc(currentVersion, 'preminor', 'alpha'),
+            semver.inc(currentVersion, 'prepatch', 'alpha')
+        ].join(' | ');
         return [
-            { name: 'Latest (stable) release (e.g. 1.0.0 -> 2.0.0)', value: 'latest' },
-            { name: 'Pre-release (e.g. 1.0.0 -> 2.0.0-alpha.0)', value: 'prerelease' }
+            { name: `Latest (stable) release (${possibleStableVersions})`, value: 'latest' },
+            { name: `Pre-release (${possiblePrereleaseVersions})`, value: 'prerelease' }
         ];
     }
-    if (currentVersionPrerelease[0] === 'rc') {
-        return [
-            { name: 'Latest (stable) release (e.g. 1.0.0-beta.2 -> 1.0.0)', value: 'latest' },
-            { name: 'Pre-release continuation (e.g. 1.0.0-alpha.0 -> 1.0.0-alpha.1)', value: 'prerelease' }
-        ];
+    const currentPreReleaseChannel = currentVersionPrerelease[0];
+    const preReleaseChannels = ['alpha', 'beta', 'rc'];
+    while (preReleaseChannels.includes(currentPreReleaseChannel)) {
+        preReleaseChannels.shift();
     }
-    return [
-        { name: 'Latest (stable) release (e.g. 1.0.0-beta.2 -> 1.0.0)', value: 'latest' },
-        { name: 'Pre-release continuation (e.g. 1.0.0-alpha.0 -> 1.0.0-alpha.1)', value: 'prerelease' },
-        { name: 'Pre-release promotion (e.g. 1.0.0-alpha.1 -> 1.0.0-beta.0)', value: 'prerelease-promote' }
+    const stableVersion = semver.inc(currentVersion, 'release');
+    const continuationVersion = semver.inc(currentVersion, 'prerelease', currentPreReleaseChannel);
+    const choices = [
+        { name: `Latest (stable) release (${stableVersion})`, value: 'latest' },
+        { name: `Pre-release continuation (${continuationVersion})`, value: 'prerelease' }
     ];
+    if (preReleaseChannels.length) {
+        const availablePromotions = preReleaseChannels
+            .map(channel => semver.inc(currentVersion, 'prerelease', channel))
+            .join(' | ');
+        choices.push({ name: `Pre-release promotion (${availablePromotions})`, value: 'prerelease-promote' });
+    }
+    return choices;
 }
 
 /**
@@ -1348,7 +1403,7 @@ const main = async (options) => {
     // Exit when no changelog entries exist.
     if (!parsedChangesetFiles.length) {
         logInfo('');
-        logInfo(chalk.bold('ℹ️  No changelog entries found, so there is nothing to prepare a changelog from.'));
+        logInfo(styleText('bold', 'ℹ️  No changelog entries found, so there is nothing to prepare a changelog from.'));
         return disableFilesystemOperations ? '' : undefined;
     }
     // Log changes in the console only when `nextVersion` is not provided.
@@ -1395,7 +1450,7 @@ const main = async (options) => {
     }
     await modifyChangelog(newChangelog, cwd);
     await commitChanges(newVersion, pathsToCommit.map(({ cwd, isRoot, filePaths }) => ({ cwd, isRoot, filePaths })));
-    logInfo('○ ' + chalk.green('Done!'));
+    logInfo('○ ' + styleText('green', 'Done!'));
 };
 /**
  * Entry point for generating a changelog with error handling.
@@ -1415,7 +1470,7 @@ const generateChangelog = async (options) => {
             throw error;
         }
         else {
-            console.error(chalk.red('Error: ' + error.message));
+            console.error(styleText('red', 'Error: ' + error.message));
             process.exit(1);
         }
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-changelog",
-  "version": "54.0.0",
+  "version": "54.2.0",
   "description": "A CKEditor 5 development tool for handling changelogs.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -28,14 +28,12 @@
     "ckeditor5-dev-changelog-create-entry": "bin/generate-template.js"
   },
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^54.0.0",
-    "chalk": "^5.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^54.2.0",
     "date-fns": "^4.0.0",
-    "fs-extra": "^11.0.0",
-    "glob": "^11.0.2",
+    "glob": "^13.0.0",
     "gray-matter": "^4.0.3",
     "inquirer": "^12.5.2",
     "semver": "^7.6.3",
     "upath": "^2.0.1"
   }
-}
+}