@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.
Files changed (36) hide show
  1. package/LICENSE.md +16 -0
  2. package/README.md +46 -0
  3. package/bin/generate-template.js +12 -0
  4. package/dist/index.d.ts +7 -0
  5. package/dist/index.js +1284 -0
  6. package/dist/tasks/generatechangelogformonorepository.d.ts +11 -0
  7. package/dist/tasks/generatechangelogforsinglerepository.d.ts +8 -0
  8. package/dist/template.d.ts +20 -0
  9. package/dist/template.js +108 -0
  10. package/dist/types.d.ts +120 -0
  11. package/dist/utils/asyncarray.d.ts +35 -0
  12. package/dist/utils/commitchanges.d.ts +8 -0
  13. package/dist/utils/composechangelog.d.ts +27 -0
  14. package/dist/utils/composereleasesummary.d.ts +23 -0
  15. package/dist/utils/constants.d.ts +56 -0
  16. package/dist/utils/determinenextversion.d.ts +26 -0
  17. package/dist/utils/displaychanges.d.ts +22 -0
  18. package/dist/utils/filtervisiblesections.d.ts +13 -0
  19. package/dist/utils/findchangelogentrypaths.d.ts +15 -0
  20. package/dist/utils/findpackages.d.ts +16 -0
  21. package/dist/utils/generatechangelog.d.ts +18 -0
  22. package/dist/utils/getdateformatted.d.ts +8 -0
  23. package/dist/utils/groupentriesbysection.d.ts +16 -0
  24. package/dist/utils/internalerror.d.ts +10 -0
  25. package/dist/utils/linktogithubuser.d.ts +11 -0
  26. package/dist/utils/loginfo.d.ts +12 -0
  27. package/dist/utils/modifychangelog.d.ts +11 -0
  28. package/dist/utils/normalizeentry.d.ts +6 -0
  29. package/dist/utils/parsechangelogentries.d.ts +9 -0
  30. package/dist/utils/providenewversion.d.ts +21 -0
  31. package/dist/utils/removechangelogentryfiles.d.ts +10 -0
  32. package/dist/utils/sortentriesbyscopeanddate.d.ts +12 -0
  33. package/dist/utils/truncatechangelog.d.ts +8 -0
  34. package/dist/utils/useraborterror.d.ts +9 -0
  35. package/dist/utils/validateentry.d.ts +17 -0
  36. package/package.json +40 -0
package/LICENSE.md ADDED
@@ -0,0 +1,16 @@
1
+ Software License Agreement
2
+ ==========================
3
+
4
+ Copyright (c) 2003-2025, [CKSource](http://cksource.com) Holding sp. z o.o. All rights reserved.
5
+
6
+ Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
7
+
8
+ Sources of Intellectual Property Included in CKEditor
9
+ -----------------------------------------------------
10
+
11
+ Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
12
+
13
+ Trademarks
14
+ ----------
15
+
16
+ **CKEditor** is a trademark of [CKSource](http://cksource.com) Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
package/README.md ADDED
@@ -0,0 +1,46 @@
1
+ CKEditor 5 Changelog
2
+ ====================
3
+
4
+ [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-dev-changelog.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-dev-changelog)
5
+ [![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5-dev.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5-dev?branch=master)
6
+
7
+ A development tool for handling the changelog preparation in CKEditor 5.
8
+
9
+ ## Installation
10
+
11
+ Install the package to use it.
12
+
13
+ ```
14
+ npm i --save-dev @ckeditor/ckeditor5-dev-changelog
15
+ ```
16
+
17
+ ## API
18
+
19
+ This package provides a command-line interface (CLI) and a JavaScript API for generating changelogs.
20
+
21
+ ### Binary scripts
22
+
23
+ The `ckeditor5-dev-changelog-create-entry` script allows you to create a new changelog entry. By default, it will be created in the
24
+ `.changelog/` directory.
25
+
26
+ ### JavaScript API
27
+
28
+ The JavaScript/TypeScript API can be used as follows:
29
+
30
+ ```ts
31
+ import { generateChangelogForMonoRepository, generateChangelogForSingleRepository } from '@ckeditor/ckeditor5-dev-changelog';
32
+
33
+ await generateChangelogForMonoRepository( { /* options */ } );
34
+ await generateChangelogForSingleRepository( { /* options */ } );
35
+ ```
36
+
37
+ Review the types to see the available options.
38
+
39
+ ## Changelog
40
+
41
+ See the [`CHANGELOG.md`](https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-changelog/CHANGELOG.md) file.
42
+
43
+ ## License
44
+
45
+ Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about
46
+ the license, please check the `LICENSE.md` file.
@@ -0,0 +1,12 @@
1
+ #!/usr/bin/env node
2
+
3
+ /**
4
+ * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
5
+ * For licensing, see LICENSE.md.
6
+ */
7
+
8
+ 'use strict';
9
+
10
+ import { generateTemplate } from '@ckeditor/ckeditor5-dev-changelog/dist/template.js';
11
+
12
+ await generateTemplate();
@@ -0,0 +1,7 @@
1
+ /**
2
+ * @license Copyright (c) 2003-2025, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md.
4
+ */
5
+ export { generateChangelogForMonoRepository } from './tasks/generatechangelogformonorepository.js';
6
+ export { generateChangelogForSingleRepository } from './tasks/generatechangelogforsinglerepository.js';
7
+ export type { ConfigBase, MonoRepoConfigBase, RepositoryConfig } from './types.js';