@ckeditor/ckeditor5-dev-changelog 51.0.0 → 51.1.0

package/dist/index.js

@@ -188,14 +188,16 @@ function groupEntriesBySection(options) {
     return files.reduce((sections, entry) => {
         const { validatedEntry, isValid } = validateEntry(entry, packageNames, isSinglePackage);
         const validatedData = validatedEntry.data;
+        const closesLinks = filterLinks(validatedData.closes, validatedEntry);
+        const closes = getIssuesLinks(closesLinks, 'Closes');
+        const seeLinks = filterLinks(validatedData.see, validatedEntry);
+        const see = getIssuesLinks(seeLinks, 'See');
         const scope = isSinglePackage ? null : getScopesLinks(validatedData.scope, transformScope);
-        const closes = getIssuesLinks(validatedData.closes, 'Closes', validatedEntry.gitHubUrl);
-        const see = getIssuesLinks(validatedData.see, 'See', validatedEntry.gitHubUrl);
         const section = getSection({ entry: validatedEntry, isSinglePackage, isValid });
         const contentWithCommunityCredits = getContentWithCommunityCredits(validatedEntry.content, validatedData.communityCredits);
         const content = linkToGitHubUser(contentWithCommunityCredits);
         const [mainContent, ...restContent] = formatContent(content);
-        const changeMessage = getChangeMessage({ restContent, scope, mainContent, entry, see, closes });
+        const changeMessage = getChangeMessage({ restContent, scope, mainContent, see, closes });
         const newEntry = {
             message: changeMessage,
             data: {
@@ -203,8 +205,8 @@ function groupEntriesBySection(options) {
                 restContent,
                 type: validatedData.type,
                 scope: validatedData.scope,
-                see: validatedData.see.map(see => getIssueLinkObject(see, validatedEntry.gitHubUrl)),
-                closes: validatedData.closes.map(closes => getIssueLinkObject(closes, validatedEntry.gitHubUrl)),
+                see: seeLinks,
+                closes: closesLinks,
                 validations: validatedData.validations,
                 communityCredits: validatedData.communityCredits
             },
@@ -217,13 +219,18 @@ function groupEntriesBySection(options) {
         return sections;
     }, getInitialSectionsWithEntries());
 }
-function getChangeMessage({ restContent, scope, mainContent, entry, see, closes }) {
+function filterLinks(links, entry) {
+    return links
+        .map(link => getIssueLinkObject(link, entry.gitHubUrl))
+        .filter(({ link }) => entry.linkFilter(link));
+}
+function getChangeMessage({ restContent, scope, mainContent, see, closes }) {
     const messageFirstLine = [
         '*',
         scope ? `**${scope}**:` : null,
         mainContent,
-        !entry.shouldSkipLinks && see.length ? see : null,
-        !entry.shouldSkipLinks && closes.length ? closes : null
+        see.length ? see : null,
+        closes.length ? closes : null
     ].filter(Boolean).join(' ');
     if (!restContent || !restContent.length) {
         return messageFirstLine;
@@ -238,7 +245,8 @@ function getChangeMessage({ restContent, scope, mainContent, entry, see, closes
 function formatContent(content) {
     const lines = content.trim()
         .split('\n')
-        .map(line => line.trimEnd());
+        .map(line => line.trimEnd())
+        .map(line => normalizeListMarker(line));
     const mainIndex = lines.findIndex(line => line.trim() !== '');
     const mainContent = lines.at(mainIndex);
     let restContent = lines.slice(mainIndex + 1);
@@ -290,14 +298,11 @@ function getIssueLinkObject(issue, gitHubUrl) {
     }
     return { displayName: '', link: '' };
 }
-function getIssuesLinks(issues, prefix, gitHubUrl) {
+function getIssuesLinks(issues, prefix) {
     if (!issues.length) {
         return '';
     }
-    const links = issues.map(String).map(issue => {
-        const { displayName, link } = getIssueLinkObject(issue, gitHubUrl);
-        return `[${displayName}](${link})`;
-    });
+    const links = issues.map(issue => `[${issue.displayName}](${issue.link})`);
     return `${prefix} ${links.join(', ')}.`;
 }
 function getSection(options) {
@@ -329,6 +334,10 @@ function getInitialSectionsWithEntries() {
     }
     return sections;
 }
+function normalizeListMarker(line) {
+    const listMarkerRegexp = /^(\s*)[-+](\s*)/;
+    return line.replace(listMarkerRegexp, '$1*$2');
+}
 
 /**
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
@@ -900,7 +909,7 @@ function getPackageName(value) {
  * Gathers changelog entry file paths (Markdown files) from the main repository and any configured external repositories.
  */
 async function findChangelogEntryPaths(options) {
-    const { cwd, externalRepositories, shouldSkipLinks, includeSubdirectories = true } = options;
+    const { cwd, externalRepositories, includeSubdirectories = true } = options;
     const globPattern = includeSubdirectories ? '**/*.md' : '*.md';
     return AsyncArray
         .from(Promise.resolve(externalRepositories))
@@ -912,7 +921,7 @@ async function findChangelogEntryPaths(options) {
         return {
             filePaths: changesetGlob.map(p => upath.normalize(p)),
             gitHubUrl: await workspaces.getRepositoryUrl(repo.cwd, { async: true }),
-            shouldSkipLinks: !!repo.shouldSkipLinks,
+            linkFilter: getLinkFilter(repo),
             cwd: repo.cwd,
             isRoot: false
         };
@@ -925,13 +934,19 @@ async function findChangelogEntryPaths(options) {
         const mainEntry = {
             filePaths: mainChangesetGlob.map(p => upath.normalize(p)),
             gitHubUrl: await workspaces.getRepositoryUrl(cwd, { async: true }),
-            shouldSkipLinks,
+            linkFilter: getLinkFilter(options),
             cwd,
             isRoot: true
         };
         return [mainEntry, ...externalResults];
     });
 }
+function getLinkFilter(options) {
+    if (typeof options.shouldSkipLinks === 'boolean') {
+        return () => !options.shouldSkipLinks;
+    }
+    return options.linkFilter || (() => true);
+}
 
 /**
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
@@ -1037,19 +1052,19 @@ function toArray(input) {
  * Reads and processes input files to extract changelog entries.
  */
 function parseChangelogEntries(entryPaths, isSinglePackage) {
-    const fileEntries = entryPaths.reduce((acc, { filePaths, gitHubUrl, shouldSkipLinks }) => {
+    const fileEntries = entryPaths.reduce((acc, { filePaths, gitHubUrl, linkFilter }) => {
         for (const changesetPath of filePaths) {
-            acc.push({ changesetPath, gitHubUrl, shouldSkipLinks });
+            acc.push({ changesetPath, gitHubUrl, linkFilter });
         }
         return acc;
     }, []);
     return AsyncArray
         .from(Promise.resolve(fileEntries))
-        .map(async ({ changesetPath, gitHubUrl, shouldSkipLinks }) => ({
+        .map(async ({ changesetPath, gitHubUrl, linkFilter }) => ({
         ...matter(await fs$1.readFile(changesetPath, 'utf-8')),
         gitHubUrl,
         changesetPath,
-        shouldSkipLinks,
+        linkFilter,
         createdAt: extractDateFromFilename(changesetPath)
     }))
         .map(entry => normalizeEntry(entry, isSinglePackage))
@@ -1307,7 +1322,7 @@ function getReleaseType(currentVersion, nextVersion) {
  * and the assembled changelog object will be returned instead.
  */
 const main = async (options) => {
-    const { nextVersion, packagesDirectory, isSinglePackage, transformScope, npmPackageToCheck, cwd = process.cwd(), externalRepositories = [], date = format(new Date(), 'yyyy-MM-dd'), shouldSkipLinks = false, shouldIgnoreRootPackage = false, disableFilesystemOperations = false } = options;
+    const { nextVersion, packagesDirectory, isSinglePackage, transformScope, npmPackageToCheck, linkFilter, shouldSkipLinks, cwd = process.cwd(), externalRepositories = [], date = format(new Date(), 'yyyy-MM-dd'), shouldIgnoreRootPackage = false, disableFilesystemOperations = false } = options;
     const { version: currentVersion, name: rootPackageName } = await workspaces.getPackageJson(cwd, { async: true });
     const packagesMetadata = await findPackages({
         cwd,
@@ -1319,6 +1334,7 @@ const main = async (options) => {
     const entryPaths = await findChangelogEntryPaths({
         cwd,
         externalRepositories,
+        linkFilter,
         shouldSkipLinks,
         includeSubdirectories: releaseType === 'latest' || releaseType === 'prerelease-promote'
     });
@@ -1422,7 +1438,7 @@ function isExpectedError(error) {
  * For licensing, see LICENSE.md.
  */
 const generateChangelogForMonoRepository = async (options) => {
-    const { date, cwd, externalRepositories, nextVersion, disableFilesystemOperations, npmPackageToCheck, packagesDirectory, shouldSkipLinks, shouldIgnoreRootPackage, transformScope } = options;
+    const { date, cwd, externalRepositories, nextVersion, disableFilesystemOperations, npmPackageToCheck, packagesDirectory, linkFilter, shouldSkipLinks, shouldIgnoreRootPackage, transformScope } = options;
     return generateChangelog({
         nextVersion,
         cwd,
@@ -1430,6 +1446,7 @@ const generateChangelogForMonoRepository = async (options) => {
         externalRepositories,
         transformScope,
         date,
+        linkFilter,
         shouldSkipLinks,
         disableFilesystemOperations,
         ...(shouldIgnoreRootPackage && npmPackageToCheck ?
@@ -1444,12 +1461,13 @@ const generateChangelogForMonoRepository = async (options) => {
  * For licensing, see LICENSE.md.
  */
 const generateChangelogForSingleRepository = async (options) => {
-    const { cwd, date, externalRepositories, nextVersion, disableFilesystemOperations, shouldSkipLinks } = options;
+    const { cwd, date, externalRepositories, nextVersion, disableFilesystemOperations, linkFilter, shouldSkipLinks } = options;
     return generateChangelog({
         nextVersion,
         cwd,
         externalRepositories,
         date,
+        linkFilter,
         shouldSkipLinks,
         disableFilesystemOperations,
         isSinglePackage: true,

package/dist/types.d.ts

@@ -41,6 +41,12 @@ export type RepositoryConfig = {
      * 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.
      */
@@ -73,7 +79,7 @@ export type ParsedFile<T = FileMetadata> = {
     changesetPath: string;
     createdAt: Date;
     gitHubUrl: string;
-    shouldSkipLinks: boolean;
+    linkFilter: LinkFilter;
 };
 export type Section = {
     entries: Array<Entry>;
@@ -94,7 +100,7 @@ export type TransformScope = (name: string) => {
 export type ChangesetPathsWithGithubUrl = {
     filePaths: Array<string>;
     gitHubUrl: string;
-    shouldSkipLinks: boolean;
+    linkFilter: LinkFilter;
     cwd: string;
     isRoot: boolean;
 };
@@ -109,6 +115,7 @@ export type LinkObject = {
     displayName: string;
     link: string;
 };
+export type LinkFilter = (resourceUrl: string) => boolean;
 export type FileMetadata = {
     type: string;
     scope: Array<string>;

package/dist/utils/findchangelogentrypaths.d.ts

@@ -2,11 +2,12 @@
  * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
  */
-import type { ChangesetPathsWithGithubUrl, RepositoryConfig } from '../types.js';
+import type { ChangesetPathsWithGithubUrl, LinkFilter, RepositoryConfig } from '../types.js';
 type FindChangelogEntryPathsOptions = {
     cwd: string;
     externalRepositories: Array<RepositoryConfig>;
-    shouldSkipLinks: boolean;
+    linkFilter?: LinkFilter;
+    shouldSkipLinks?: boolean;
     includeSubdirectories?: boolean;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-dev-changelog",
-  "version": "51.0.0",
+  "version": "51.1.0",
   "description": "A CKEditor 5 development tool for handling changelogs.",
   "keywords": [],
   "author": "CKSource (http://cksource.com/)",
@@ -28,7 +28,7 @@
     "ckeditor5-dev-changelog-create-entry": "bin/generate-template.js"
   },
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^51.0.0",
+    "@ckeditor/ckeditor5-dev-utils": "^51.1.0",
     "chalk": "^5.0.0",
     "date-fns": "^4.0.0",
     "fs-extra": "^11.0.0",