@yaawn/workflow 0.4.0 → 0.5.0

package/dist/wizard/section.js

@@ -0,0 +1,143 @@
+import { KIND_MULTISELECT, KIND_PROJECTS_LIST, KIND_SINGLE_SELECT, KIND_TEXT_LIST, } from "../config/index.js";
+import { appendItems, ChecklistFormat, normalize } from "./items.js";
+// eslint-disable-next-line no-control-regex -- matches the C0/C1 control characters an item must not contain
+const CONTROL_CHARACTER = /[\u0000-\u001f\u007f-\u009f]/;
+/** Thrown when an item is blank. */
+export class EmptyItemError extends Error {
+    constructor() {
+        super("empty item");
+        this.name = "EmptyItemError";
+    }
+}
+/** Thrown when an item is already listed in the file or was already added in this session. */
+export class DuplicateItemError extends Error {
+    item;
+    constructor(item) {
+        super(`duplicate item: ${item}`);
+        this.item = item;
+        this.name = "DuplicateItemError";
+    }
+}
+/** Thrown when an item contains control characters, which could drive the terminal or break the file. */
+export class ControlCharacterError extends Error {
+    constructor() {
+        super("item contains control characters");
+        this.name = "ControlCharacterError";
+    }
+}
+const NO_FILE = { fileName: "", path: "", content: "", format: new ChecklistFormat() };
+/** One wizard step with its current state. */
+export class Section {
+    id;
+    title;
+    description;
+    kind;
+    placeholder;
+    existing;
+    added = [];
+    options;
+    file;
+    constructor(spec, state = {}) {
+        this.id = spec.id;
+        this.title = spec.title;
+        this.description = spec.description;
+        this.kind = spec.kind;
+        this.placeholder = spec.placeholder;
+        this.existing = [...(state.existing ?? [])];
+        this.options = (state.options ?? []).map((option) => ({ ...option }));
+        this.file = state.file ?? NO_FILE;
+    }
+    /** The output file a text-list section appends to. */
+    get fileName() {
+        return this.file.fileName;
+    }
+    isTextList() {
+        return this.kind === KIND_TEXT_LIST;
+    }
+    isMultiselect() {
+        return this.kind === KIND_MULTISELECT;
+    }
+    isSingleSelect() {
+        return this.kind === KIND_SINGLE_SELECT;
+    }
+    /** Whether the section collects GitHub project names, which stay in memory instead of a file. */
+    isProjectsList() {
+        return this.kind === KIND_PROJECTS_LIST;
+    }
+    /** Whether the section is chosen from options rather than typed. */
+    hasOptions() {
+        return this.isMultiselect() || this.isSingleSelect();
+    }
+    /** Checks a typed item without changing the section. */
+    checkItem(item) {
+        const trimmed = item.trim();
+        if (trimmed === "") {
+            return { status: "empty" };
+        }
+        if (CONTROL_CHARACTER.test(trimmed)) {
+            return { status: "control-character" };
+        }
+        if (this.isDuplicate(trimmed)) {
+            return { status: "duplicate", item: trimmed };
+        }
+        return { status: "accepted", item: trimmed };
+    }
+    /** Trims item and appends it; throws when it is empty, a duplicate or contains control characters. */
+    add(item) {
+        const check = this.checkItem(item);
+        switch (check.status) {
+            case "empty":
+                throw new EmptyItemError();
+            case "control-character":
+                throw new ControlCharacterError();
+            case "duplicate":
+                throw new DuplicateItemError(check.item);
+            case "accepted":
+                this.added.push(check.item);
+        }
+    }
+    /** Whether item matches an existing or added item after normalization. */
+    isDuplicate(item) {
+        const key = normalize(item);
+        const matches = (known) => normalize(known) === key;
+        return this.existing.some(matches) || this.added.some(matches);
+    }
+    /**
+     * Selects exactly the options whose value is in values. A single-select
+     * section selects the first value that is one of its options and keeps
+     * its selection when none is.
+     */
+    setSelected(values) {
+        if (this.isSingleSelect()) {
+            this.selectFirstOption(values);
+            return;
+        }
+        for (const option of this.options) {
+            option.selected = values.includes(option.value);
+        }
+    }
+    selectFirstOption(values) {
+        const value = values.find((candidate) => this.hasOption(candidate));
+        if (value === undefined) {
+            return;
+        }
+        for (const option of this.options) {
+            option.selected = option.value === value;
+        }
+    }
+    hasOption(value) {
+        return this.options.some((option) => option.value === value);
+    }
+    /** The first selected option's value, or "". */
+    selectedValue() {
+        return this.options.find((option) => option.selected)?.value ?? "";
+    }
+    /** The values of the selected options in order. */
+    selectedValues() {
+        return this.options.filter((option) => option.selected).map((option) => option.value);
+    }
+    /** The file content with the added items appended. */
+    updatedContent() {
+        return appendItems(this.file.content, this.added, this.file.format);
+    }
+}

package/dist/wizard/wizard.js

@@ -0,0 +1,73 @@
+import { isAgent } from "../config/index.js";
+import { normalize } from "./items.js";
+/** The ordered wizard sections. */
+export class Wizard {
+    sections;
+    constructor(sections) {
+        this.sections = sections;
+    }
+    get length() {
+        return this.sections.length;
+    }
+    /** One change per text-list section, including those without added items so callers can report them as unchanged. */
+    changes() {
+        return this.sections
+            .filter((section) => section.isTextList())
+            .map((section) => ({
+            fileName: section.fileName,
+            path: section.file.path,
+            content: section.updatedContent(),
+            added: section.added.length,
+        }));
+    }
+    /** The single-select agent section, if the wizard has one. */
+    agentSection() {
+        return this.sections.find((section) => section.isSingleSelect());
+    }
+    /** Selects agent in the agent section; values that are not one of its options leave the selection unchanged. */
+    selectAgent(agent) {
+        this.agentSection()?.setSelected([agent]);
+    }
+    /** The agent chosen in the agent section, or fallback when the wizard has none or nothing valid is selected. */
+    selectedAgent(fallback) {
+        const agent = this.agentSection()?.selectedValue();
+        return isAgent(agent) ? agent : fallback;
+    }
+    /** The multiselect section, if the wizard has one. */
+    multiselect() {
+        return this.sections.find((section) => section.isMultiselect());
+    }
+    /** The selection of the multiselect section, or fallback when the wizard has none. */
+    selectedLanguages(fallback) {
+        const section = this.multiselect();
+        return section === undefined ? [...fallback] : section.selectedValues();
+    }
+    /**
+     * The GitHub project names entered in the projects-list section in entry
+     * order: trimmed, blanks dropped and case-insensitive duplicates removed.
+     * Empty without the section.
+     */
+    projectNames() {
+        const names = [];
+        const seen = new Set();
+        for (const section of this.sections.filter((candidate) => candidate.isProjectsList())) {
+            for (const name of [...section.existing, ...section.added].map((entry) => entry.trim())) {
+                const key = normalize(name);
+                if (name !== "" && !seen.has(key)) {
+                    seen.add(key);
+                    names.push(name);
+                }
+            }
+        }
+        return names;
+    }
+    /** The plain result the caller passes on to the install. */
+    result(fallback) {
+        return {
+            agent: this.selectedAgent(fallback.agent),
+            changes: this.changes(),
+            projectNames: this.projectNames(),
+            languages: this.selectedLanguages(fallback.languages),
+        };
+    }
+}

package/github/ISSUE_TEMPLATE/yaawn-prototype.md

@@ -0,0 +1,48 @@
+---
+about: Build a throwaway version of a feature idea to test with customers.
+assignees: ""
+labels: ["Yaawn: Prototype", "Yaawn: To Be Refined"]
+name: Yaawn Prototype
+projects: []
+title: ""
+---
+
+<!-- What should the experiment teach us? State the goal and the success criteria. -->
+
+## Goal
+
+<!-- What will be built to test it? Describe the experiment, not the implementation. The prototype runs on a prototype/ branch that is never merged. -->
+
+## What Will Be Built
+
+## Results
+
+<!-- Filled in by /yaawn-extract-learnings after the prototype was tested with customers: what was observed against the success criteria, and what was learned. -->
+
+## Implementation Plan
+
+<!-- How? Talk about this during planning part 3 or during work. -->
+
+### Human Readable
+
+### Open Questions
+
+| #   | Questions | Owner | Answer |
+| --- | --------- | ----- | ------ |
+|     |           |       |        |
+
+### Design Decisions
+
+<!-- Document decisions here that were made during planning or a grilling session. -->
+
+| #   | Decision | Choice | Rationale |
+| --- | -------- | ------ | --------- |
+|     |          |        |           |
+
+### Files to Change
+
+<!-- Bullet list of repo-relative paths of every file the implementation will change. -->
+
+### LLM Plan
+
+<!-- The plan is written here by /yaawn-save-plan. The Definition of Done lives in `.yaawn/yaawn-definition-of-done.md`. -->

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@yaawn/workflow",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Installs .agents/ skill files (skills, instructions, output-styles) into your project via `npx @yaawn/workflow`.",
   "license": "MIT",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/markusfalk/yaawn.git",
@@ -12,24 +13,24 @@
     "access": "public"
   },
   "bin": {
-    "workflow": "scripts/install.js"
+    "workflow": "dist/cli/main.js"
   },
   "scripts": {
-    "release:dry-run": "node release/release-installer.mjs --dry-run"
+    "prepublishOnly": "npm run build:workflow --prefix ../.."
   },
   "files": [
-    "scripts/",
+    "dist/",
+    "!dist/**/*.test.*",
     "config/",
     "agents/",
     "!agents/**/*.test.ts",
     "yaawn/",
     "github/"
   ],
-  "optionalDependencies": {
-    "@yaawn/workflow-darwin-arm64": "0.4.0",
-    "@yaawn/workflow-darwin-x64": "0.4.0",
-    "@yaawn/workflow-linux-x64": "0.4.0",
-    "@yaawn/workflow-linux-arm64": "0.4.0",
-    "@yaawn/workflow-win32-x64": "0.4.0"
+  "engines": {
+    "node": ">=23.5.0 || ^22.13.0 || ^20.17.0"
+  },
+  "dependencies": {
+    "@clack/prompts": "1.8.1"
   }
 }

package/agents/instructions/output-styles/yaawn-eli5.instructions.md

@@ -1,45 +0,0 @@
----
-name: ELI5
-description: 'Use only when the user explicitly asks for an ELI5, beginner-level, or plainly-worded explanation. Rewrites chat prose to use analogies, everyday vocabulary, and short sentences. Changes wording only — never code, commands, or file paths.'
-keep-coding-instructions: true
----
-
-# ELI5
-
-Explain things the way you would to someone smart who has never seen this system before.
-
-## Scope
-
-This style changes **the prose of chat answers only**. It never changes:
-
-- code, identifiers, and type names
-- file paths and shell commands
-- API names, endpoints, and configuration keys
-- error messages, stack traces, and log output
-- diffs and code comments
-- commit messages and PR descriptions
-- i18n keys and i18n values
-- anything inside a fenced code block
-
-Reproduce all of the above verbatim. Generated code follows the repository's existing conventions and is never reworded to fit this style.
-
-Accuracy outranks every rule below:
-
-- Never simplify a technical term into an inaccurate one.
-- Never shorten an error message or a security warning.
-- Never drop a caveat to make a sentence shorter.
-
-If a rule in this file would make the answer wrong, the rule loses.
-
-If another output style is also active, stop and ask which one applies.
-
-## Writing rules
-
-- Lead with an analogy or a concrete everyday comparison, then connect it back to the real thing.
-- Use everyday vocabulary. Prefer "reads" over "consumes", "goes wrong" over "fails to resolve".
-- Keep sentences short. One idea per sentence.
-- Introduce every technical term the first time it appears: name it, then say what it does in plain words.
-- Prefer concrete examples over abstract description.
-- Say what something is _for_ before saying how it works.
-- Do not use jargon as a shortcut. If a term is unavoidable, explain it.
-- Keep the answer as short as the question allows. Simple is not the same as long.

package/scripts/install.js

@@ -1,73 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-
-/**
- * Launcher for @yaawn/workflow (`npx @yaawn/workflow`).
- *
- * The installer itself is a Go binary shipped in a per-platform optional
- * dependency (`<package name>-<platform>`, e.g. `@yaawn/workflow-<platform>`).
- * The package name is read from this package's package.json, so a rename only
- * touches package.json. This shim finds the binary
- * for the current platform and runs it with the package root, so the binary
- * can read the bundled config and payload.
- */
-
-const path = require("path");
-const { spawnSync } = require("child_process");
-const { name: packageName } = require("../package.json");
-
-const BINARY_NAME = "workflow";
-
-const PLATFORM_KEYS = {
-  "darwin/arm64": "darwin-arm64",
-  "darwin/x64": "darwin-x64",
-  "linux/x64": "linux-x64",
-  "linux/arm64": "linux-arm64",
-  "win32/x64": "win32-x64",
-};
-
-const currentPlatform = `${process.platform}/${process.arch}`;
-
-function fail(message) {
-  process.stderr.write(`${BINARY_NAME}: ${message}\n`);
-  process.exit(1);
-}
-
-function resolveBinary() {
-  const platformKey = PLATFORM_KEYS[currentPlatform];
-  if (!platformKey) {
-    fail(
-      `unsupported platform ${currentPlatform} — supported: ${Object.keys(PLATFORM_KEYS).join(", ")}`,
-    );
-  }
-  if (typeof packageName !== "string" || packageName === "") {
-    fail("package.json has no package name — reinstall the package");
-  }
-  const platformPackage = `${packageName}-${platformKey}`;
-  try {
-    const manifest = require.resolve(`${platformPackage}/package.json`);
-    const fileName =
-      process.platform === "win32" ? `${BINARY_NAME}.exe` : BINARY_NAME;
-    return path.join(path.dirname(manifest), "bin", fileName);
-  } catch {
-    fail(
-      `installer binary package ${platformPackage} is not installed — it may be missing from the registry or skipped by --no-optional`,
-    );
-  }
-}
-
-const binary = resolveBinary();
-
-const packageRoot = path.join(__dirname, "..");
-const result = spawnSync(
-  binary,
-  ["--package-root", packageRoot, ...process.argv.slice(2)],
-  {
-    stdio: "inherit",
-  },
-);
-
-if (result.error)
-  fail(`could not start the installer (${result.error.message})`);
-if (result.signal) process.kill(process.pid, result.signal);
-process.exit(result.status === null ? 1 : result.status);