@iodes/releasekit 0.2.0 → 0.2.1

package/README.md

@@ -53,17 +53,17 @@ Run inside your product's Git repository:
 releasekit init
 ```
 
-Interactive setup asks for your product name, agent tools, original language, complete language set, and image themes. Press Enter to accept each default. Explicit options skip their corresponding questions. Settings are saved to `releasekit/config.yaml`; setup prints invocation hints only for the tools you selected. Ctrl+C cancels setup before configuration is written.
+Setup asks for agent tools first, then image themes. In the tool list, use ↑/↓ to move, Space to select or clear a tool, and Enter to continue. No tools are selected initially; A toggles all and I inverts the selection. Select at least one tool to continue. Pressing Enter with no selection displays an error and keeps the tool picker open. For image themes, use ↑/↓ to choose **Both dark and light** (the default), **Dark only**, or **Light only**, then press Enter. The picker explains each highlighted choice: both themes prepares matching versions for dark and light backgrounds; a single theme prepares one version for the chosen background. This default applies to generated release-note illustrations in new drafts and can be changed later. Ctrl+C cancels before configuration is written. Product name defaults to the repository folder name, and the original language defaults to English with no translations. Language selection remains part of the first draft workflow.
 
-For scripts, CI, or a coding agent, pass options directly:
+The original command still initializes immediately with no questions:
 
 ```sh
-releasekit init --no-interactive --tools codex,claude --source-locale en-US --locales en-US,ko-KR --themes both
+releasekit init --tools codex,claude,cursor --themes both
 ```
 
-Prompts are disabled with `--json`, `--no-interactive`, or non-terminal input/output. Omitted settings then use the defaults: repository name, all supported tools, English only, and both themes. Use `--tools none` to install no agent skills. `--locales` must include the original language with no duplicates. You can also initialize another existing Git repository with `releasekit init ./your-product` (relative to `--cwd`, if supplied). Re-running init preserves existing configuration and directs you to `releasekit update` for managed skills.
+Use `--tools codex` to install only selected tools, or `--tools none` to install no skills. Explicit `--tools` and `--themes` options skip their corresponding questions. With `--json`, `--no-interactive`, or non-terminal input/output, setup skips all questions and uses all supported tools and both themes unless explicitly overridden. Optional `--product`, `--source-locale`, and `--locales` overrides remain available without adding questions; `--locales` must include the original language with no duplicates.
 
-Edit `releasekit/config.yaml` later to change defaults for new drafts. Existing releases retain their saved settings.
+Settings are saved to `releasekit/config.yaml`, and setup prints invocation hints for the installed tools. You can also initialize another existing Git repository with `releasekit init ./your-product` (relative to `--cwd`, if supplied). Re-running init preserves existing configuration and directs you to `releasekit update` for managed skills. Edit `releasekit/config.yaml` later to change defaults for new drafts. Existing releases retain their saved settings.
 
 ### 3. Ask your agent
 
@@ -135,7 +135,7 @@ releasekit update                      # Refresh installed skills; preserve user
 
 `list` shows release identities, saved draft/ready state, note counts, and dates. `status` checks content with the same validation used by `validate`, displays errors and warnings, and suggests the next step. A ready label alone does not guarantee that files still pass validation. Status is read-only and exits successfully even when drafts have pending work; use `validate` for a failing exit code when content is invalid. Before initialization, `status` points to `init`.
 
-Running `releasekit update` refreshes skills for all supported tools (Codex, Claude Code, and Cursor), regardless of the saved init selection. It installs missing skills, preserves project configuration and locally modified files, and never prompts for tool selection. The result shows the project, supported tools, updated files, already-current files, and preserved edits, followed by invocation hints and the next command. Conflicts produce exit code 1. `--json` returns only the structured result, including `written`, `unchanged`, and `conflicts` arrays. This command refreshes bundled project skills; it does not upgrade the CLI package itself.
+Running `releasekit update` refreshes skills for all supported tools (Codex, Claude Code, and Cursor), regardless of the saved init selection. It installs missing skills, preserves current project configuration and locally modified files, and never prompts for tool selection. For older configurations containing `history.limit`, update first saves the original to `releasekit/config.yaml.before-update`, removes only that obsolete setting, and then refreshes skills. Other settings, comments on retained entries, and line endings are preserved. The result reports the migration and backup path. Use `export --limit` for an explicit export limit; omitting it exports all releases. Unrelated invalid settings still need correction and are never silently discarded. The result shows the project, supported tools, updated files, already-current files, and preserved edits, followed by invocation hints and the next command. Conflicts produce exit code 1. `--json` returns only the structured result, including `written`, `unchanged`, and `conflicts` arrays. This command refreshes bundled project skills; it does not upgrade the CLI package itself.
 
 Setup, update, prepare, list, status, and validate print readable summaries. `--json` preserves structured output for automation; command and option errors are JSON objects on stderr with a nonzero exit code. Help and version output remain plain text. Other content operations retain their detailed JSON results. Run `releasekit <command> --help` for options and `releasekit --help` for the workflow overview.
 

package/dist/cli.js

@@ -52,7 +52,7 @@ program.command('init [directory]').description('Initialize content and install
     let setup = { ...options, tools: options.tools === undefined ? undefined : parseTools(options.tools),
         locales: options.locales === undefined ? undefined : commaList(options.locales) };
     if (program.opts().interactive && !program.opts().json && process.stdin.isTTY && process.stdout.isTTY)
-        setup = await interactiveSetup(instance.root, setup);
+        setup = await interactiveSetup(setup);
     const result = await initProject(instance, setup);
     emit(result, [`Initialized ReleaseKit in ${instance.root}`, `Configuration: ${result.config}`,
         `Installed skills for: ${result.tools.join(', ') || 'none'}`, ...result.tools.map(tool => result.hints[tool]),
@@ -64,10 +64,9 @@ program.command('init [directory]').description('Initialize content and install
 program.command('update').description('Refresh skills for all supported tools while preserving user edits')
     .action(async () => {
     const instance = project();
-    const config = await instance.config();
-    if (!program.opts().json)
-        console.log(`ReleaseKit skill update — ${config.product}\nProject: ${instance.root}\nTools: codex, claude, cursor\n`);
     const result = await updateProject(instance);
+    if (!program.opts().json)
+        console.log(`ReleaseKit skill update — ${result.product}\nProject: ${instance.root}\nTools: codex, claude, cursor\n`);
     emit(result, formatUpdate(result));
     if (result.conflicts.length)
         process.exitCode = 1;

package/dist/install.d.ts

@@ -12,6 +12,22 @@ export declare function installSkills(project: Project, tools?: ProjectConfig['t
     };
 }>;
 export declare function updateProject(project: Project): Promise<{
+    product: string;
+    migrations: string[];
+    backup: null;
+    tools: ("claude" | "codex" | "cursor")[];
+    written: string[];
+    conflicts: string[];
+    unchanged: string[];
+    hints: {
+        codex: string;
+        claude: string;
+        cursor: string;
+    };
+} | {
+    product: string;
+    migrations: string[];
+    backup: string;
     tools: ("claude" | "codex" | "cursor")[];
     written: string[];
     conflicts: string[];
@@ -22,7 +38,7 @@ export declare function updateProject(project: Project): Promise<{
         cursor: string;
     };
 }>;
-export declare function formatUpdate(result: Awaited<ReturnType<typeof installSkills>>): string;
+export declare function formatUpdate(result: Awaited<ReturnType<typeof updateProject>>): string;
 export interface InitOptions {
     product?: string;
     tools?: ProjectConfig['tools'];

package/dist/install.js

@@ -3,6 +3,7 @@ import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 import { z } from 'zod';
 import { Project } from './project.js';
+import { migrateConfig } from './migrate-config.js';
 import { configSchema, defaultConfig } from './model.js';
 import { exists, within, write, writeYaml, digest } from './files.js';
 const resources = fileURLToPath(new URL('../kit/', import.meta.url));
@@ -52,11 +53,15 @@ export async function installSkills(project, tools) {
         } };
 }
 export async function updateProject(project) {
-    return installSkills(project, ['codex', 'claude', 'cursor']);
+    const migration = await migrateConfig(project);
+    return { ...await installSkills(project, ['codex', 'claude', 'cursor']), ...migration };
 }
 export function formatUpdate(result) {
     const lines = [result.conflicts.length ? 'Update needs attention.' : result.tools.length ? 'Skills are up to date.' : 'No agent tools selected.',
         `  Updated: ${result.written.length} files`, `  Already current: ${result.unchanged.length} files`, `  Modified files preserved: ${result.conflicts.length}`];
+    if (result.migrations.length) {
+        lines.push('', ...result.migrations.map(item => `  Configuration: ${item}`), `  Original configuration: ${result.backup}`);
+    }
     if (result.conflicts.length) {
         lines.push('', ...result.conflicts.map(file => `  ! ${file}`), 'Compare these files with the installed package templates and merge the changes you want to keep.');
     }

package/dist/migrate-config.d.ts

@@ -0,0 +1,10 @@
+import { Project } from './project.js';
+export declare function migrateConfig(project: Project): Promise<{
+    product: string;
+    migrations: string[];
+    backup: null;
+} | {
+    product: string;
+    migrations: string[];
+    backup: string;
+}>;

package/dist/migrate-config.js

@@ -0,0 +1,44 @@
+import * as fs from 'node:fs/promises';
+import { parseDocument } from 'yaml';
+import { Project, parseProjectConfig } from './project.js';
+import { canonical, exists, parseYaml, write } from './files.js';
+export async function migrateConfig(project) {
+    const file = await project.content('config.yaml');
+    if (!(await exists(file)))
+        throw new Error('ReleaseKit is not initialized. Run releasekit init first.');
+    const original = await fs.readFile(file, 'utf8');
+    const raw = parseYaml(original);
+    const migrations = [];
+    if (raw && typeof raw === 'object' && 'history' in raw && raw.history && typeof raw.history === 'object' && 'limit' in raw.history) {
+        delete raw.history.limit;
+        migrations.push('Removed history.limit; use export --limit to limit exported releases. Omit --limit to export all releases.');
+    }
+    // Validate the complete proposed configuration before touching any files.
+    const config = parseProjectConfig(raw);
+    if (!migrations.length)
+        return { product: config.product, migrations, backup: null };
+    const document = parseDocument(original);
+    document.deleteIn(['history', 'limit']);
+    let migrated = document.toString();
+    if (original.includes('\r\n'))
+        migrated = migrated.replace(/\r?\n/g, '\r\n');
+    if (original.startsWith('\uFEFF') && !migrated.startsWith('\uFEFF'))
+        migrated = '\uFEFF' + migrated;
+    if (canonical(parseYaml(migrated)) !== canonical(raw))
+        throw new Error('Configuration migration would change unrelated settings. No files were changed.');
+    const backup = await project.content('config.yaml.before-update');
+    try {
+        await fs.writeFile(backup, original, { flag: 'wx' });
+    }
+    catch (error) {
+        if (error.code !== 'EEXIST')
+            throw error;
+        if (await fs.readFile(backup, 'utf8') !== original) {
+            throw new Error(`A different configuration backup already exists at ${backup}. Move it aside before running update again; no files were overwritten.`);
+        }
+    }
+    if (await fs.readFile(file, 'utf8') !== original)
+        throw new Error('Configuration changed during update. Run update again; the configuration was not overwritten.');
+    await write(file, migrated);
+    return { product: config.product, migrations, backup };
+}

package/dist/project.d.ts

@@ -1,6 +1,7 @@
 import { type HistoryStart, type ProjectConfig, type Release, type ReleaseId, type ReleaseRef } from './model.js';
 export declare function checkLimit(limit?: number): void;
 export declare function linearHistory(releases: Release[]): Release[];
+export declare function parseProjectConfig(raw: unknown): ProjectConfig;
 export declare class Project {
     readonly root: string;
     constructor(root: string);

package/dist/project.js

@@ -46,6 +46,16 @@ export function linearHistory(releases) {
         throw new Error('Disconnected release history or cycle found.');
     return chain;
 }
+export function parseProjectConfig(raw) {
+    if (raw && typeof raw === 'object' && 'history' in raw && raw.history && typeof raw.history === 'object' && 'limit' in raw.history) {
+        throw new Error('Run releasekit update to migrate this configuration automatically. Remove history.limit from config.yaml; use export --limit instead. Omit --limit to export all releases.');
+    }
+    const config = configSchema.parse(raw);
+    if (!config.locales.includes(config.sourceLocale) || new Set(config.locales).size !== config.locales.length) {
+        throw new Error('Project locales must be unique and include the source locale.');
+    }
+    return config;
+}
 export class Project {
     root;
     constructor(root) { this.root = path.resolve(root); }
@@ -56,14 +66,7 @@ export class Project {
         if (!(await exists(file)))
             throw new Error('ReleaseKit is not initialized. Run releasekit init first.');
         const raw = parseYaml(await fs.readFile(file, 'utf8'));
-        if (raw && typeof raw === 'object' && 'history' in raw && raw.history && typeof raw.history === 'object' && 'limit' in raw.history) {
-            throw new Error('Remove history.limit from config.yaml; use export --limit instead. Omit --limit to export all releases.');
-        }
-        const config = configSchema.parse(raw);
-        if (!config.locales.includes(config.sourceLocale) || new Set(config.locales).size !== config.locales.length) {
-            throw new Error('Project locales must be unique and include the source locale.');
-        }
-        return config;
+        return parseProjectConfig(raw);
     }
     async requireChannel(channel) {
         ref({ channel, version: 'check' });

package/dist/setup.d.ts

@@ -1,7 +1,18 @@
+import { checkbox, select } from '@inquirer/prompts';
+import { type ProjectConfig } from './model.js';
 import type { InitOptions } from './install.js';
 export declare const commaList: (value: string) => string[];
 export declare function parseTools(value: string): ("claude" | "codex" | "cursor")[];
-type Ask = (question: string) => Promise<string>;
-export declare function collectSetup(root: string, options: InitOptions, ask: Ask, report: (message: string) => void): Promise<InitOptions>;
-export declare function interactiveSetup(root: string, options: InitOptions): Promise<InitOptions>;
+type Theme = ProjectConfig['visuals']['themes'];
+export declare function selectAgentTools(context?: Parameters<typeof checkbox>[1]): Promise<("claude" | "codex" | "cursor")[]> & {
+    cancel: () => void;
+};
+interface SetupPrompts {
+    tools?: () => Promise<ProjectConfig['tools']>;
+    theme?: () => Promise<Theme>;
+}
+export declare function selectImageThemes(context?: Parameters<typeof select>[1]): Promise<"both" | "dark" | "light"> & {
+    cancel: () => void;
+};
+export declare function interactiveSetup(options: InitOptions, prompts?: SetupPrompts): Promise<InitOptions>;
 export {};

package/dist/setup.js

@@ -1,7 +1,5 @@
-import path from 'node:path';
-import { createInterface } from 'node:readline/promises';
-import { stdin, stdout } from 'node:process';
-import { configSchema, defaultConfig } from './model.js';
+import { checkbox, select } from '@inquirer/prompts';
+import { configSchema } from './model.js';
 export const commaList = (value) => value.split(',').map(s => s.trim()).filter(Boolean);
 export function parseTools(value) {
     if (value === 'none')
@@ -11,54 +9,47 @@ export function parseTools(value) {
         throw new Error('Choose codex, claude, cursor, or none.');
     return configSchema.shape.tools.parse(values);
 }
-// Collect and validate everything before initProject writes any files.
-export async function collectSetup(root, options, ask, report) {
-    const defaults = defaultConfig(path.basename(root));
-    async function field(label, fallback, parse) {
-        for (;;) {
-            const answer = (await ask(`${label} [${fallback}]: `)).trim() || fallback;
-            try {
-                return parse(answer);
-            }
-            catch (error) {
-                report(error instanceof Error ? error.message : String(error));
-            }
-        }
-    }
-    const product = options.product ?? await field('Product name', defaults.product, value => configSchema.shape.product.parse(value));
-    const tools = options.tools ?? await field('Agent tools (codex, claude, cursor; comma-separated, or none)', defaults.tools.join(','), parseTools);
-    const sourceLocale = options.sourceLocale ?? await field('Original language (locale code)', defaults.sourceLocale, value => configSchema.shape.sourceLocale.parse(value));
-    const locales = options.locales ?? await field('All languages, including the original (comma-separated locale codes)', sourceLocale, value => {
-        const values = configSchema.shape.locales.parse(commaList(value));
-        if (!values.includes(sourceLocale) || new Set(values).size !== values.length)
-            throw new Error(`Languages must be unique and include ${sourceLocale}.`);
-        return values;
-    });
-    const themes = options.themes ?? await field('Image themes (both, dark, light)', defaults.visuals.themes, value => configSchema.shape.visuals.shape.themes.parse(value));
-    return { product, tools, sourceLocale, locales, themes };
+export function selectAgentTools(context) {
+    (context?.output ?? process.stdout).write('Choose at least one coding agent to receive ReleaseKit skills.\nUse Space to select or clear tools, then Enter to continue.\n\n');
+    return checkbox({
+        message: 'Which agent tools do you use?',
+        choices: [
+            { name: 'Codex', value: 'codex', checked: false },
+            { name: 'Claude Code', value: 'claude', checked: false },
+            { name: 'Cursor', value: 'cursor', checked: false },
+        ],
+        required: true,
+        loop: false,
+        shortcuts: { all: 'a', invert: 'i' },
+    }, context);
 }
-export function interactiveSetup(root, options) {
-    return withTerminal((ask, report) => collectSetup(root, options, ask, report), 'Setup cancelled. No configuration was written.');
+export function selectImageThemes(context) {
+    (context?.output ?? process.stdout).write('Choose the theme variants for generated release-note illustrations.\nThis default applies to new drafts and can be changed later.\n\n');
+    return select({
+        message: 'Which image themes should new drafts use?',
+        choices: [
+            { name: 'Both dark and light (recommended)', value: 'both',
+                description: 'Two matching versions of each illustration, one for dark backgrounds and one for light. Choose this when your product supports both themes.' },
+            { name: 'Dark only', value: 'dark',
+                description: 'One version of each illustration for dark backgrounds. Choose this when your release notes are always shown in a dark theme.' },
+            { name: 'Light only', value: 'light',
+                description: 'One version of each illustration for light backgrounds. Choose this when your release notes are always shown in a light theme.' },
+        ],
+        default: 'both',
+        loop: false,
+    }, context);
 }
-async function withTerminal(collect, cancelled) {
-    const terminal = createInterface({ input: stdin, output: stdout });
-    const abort = new AbortController();
-    const cancel = () => abort.abort();
-    terminal.on('SIGINT', cancel);
-    terminal.on('close', cancel);
+// All other settings retain their explicit values or initProject defaults.
+export async function interactiveSetup(options, prompts = {}) {
     try {
-        return await collect(question => {
-            if (abort.signal.aborted)
-                throw new Error(cancelled);
-            return terminal.question(question, { signal: abort.signal });
-        }, message => stdout.write(`${message}\n`));
+        const tools = options.tools ?? await (prompts.tools ?? selectAgentTools)();
+        const themes = options.themes ?? await (prompts.theme ?? selectImageThemes)();
+        return { ...options, tools, themes };
     }
     catch (error) {
-        if (abort.signal.aborted)
-            throw new Error(cancelled);
+        if (error instanceof Error && ['ExitPromptError', 'AbortPromptError'].includes(error.name)) {
+            throw new Error('Setup cancelled. No configuration was written.');
+        }
         throw error;
     }
-    finally {
-        terminal.close();
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iodes/releasekit",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Git-based visual release notes and portable agent skills",
   "type": "module",
   "license": "MIT",
@@ -40,6 +40,7 @@
     "prepack": "npm run build"
   },
   "dependencies": {
+    "@inquirer/prompts": "^7.10.1",
     "commander": "^15.0.0",
     "sharp": "^0.35.4",
     "yaml": "^2.9.0",