@ramon-sg/issue-flow 0.2.7 → 0.3.1

package/dist/commands/init.js

@@ -1,134 +0,0 @@
-/**
- * @file `issue-flow init`: sets a repo up for the flow, and can run again to fill in what
- * is missing. It writes `.agents/flow.json` (from `paseo.json` if the repo has one, plus the
- * recipes it picks), the flow's dev dependencies and scripts in `package.json`, and the
- * `SessionStart`, `WorktreeCreate` and `WorktreeRemove` hooks. Only the flow's own files:
- * the skills, `claude-cloud` and `claude-repo-guard` are installed by `agent-kitchen`,
- * which runs this command.
- */
-import { confirm } from "../ask.js";
-import { CONFIG_PATH, isObject } from "../config-base.js";
-import { parseConfig } from "../config.js";
-import { checkoutRoot, locateRepo } from "../git.js";
-import { UsageError, warn } from "../output.js";
-import { KEPT, withFlowPackages } from "../package-edits.js";
-import { applyRecipe, detectedRecipes, loadRecipes, projectPrefix } from "../recipes.js";
-import { registerHooks } from "../settings-hooks.js";
-import { FLOW_REPO, ownVersions, packageManager, readJson, SETTINGS_FILE, SetupError, writeJson } from "../setup-files.js";
-/**
- * The URL of the config's schema at a version.
- * @param version - This package's version.
- * @returns The URL.
- * @example schemaUrl("0.1.0") // "https://raw.githubusercontent.com/ramon-sg/issue-flow/v0.1.0/schema.json"
- */
-export function schemaUrl(version) {
-    return `https://raw.githubusercontent.com/${FLOW_REPO}/v${version}/schema.json`;
-}
-/**
- * A new config: the schema, and the branch rules of `paseo.json` if the repo has one.
- * @param root - The repo.
- * @param version - This package's version.
- * @returns The config and what it took from `paseo.json`.
- */
-function freshConfig(root, version) {
-    const raw = { $schema: schemaUrl(version) };
-    const issues = readJson(root, "paseo.json")?.project;
-    const paseo = isObject(issues) && isObject(issues.issues) ? issues.issues : null;
-    if (paseo === null)
-        return { raw, changes: ["new"] };
-    const branch = {};
-    if (typeof paseo.branchTemplate === "string")
-        branch.template = paseo.branchTemplate;
-    if (isObject(paseo.types))
-        branch.types = paseo.types;
-    if (Object.keys(branch).length > 0)
-        raw.branch = branch;
-    return { raw, changes: ["new, with the branch rules of paseo.json"] };
-}
-/**
- * The recipes to apply: the ones named with `--recipe`, or each one the repo's files
- * suggest, after asking (all of them with `--yes`).
- * @param root - The repo.
- * @param options - The options.
- * @param out - Where to ask.
- * @returns The recipes.
- * @throws UsageError if `--recipe` names one that does not exist.
- */
-async function pickRecipes(root, options, out) {
-    const recipes = loadRecipes();
-    if (options.recipes !== null) {
-        const unknown = options.recipes.find((name) => !recipes.some((recipe) => recipe.name === name));
-        if (unknown !== undefined)
-            throw new UsageError(`unknown recipe ${unknown}; there are ${recipes.map((recipe) => recipe.name).join(", ")}.`);
-        return recipes.filter((recipe) => options.recipes?.includes(recipe.name));
-    }
-    const picked = [];
-    for (const recipe of recipes.filter((item) => detectedRecipes(root, recipes).includes(item.name)))
-        if (options.yes || (await confirm(out, `Recipe ${recipe.name}: ${recipe.description} Add it?`)))
-            picked.push(recipe);
-    return picked;
-}
-/**
- * What `init` would write: the config, `package.json` and the settings' hooks.
- * @param root - The repo.
- * @param versions - This package's versions.
- * @param recipes - The recipes to apply.
- * @returns The files that change.
- * @throws ConfigError if the resulting config is invalid; SetupError if a file is broken.
- */
-function plan(root, versions, recipes) {
-    const existing = readJson(root, CONFIG_PATH);
-    const start = existing === null ? freshConfig(root, versions.issueFlow) : { raw: existing, changes: [] };
-    let { raw } = start;
-    const configChanges = [...start.changes];
-    for (const recipe of recipes) {
-        const applied = applyRecipe(raw, recipe, projectPrefix(root));
-        raw = applied.raw;
-        configChanges.push(...applied.changes.map((change) => (change.startsWith(KEPT) ? `${change} (${recipe.name})` : `${recipe.name}: ${change}`)));
-    }
-    parseConfig(raw);
-    const pkg = withFlowPackages(readJson(root, "package.json"), versions, false);
-    const hooks = registerHooks(readJson(root, SETTINGS_FILE), versions.issueFlow);
-    const file = (path, value, lines) => ({
-        path,
-        value,
-        changes: lines.filter((line) => !line.startsWith(KEPT)).map((line) => `${path}: ${line}`),
-        kept: lines.filter((line) => line.startsWith(KEPT)).map((line) => `${path}: ${line}`),
-    });
-    return [file(CONFIG_PATH, raw, configChanges), file("package.json", pkg.pkg, pkg.changes), file(SETTINGS_FILE, hooks.settings, hooks.changes)];
-}
-/**
- * Sets the repo up for the flow; see the file's header.
- * @param options - The options.
- * @param out - Where to write and ask.
- * @returns 0, or 1 if the files were not written.
- * @throws SetupError outside the main checkout or with a broken file; ConfigError if the
- * config would be invalid; UsageError for an unknown recipe.
- * @example await init({ cwd, yes: true, recipes: null }, out)
- */
-export async function init(options, out) {
-    const located = locateRepo(options.cwd);
-    if (located === null)
-        throw new SetupError("run init inside a checkout of the repo.");
-    if (checkoutRoot(options.cwd) !== located.mainRoot)
-        throw new SetupError(`run init in the main checkout, ${located.mainRoot}, not in a worktree.`);
-    const root = located.mainRoot;
-    const versions = ownVersions();
-    const files = plan(root, versions, await pickRecipes(root, options, out)).filter((file) => file.changes.length > 0 || file.kept.length > 0);
-    for (const line of files.flatMap((file) => file.kept))
-        warn(out, line);
-    const lines = files.flatMap((file) => file.changes);
-    if (lines.length === 0)
-        out.stdout("The config, package.json and the hooks are already set up.\n");
-    else
-        out.stdout(`issue-flow ${versions.issueFlow} will write:\n${lines.map((line) => `  ${line}\n`).join("")}`);
-    if (lines.length > 0 && !options.yes && !(await confirm(out, "Write it?"))) {
-        warn(out, "nothing written.");
-        return 1;
-    }
-    for (const file of files.filter((item) => item.changes.length > 0))
-        writeJson(root, file.path, file.value);
-    const manager = packageManager(root, readJson(root, "package.json"));
-    out.stdout(`Next: run '${manager} install', and commit .agents/, .claude/ and package.json.\n`);
-    return 0;
-}

package/dist/commands/upgrade.d.ts

@@ -1,16 +0,0 @@
-import { type Output } from "../output.js";
-/** Options of `issue-flow upgrade`. */
-export interface UpgradeOptions {
-    cwd: string;
-    dryRun: boolean;
-}
-/**
- * Moves the repo's flow files to this version; see the file's header.
- * @param options - The options.
- * @param out - Where to write.
- * @returns 0.
- * @throws SetupError outside the main checkout, if a file is broken, or if the repo is
- * already at a newer version (a stale local copy must not move it back).
- * @example upgrade({ cwd, dryRun: false }, out)
- */
-export declare function upgrade(options: UpgradeOptions, out: Output): number;

package/dist/commands/upgrade.js

@@ -1,72 +0,0 @@
-/**
- * @file `issue-flow upgrade [--dry-run]`: moves the repo's flow files to the version that
- * runs: `@ramon-sg/issue-flow`, the hooks and the config's schema to it, and `github-rest`
- * and `skills-manager` up to the versions it was tested with only if they fall short (a
- * newer one, or a range that allows it, is kept and reported). `agent-kitchen` runs it as `npx @ramon-sg/issue-flow@<version> upgrade` and then
- * moves the flow's skills to the same tag, because the skills call this CLI.
- */
-import { CONFIG_PATH } from "../config-base.js";
-import { checkoutRoot, locateRepo } from "../git.js";
-import { warn } from "../output.js";
-import { dependencyVersion, isNewer, KEPT, withFlowPackages } from "../package-edits.js";
-import { hookVersions, registerHooks } from "../settings-hooks.js";
-import { FLOW_REPO, ownVersions, PACKAGE, packageManager, readJson, SETTINGS_FILE, SetupError, writeJson } from "../setup-files.js";
-import { schemaUrl } from "./init.js";
-/** The start of the schema URL `init` writes, at any version. */
-const SCHEMA_PREFIX = `https://raw.githubusercontent.com/${FLOW_REPO}/`;
-/**
- * The newest version of the flow the repo already has, in package.json or a hook.
- * @param root - The repo.
- * @returns The version, or null if it has none.
- */
-function repoVersion(root) {
-    const found = [dependencyVersion(readJson(root, "package.json"), PACKAGE), ...Object.values(hookVersions(readJson(root, SETTINGS_FILE)))];
-    return found.filter((version) => version !== null).reduce((newest, version) => (newest === null || isNewer(version, newest) ? version : newest), null);
-}
-/**
- * Moves the repo's flow files to this version; see the file's header.
- * @param options - The options.
- * @param out - Where to write.
- * @returns 0.
- * @throws SetupError outside the main checkout, if a file is broken, or if the repo is
- * already at a newer version (a stale local copy must not move it back).
- * @example upgrade({ cwd, dryRun: false }, out)
- */
-export function upgrade(options, out) {
-    const located = locateRepo(options.cwd);
-    if (located === null)
-        throw new SetupError("run upgrade inside a checkout of the repo.");
-    const root = located.mainRoot;
-    if (checkoutRoot(options.cwd) !== root)
-        throw new SetupError(`run upgrade in the main checkout, ${root}, not in a worktree.`);
-    const versions = ownVersions();
-    const current = repoVersion(root);
-    if (current !== null && isNewer(current, versions.issueFlow))
-        throw new SetupError(`the repo is at issue-flow ${current}, newer than this ${versions.issueFlow}; run 'npx ${PACKAGE}@${current.replace(/^[\^~=]/, "")} upgrade' or 'npx agent-kitchen apply'.`);
-    const writes = [];
-    const lines = [];
-    const pkg = withFlowPackages(readJson(root, "package.json"), versions, true);
-    const kept = pkg.changes.filter((change) => change.startsWith(KEPT));
-    const moved = pkg.changes.filter((change) => !change.startsWith(KEPT));
-    for (const change of kept)
-        warn(out, `package.json: ${change}`);
-    if (moved.length > 0)
-        writes.push({ path: "package.json", value: pkg.pkg });
-    lines.push(...moved.map((change) => `package.json: ${change}`));
-    const hooks = registerHooks(readJson(root, SETTINGS_FILE), versions.issueFlow);
-    if (hooks.changes.length > 0)
-        writes.push({ path: SETTINGS_FILE, value: hooks.settings });
-    lines.push(...hooks.changes.map((change) => `${SETTINGS_FILE}: ${change}`));
-    const config = readJson(root, CONFIG_PATH);
-    if (config !== null && typeof config.$schema === "string" && config.$schema.startsWith(SCHEMA_PREFIX) && config.$schema !== schemaUrl(versions.issueFlow)) {
-        writes.push({ path: CONFIG_PATH, value: { ...config, $schema: schemaUrl(versions.issueFlow) } });
-        lines.push(`${CONFIG_PATH}: $schema at v${versions.issueFlow}`);
-    }
-    out.stdout(lines.length === 0 ? `Already at issue-flow ${versions.issueFlow}.\n` : `To issue-flow ${versions.issueFlow}:\n${lines.map((line) => `  ${line}\n`).join("")}`);
-    if (options.dryRun || writes.length === 0)
-        return 0;
-    for (const write of writes)
-        writeJson(root, write.path, write.value);
-    out.stdout(`Next: run '${packageManager(root, readJson(root, "package.json"))} install', review the diff and commit it.\n`);
-    return 0;
-}