cstm-changeset 1.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Paul Morar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+# cstm-changeset
+
+[![npm version](https://img.shields.io/npm/v/cstm-changeset.svg)](https://www.npmjs.com/package/cstm-changeset)
+[![license](https://img.shields.io/npm/l/cstm-changeset.svg)](./LICENSE.md)
+
+A CLI wrapper around `changeset add` that prompts for structured business context — because changelogs should tell the *why*, not just the *what*.
+
+## Why?
+
+[Changesets](https://github.com/changesets/changesets) is a fantastic tool for managing versioning and changelogs. But out of the box, it only captures *what* changed. When a teammate (or future you) looks back at the changelog, questions like these often go unanswered:
+
+- What business value did this change bring?
+- Did this affect clients? How?
+- Was it tested? How thoroughly?
+
+**cstm-changeset** fixes that by adding a quick interactive prompt after `changeset add`, appending structured context directly to your changeset file.
+
+## Installation
+
+```bash
+npm install -D cstm-changeset
+```
+
+> **Note:** Requires Node.js 24+ and `@changesets/cli` as a peer dependency.
+
+## Usage
+
+Instead of running `npx changeset add`, run:
+
+```bash
+npx cstm-changeset
+```
+
+The CLI will:
+
+1. Run the standard `changeset add` flow (package selection, bump type, summary)
+2. Prompt you with a few follow-up questions about business context
+3. Append the answers to the newly created changeset file
+
+## Example
+
+Here's what the interactive prompt looks like:
+
+<!-- TODO: Add screenshot -->
+![Example prompt](./docs/example.png)
+
+And here's what gets appended to your changeset:
+
+```markdown
+## Business Context
+
+**Business value:** Improves checkout conversion by reducing page load time
+
+**Client impact:** Yes — Clients using the legacy API will need to migrate
+
+**Tested:** Yes — Ran load tests simulating 10k concurrent users
+```
+
+## How It Works
+
+1. Detects your `.changeset` directory
+2. Runs `npx changeset add` under the hood
+3. Identifies the newly created changeset file
+4. Asks three quick questions:
+   - What value does this change bring to the business?
+   - Does this carry client impact? (if yes, describe it)
+   - Has this been tested? (if yes, describe how)
+5. Appends a "Business Context" section to the changeset
+
+## Requirements
+
+- Node.js **24+**
+- `@changesets/cli` **2+** (peer dependency)
+
+## License
+
+[MIT](./LICENSE.md)

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { Interface } from "node:readline";
+interface BusinessContext {
+    businessValue: string;
+    hasClientImpact: boolean;
+    clientImpactDetail: string;
+    isTested: boolean;
+    testingDetail: string;
+}
+export declare function getChangesetDir(): string;
+export declare function getChangesetFiles(dir: string): string[];
+export declare function askYesNo(rl: Interface, question: string): Promise<boolean>;
+export declare function askFreeText(rl: Interface, question: string): Promise<string>;
+export declare function buildAnnotation(ctx: BusinessContext): string;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAGA,OAAO,EAAmB,SAAS,EAAE,MAAM,eAAe,CAAC;AAM3D,UAAU,eAAe;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,OAAO,CAAC;IACzB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;AAID,wBAAgB,eAAe,IAAI,MAAM,CAExC;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAYvD;AAQD,wBAAsB,QAAQ,CAC5B,EAAE,EAAE,SAAS,EACb,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,OAAO,CAAC,CAOlB;AAED,wBAAsB,WAAW,CAC/B,EAAE,EAAE,SAAS,EACb,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,MAAM,CAAC,CAGjB;AAID,wBAAgB,eAAe,CAAC,GAAG,EAAE,eAAe,GAAG,MAAM,CAU5D"}

package/dist/index.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+import { spawnSync } from "node:child_process";
+import { createInterface } from "node:readline";
+import { readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+// ─── Filesystem ───────────────────────────────────────────────────────────────
+export function getChangesetDir() {
+    return resolve(process.cwd(), ".changeset");
+}
+export function getChangesetFiles(dir) {
+    try {
+        return readdirSync(dir).filter((f) => f.endsWith(".md") && f !== "README.md");
+    }
+    catch {
+        console.error(`\n❌  Could not find a .changeset directory at:\n   ${dir}\n\n` +
+            `   Make sure you're running this from the root of a project that uses changesets.\n`);
+        process.exit(1);
+    }
+}
+// ─── Prompt helpers ───────────────────────────────────────────────────────────
+function ask(rl, question) {
+    return new Promise((res) => rl.question(question, res));
+}
+export async function askYesNo(rl, question) {
+    while (true) {
+        const answer = (await ask(rl, `${question} (y/n): `)).trim().toLowerCase();
+        if (answer === "y" || answer === "yes")
+            return true;
+        if (answer === "n" || answer === "no")
+            return false;
+        console.log('  Please answer "y" or "n".');
+    }
+}
+export async function askFreeText(rl, question) {
+    const answer = (await ask(rl, `${question}\n> `)).trim();
+    return answer || "No details provided.";
+}
+// ─── Annotation ───────────────────────────────────────────────────────────────
+export function buildAnnotation(ctx) {
+    return `
+## Business Context
+
+**Business value:** ${ctx.businessValue}
+
+**Client impact:** ${ctx.hasClientImpact ? `Yes — ${ctx.clientImpactDetail}` : "No"}
+
+**Tested:** ${ctx.isTested ? `Yes — ${ctx.testingDetail}` : "No"}
+`;
+}
+// ─── Main ─────────────────────────────────────────────────────────────────────
+async function main() {
+    const changesetDir = getChangesetDir();
+    const before = new Set(getChangesetFiles(changesetDir));
+    console.log("\n📝  Running changeset add...\n");
+    const result = spawnSync("npx", ["changeset", "add"], { stdio: "inherit" });
+    if (result.status !== 0) {
+        console.error("\n❌  changeset add failed. Exiting.");
+        process.exit(result.status ?? 1);
+    }
+    const after = getChangesetFiles(changesetDir);
+    const newFiles = after.filter((f) => !before.has(f));
+    if (newFiles.length === 0) {
+        console.log("\nNo new changeset file detected — nothing to annotate.");
+        process.exit(0);
+    }
+    const newFile = resolve(changesetDir, newFiles[0]);
+    const rl = createInterface({ input: process.stdin, output: process.stdout });
+    console.log("\n─────────────────────────────────────────────");
+    console.log("  📋  A few more questions for the changelog");
+    console.log("─────────────────────────────────────────────\n");
+    const businessValue = await askFreeText(rl, "1. What value does this change bring to the business?");
+    console.log();
+    const hasClientImpact = await askYesNo(rl, "2. Does this carry client impact?");
+    let clientImpactDetail = "";
+    if (hasClientImpact) {
+        clientImpactDetail = await askFreeText(rl, "   Please describe the client impact:");
+    }
+    console.log();
+    const isTested = await askYesNo(rl, "3. Has this been tested?");
+    let testingDetail = "";
+    if (isTested) {
+        testingDetail = await askFreeText(rl, "   Briefly describe how it was tested:");
+    }
+    rl.close();
+    const existingContent = readFileSync(newFile, "utf8");
+    const annotation = buildAnnotation({
+        businessValue,
+        hasClientImpact,
+        clientImpactDetail,
+        isTested,
+        testingDetail,
+    });
+    writeFileSync(newFile, existingContent.trimEnd() + "\n" + annotation);
+    console.log(`\n✅  Changeset annotated: ${newFiles[0]}\n`);
+}
+main().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAa,MAAM,eAAe,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACnE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAYpC,iFAAiF;AAEjF,MAAM,UAAU,eAAe;IAC7B,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,YAAY,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,IAAI,CAAC;QACH,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,MAAM,CAC5B,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,WAAW,CAC9C,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,KAAK,CACX,sDAAsD,GAAG,MAAM;YAC7D,qFAAqF,CACxF,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,iFAAiF;AAEjF,SAAS,GAAG,CAAC,EAAa,EAAE,QAAgB;IAC1C,OAAO,IAAI,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC5B,EAAa,EACb,QAAgB;IAEhB,OAAO,IAAI,EAAE,CAAC;QACZ,MAAM,MAAM,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,GAAG,QAAQ,UAAU,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QAC3E,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,KAAK;YAAE,OAAO,IAAI,CAAC;QACpD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,IAAI;YAAE,OAAO,KAAK,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,WAAW,CAC/B,EAAa,EACb,QAAgB;IAEhB,MAAM,MAAM,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,EAAE,GAAG,QAAQ,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACzD,OAAO,MAAM,IAAI,sBAAsB,CAAC;AAC1C,CAAC;AAED,iFAAiF;AAEjF,MAAM,UAAU,eAAe,CAAC,GAAoB;IAClD,OAAO;;;sBAGa,GAAG,CAAC,aAAa;;qBAElB,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI;;cAErE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC,IAAI;CAC/D,CAAC;AACF,CAAC;AAED,iFAAiF;AAEjF,KAAK,UAAU,IAAI;IACjB,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,CAAC;IAExD,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,SAAS,CAAC,KAAK,EAAE,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;IAE5E,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACrD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,KAAK,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;IAC9C,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAErD,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAC;QACvE,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnD,MAAM,EAAE,GAAG,eAAe,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAE7E,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;IAC/D,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAC;IAC5D,OAAO,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;IAE/D,MAAM,aAAa,GAAG,MAAM,WAAW,CACrC,EAAE,EACF,uDAAuD,CACxD,CAAC;IAEF,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,MAAM,eAAe,GAAG,MAAM,QAAQ,CACpC,EAAE,EACF,mCAAmC,CACpC,CAAC;IACF,IAAI,kBAAkB,GAAG,EAAE,CAAC;IAC5B,IAAI,eAAe,EAAE,CAAC;QACpB,kBAAkB,GAAG,MAAM,WAAW,CACpC,EAAE,EACF,uCAAuC,CACxC,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,GAAG,EAAE,CAAC;IACd,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,EAAE,EAAE,0BAA0B,CAAC,CAAC;IAChE,IAAI,aAAa,GAAG,EAAE,CAAC;IACvB,IAAI,QAAQ,EAAE,CAAC;QACb,aAAa,GAAG,MAAM,WAAW,CAC/B,EAAE,EACF,wCAAwC,CACzC,CAAC;IACJ,CAAC;IAED,EAAE,CAAC,KAAK,EAAE,CAAC;IAEX,MAAM,eAAe,GAAG,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACtD,MAAM,UAAU,GAAG,eAAe,CAAC;QACjC,aAAa;QACb,eAAe;QACf,kBAAkB;QAClB,QAAQ;QACR,aAAa;KACd,CAAC,CAAC;IAEH,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,UAAU,CAAC,CAAC;IAEtE,OAAO,CAAC,GAAG,CAAC,6BAA6B,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC5D,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,GAAY,EAAE,EAAE;IAC5B,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "cstm-changeset",
+  "version": "1.0.1",
+  "description": "A changeset add wrapper that prompts for structured business context",
+  "type": "module",
+  "engines": {
+    "node": ">=24"
+  },
+  "bin": {
+    "cstm-changeset": "./dist/index.js"
+  },
+  "files": [
+    "dist/",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "peerDependencies": {
+    "@changesets/cli": ">=2"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.27.0",
+    "@types/node": "^20.0.0",
+    "tsx": "^4.0.0",
+    "typescript": "^5.0.0"
+  },
+  "keywords": [
+    "changesets",
+    "changelog",
+    "cli"
+  ],
+  "license": "MIT"
+}