inclusion-md 0.1.0

package/lib/prompt.js

@@ -0,0 +1,111 @@
+"use strict";
+
+const readline = require("readline");
+const c = require("./colors");
+
+function createPrompter({ acceptDefaults = false } = {}) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+    terminal: process.stdout.isTTY,
+  });
+
+  rl.on("SIGINT", () => {
+    rl.close();
+    const err = new Error("Cancelled by user");
+    err.code = "USER_CANCELLED";
+    throw err;
+  });
+
+  function ask(question) {
+    return new Promise((resolve, reject) => {
+      rl.question(question, (answer) => resolve(answer));
+      rl.once("close", () => {
+        const err = new Error("Cancelled by user");
+        err.code = "USER_CANCELLED";
+        reject(err);
+      });
+    });
+  }
+
+  function fmtDefault(d) {
+    if (d === undefined || d === null || d === "") return "";
+    return c.dim(` (${d})`);
+  }
+
+  async function text(label, { default: def = "", required = false } = {}) {
+    if (acceptDefaults) return def;
+    while (true) {
+      const raw = await ask(`${c.cyan("?")} ${c.bold(label)}${fmtDefault(def)}: `);
+      const val = (raw || "").trim();
+      if (val) return val;
+      if (def) return def;
+      if (!required) return "";
+      process.stdout.write(c.yellow("  This one's required - try again.\n"));
+    }
+  }
+
+  async function multiline(label, { default: def = "" } = {}) {
+    if (acceptDefaults) return def;
+    process.stdout.write(
+      `${c.cyan("?")} ${c.bold(label)}\n` +
+        c.dim("  (one item per line; empty line to finish")
+    );
+    if (def)
+      process.stdout.write(c.dim(`; press enter immediately to accept default`));
+    process.stdout.write(c.dim(")\n"));
+    const lines = [];
+    while (true) {
+      const raw = await ask(c.dim("  - "));
+      const val = (raw || "").trim();
+      if (val === "" && lines.length === 0 && def) return def;
+      if (val === "") break;
+      lines.push(val);
+    }
+    return lines.length ? lines.map((l) => `- ${l}`).join("\n") : def;
+  }
+
+  async function choice(label, options, { default: defIndex = 0 } = {}) {
+    if (acceptDefaults) return options[defIndex].value;
+    process.stdout.write(`${c.cyan("?")} ${c.bold(label)}\n`);
+    options.forEach((opt, i) => {
+      const marker = i === defIndex ? c.green("*") : " ";
+      process.stdout.write(
+        `  ${marker} ${c.bold(String(i + 1))}) ${opt.label}` +
+          (opt.hint ? c.dim(`  - ${opt.hint}`) : "") +
+          "\n"
+      );
+    });
+    while (true) {
+      const raw = await ask(c.dim(`  choose 1-${options.length} `) + fmtDefault(defIndex + 1) + ": ");
+      const val = (raw || "").trim();
+      if (val === "") return options[defIndex].value;
+      const n = parseInt(val, 10);
+      if (Number.isInteger(n) && n >= 1 && n <= options.length) {
+        return options[n - 1].value;
+      }
+      process.stdout.write(c.yellow(`  Please enter a number 1-${options.length}.\n`));
+    }
+  }
+
+  async function confirm(label, { default: def = false } = {}) {
+    if (acceptDefaults) return def;
+    const hint = def ? "Y/n" : "y/N";
+    while (true) {
+      const raw = await ask(`${c.cyan("?")} ${c.bold(label)} ${c.dim(`(${hint})`)}: `);
+      const val = (raw || "").trim().toLowerCase();
+      if (val === "") return def;
+      if (val === "y" || val === "yes") return true;
+      if (val === "n" || val === "no") return false;
+      process.stdout.write(c.yellow("  Please answer y or n.\n"));
+    }
+  }
+
+  function close() {
+    rl.close();
+  }
+
+  return { text, multiline, choice, confirm, close };
+}
+
+module.exports = { createPrompter };

package/lib/template.js

@@ -0,0 +1,70 @@
+"use strict";
+
+const fs = require("fs");
+const path = require("path");
+
+const VARIANTS = {
+  generic: "INCLUSION.md",
+  "frontend-app": "examples/frontend-app/INCLUSION.md",
+  "design-system": "examples/design-system/INCLUSION.md",
+  "backend-api": "examples/backend-api/INCLUSION.md",
+};
+
+function loadTemplate(variant) {
+  const rel = VARIANTS[variant];
+  if (!rel) {
+    throw new Error(
+      `Unknown variant "${variant}". Choose one of: ${Object.keys(VARIANTS).join(", ")}.`
+    );
+  }
+  // Resolve relative to the package root (one level up from /lib).
+  const base = path.resolve(__dirname, "..");
+  const full = path.join(base, rel);
+  if (!fs.existsSync(full)) {
+    throw new Error(`Template not found at ${full}.`);
+  }
+  return fs.readFileSync(full, "utf8");
+}
+
+/**
+ * Render the generic template by substituting Section 1 (Project Context) and
+ * Section 12 (Maintenance) with the user's answers. We do a targeted block
+ * replace so we don't have to maintain a parallel templating language - the
+ * canonical INCLUSION.md is itself the template.
+ */
+function renderGeneric(template, answers) {
+  let out = template;
+
+  // --- Section 1: Project Context -----------------------------------------
+  const newProjectContext =
+    `## 1. Project Context\n\n` +
+    `- **Product:** ${answers.product}\n` +
+    `- **Primary users:** ${answers.primaryUsers}\n` +
+    `- **Known underserved users:** ${answers.underservedUsers}\n` +
+    `- **Distribution context:** ${answers.distribution}\n` +
+    `- **Stakes:** ${answers.stakes}\n\n` +
+    `Generated code, copy, and interaction patterns should be evaluated against the\n` +
+    `context above before being merged.`;
+
+  out = replaceSection(out, /^## 1\. Project Context[\s\S]*?(?=^---\s*$)/m, newProjectContext + "\n\n");
+
+  // --- Section 12: Maintenance --------------------------------------------
+  const newMaintenance =
+    `## 12. Maintenance\n\n` +
+    `- **Owner:** ${answers.owner}\n` +
+    `- **Review cadence:** ${answers.cadence}\n` +
+    `- **Change log:** Track meaningful changes to this file in\n` +
+    `  [\`CHANGELOG.md\`](./CHANGELOG.md) or in repository releases.\n` +
+    `- **Feedback:** ${answers.feedback}`;
+
+  out = replaceSection(out, /^## 12\. Maintenance[\s\S]*?(?=^---\s*$)/m, newMaintenance + "\n\n");
+
+  return out;
+}
+
+function replaceSection(source, regex, replacement) {
+  if (!regex.test(source)) return source;
+  return source.replace(regex, replacement);
+}
+
+module.exports = { loadTemplate, renderGeneric, VARIANTS };

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "inclusion-md",
+  "version": "0.1.0",
+  "description": "Scaffold an INCLUSION.md - a context engineering doc that gives AI coding assistants inclusion-oriented guidance during code generation.",
+  "keywords": [
+    "inclusion",
+    "accessibility",
+    "a11y",
+    "ai",
+    "llm",
+    "context-engineering",
+    "copilot",
+    "claude",
+    "cursor",
+    "design-systems"
+  ],
+  "homepage": "https://github.com/BranonConor/inclusion.md#readme",
+  "bugs": {
+    "url": "https://github.com/BranonConor/inclusion.md/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BranonConor/inclusion.md.git"
+  },
+  "license": "MIT",
+  "author": "Branon Eusebio (https://branon.dev)",
+  "type": "commonjs",
+  "bin": {
+    "inclusion-md": "bin/inclusion-md.js"
+  },
+  "files": [
+    "bin",
+    "lib",
+    "templates",
+    "INCLUSION.md",
+    "examples",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "test": "node bin/inclusion-md.js --help"
+  }
+}