release-note-cli 0.1.0

package/README.md

@@ -0,0 +1,76 @@
+# release-note-cli
+
+Git 커밋 로그에서 릴리스 노트를 자동 생성하는 CLI.
+[Conventional Commits](https://www.conventionalcommits.org/) 규칙을 따르는 커밋을 파싱해서 카테고리별로 정리해줍니다.
+
+## Install
+
+```bash
+npm install -g release-note-cli
+```
+
+## Usage
+
+```bash
+# 두 태그 사이 릴리스 노트 생성
+notes gen v1.0.0 v1.1.0
+
+# 특정 ref부터 HEAD까지
+notes gen v1.0.0
+
+# 마지막 태그부터 HEAD까지
+notes latest
+
+# 텍스트 포맷으로 출력
+notes gen v1.0.0 v1.1.0 -o text
+
+# CHANGELOG.md에 추가
+notes latest -a
+```
+
+## Output Example
+
+```markdown
+## v1.1.0 (2026-02-26)
+
+### Features
+- **auth:** add Google OAuth login (a1b2c3d)
+- implement dark mode toggle (d4e5f6g)
+
+### Bug Fixes
+- **api:** fix token refresh race condition (h7i8j9k)
+
+### Breaking Changes
+- **config:** rename apiUrl to apiBase (l0m1n2o)
+```
+
+## Supported Commit Types
+
+| Type | Category |
+|------|----------|
+| `feat` | Features |
+| `fix` | Bug Fixes |
+| `docs` | Documentation |
+| `refactor` | Refactoring |
+| `perf` | Performance |
+| `style`, `test`, `chore`, `ci`, `build` | Other Changes |
+
+`BREAKING CHANGE:` in body 또는 `feat!:` 형태의 `!` 접미사는 Breaking Changes로 분류됩니다.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `notes gen <from> [to]` | 두 git ref 사이의 릴리스 노트 생성 |
+| `notes latest` | 마지막 태그 → HEAD 릴리스 노트 생성 |
+
+### Options
+
+| Flag | Description | Default |
+|------|-------------|---------|
+| `-o, --output <format>` | 출력 포맷 (`markdown` / `text`) | `markdown` |
+| `-a, --append` | CHANGELOG.md에 추가 | `false` |
+
+## License
+
+MIT

package/dist/commands/gen.js

@@ -0,0 +1,69 @@
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+import pc from 'picocolors';
+import { isGitRepo, isValidRef, getCommitsBetween } from '../lib/git.js';
+import { parseCommits, groupByType } from '../lib/parser.js';
+import { formatMarkdown, formatText } from '../lib/formatter.js';
+export function cmdGen(from, to, options) {
+    const cwd = process.cwd();
+    if (!isGitRepo(cwd)) {
+        console.error(pc.red('Error: Not a git repository.'));
+        process.exit(1);
+    }
+    if (!isValidRef(cwd, from)) {
+        console.error(pc.red(`Error: Invalid ref "${from}". Check the tag or commit exists.`));
+        process.exit(1);
+    }
+    const toRef = to || 'HEAD';
+    if (to && !isValidRef(cwd, to)) {
+        console.error(pc.red(`Error: Invalid ref "${to}". Check the tag or commit exists.`));
+        process.exit(1);
+    }
+    const rawCommits = getCommitsBetween(cwd, from, toRef);
+    if (rawCommits.length === 0) {
+        console.log(pc.yellow('No commits found in the specified range.'));
+        return;
+    }
+    const parsed = parseCommits(rawCommits);
+    const grouped = groupByType(parsed);
+    // Determine version label
+    const versionLabel = to || 'Unreleased';
+    const dateStr = new Date().toISOString().slice(0, 10);
+    const format = options.output || 'markdown';
+    const output = format === 'text'
+        ? formatText(versionLabel, dateStr, grouped)
+        : formatMarkdown(versionLabel, dateStr, grouped);
+    if (options.append) {
+        appendToChangelog(cwd, output);
+        console.log(pc.green(`✓ Appended to CHANGELOG.md (${parsed.length} commits)`));
+    }
+    else {
+        console.log(output);
+    }
+    // Summary
+    const summary = [
+        grouped.feat.length && `${grouped.feat.length} features`,
+        grouped.fix.length && `${grouped.fix.length} fixes`,
+        grouped.breaking.length && `${grouped.breaking.length} breaking`,
+    ].filter(Boolean).join(', ');
+    console.error(pc.dim(`${parsed.length} commits processed${summary ? ': ' + summary : ''}`));
+}
+function appendToChangelog(cwd, content) {
+    const changelogPath = join(cwd, 'CHANGELOG.md');
+    if (!existsSync(changelogPath)) {
+        writeFileSync(changelogPath, `# Changelog\n\n${content}`, 'utf-8');
+        return;
+    }
+    const existing = readFileSync(changelogPath, 'utf-8');
+    const insertIndex = existing.indexOf('\n## ');
+    if (insertIndex === -1) {
+        // No existing version headers, append at end
+        writeFileSync(changelogPath, existing.trimEnd() + '\n\n' + content, 'utf-8');
+    }
+    else {
+        // Insert before the first ## header (after the newline)
+        const before = existing.slice(0, insertIndex + 1);
+        const after = existing.slice(insertIndex + 1);
+        writeFileSync(changelogPath, before + content + after, 'utf-8');
+    }
+}

package/dist/commands/latest.js

@@ -0,0 +1,18 @@
+import pc from 'picocolors';
+import { isGitRepo, getLatestTag } from '../lib/git.js';
+import { cmdGen } from './gen.js';
+export function cmdLatest(options) {
+    const cwd = process.cwd();
+    if (!isGitRepo(cwd)) {
+        console.error(pc.red('Error: Not a git repository.'));
+        process.exit(1);
+    }
+    const tag = getLatestTag(cwd);
+    if (!tag) {
+        console.error(pc.red('Error: No tags found.'));
+        console.error(pc.dim('Hint: Use "notes gen <commit-hash> HEAD" instead.'));
+        process.exit(1);
+    }
+    console.error(pc.dim(`Latest tag: ${tag}`));
+    cmdGen(tag, undefined, options);
+}

package/dist/index.js

@@ -0,0 +1,22 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { cmdGen } from './commands/gen.js';
+import { cmdLatest } from './commands/latest.js';
+const program = new Command();
+program
+    .name('notes')
+    .description('Generate release notes from git commit logs')
+    .version('0.1.0', '-v, --version');
+program
+    .command('gen <from> [to]')
+    .description('Generate release notes between two git refs (tags, commits, branches)')
+    .option('-o, --output <format>', 'Output format: markdown or text', 'markdown')
+    .option('-a, --append', 'Append to CHANGELOG.md')
+    .action(cmdGen);
+program
+    .command('latest')
+    .description('Generate notes from latest tag to HEAD')
+    .option('-o, --output <format>', 'Output format: markdown or text', 'markdown')
+    .option('-a, --append', 'Append to CHANGELOG.md')
+    .action(cmdLatest);
+program.parse();

package/dist/lib/formatter.js

@@ -0,0 +1,46 @@
+const SECTIONS = [
+    { key: 'breaking', mdTitle: 'Breaking Changes', textTitle: 'Breaking Changes' },
+    { key: 'feat', mdTitle: 'Features', textTitle: 'Features' },
+    { key: 'fix', mdTitle: 'Bug Fixes', textTitle: 'Bug Fixes' },
+    { key: 'docs', mdTitle: 'Documentation', textTitle: 'Documentation' },
+    { key: 'refactor', mdTitle: 'Refactoring', textTitle: 'Refactoring' },
+    { key: 'perf', mdTitle: 'Performance', textTitle: 'Performance' },
+    { key: 'other', mdTitle: 'Other Changes', textTitle: 'Other Changes' },
+];
+function formatCommitLine(c, withScope) {
+    const scope = withScope && c.scope ? `**${c.scope}:** ` : '';
+    return `${scope}${c.description} (${c.shortHash})`;
+}
+export function formatMarkdown(version, date, groups) {
+    const lines = [];
+    lines.push(`## ${version} (${date})`);
+    lines.push('');
+    for (const section of SECTIONS) {
+        const commits = groups[section.key];
+        if (commits.length === 0)
+            continue;
+        lines.push(`### ${section.mdTitle}`);
+        lines.push('');
+        for (const c of commits) {
+            lines.push(`- ${formatCommitLine(c, true)}`);
+        }
+        lines.push('');
+    }
+    return lines.join('\n');
+}
+export function formatText(version, date, groups) {
+    const lines = [];
+    lines.push(`${version} (${date})`);
+    lines.push('');
+    for (const section of SECTIONS) {
+        const commits = groups[section.key];
+        if (commits.length === 0)
+            continue;
+        lines.push(`${section.textTitle}:`);
+        for (const c of commits) {
+            lines.push(`  - ${formatCommitLine(c, true)}`);
+        }
+        lines.push('');
+    }
+    return lines.join('\n');
+}

package/dist/lib/git.js

@@ -0,0 +1,48 @@
+import { execSync } from 'child_process';
+import { existsSync } from 'fs';
+import { join } from 'path';
+const COMMIT_DELIM = '---COMMIT_DELIM---';
+const FIELD_DELIM = '---FIELD_DELIM---';
+function git(path, args) {
+    try {
+        return execSync(`git ${args}`, {
+            cwd: path,
+            encoding: 'utf-8',
+            stdio: ['pipe', 'pipe', 'pipe'],
+        }).trim();
+    }
+    catch {
+        return null;
+    }
+}
+export function isGitRepo(path) {
+    return existsSync(join(path, '.git'));
+}
+export function getLatestTag(path) {
+    return git(path, 'describe --abbrev=0 --tags');
+}
+export function getCommitsBetween(path, from, to) {
+    const format = [
+        '%H', '%h', '%s', '%b', '%an', '%cI',
+    ].join(FIELD_DELIM);
+    const raw = git(path, `log ${from}..${to} --format=${COMMIT_DELIM}${format}`);
+    if (!raw)
+        return [];
+    return raw
+        .split(COMMIT_DELIM)
+        .filter(chunk => chunk.trim().length > 0)
+        .map(chunk => {
+        const fields = chunk.trim().split(FIELD_DELIM);
+        return {
+            hash: fields[0] || '',
+            shortHash: fields[1] || '',
+            subject: fields[2] || '',
+            body: fields[3] || '',
+            author: fields[4] || '',
+            date: fields[5] || '',
+        };
+    });
+}
+export function isValidRef(path, ref) {
+    return git(path, `rev-parse --verify ${ref}`) !== null;
+}

package/dist/lib/parser.js

@@ -0,0 +1,68 @@
+const KNOWN_TYPES = new Set([
+    'feat', 'fix', 'docs', 'refactor', 'perf',
+    'style', 'test', 'chore', 'ci', 'build',
+]);
+const CONVENTIONAL_RE = /^(\w+)(?:\(([^)]+)\))?(!)?:\s*(.+)/;
+export function parseCommit(raw) {
+    const match = raw.subject.match(CONVENTIONAL_RE);
+    let type = 'other';
+    let scope;
+    let description = raw.subject;
+    let breaking = false;
+    if (match) {
+        const [, rawType, rawScope, bangMark, desc] = match;
+        if (KNOWN_TYPES.has(rawType)) {
+            type = rawType;
+        }
+        scope = rawScope || undefined;
+        description = desc;
+        breaking = bangMark === '!';
+    }
+    if (!breaking && raw.body.includes('BREAKING CHANGE:')) {
+        breaking = true;
+    }
+    return {
+        hash: raw.hash,
+        shortHash: raw.shortHash,
+        subject: raw.subject,
+        body: raw.body,
+        author: raw.author,
+        date: raw.date,
+        type,
+        scope,
+        description,
+        breaking,
+    };
+}
+export function parseCommits(raws) {
+    return raws.map(parseCommit);
+}
+export function groupByType(commits) {
+    const groups = {
+        feat: [],
+        fix: [],
+        docs: [],
+        refactor: [],
+        perf: [],
+        other: [],
+        breaking: [],
+    };
+    for (const c of commits) {
+        if (c.breaking) {
+            groups.breaking.push(c);
+        }
+        if (c.type === 'feat')
+            groups.feat.push(c);
+        else if (c.type === 'fix')
+            groups.fix.push(c);
+        else if (c.type === 'docs')
+            groups.docs.push(c);
+        else if (c.type === 'refactor')
+            groups.refactor.push(c);
+        else if (c.type === 'perf')
+            groups.perf.push(c);
+        else
+            groups.other.push(c);
+    }
+    return groups;
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "release-note-cli",
+  "version": "0.1.0",
+  "description": "Generate release notes from git commit logs",
+  "type": "module",
+  "bin": {
+    "notes": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "release-notes",
+    "changelog",
+    "git",
+    "conventional-commits",
+    "cli"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "start": "node dist/index.js",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "commander": "^12.0.0",
+    "picocolors": "^1.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  }
+}