@ckeditor/ckeditor5-dev-changelog 50.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +16 -0
- package/README.md +46 -0
- package/bin/generate-template.js +12 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +1284 -0
- package/dist/tasks/generatechangelogformonorepository.d.ts +11 -0
- package/dist/tasks/generatechangelogforsinglerepository.d.ts +8 -0
- package/dist/template.d.ts +20 -0
- package/dist/template.js +108 -0
- package/dist/types.d.ts +120 -0
- package/dist/utils/asyncarray.d.ts +35 -0
- package/dist/utils/commitchanges.d.ts +8 -0
- package/dist/utils/composechangelog.d.ts +27 -0
- package/dist/utils/composereleasesummary.d.ts +23 -0
- package/dist/utils/constants.d.ts +56 -0
- package/dist/utils/determinenextversion.d.ts +26 -0
- package/dist/utils/displaychanges.d.ts +22 -0
- package/dist/utils/filtervisiblesections.d.ts +13 -0
- package/dist/utils/findchangelogentrypaths.d.ts +15 -0
- package/dist/utils/findpackages.d.ts +16 -0
- package/dist/utils/generatechangelog.d.ts +18 -0
- package/dist/utils/getdateformatted.d.ts +8 -0
- package/dist/utils/groupentriesbysection.d.ts +16 -0
- package/dist/utils/internalerror.d.ts +10 -0
- package/dist/utils/linktogithubuser.d.ts +11 -0
- package/dist/utils/loginfo.d.ts +12 -0
- package/dist/utils/modifychangelog.d.ts +11 -0
- package/dist/utils/normalizeentry.d.ts +6 -0
- package/dist/utils/parsechangelogentries.d.ts +9 -0
- package/dist/utils/providenewversion.d.ts +21 -0
- package/dist/utils/removechangelogentryfiles.d.ts +10 -0
- package/dist/utils/sortentriesbyscopeanddate.d.ts +12 -0
- package/dist/utils/truncatechangelog.d.ts +8 -0
- package/dist/utils/useraborterror.d.ts +9 -0
- package/dist/utils/validateentry.d.ts +17 -0
- package/package.json +40 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
import type { ChangesetPathsWithGithubUrl } from '../types.js';
|
|
6
|
+
/**
|
|
7
|
+
* Cleans up the input files that have been incorporated into the changelog by deleting them
|
|
8
|
+
* and removing any resulting empty directories both in the current repository and in any external repositories.
|
|
9
|
+
*/
|
|
10
|
+
export declare function removeChangelogEntryFiles(entryPaths: Array<ChangesetPathsWithGithubUrl>): Promise<void>;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
import type { ParsedFile } from '../types.js';
|
|
6
|
+
/**
|
|
7
|
+
* Sorts parsed files according to the rules:
|
|
8
|
+
* 1. Entries with more scopes at the top.
|
|
9
|
+
* 2. Entries with single scope grouped by scope and sorted by date within a group.
|
|
10
|
+
* 3. Entries with no scope at the bottom.
|
|
11
|
+
*/
|
|
12
|
+
export declare function sortEntriesByScopeAndDate(entries: Array<ParsedFile>): Array<ParsedFile>;
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* This function limits the size of the changelog by removing older entries.
|
|
7
|
+
*/
|
|
8
|
+
export declare function truncateChangelog(length: number, cwd: string): void;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
/**
|
|
6
|
+
* Custom error class for handling a case when a user aborts the process (at any stage).
|
|
7
|
+
*/
|
|
8
|
+
export declare class UserAbortError extends Error {
|
|
9
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
|
|
3
|
+
* For licensing, see LICENSE.md.
|
|
4
|
+
*/
|
|
5
|
+
import type { ParsedFile } from '../types.js';
|
|
6
|
+
/**
|
|
7
|
+
* Validates a changelog entry against expected types, scopes, and issue references.
|
|
8
|
+
*
|
|
9
|
+
* It checks if the type is valid and consistent with single or multi-package modes,
|
|
10
|
+
* verifies scopes against known package names, and ensures issue references are correctly formatted.
|
|
11
|
+
*
|
|
12
|
+
* Returns whether the entry is valid along with a validated version including any validation messages.
|
|
13
|
+
*/
|
|
14
|
+
export declare function validateEntry(entry: ParsedFile, packagesNames: Array<string>, singlePackage: boolean): {
|
|
15
|
+
isValid: boolean;
|
|
16
|
+
validatedEntry: ParsedFile;
|
|
17
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@ckeditor/ckeditor5-dev-changelog",
|
|
3
|
+
"version": "50.1.0",
|
|
4
|
+
"description": "A CKEditor 5 development tool for handling changelogs.",
|
|
5
|
+
"keywords": [],
|
|
6
|
+
"author": "CKSource (http://cksource.com/)",
|
|
7
|
+
"license": "GPL-2.0-or-later",
|
|
8
|
+
"homepage": "https://github.com/ckeditor/ckeditor5-dev/tree/master/packages/ckeditor5-dev-changelog",
|
|
9
|
+
"bugs": "https://github.com/ckeditor/ckeditor5/issues",
|
|
10
|
+
"repository": {
|
|
11
|
+
"type": "git",
|
|
12
|
+
"url": "https://github.com/ckeditor/ckeditor5-dev.git",
|
|
13
|
+
"directory": "packages/ckeditor5-dev-changelog"
|
|
14
|
+
},
|
|
15
|
+
"engines": {
|
|
16
|
+
"node": ">=20.0.0",
|
|
17
|
+
"npm": ">=5.7.1"
|
|
18
|
+
},
|
|
19
|
+
"type": "module",
|
|
20
|
+
"main": "dist/index.js",
|
|
21
|
+
"types": "dist/index.d.ts",
|
|
22
|
+
"files": [
|
|
23
|
+
"bin",
|
|
24
|
+
"dist"
|
|
25
|
+
],
|
|
26
|
+
"bin": {
|
|
27
|
+
"ckeditor5-dev-changelog-create-entry": "bin/generate-template.js"
|
|
28
|
+
},
|
|
29
|
+
"dependencies": {
|
|
30
|
+
"@ckeditor/ckeditor5-dev-utils": "^50.1.0",
|
|
31
|
+
"chalk": "^5.0.0",
|
|
32
|
+
"date-fns": "^4.0.0",
|
|
33
|
+
"fs-extra": "^11.0.0",
|
|
34
|
+
"glob": "^11.0.2",
|
|
35
|
+
"gray-matter": "^4.0.3",
|
|
36
|
+
"inquirer": "^12.5.2",
|
|
37
|
+
"semver": "^7.6.3",
|
|
38
|
+
"upath": "^2.0.1"
|
|
39
|
+
}
|
|
40
|
+
}
|