@releasekit/notes 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,177 @@
+import { NotesConfig } from '@releasekit/config';
+export { loadAuth, saveAuth } from '@releasekit/config';
+import { ReleaseKitError } from '@releasekit/core';
+export { EXIT_CODES } from '@releasekit/core';
+
+declare function loadConfig(projectDir?: string, configFile?: string): NotesConfig;
+declare function getDefaultConfig(): NotesConfig;
+
+interface RetryOptions {
+    maxAttempts?: number;
+    initialDelay?: number;
+    maxDelay?: number;
+    backoffFactor?: number;
+}
+
+type ChangelogType = 'added' | 'changed' | 'deprecated' | 'removed' | 'fixed' | 'security';
+interface ChangelogEntry {
+    type: ChangelogType;
+    description: string;
+    issueIds?: string[];
+    scope?: string;
+    originalType?: string;
+    breaking?: boolean;
+}
+interface PackageChangelog {
+    packageName: string;
+    version: string;
+    previousVersion: string | null;
+    revisionRange: string;
+    repoUrl: string | null;
+    date: string;
+    entries: ChangelogEntry[];
+}
+type InputSource = 'package-versioner' | 'conventional-changelog' | 'git-log' | 'manual';
+interface ChangelogInput {
+    source: InputSource;
+    packages: PackageChangelog[];
+    metadata?: {
+        repoUrl?: string;
+        defaultBranch?: string;
+    };
+}
+interface EnhancedData {
+    entries: ChangelogEntry[];
+    summary?: string;
+    categories?: Record<string, ChangelogEntry[]>;
+    releaseNotes?: string;
+}
+interface TemplateContext {
+    packageName: string;
+    version: string;
+    previousVersion: string | null;
+    date: string;
+    repoUrl: string | null;
+    entries: ChangelogEntry[];
+    compareUrl?: string;
+    enhanced?: EnhancedData;
+}
+interface DocumentContext {
+    project: {
+        name: string;
+        repoUrl?: string;
+    };
+    versions: TemplateContext[];
+    unreleased?: TemplateContext;
+    compareUrls?: Record<string, string>;
+}
+interface LLMOptions {
+    timeout?: number;
+    maxTokens?: number;
+    temperature?: number;
+}
+interface LLMConfig {
+    provider: string;
+    model: string;
+    baseURL?: string;
+    apiKey?: string;
+    options?: LLMOptions;
+    concurrency?: number;
+    retry?: RetryOptions;
+    tasks?: {
+        summarize?: boolean;
+        enhance?: boolean;
+        categorize?: boolean;
+        releaseNotes?: boolean;
+    };
+}
+type OutputFormat = 'markdown' | 'github-release' | 'json';
+interface OutputConfig {
+    format: OutputFormat;
+    file?: string;
+    options?: Record<string, unknown>;
+}
+type MonorepoMode = 'root' | 'packages' | 'both';
+interface MonorepoConfig {
+    mode?: MonorepoMode;
+    rootPath?: string;
+    packagesPath?: string;
+}
+type UpdateStrategy = 'prepend' | 'regenerate';
+type TemplateEngine = 'handlebars' | 'liquid' | 'ejs';
+interface TemplateConfig {
+    path?: string;
+    engine?: TemplateEngine;
+}
+interface Config {
+    input?: {
+        source?: string;
+        file?: string;
+    };
+    output: OutputConfig[];
+    monorepo?: MonorepoConfig;
+    templates?: TemplateConfig;
+    llm?: LLMConfig;
+    updateStrategy?: UpdateStrategy;
+}
+interface CompleteOptions {
+    maxTokens?: number;
+    temperature?: number;
+    timeout?: number;
+}
+
+declare function createTemplateContext(pkg: PackageChangelog): TemplateContext;
+declare function runPipeline(input: ChangelogInput, config: Config, dryRun: boolean): Promise<void>;
+declare function processInput(inputJson: string, config: Config, dryRun: boolean): Promise<void>;
+
+declare abstract class NotesError extends ReleaseKitError {
+}
+
+declare class InputParseError extends NotesError {
+    readonly code = "INPUT_PARSE_ERROR";
+    readonly suggestions: string[];
+}
+declare class TemplateError extends NotesError {
+    readonly code = "TEMPLATE_ERROR";
+    readonly suggestions: string[];
+}
+declare class LLMError extends NotesError {
+    readonly code = "LLM_ERROR";
+    readonly suggestions: string[];
+}
+declare class GitHubError extends NotesError {
+    readonly code = "GITHUB_ERROR";
+    readonly suggestions: string[];
+}
+declare class ConfigError extends NotesError {
+    readonly code = "CONFIG_ERROR";
+    readonly suggestions: string[];
+}
+declare function getExitCode(error: NotesError): number;
+
+declare function parsePackageVersioner(json: string): ChangelogInput;
+declare function parsePackageVersionerFile(filePath: string): ChangelogInput;
+declare function parsePackageVersionerStdin(): Promise<ChangelogInput>;
+
+interface MonorepoOptions {
+    rootPath: string;
+    packagesPath: string;
+    mode: 'root' | 'packages' | 'both';
+}
+declare function aggregateToRoot(contexts: TemplateContext[]): TemplateContext;
+
+declare function writeMonorepoChangelogs(contexts: TemplateContext[], options: MonorepoOptions, config: {
+    updateStrategy?: 'prepend' | 'regenerate';
+}, dryRun: boolean): void;
+declare function detectMonorepo(cwd: string): {
+    isMonorepo: boolean;
+    packagesPath: string;
+};
+
+declare function renderJson(contexts: TemplateContext[]): string;
+declare function writeJson(outputPath: string, contexts: TemplateContext[], dryRun: boolean): void;
+
+declare function renderMarkdown(contexts: TemplateContext[]): string;
+declare function writeMarkdown(outputPath: string, contexts: TemplateContext[], config: Config, dryRun: boolean): void;
+
+export { NotesError as ChangelogCreatorError, type ChangelogEntry, type ChangelogInput, type ChangelogType, type CompleteOptions, type Config, ConfigError, type DocumentContext, type EnhancedData, GitHubError, InputParseError, type InputSource, type LLMConfig, LLMError, type LLMOptions, type MonorepoConfig, type MonorepoMode, NotesError, type OutputConfig, type OutputFormat, type PackageChangelog, type RetryOptions, 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 };

package/dist/index.d.ts

@@ -0,0 +1,177 @@
+import { NotesConfig } from '@releasekit/config';
+export { loadAuth, saveAuth } from '@releasekit/config';
+import { ReleaseKitError } from '@releasekit/core';
+export { EXIT_CODES } from '@releasekit/core';
+
+declare function loadConfig(projectDir?: string, configFile?: string): NotesConfig;
+declare function getDefaultConfig(): NotesConfig;
+
+interface RetryOptions {
+    maxAttempts?: number;
+    initialDelay?: number;
+    maxDelay?: number;
+    backoffFactor?: number;
+}
+
+type ChangelogType = 'added' | 'changed' | 'deprecated' | 'removed' | 'fixed' | 'security';
+interface ChangelogEntry {
+    type: ChangelogType;
+    description: string;
+    issueIds?: string[];
+    scope?: string;
+    originalType?: string;
+    breaking?: boolean;
+}
+interface PackageChangelog {
+    packageName: string;
+    version: string;
+    previousVersion: string | null;
+    revisionRange: string;
+    repoUrl: string | null;
+    date: string;
+    entries: ChangelogEntry[];
+}
+type InputSource = 'package-versioner' | 'conventional-changelog' | 'git-log' | 'manual';
+interface ChangelogInput {
+    source: InputSource;
+    packages: PackageChangelog[];
+    metadata?: {
+        repoUrl?: string;
+        defaultBranch?: string;
+    };
+}
+interface EnhancedData {
+    entries: ChangelogEntry[];
+    summary?: string;
+    categories?: Record<string, ChangelogEntry[]>;
+    releaseNotes?: string;
+}
+interface TemplateContext {
+    packageName: string;
+    version: string;
+    previousVersion: string | null;
+    date: string;
+    repoUrl: string | null;
+    entries: ChangelogEntry[];
+    compareUrl?: string;
+    enhanced?: EnhancedData;
+}
+interface DocumentContext {
+    project: {
+        name: string;
+        repoUrl?: string;
+    };
+    versions: TemplateContext[];
+    unreleased?: TemplateContext;
+    compareUrls?: Record<string, string>;
+}
+interface LLMOptions {
+    timeout?: number;
+    maxTokens?: number;
+    temperature?: number;
+}
+interface LLMConfig {
+    provider: string;
+    model: string;
+    baseURL?: string;
+    apiKey?: string;
+    options?: LLMOptions;
+    concurrency?: number;
+    retry?: RetryOptions;
+    tasks?: {
+        summarize?: boolean;
+        enhance?: boolean;
+        categorize?: boolean;
+        releaseNotes?: boolean;
+    };
+}
+type OutputFormat = 'markdown' | 'github-release' | 'json';
+interface OutputConfig {
+    format: OutputFormat;
+    file?: string;
+    options?: Record<string, unknown>;
+}
+type MonorepoMode = 'root' | 'packages' | 'both';
+interface MonorepoConfig {
+    mode?: MonorepoMode;
+    rootPath?: string;
+    packagesPath?: string;
+}
+type UpdateStrategy = 'prepend' | 'regenerate';
+type TemplateEngine = 'handlebars' | 'liquid' | 'ejs';
+interface TemplateConfig {
+    path?: string;
+    engine?: TemplateEngine;
+}
+interface Config {
+    input?: {
+        source?: string;
+        file?: string;
+    };
+    output: OutputConfig[];
+    monorepo?: MonorepoConfig;
+    templates?: TemplateConfig;
+    llm?: LLMConfig;
+    updateStrategy?: UpdateStrategy;
+}
+interface CompleteOptions {
+    maxTokens?: number;
+    temperature?: number;
+    timeout?: number;
+}
+
+declare function createTemplateContext(pkg: PackageChangelog): TemplateContext;
+declare function runPipeline(input: ChangelogInput, config: Config, dryRun: boolean): Promise<void>;
+declare function processInput(inputJson: string, config: Config, dryRun: boolean): Promise<void>;
+
+declare abstract class NotesError extends ReleaseKitError {
+}
+
+declare class InputParseError extends NotesError {
+    readonly code = "INPUT_PARSE_ERROR";
+    readonly suggestions: string[];
+}
+declare class TemplateError extends NotesError {
+    readonly code = "TEMPLATE_ERROR";
+    readonly suggestions: string[];
+}
+declare class LLMError extends NotesError {
+    readonly code = "LLM_ERROR";
+    readonly suggestions: string[];
+}
+declare class GitHubError extends NotesError {
+    readonly code = "GITHUB_ERROR";
+    readonly suggestions: string[];
+}
+declare class ConfigError extends NotesError {
+    readonly code = "CONFIG_ERROR";
+    readonly suggestions: string[];
+}
+declare function getExitCode(error: NotesError): number;
+
+declare function parsePackageVersioner(json: string): ChangelogInput;
+declare function parsePackageVersionerFile(filePath: string): ChangelogInput;
+declare function parsePackageVersionerStdin(): Promise<ChangelogInput>;
+
+interface MonorepoOptions {
+    rootPath: string;
+    packagesPath: string;
+    mode: 'root' | 'packages' | 'both';
+}
+declare function aggregateToRoot(contexts: TemplateContext[]): TemplateContext;
+
+declare function writeMonorepoChangelogs(contexts: TemplateContext[], options: MonorepoOptions, config: {
+    updateStrategy?: 'prepend' | 'regenerate';
+}, dryRun: boolean): void;
+declare function detectMonorepo(cwd: string): {
+    isMonorepo: boolean;
+    packagesPath: string;
+};
+
+declare function renderJson(contexts: TemplateContext[]): string;
+declare function writeJson(outputPath: string, contexts: TemplateContext[], dryRun: boolean): void;
+
+declare function renderMarkdown(contexts: TemplateContext[]): string;
+declare function writeMarkdown(outputPath: string, contexts: TemplateContext[], config: Config, dryRun: boolean): void;
+
+export { NotesError as ChangelogCreatorError, type ChangelogEntry, type ChangelogInput, type ChangelogType, type CompleteOptions, type Config, ConfigError, type DocumentContext, type EnhancedData, GitHubError, InputParseError, type InputSource, type LLMConfig, LLMError, type LLMOptions, type MonorepoConfig, type MonorepoMode, NotesError, type OutputConfig, type OutputFormat, type PackageChangelog, type RetryOptions, 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 };

package/dist/index.js

@@ -0,0 +1,55 @@
+import {
+  ConfigError,
+  EXIT_CODES,
+  GitHubError,
+  InputParseError,
+  LLMError,
+  NotesError,
+  TemplateError,
+  aggregateToRoot,
+  createTemplateContext,
+  detectMonorepo,
+  getDefaultConfig,
+  getExitCode,
+  loadAuth,
+  loadConfig,
+  parsePackageVersioner,
+  parsePackageVersionerFile,
+  parsePackageVersionerStdin,
+  processInput,
+  renderJson,
+  renderMarkdown,
+  runPipeline,
+  saveAuth,
+  writeJson,
+  writeMarkdown,
+  writeMonorepoChangelogs
+} from "./chunk-GN5RQW3G.js";
+export {
+  NotesError as ChangelogCreatorError,
+  ConfigError,
+  EXIT_CODES,
+  GitHubError,
+  InputParseError,
+  LLMError,
+  NotesError,
+  TemplateError,
+  aggregateToRoot,
+  createTemplateContext,
+  detectMonorepo,
+  getDefaultConfig,
+  getExitCode,
+  loadAuth,
+  loadConfig,
+  parsePackageVersioner,
+  parsePackageVersionerFile,
+  parsePackageVersionerStdin,
+  processInput,
+  renderJson,
+  renderMarkdown,
+  runPipeline,
+  saveAuth,
+  writeJson,
+  writeMarkdown,
+  writeMonorepoChangelogs
+};

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@releasekit/notes",
+  "version": "0.1.0",
+  "description": "CLI tool for generating changelogs with LLM-powered enhancement and flexible templating",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "bin": {
+    "releasekit-notes": "./dist/cli.js"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts src/cli.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts src/cli.ts --format esm,cjs --watch --dts",
+    "clean": "rm -rf dist coverage .turbo",
+    "test": "vitest run",
+    "test:unit": "vitest run --coverage",
+    "test:coverage": "vitest run --coverage",
+    "lint": "biome check .",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": ["changelog", "release-notes", "llm", "template", "cli"],
+  "author": "Sam Maister <goosewobbler@protonmail.com>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/goosewobbler/releasekit",
+    "directory": "packages/notes"
+  },
+  "files": ["dist", "templates", "README.md", "LICENSE"],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@anthropic-ai/sdk": "^0.39.0",
+    "@octokit/rest": "^21.1.1",
+    "@releasekit/config": "workspace:*",
+    "@releasekit/core": "workspace:*",
+    "chalk": "catalog:",
+    "commander": "catalog:",
+    "ejs": "^3.1.10",
+    "handlebars": "^4.7.8",
+    "liquidjs": "^10.21.0",
+    "openai": "^4.87.0",
+    "zod": "catalog:"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "catalog:",
+    "@types/ejs": "^3.1.5",
+    "@types/node": "catalog:",
+    "@vitest/coverage-v8": "catalog:",
+    "tsup": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "catalog:"
+  },
+  "engines": {
+    "node": ">=18 || >=20"
+  }
+}

package/templates/angular/document.hbs

@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+{{#each versions}}
+{{> version}}
+{{/each}}

package/templates/angular/entry.hbs

@@ -0,0 +1,2 @@
+- {{#if scope}}**{{scope}}**: {{/if}}{{description}}{{#if issueIds}} ({{join issueIds ", "}}){{/if}}
+

package/templates/angular/version.hbs

@@ -0,0 +1,8 @@
+## [{{version}}] - {{date}}
+{{#if compareUrl}}
+[Full Changelog]({{compareUrl}})
+{{/if}}
+
+{{#each entries}}
+{{> entry}}
+{{/each}}

package/templates/github-release/release.md.ejs

@@ -0,0 +1,20 @@
+## What's Changed
+
+<% if (versions.length > 0) { %>
+<% const version = versions[0]; %>
+
+<% if (version.enhanced?.releaseNotes) { %>
+<%= version.enhanced.releaseNotes %>
+<% } else { %>
+<% if (version.entries.length > 0) { %>
+<% version.entries.forEach(function(entry) { %>
+- <% if (entry.scope) { %>**<%= entry.scope %>**: <% } %><%= entry.description %><% if (entry.issueIds) { %> (<%= entry.issueIds.join(', ') %>)<% } %>
+
+<% }); %>
+<% } %>
+<% } %>
+
+<% if (version.compareUrl) { %>
+**Full Changelog**: <%= version.compareUrl %>
+<% } %>
+<% } %>

package/templates/keep-a-changelog/document.liquid

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+{% for version in versions %}
+{% include "version" %}
+{% endfor %}

package/templates/keep-a-changelog/entry.liquid

@@ -0,0 +1,2 @@
+- {% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
+

package/templates/keep-a-changelog/version.liquid

@@ -0,0 +1,54 @@
+## [{{ version.version }}]{% if version.previousVersion %}{% endif %} - {{ version.date }}
+{% if version.compareUrl %}
+[Full Changelog]({{ version.compareUrl }})
+{% endif %}
+
+{% assign added = version.entries | where: "type", "added" %}
+{% assign changed = version.entries | where: "type", "changed" %}
+{% assign deprecated = version.entries | where: "type", "deprecated" %}
+{% assign removed = version.entries | where: "type", "removed" %}
+{% assign fixed = version.entries | where: "type", "fixed" %}
+{% assign security = version.entries | where: "type", "security" %}
+
+{% if added.size > 0 %}
+### Added
+{% for entry in added %}
+- {% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
+
+{% endfor %}
+{% endif %}
+{% if changed.size > 0 %}
+### Changed
+{% for entry in changed %}
+- {% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
+
+{% endfor %}
+{% endif %}
+{% if deprecated.size > 0 %}
+### Deprecated
+{% for entry in deprecated %}
+- {% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
+
+{% endfor %}
+{% endif %}
+{% if removed.size > 0 %}
+### Removed
+{% for entry in removed %}
+- {% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
+
+{% endfor %}
+{% endif %}
+{% if fixed.size > 0 %}
+### Fixed
+{% for entry in fixed %}
+- {% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
+
+{% endfor %}
+{% endif %}
+{% if security.size > 0 %}
+### Security
+{% for entry in security %}
+- {% if entry.scope %}**{{ entry.scope }}**: {% endif %}{{ entry.description }}{% if entry.issueIds %} ({{ entry.issueIds | join: ", " }}){% endif %}
+
+{% endfor %}
+{% endif %}