@releasekit/notes 0.2.0 → 0.3.0-next.1

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 (12) hide show
  1. package/README.md +1 -1
  2. package/dist/aggregator-BDTUZWOA.js +13 -0
  3. package/dist/chunk-H7G2HRHI.js +134 -0
  4. package/dist/{chunk-DGZ6TM5J.js → chunk-LKJLUB7X.js} +133 -356
  5. package/dist/chunk-O4VCGEZT.js +147 -0
  6. package/dist/cli.cjs +383 -328
  7. package/dist/cli.js +6 -27
  8. package/dist/index.cjs +385 -309
  9. package/dist/index.d.cts +11 -4
  10. package/dist/index.d.ts +11 -4
  11. package/dist/index.js +12 -6
  12. package/package.json +2 -2
package/dist/index.d.cts CHANGED
@@ -152,8 +152,14 @@ interface CompleteOptions {
152
152
  }
153
153
 
154
154
  declare function createTemplateContext(pkg: PackageChangelog): TemplateContext;
155
- declare function runPipeline(input: ChangelogInput, config: Config, dryRun: boolean): Promise<void>;
156
- declare function processInput(inputJson: string, config: Config, dryRun: boolean): Promise<void>;
155
+ interface PipelineResult {
156
+ /** Per-package rendered markdown keyed by package name. */
157
+ packageNotes: Record<string, string>;
158
+ /** File paths that were written to disk. */
159
+ files: string[];
160
+ }
161
+ declare function runPipeline(input: ChangelogInput, config: Config, dryRun: boolean): Promise<PipelineResult>;
162
+ declare function processInput(inputJson: string, config: Config, dryRun: boolean): Promise<PipelineResult>;
157
163
 
158
164
  declare abstract class NotesError extends ReleaseKitError {
159
165
  }
@@ -193,7 +199,7 @@ declare function aggregateToRoot(contexts: TemplateContext[]): TemplateContext;
193
199
 
194
200
  declare function writeMonorepoChangelogs(contexts: TemplateContext[], options: MonorepoOptions, config: {
195
201
  updateStrategy?: 'prepend' | 'regenerate';
196
- }, dryRun: boolean): void;
202
+ }, dryRun: boolean): string[];
197
203
  declare function detectMonorepo(cwd: string): {
198
204
  isMonorepo: boolean;
199
205
  packagesPath: string;
@@ -202,7 +208,8 @@ declare function detectMonorepo(cwd: string): {
202
208
  declare function renderJson(contexts: TemplateContext[]): string;
203
209
  declare function writeJson(outputPath: string, contexts: TemplateContext[], dryRun: boolean): void;
204
210
 
211
+ declare function formatVersion(context: TemplateContext): string;
205
212
  declare function renderMarkdown(contexts: TemplateContext[]): string;
206
213
  declare function writeMarkdown(outputPath: string, contexts: TemplateContext[], config: Config, dryRun: boolean): void;
207
214
 
208
- export { NotesError as ChangelogCreatorError, type ChangelogEntry, type ChangelogInput, type ChangelogType, type CompleteOptions, type Config, ConfigError, type DocumentContext, type EnhancedData, GitHubError, InputParseError, type InputSource, type LLMCategory, type LLMConfig, LLMError, type LLMOptions, type LLMPromptOverrides, type LLMPromptsConfig, type MonorepoConfig, type MonorepoMode, NotesError, type OutputConfig, type OutputFormat, type PackageChangelog, type RetryOptions, type ScopeConfig, type ScopeRules, type TemplateConfig, type TemplateContext, type TemplateEngine, TemplateError, type UpdateStrategy, aggregateToRoot, createTemplateContext, detectMonorepo, getDefaultConfig, getExitCode, loadConfig, parsePackageVersioner, parsePackageVersionerFile, parsePackageVersionerStdin, processInput, renderJson, renderMarkdown, runPipeline, writeJson, writeMarkdown, writeMonorepoChangelogs };
215
+ export { NotesError as ChangelogCreatorError, type ChangelogEntry, type ChangelogInput, type ChangelogType, type CompleteOptions, type Config, ConfigError, type DocumentContext, type EnhancedData, GitHubError, InputParseError, type InputSource, type LLMCategory, type LLMConfig, LLMError, type LLMOptions, type LLMPromptOverrides, type LLMPromptsConfig, type MonorepoConfig, type MonorepoMode, NotesError, type OutputConfig, type OutputFormat, type PackageChangelog, type PipelineResult, type RetryOptions, type ScopeConfig, type ScopeRules, type TemplateConfig, type TemplateContext, type TemplateEngine, TemplateError, type UpdateStrategy, aggregateToRoot, createTemplateContext, detectMonorepo, formatVersion, getDefaultConfig, getExitCode, loadConfig, parsePackageVersioner, parsePackageVersionerFile, parsePackageVersionerStdin, processInput, renderJson, renderMarkdown, runPipeline, writeJson, writeMarkdown, writeMonorepoChangelogs };
package/dist/index.d.ts CHANGED
@@ -152,8 +152,14 @@ interface CompleteOptions {
152
152
  }
153
153
 
154
154
  declare function createTemplateContext(pkg: PackageChangelog): TemplateContext;
155
- declare function runPipeline(input: ChangelogInput, config: Config, dryRun: boolean): Promise<void>;
156
- declare function processInput(inputJson: string, config: Config, dryRun: boolean): Promise<void>;
155
+ interface PipelineResult {
156
+ /** Per-package rendered markdown keyed by package name. */
157
+ packageNotes: Record<string, string>;
158
+ /** File paths that were written to disk. */
159
+ files: string[];
160
+ }
161
+ declare function runPipeline(input: ChangelogInput, config: Config, dryRun: boolean): Promise<PipelineResult>;
162
+ declare function processInput(inputJson: string, config: Config, dryRun: boolean): Promise<PipelineResult>;
157
163
 
158
164
  declare abstract class NotesError extends ReleaseKitError {
159
165
  }
@@ -193,7 +199,7 @@ declare function aggregateToRoot(contexts: TemplateContext[]): TemplateContext;
193
199
 
194
200
  declare function writeMonorepoChangelogs(contexts: TemplateContext[], options: MonorepoOptions, config: {
195
201
  updateStrategy?: 'prepend' | 'regenerate';
196
- }, dryRun: boolean): void;
202
+ }, dryRun: boolean): string[];
197
203
  declare function detectMonorepo(cwd: string): {
198
204
  isMonorepo: boolean;
199
205
  packagesPath: string;
@@ -202,7 +208,8 @@ declare function detectMonorepo(cwd: string): {
202
208
  declare function renderJson(contexts: TemplateContext[]): string;
203
209
  declare function writeJson(outputPath: string, contexts: TemplateContext[], dryRun: boolean): void;
204
210
 
211
+ declare function formatVersion(context: TemplateContext): string;
205
212
  declare function renderMarkdown(contexts: TemplateContext[]): string;
206
213
  declare function writeMarkdown(outputPath: string, contexts: TemplateContext[], config: Config, dryRun: boolean): void;
207
214
 
208
- export { NotesError as ChangelogCreatorError, type ChangelogEntry, type ChangelogInput, type ChangelogType, type CompleteOptions, type Config, ConfigError, type DocumentContext, type EnhancedData, GitHubError, InputParseError, type InputSource, type LLMCategory, type LLMConfig, LLMError, type LLMOptions, type LLMPromptOverrides, type LLMPromptsConfig, type MonorepoConfig, type MonorepoMode, NotesError, type OutputConfig, type OutputFormat, type PackageChangelog, type RetryOptions, type ScopeConfig, type ScopeRules, type TemplateConfig, type TemplateContext, type TemplateEngine, TemplateError, type UpdateStrategy, aggregateToRoot, createTemplateContext, detectMonorepo, getDefaultConfig, getExitCode, loadConfig, parsePackageVersioner, parsePackageVersionerFile, parsePackageVersionerStdin, processInput, renderJson, renderMarkdown, runPipeline, writeJson, writeMarkdown, writeMonorepoChangelogs };
215
+ export { NotesError as ChangelogCreatorError, type ChangelogEntry, type ChangelogInput, type ChangelogType, type CompleteOptions, type Config, ConfigError, type DocumentContext, type EnhancedData, GitHubError, InputParseError, type InputSource, type LLMCategory, type LLMConfig, LLMError, type LLMOptions, type LLMPromptOverrides, type LLMPromptsConfig, type MonorepoConfig, type MonorepoMode, NotesError, type OutputConfig, type OutputFormat, type PackageChangelog, type PipelineResult, type RetryOptions, type ScopeConfig, type ScopeRules, type TemplateConfig, type TemplateContext, type TemplateEngine, TemplateError, type UpdateStrategy, aggregateToRoot, createTemplateContext, detectMonorepo, formatVersion, getDefaultConfig, getExitCode, loadConfig, parsePackageVersioner, parsePackageVersionerFile, parsePackageVersionerStdin, processInput, renderJson, renderMarkdown, runPipeline, writeJson, writeMarkdown, writeMonorepoChangelogs };
package/dist/index.js CHANGED
@@ -6,9 +6,7 @@ import {
6
6
  LLMError,
7
7
  NotesError,
8
8
  TemplateError,
9
- aggregateToRoot,
10
9
  createTemplateContext,
11
- detectMonorepo,
12
10
  getDefaultConfig,
13
11
  getExitCode,
14
12
  loadAuth,
@@ -18,13 +16,20 @@ import {
18
16
  parsePackageVersionerStdin,
19
17
  processInput,
20
18
  renderJson,
21
- renderMarkdown,
22
19
  runPipeline,
23
20
  saveAuth,
24
- writeJson,
25
- writeMarkdown,
21
+ writeJson
22
+ } from "./chunk-LKJLUB7X.js";
23
+ import {
24
+ aggregateToRoot,
25
+ detectMonorepo,
26
26
  writeMonorepoChangelogs
27
- } from "./chunk-DGZ6TM5J.js";
27
+ } from "./chunk-O4VCGEZT.js";
28
+ import {
29
+ formatVersion,
30
+ renderMarkdown,
31
+ writeMarkdown
32
+ } from "./chunk-H7G2HRHI.js";
28
33
  export {
29
34
  NotesError as ChangelogCreatorError,
30
35
  ConfigError,
@@ -37,6 +42,7 @@ export {
37
42
  aggregateToRoot,
38
43
  createTemplateContext,
39
44
  detectMonorepo,
45
+ formatVersion,
40
46
  getDefaultConfig,
41
47
  getExitCode,
42
48
  loadAuth,
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@releasekit/notes",
3
- "version": "0.2.0",
4
- "description": "Changelog generation with LLM-powered enhancement and flexible templating",
3
+ "version": "0.3.0-next.1",
4
+ "description": "Release notes and changelog generation with LLM-powered enhancement and flexible templating",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
7
7
  "module": "./dist/index.js",