@ckeditor/ckeditor5-dev-changelog 55.6.0-alpha.0 → 55.6.1

package/dist/tasks/generatechangelogformonorepository.d.ts

@@ -1,11 +1,7 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-import type { ConfigBase, GenerateChangelogEntryPoint, MonoRepoConfigBase } from '../types.js';
+import type { ConfigBase, GenerateChangelogEntryPoint, MonoRepoConfigBase } from "../types.js";
 type MonoRepositoryConfig = ConfigBase & MonoRepoConfigBase & {
-    packagesDirectory: ConfigBase['packagesDirectory'];
-    transformScope: MonoRepoConfigBase['transformScope'];
+	packagesDirectory: ConfigBase["packagesDirectory"];
+	transformScope: MonoRepoConfigBase["transformScope"];
 };
 export declare const generateChangelogForMonoRepository: GenerateChangelogEntryPoint<MonoRepositoryConfig>;
 export {};

package/dist/tasks/generatechangelogforsinglerepository.d.ts

@@ -1,8 +1,4 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-import type { ConfigBase, GenerateChangelogEntryPoint } from '../types.js';
-type SingleRepositoryConfig = Omit<ConfigBase, 'packagesDirectory'>;
+import type { ConfigBase, GenerateChangelogEntryPoint } from "../types.js";
+type SingleRepositoryConfig = Omit<ConfigBase, "packagesDirectory">;
 export declare const generateChangelogForSingleRepository: GenerateChangelogEntryPoint<SingleRepositoryConfig>;
 export {};

package/dist/template.d.ts

@@ -1,15 +1,11 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-/**
- * Options for the `generateTemplate` function.
- */
+* Options for the `generateTemplate` function.
+*/
 interface GenerateTemplateOptions {
-    directory: string;
+	directory: string;
 }
 /**
- * Generates a template file for the changelog in the specified directory.
- */
+* Generates a template file for the changelog in the specified directory.
+*/
 export declare function generateTemplate(args?: Partial<GenerateTemplateOptions> | undefined, retries?: number): Promise<void>;
 export {};

package/dist/template.js

@@ -1,128 +1,118 @@
-import { mkdir, copyFile, constants } from 'node:fs/promises';
-import { styleText, promisify } from 'node:util';
-import { exec } from 'node:child_process';
-import { cac } from 'cac';
-import path from 'upath';
-import { format } from 'date-fns';
-
+import { constants, copyFile, mkdir } from "node:fs/promises";
+import { promisify, styleText } from "node:util";
+import { exec } from "node:child_process";
+import { cac } from "cac";
+import path from "upath";
+import { format } from "date-fns";
+//#region src/utils/constants.ts
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-const CHANGESET_DIRECTORY = '.changelog';
-const TEMPLATE_FILE = path.join(import.meta.dirname, '../template/template.md');
-
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md.
+*/
+const VERSIONING_POLICY_URL = "https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/versioning-policy.html";
+const CHANGESET_DIRECTORY = ".changelog";
+const TEMPLATE_FILE = path.join(import.meta.dirname, "../template/template.md");
+`${VERSIONING_POLICY_URL}`, `${VERSIONING_POLICY_URL}`;
+//#endregion
+//#region src/template.ts
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md.
+*/
 /**
- * Default options for the `generateTemplate` function.
- */
-const DEFAULT_OPTIONS = {
-    directory: CHANGESET_DIRECTORY
-};
+* Default options for the `generateTemplate` function.
+*/
+const DEFAULT_OPTIONS = { directory: CHANGESET_DIRECTORY };
 /**
- * List of branch names that are usually protected.
- */
+* List of branch names that are usually protected.
+*/
 const PROTECTED_BRANCHES = [
-    'master',
-    'main',
-    'release',
-    'stable'
+	"master",
+	"main",
+	"release",
+	"stable"
 ];
 /**
- * Reads CLI arguments and turn the keys into camelcase.
- */
+* Reads CLI arguments and turn the keys into camelcase.
+*/
 function getCliArguments() {
-    const cli = cac('ckeditor5-dev-changelog-create-entry');
-    cli.usage('[options]');
-    cli.option('--directory <path>', 'Directory where the changelog entry will be created.', { default: DEFAULT_OPTIONS.directory });
-    cli.help();
-    const { options } = cli.parse(process.argv);
-    if (options.help) {
-        return;
-    }
-    cli.globalCommand.checkUnknownOptions();
-    cli.globalCommand.checkOptionValue();
-    cli.globalCommand.checkRequiredArgs();
-    cli.globalCommand.checkUnusedArgs();
-    return options;
+	const cli = cac("ckeditor5-dev-changelog-create-entry");
+	cli.usage("[options]");
+	cli.option("--directory <path>", "Directory where the changelog entry will be created.", { default: DEFAULT_OPTIONS.directory });
+	cli.help();
+	const { options } = cli.parse(process.argv);
+	if (options.help) return;
+	cli.globalCommand.checkUnknownOptions();
+	cli.globalCommand.checkOptionValue();
+	cli.globalCommand.checkRequiredArgs();
+	cli.globalCommand.checkUnusedArgs();
+	return options;
 }
 /**
- * Returns normalized options object for the `generateTemplate` function.
- */
+* Returns normalized options object for the `generateTemplate` function.
+*/
 function normalizeOptions(options) {
-    const normalized = Object.assign({}, DEFAULT_OPTIONS, options);
-    // Ensure that paths are absolute and resolve to the current working directory.
-    normalized.directory = path.resolve(process.cwd(), normalized.directory);
-    return normalized;
+	const normalized = Object.assign({}, DEFAULT_OPTIONS, options);
+	normalized.directory = path.resolve(process.cwd(), normalized.directory);
+	return normalized;
 }
 /**
- * Returns the current git branch name formatted to be used in a filename.
- */
+* Returns the current git branch name formatted to be used in a filename.
+*/
 async function getFormattedGitBranchName() {
-    try {
-        const asyncExec = promisify(exec);
-        const { stdout } = await asyncExec('git rev-parse --abbrev-ref HEAD', { encoding: 'utf8' });
-        return stdout
-            .trim()
-            .replace(/[^a-zA-Z0-9]/g, '_');
-    }
-    catch {
-        console.error(styleText(['red', 'bold'], 'Error: Git is not installed or the current folder is not in git repository.'));
-        process.exit(1);
-    }
+	try {
+		const { stdout } = await promisify(exec)("git rev-parse --abbrev-ref HEAD", { encoding: "utf8" });
+		return stdout.trim().replace(/[^a-zA-Z0-9]/g, "_");
+	} catch {
+		console.error(styleText(["red", "bold"], "Error: Git is not installed or the current folder is not in git repository."));
+		process.exit(1);
+	}
 }
 /**
- * Returns a filename for the template file based on the current date and git branch name.
- * The filename is formatted as `YYYYMMDDHHMMSS_{GIT_BRANCH_NAME}.md`.
- */
+* Returns a filename for the template file based on the current date and git branch name.
+* The filename is formatted as `YYYYMMDDHHMMSS_{GIT_BRANCH_NAME}.md`.
+*/
 function getFileName(gitBranchName) {
-    const date = format(new Date(), 'yyyyMMddHHmmss');
-    return `${date}_${gitBranchName}.md`;
+	return `${format(/* @__PURE__ */ new Date(), "yyyyMMddHHmmss")}_${gitBranchName}.md`;
 }
 /**
- * Generates a template file for the changelog in the specified directory.
- */
+* Generates a template file for the changelog in the specified directory.
+*/
 async function generateTemplate(args = getCliArguments(), retries = 5) {
-    if (!args) {
-        return;
-    }
-    const options = normalizeOptions(args);
-    const gitBranchName = await getFormattedGitBranchName();
-    const filename = getFileName(gitBranchName);
-    const outputPath = path.resolve(options.directory, filename);
-    await mkdir(options.directory, { recursive: true });
-    try {
-        await copyFile(TEMPLATE_FILE, outputPath, constants.COPYFILE_EXCL);
-        const indent = ' '.repeat(2);
-        const relativePath = path.relative(process.cwd(), outputPath);
-        console.log(styleText('green', '◌ The changelog file has been successfully created.'));
-        console.log('');
-        console.log('◌ Please fill it with relevant information about your changes.');
-        console.log(indent + styleText(['cyan', 'bold'], `file://${outputPath}`));
-        console.log('');
-        console.log('◌ Once done, commit the changelog file:');
-        console.log(styleText('gray', indent + styleText('gray', `$ git add ${relativePath}`)));
-        console.log(styleText('gray', indent + styleText('gray', '$ git commit -m "..."')));
-        if (PROTECTED_BRANCHES.includes(gitBranchName)) {
-            console.log('');
-            console.warn(styleText(['red', 'bold'], 'You are on a protected branch!'), styleText('red', 'Consider creating a new branch for your changes.'));
-        }
-    }
-    catch (error) {
-        if (retries <= 0) {
-            console.error(styleText(['red', 'bold'], 'Error: Generating changelog file failed with the following error:'));
-            throw error;
-        }
-        console.error(styleText('gray', 'You are going to fast 🥵 Waiting 1 second to ensure unique changelog name.'));
-        return new Promise(resolve => {
-            setTimeout(() => {
-                resolve(generateTemplate(options, retries - 1));
-            }, 1000);
-        });
-    }
+	if (!args) return;
+	const options = normalizeOptions(args);
+	const gitBranchName = await getFormattedGitBranchName();
+	const filename = getFileName(gitBranchName);
+	const outputPath = path.resolve(options.directory, filename);
+	await mkdir(options.directory, { recursive: true });
+	try {
+		await copyFile(TEMPLATE_FILE, outputPath, constants.COPYFILE_EXCL);
+		const indent = " ".repeat(2);
+		const relativePath = path.relative(process.cwd(), outputPath);
+		console.log(styleText("green", "◌ The changelog file has been successfully created."));
+		console.log("");
+		console.log("◌ Please fill it with relevant information about your changes.");
+		console.log(indent + styleText(["cyan", "bold"], `file://${outputPath}`));
+		console.log("");
+		console.log("◌ Once done, commit the changelog file:");
+		console.log(styleText("gray", indent + styleText("gray", `$ git add ${relativePath}`)));
+		console.log(styleText("gray", indent + styleText("gray", "$ git commit -m \"...\"")));
+		if (PROTECTED_BRANCHES.includes(gitBranchName)) {
+			console.log("");
+			console.warn(styleText(["red", "bold"], "You are on a protected branch!"), styleText("red", "Consider creating a new branch for your changes."));
+		}
+	} catch (error) {
+		if (retries <= 0) {
+			console.error(styleText(["red", "bold"], "Error: Generating changelog file failed with the following error:"));
+			throw error;
+		}
+		console.error(styleText("gray", "You are going to fast 🥵 Waiting 1 second to ensure unique changelog name."));
+		return new Promise((resolve) => {
+			setTimeout(() => {
+				resolve(generateTemplate(options, retries - 1));
+			}, 1e3);
+		});
+	}
 }
-
+//#endregion
 export { generateTemplate };

package/dist/types.d.ts

@@ -1,131 +1,129 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-import type { SECTIONS } from './utils/constants.js';
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md.
+*/
+import type { SECTIONS } from "./utils/constants.js";
 export type ConfigBase = RepositoryConfig & {
-    /**
-     * The next version number to use. If not provided, will be calculated based on changes.
-     * Must be a valid version in terms of the semantic versioning specification.
-     */
-    nextVersion?: string;
-    /**
-     * Array of external repository configurations to include in the changelog.
-     */
-    externalRepositories?: Array<RepositoryConfig>;
-    /**
-     * The date to use for the changelog entry. Defaults to current date in YYYY-MM-DD format.
-     */
-    date?: string;
+	/**
+	* The next version number to use. If not provided, will be calculated based on changes.
+	* Must be a valid version in terms of the semantic versioning specification.
+	*/
+	nextVersion?: string;
+	/**
+	* Array of external repository configurations to include in the changelog.
+	*/
+	externalRepositories?: Array<RepositoryConfig>;
+	/**
+	* The date to use for the changelog entry. Defaults to current date in YYYY-MM-DD format.
+	*/
+	date?: string;
 };
 export type MonoRepoConfigBase = {
-    /**
-     * Function to transform package scopes in the changelog entries.
-     */
-    transformScope?: TransformScope;
-    /**
-     * Whether to include the root package name in the bumped packages versions section in the changelog.
-     */
-    shouldIgnoreRootPackage?: unknown;
-    /**
-     * The package that will be used when determining if the next version is available on npm.
-     */
-    npmPackageToCheck?: unknown;
+	/**
+	* Function to transform package scopes in the changelog entries.
+	*/
+	transformScope?: TransformScope;
+	/**
+	* Whether to include the root package name in the bumped packages versions section in the changelog.
+	*/
+	shouldIgnoreRootPackage?: unknown;
+	/**
+	* The package that will be used when determining if the next version is available on npm.
+	*/
+	npmPackageToCheck?: unknown;
 } & NpmPackageRequiredWhenSkipRootPackage;
 export type RepositoryConfig = {
-    /**
-     * The current working directory of the repository.
-     */
-    cwd: string;
-    /**
-     * The directory containing the packages. Defaults to 'packages'.
-     */
-    packagesDirectory: null | string;
-    /**
-     * Function that decides whether to filter out a link in the changelog entry.
-     * If `shouldSkipLinks` flag is set, the `shouldSkipLinks` flag takes precedence over the `linkFilter` function.
-     * No links are skipped by default.
-     */
-    linkFilter?: LinkFilter;
-    /**
-     * Whether to skip links in the changelog entries. Defaults to false.
-     */
-    shouldSkipLinks?: boolean;
+	/**
+	* The current working directory of the repository.
+	*/
+	cwd: string;
+	/**
+	* The directory containing the packages. Defaults to 'packages'.
+	*/
+	packagesDirectory: null | string;
+	/**
+	* Function that decides whether to filter out a link in the changelog entry.
+	* If `shouldSkipLinks` flag is set, the `shouldSkipLinks` flag takes precedence over the `linkFilter` function.
+	* No links are skipped by default.
+	*/
+	linkFilter?: LinkFilter;
+	/**
+	* Whether to skip links in the changelog entries. Defaults to false.
+	*/
+	shouldSkipLinks?: boolean;
 };
 export type GenerateChangelogEntryPoint<K extends object> = <T extends boolean | undefined = undefined>(config: K & {
-    /**
-     * Controls whether changeset files will be deleted after generating changelog.
-     */
-    disableFilesystemOperations?: T;
+	/**
+	* Controls whether changeset files will be deleted after generating changelog.
+	*/
+	disableFilesystemOperations?: T;
 }) => Promise<T extends true ? string : void>;
 export type SectionName = keyof typeof SECTIONS;
 export type Entry = {
-    message: string;
-    data: {
-        type: string;
-        scope: Array<string>;
-        mainContent: string | undefined;
-        restContent: Array<string>;
-        communityCredits: Array<string>;
-        validations: Array<string>;
-        see: Array<LinkObject>;
-        closes: Array<LinkObject>;
-    };
-    changesetPath: string;
+	message: string;
+	data: {
+		type: string;
+		scope: Array<string>;
+		mainContent: string | undefined;
+		restContent: Array<string>;
+		communityCredits: Array<string>;
+		validations: Array<string>;
+		see: Array<LinkObject>;
+		closes: Array<LinkObject>;
+	};
+	changesetPath: string;
 };
 export type ParsedFile<T = FileMetadata> = {
-    content: string;
-    data: T;
-    changesetPath: string;
-    createdAt: Date;
-    gitHubUrl: string;
-    linkFilter: LinkFilter;
+	content: string;
+	data: T;
+	changesetPath: string;
+	createdAt: Date;
+	gitHubUrl: string;
+	linkFilter: LinkFilter;
 };
 export type Section = {
-    entries: Array<Entry>;
-    title: string;
-    titleInLogs?: string;
-    excludeInChangelog?: boolean;
+	entries: Array<Entry>;
+	title: string;
+	titleInLogs?: string;
+	excludeInChangelog?: boolean;
 };
 export type SectionsWithEntries = Record<SectionName, Section>;
 export type ReleaseInfo = {
-    title: string;
-    version: string;
-    packages: Array<string>;
+	title: string;
+	version: string;
+	packages: Array<string>;
 };
 export type TransformScope = (name: string) => {
-    displayName: string;
-    npmUrl: string;
+	displayName: string;
+	npmUrl: string;
 };
 export type ChangesetPathsWithGithubUrl = {
-    filePaths: Array<string>;
-    gitHubUrl: string;
-    linkFilter: LinkFilter;
-    cwd: string;
-    isRoot: boolean;
+	filePaths: Array<string>;
+	gitHubUrl: string;
+	linkFilter: LinkFilter;
+	cwd: string;
+	isRoot: boolean;
 };
 type NpmPackageRequiredWhenSkipRootPackage = {
-    shouldIgnoreRootPackage?: true;
-    npmPackageToCheck: string;
+	shouldIgnoreRootPackage?: true;
+	npmPackageToCheck: string;
 } | {
-    shouldIgnoreRootPackage?: false;
-    npmPackageToCheck?: never;
+	shouldIgnoreRootPackage?: false;
+	npmPackageToCheck?: never;
 };
 export type LinkObject = {
-    displayName: string;
-    link: string;
+	displayName: string;
+	link: string;
 };
 export type LinkFilter = (resourceUrl: string) => boolean;
 export type FileMetadata = {
-    type: string;
-    scope: Array<string>;
-    closes: Array<string>;
-    see: Array<string>;
-    communityCredits: Array<string>;
-    validations: Array<string>;
+	type: string;
+	scope: Array<string>;
+	closes: Array<string>;
+	see: Array<string>;
+	communityCredits: Array<string>;
+	validations: Array<string>;
 };
-export type ChangelogReleaseType = 'latest' | // e.g. 1.0.0 -> 2.0.0 or 2.0.0-beta.1 -> 2.0.0.
-'prerelease' | // e.g. 1.0.0 -> 2.0.0-alpha.0 or 2.0.0-alpha.0 -> 2.0.0-alpha.1.
-'prerelease-promote';
-export type ReleaseChannel = 'alpha' | 'beta' | 'rc' | 'latest';
+export type ChangelogReleaseType = "latest" | "prerelease" | "prerelease-promote";
+export type ReleaseChannel = "alpha" | "beta" | "rc" | "latest";
 export {};

package/dist/utils/asyncarray.d.ts

@@ -1,35 +1,35 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md.
+*/
 /**
- * A utility class that wraps a Promise of an array and provides async array-like operations.
- */
+* A utility class that wraps a Promise of an array and provides async array-like operations.
+*/
 export declare class AsyncArray<T> {
-    private readonly promise;
-    /**
-     * Creates a new `AsyncArray` instance.
-     */
-    constructor(promise: Promise<Array<T>>);
-    /**
-     * Creates an `AsyncArray` from a given promise.
-     */
-    static from<U>(promise: Promise<Array<U>>): AsyncArray<U>;
-    /**
-     * Asynchronously maps each item in the array using the provided callback.
-     */
-    map<U>(fn: (item: T, index: number, array: Array<T>) => U | Promise<U>): AsyncArray<U>;
-    /**
-     * Flattens one level of nesting in an array of arrays.
-     */
-    flat<U>(this: AsyncArray<Array<U>>): AsyncArray<U>;
-    /**
-     * Maps each item using a callback that returns an array (or promise of an array),
-     * then flattens the result by one level.
-     */
-    flatMap<U>(fn: (item: T, index: number, array: Array<T>) => Array<U> | Promise<Array<U>>): AsyncArray<U>;
-    /**
-     * Allows chaining or awaiting the result of the internal promise.
-     */
-    then<U>(onfulfilled: (value: Array<T>) => U | Promise<U>): Promise<U>;
+	private readonly promise;
+	/**
+	* Creates a new `AsyncArray` instance.
+	*/
+	constructor(promise: Promise<Array<T>>);
+	/**
+	* Creates an `AsyncArray` from a given promise.
+	*/
+	static from<U>(promise: Promise<Array<U>>): AsyncArray<U>;
+	/**
+	* Asynchronously maps each item in the array using the provided callback.
+	*/
+	map<U>(fn: (item: T, index: number, array: Array<T>) => U | Promise<U>): AsyncArray<U>;
+	/**
+	* Flattens one level of nesting in an array of arrays.
+	*/
+	flat<U>(this: AsyncArray<Array<U>>): AsyncArray<U>;
+	/**
+	* Maps each item using a callback that returns an array (or promise of an array),
+	* then flattens the result by one level.
+	*/
+	flatMap<U>(fn: (item: T, index: number, array: Array<T>) => Array<U> | Promise<Array<U>>): AsyncArray<U>;
+	/**
+	* Allows chaining or awaiting the result of the internal promise.
+	*/
+	then<U>(onfulfilled: (value: Array<T>) => U | Promise<U>): Promise<U>;
 }

package/dist/utils/commitchanges.d.ts

@@ -1,8 +1,4 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-import type { ChangesetPathsWithGithubUrl } from '../types.js';
-type RepositoryData = Pick<ChangesetPathsWithGithubUrl, 'cwd' | 'isRoot' | 'filePaths'>;
+import type { ChangesetPathsWithGithubUrl } from "../types.js";
+type RepositoryData = Pick<ChangesetPathsWithGithubUrl, "cwd" | "isRoot" | "filePaths">;
 export declare function commitChanges(version: string, repositories: Array<RepositoryData>): Promise<void>;
 export {};

package/dist/utils/composechangelog.d.ts

@@ -1,24 +1,20 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md.
- */
-import type { ReleaseInfo, Section } from '../types.js';
+import type { ReleaseInfo, Section } from "../types.js";
 export type ComposeChangelogOptions = {
-    cwd: string;
-    date: string;
-    currentVersion: string;
-    newVersion: string;
-    sections: Array<Section>;
-    releasedPackagesInfo: Array<ReleaseInfo>;
-    isSinglePackage: boolean;
+	cwd: string;
+	date: string;
+	currentVersion: string;
+	newVersion: string;
+	sections: Array<Section>;
+	releasedPackagesInfo: Array<ReleaseInfo>;
+	isSinglePackage: boolean;
 };
 /**
- * Generates a formatted changelog string for a new version release.
- *
- * This function constructs the changelog content including
- * * A version header with a link to the GitHub comparison view (except for an initial version).
- * * Sections with grouped changelog entries and their messages.
- * * A collapsible summary of released packages and their version bumps for a mono-repository setup.
- * * Special handling for single-package repositories.
- */
+* Generates a formatted changelog string for a new version release.
+*
+* This function constructs the changelog content including
+* * A version header with a link to the GitHub comparison view (except for an initial version).
+* * Sections with grouped changelog entries and their messages.
+* * A collapsible summary of released packages and their version bumps for a mono-repository setup.
+* * Special handling for single-package repositories.
+*/
 export declare function composeChangelog(options: ComposeChangelogOptions): Promise<string>;