@thjodann/wk 1.0.0

package/dist/core/profiles.js

@@ -0,0 +1,243 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.profileRecipes = exports.userMaterialTags = exports.audienceTags = exports.siteAudiences = exports.wikiProfiles = void 0;
+exports.parseWikiProfile = parseWikiProfile;
+exports.parseSiteAudience = parseSiteAudience;
+exports.wikiProfiles = ["user", "developer", "mixed"];
+exports.siteAudiences = ["all", "user", "developer"];
+exports.audienceTags = {
+    all: "audience:all",
+    user: "audience:user",
+    developer: "audience:developer"
+};
+exports.userMaterialTags = [
+    "faq",
+    "getting-started",
+    "instructions",
+    "troubleshooting"
+];
+exports.profileRecipes = {
+    mixed: {
+        name: "mixed",
+        description: "Balanced first-pass wiki for users and maintainers.",
+        target_counts: {
+            article: 5,
+            concept: 8,
+            decision: 4,
+            event: 2,
+            note: 3,
+            symbol: 4
+        },
+        page_emphasis: [
+            "Home starts with public articles for user orientation and shared project essentials.",
+            "Guides prioritize article-led setup, FAQ, troubleshooting, and developer architecture.",
+            "Agent record indexes remain available as evidence and maintainer context."
+        ],
+        recommended_tags: [
+            exports.audienceTags.all,
+            exports.audienceTags.user,
+            exports.audienceTags.developer,
+            ...exports.userMaterialTags
+        ],
+        seeds: [
+            articleSeed("Project overview", "Write the public entry article: what this is, who it is for, and why it matters.", "all", ["product", "overview", "homepage"]),
+            articleSeed("Getting started", "Write the first successful user path with concrete setup or first-run steps.", "user", ["getting-started", "instructions", "homepage"]),
+            articleSeed("Features and workflows", "Explain the main user-facing modes, workflows, or feature areas.", "user", ["features", "instructions"]),
+            articleSeed("FAQ and troubleshooting", "Answer common user questions and first fixes in a browseable public page.", "user", ["faq", "troubleshooting"]),
+            articleSeed("Developer guide", "Explain architecture, generated-file rules, and the maintainer/agent workflow.", "developer", ["architecture", "dx", "maintenance"]),
+            conceptSeed("Product promise", "Explain what the project is, who it is for, and the core value in plain language.", "all", ["product", "overview", "homepage"]),
+            conceptSeed("Install and first start", "Explain how a new user gets from download/install to the first useful session.", "user", ["getting-started", "instructions", "homepage"]),
+            conceptSeed("Modes and features", "Describe the main user-facing modes, workflows, or feature areas.", "user", ["features", "instructions"]),
+            conceptSeed("Privacy and local data", "Explain what data stays local, what leaves the machine, and what users should know.", "user", ["privacy", "faq"]),
+            conceptSeed("FAQ", "Answer common user questions in short, scannable form.", "user", ["faq"]),
+            conceptSeed("Troubleshooting", "List common problems, symptoms, and first fixes.", "user", ["troubleshooting", "instructions"]),
+            conceptSeed("Architecture overview", "Summarize the main technical parts and how maintainers should orient themselves.", "developer", ["architecture", "dx"]),
+            conceptSeed("Data model", "Explain durable data, storage boundaries, generated files, and source-of-truth rules.", "developer", ["architecture", "data-model"]),
+            decisionSeed("Choose local-first project knowledge", "Capture why the wiki is generated from repo-local records instead of a hosted service.", "all", ["architecture", "product"]),
+            decisionSeed("Separate user and developer surfaces", "Capture how user-facing wiki pages differ from agent record indexes and maintainer docs.", "all", ["ux", "dx"]),
+            decisionSeed("Keep generated files deterministic", "Capture why generated Markdown and static site output should be reproducible.", "developer", ["docs", "generated-files"]),
+            decisionSeed("Use a static human wiki site", "Capture why the human wiki is plain static HTML rather than a dynamic app.", "all", ["site", "publishing"]),
+            eventSeed("Initial wiki seed", "Record the first meaningful Wikiwiki seeding pass and what it covered.", "all", ["milestone"]),
+            eventSeed("Latest dogfood milestone", "Record the most recent product/development milestone worth showing in project history.", "developer", ["devlog", "milestone"]),
+            noteSeed("Generated file workflow", "Remind contributors to edit structured records and rerun render/site commands instead of editing generated output.", "developer", ["docs", "generated-files"]),
+            noteSeed("Documentation drift caveats", "Capture known areas where the wiki may lag reality or need human review.", "all", ["docs", "caveats"]),
+            noteSeed("Open user questions", "Track unresolved user-facing questions that should become FAQ or troubleshooting material.", "user", ["faq", "product"]),
+            symbolSeed("Application entrypoint", "Point maintainers at the main runtime or CLI entrypoint.", "developer", "TODO: path/to/entrypoint"),
+            symbolSeed("Data store", "Point maintainers at the source-of-truth storage module.", "developer", "TODO: path/to/store"),
+            symbolSeed("Site renderer", "Point maintainers at the wiki/site rendering module.", "developer", "TODO: path/to/site-renderer"),
+            symbolSeed("Test entrypoint", "Point maintainers at the primary tests for wiki-critical behavior.", "developer", "TODO: path/to/tests")
+        ]
+    },
+    user: {
+        name: "user",
+        description: "First-pass wiki focused on product orientation and support.",
+        target_counts: {
+            article: 5,
+            concept: 6,
+            decision: 2,
+            event: 1,
+            note: 3,
+            symbol: 0
+        },
+        page_emphasis: [
+            "Home leads with public articles that explain the product, who it is for, and how to begin.",
+            "Guides prioritize article-led getting started, modes/features, privacy, FAQ, and troubleshooting.",
+            "Developer-only records stay out of the primary reader journey."
+        ],
+        recommended_tags: [
+            exports.audienceTags.all,
+            exports.audienceTags.user,
+            ...exports.userMaterialTags
+        ],
+        seeds: [
+            articleSeed("Overview", "Write the public entry article for the product promise and audience.", "all", ["product", "overview", "homepage"]),
+            articleSeed("Getting started", "Write the first successful user path.", "user", ["getting-started", "instructions", "homepage"]),
+            articleSeed("Features", "Explain what users can do and when to use each feature area.", "user", ["features", "instructions"]),
+            articleSeed("Privacy and data", "Explain user-visible privacy and storage behavior.", "user", ["privacy", "faq"]),
+            articleSeed("FAQ and troubleshooting", "Answer common questions and fixes.", "user", ["faq", "troubleshooting"]),
+            conceptSeed("Product promise", "Explain what the project is, who it is for, and why it matters.", "all", ["product", "overview", "homepage"]),
+            conceptSeed("Getting started", "Explain the first successful user path.", "user", ["getting-started", "instructions", "homepage"]),
+            conceptSeed("Core modes and features", "Describe what users can do and when to use each mode.", "user", ["features", "instructions"]),
+            conceptSeed("Privacy and data", "Explain user-visible privacy and storage behavior.", "user", ["privacy", "faq"]),
+            conceptSeed("FAQ", "Answer common user questions.", "user", ["faq"]),
+            conceptSeed("Troubleshooting", "Document common symptoms and fixes.", "user", ["troubleshooting"]),
+            decisionSeed("Define the user promise", "Capture the product boundary and user promise that docs should preserve.", "all", ["product", "ux"]),
+            decisionSeed("Choose a support path", "Capture how users should get unstuck and where support material belongs.", "user", ["support", "troubleshooting"]),
+            eventSeed("Initial user wiki seed", "Record the first user-facing wiki pass.", "all", ["milestone"]),
+            noteSeed("Known caveats", "Capture caveats users should know before they get surprised.", "user", ["caveats", "faq"]),
+            noteSeed("Open FAQ items", "Track unanswered user questions.", "user", ["faq"]),
+            noteSeed("Docs review reminders", "Track user-facing pages that need verification.", "user", ["docs"])
+        ]
+    },
+    developer: {
+        name: "developer",
+        description: "First-pass wiki focused on architecture, maintenance, and agent workflows.",
+        target_counts: {
+            article: 3,
+            concept: 7,
+            decision: 5,
+            event: 3,
+            note: 2,
+            symbol: 6
+        },
+        page_emphasis: [
+            "Home leads with developer articles for architecture and source-of-truth rules.",
+            "Guides prioritize article-led data model, workflow, decisions, and symbol anchors.",
+            "User-facing records are included only when they clarify product intent."
+        ],
+        recommended_tags: [
+            exports.audienceTags.all,
+            exports.audienceTags.developer,
+            "architecture",
+            "data-model",
+            "generated-files",
+            "maintenance"
+        ],
+        seeds: [
+            articleSeed("Architecture overview", "Write the maintainer entry article for modules and boundaries.", "developer", ["architecture", "homepage"]),
+            articleSeed("Data model", "Write the article for persisted records, generated artifacts, and source-of-truth rules.", "developer", ["architecture", "data-model"]),
+            articleSeed("Development workflow", "Write the article for build/test/render/closeout and agent expectations.", "developer", ["dx", "maintenance", "agents"]),
+            conceptSeed("Architecture overview", "Summarize the main modules and boundaries.", "developer", ["architecture", "homepage"]),
+            conceptSeed("Data model", "Explain persisted records, generated artifacts, and source-of-truth rules.", "developer", ["architecture", "data-model"]),
+            conceptSeed("Development workflow", "Document the daily build/test/render workflow.", "developer", ["dx", "maintenance"]),
+            conceptSeed("Generated-file workflow", "Explain what should and should not be edited by hand.", "developer", ["generated-files", "docs"]),
+            conceptSeed("Extension points", "Identify likely integration points for future tools or agents.", "developer", ["architecture", "agents"]),
+            conceptSeed("Testing strategy", "Explain the important tests and release checks.", "developer", ["tests", "release"]),
+            conceptSeed("Product promise", "Keep a short shared summary of the product intent developers should preserve.", "all", ["product", "overview"]),
+            decisionSeed("Choose the storage model", "Capture why records are stored where they are.", "developer", ["architecture", "data-model"]),
+            decisionSeed("Choose generated output boundaries", "Capture why Markdown and site output are generated artifacts.", "developer", ["generated-files", "docs"]),
+            decisionSeed("Choose agent workflow boundaries", "Capture what agents may infer and what requires user authority.", "developer", ["agents", "authority"]),
+            decisionSeed("Choose publishing workflow", "Capture how docs are built and published.", "developer", ["publishing", "ci"]),
+            decisionSeed("Choose user/developer audience split", "Capture how the wiki separates reader journeys.", "all", ["ux", "dx"]),
+            eventSeed("Initial developer wiki seed", "Record the first developer-focused wiki pass.", "developer", ["milestone", "devlog"]),
+            eventSeed("Current architecture milestone", "Record the most recent architecture milestone.", "developer", ["architecture", "milestone"]),
+            eventSeed("Current release milestone", "Record the most recent release or packaging milestone.", "developer", ["release", "milestone"]),
+            noteSeed("Maintenance caveats", "Capture known rough edges or stale areas.", "developer", ["maintenance", "caveats"]),
+            noteSeed("Agent closeout reminders", "Capture how agents should update records before finishing work.", "developer", ["agents", "docs"]),
+            symbolSeed("Application entrypoint", "Point to the main app or CLI entrypoint.", "developer", "TODO: path/to/entrypoint"),
+            symbolSeed("Record store", "Point to the durable storage implementation.", "developer", "TODO: path/to/store"),
+            symbolSeed("Validation layer", "Point to schema or validation code.", "developer", "TODO: path/to/validation"),
+            symbolSeed("Renderer", "Point to Markdown or site rendering code.", "developer", "TODO: path/to/renderer"),
+            symbolSeed("Search/indexing", "Point to search or indexing code.", "developer", "TODO: path/to/search"),
+            symbolSeed("Release checks", "Point to test or packaging entrypoints.", "developer", "TODO: path/to/release-checks")
+        ]
+    }
+};
+function parseWikiProfile(value, fallback = "mixed") {
+    if (!value) {
+        return fallback;
+    }
+    if (exports.wikiProfiles.includes(value)) {
+        return value;
+    }
+    throw new Error(`Unknown wiki profile: ${value}. Expected one of: ${exports.wikiProfiles.join(", ")}.`);
+}
+function parseSiteAudience(value, fallback = "all") {
+    if (!value) {
+        return fallback;
+    }
+    if (exports.siteAudiences.includes(value)) {
+        return value;
+    }
+    throw new Error(`Unknown site audience: ${value}. Expected one of: ${exports.siteAudiences.join(", ")}.`);
+}
+function articleSeed(title, purpose, audience, tags) {
+    return {
+        type: "article",
+        title,
+        purpose,
+        audience,
+        tags: withAudience(tags, audience)
+    };
+}
+function conceptSeed(title, purpose, audience, tags) {
+    return {
+        type: "concept",
+        title,
+        purpose,
+        audience,
+        tags: withAudience(tags, audience)
+    };
+}
+function decisionSeed(title, purpose, audience, tags) {
+    return {
+        type: "decision",
+        title,
+        purpose,
+        audience,
+        tags: withAudience(tags, audience)
+    };
+}
+function eventSeed(title, purpose, audience, tags) {
+    return {
+        type: "event",
+        title,
+        purpose,
+        audience,
+        tags: withAudience(tags, audience)
+    };
+}
+function noteSeed(title, purpose, audience, tags) {
+    return {
+        type: "note",
+        title,
+        purpose,
+        audience,
+        tags: withAudience(tags, audience)
+    };
+}
+function symbolSeed(title, purpose, audience, file) {
+    return {
+        type: "symbol",
+        title,
+        purpose,
+        audience,
+        file,
+        tags: withAudience(["symbol", "dx"], audience)
+    };
+}
+function withAudience(tags, audience) {
+    const audienceTag = exports.audienceTags[audience];
+    return [audienceTag, ...tags.filter((tag) => tag !== audienceTag)];
+}
+//# sourceMappingURL=profiles.js.map

package/dist/core/profiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profiles.js","sourceRoot":"","sources":["../../src/core/profiles.ts"],"names":[],"mappings":";;;AA2LA,4CAUC;AAED,8CAUC;AA/MY,QAAA,YAAY,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,CAAU,CAAC;AACvD,QAAA,aAAa,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,WAAW,CAAU,CAAC;AAuBtD,QAAA,YAAY,GAAG;IAC1B,GAAG,EAAE,cAAc;IACnB,IAAI,EAAE,eAAe;IACrB,SAAS,EAAE,oBAAoB;CACvB,CAAC;AAEE,QAAA,gBAAgB,GAAG;IAC9B,KAAK;IACL,iBAAiB;IACjB,cAAc;IACd,iBAAiB;CACT,CAAC;AAEE,QAAA,cAAc,GAA2C;IACpE,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,WAAW,EAAE,qDAAqD;QAClE,aAAa,EAAE;YACb,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,CAAC;YACR,IAAI,EAAE,CAAC;YACP,MAAM,EAAE,CAAC;SACV;QACD,aAAa,EAAE;YACb,sFAAsF;YACtF,wFAAwF;YACxF,2EAA2E;SAC5E;QACD,gBAAgB,EAAE;YAChB,oBAAY,CAAC,GAAG;YAChB,oBAAY,CAAC,IAAI;YACjB,oBAAY,CAAC,SAAS;YACtB,GAAG,wBAAgB;SACpB;QACD,KAAK,EAAE;YACL,WAAW,CAAC,kBAAkB,EAAE,kFAAkF,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAC/J,WAAW,CAAC,iBAAiB,EAAE,8EAA8E,EAAE,MAAM,EAAE,CAAC,iBAAiB,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;YACvK,WAAW,CAAC,wBAAwB,EAAE,kEAAkE,EAAE,MAAM,EAAE,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YAC/I,WAAW,CAAC,yBAAyB,EAAE,2EAA2E,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;YACvJ,WAAW,CAAC,iBAAiB,EAAE,gFAAgF,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;YACpK,WAAW,CAAC,iBAAiB,EAAE,mFAAmF,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAC/J,WAAW,CAAC,yBAAyB,EAAE,gFAAgF,EAAE,MAAM,EAAE,CAAC,iBAAiB,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;YACjL,WAAW,CAAC,oBAAoB,EAAE,mEAAmE,EAAE,MAAM,EAAE,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YAC5I,WAAW,CAAC,wBAAwB,EAAE,qFAAqF,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACxJ,WAAW,CAAC,KAAK,EAAE,wDAAwD,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;YAC7F,WAAW,CAAC,iBAAiB,EAAE,kDAAkD,EAAE,MAAM,EAAE,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;YAC/H,WAAW,CAAC,uBAAuB,EAAE,kFAAkF,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;YAC7J,WAAW,CAAC,YAAY,EAAE,uFAAuF,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAC/J,YAAY,CAAC,sCAAsC,EAAE,wFAAwF,EAAE,KAAK,EAAE,CAAC,cAAc,EAAE,SAAS,CAAC,CAAC;YAClL,YAAY,CAAC,sCAAsC,EAAE,0FAA0F,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACrK,YAAY,CAAC,oCAAoC,EAAE,+EAA+E,EAAE,WAAW,EAAE,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;YAC7K,YAAY,CAAC,8BAA8B,EAAE,4EAA4E,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;YACzJ,SAAS,CAAC,mBAAmB,EAAE,wEAAwE,EAAE,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC;YAC9H,SAAS,CAAC,0BAA0B,EAAE,wFAAwF,EAAE,WAAW,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACrK,QAAQ,CAAC,yBAAyB,EAAE,oHAAoH,EAAE,WAAW,EAAE,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC;YACnM,QAAQ,CAAC,6BAA6B,EAAE,0EAA0E,EAAE,KAAK,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAC/I,QAAQ,CAAC,qBAAqB,EAAE,4FAA4F,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YACzJ,UAAU,CAAC,wBAAwB,EAAE,0DAA0D,EAAE,WAAW,EAAE,0BAA0B,CAAC;YACzI,UAAU,CAAC,YAAY,EAAE,0DAA0D,EAAE,WAAW,EAAE,qBAAqB,CAAC;YACxH,UAAU,CAAC,eAAe,EAAE,sDAAsD,EAAE,WAAW,EAAE,6BAA6B,CAAC;YAC/H,UAAU,CAAC,iBAAiB,EAAE,oEAAoE,EAAE,WAAW,EAAE,qBAAqB,CAAC;SACxI;KACF;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,MAAM;QACZ,WAAW,EAAE,6DAA6D;QAC1E,aAAa,EAAE;YACb,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,CAAC;YACR,IAAI,EAAE,CAAC;YACP,MAAM,EAAE,CAAC;SACV;QACD,aAAa,EAAE;YACb,4FAA4F;YAC5F,mGAAmG;YACnG,gEAAgE;SACjE;QACD,gBAAgB,EAAE;YAChB,oBAAY,CAAC,GAAG;YAChB,oBAAY,CAAC,IAAI;YACjB,GAAG,wBAAgB;SACpB;QACD,KAAK,EAAE;YACL,WAAW,CAAC,UAAU,EAAE,sEAAsE,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAC3I,WAAW,CAAC,iBAAiB,EAAE,uCAAuC,EAAE,MAAM,EAAE,CAAC,iBAAiB,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;YAChI,WAAW,CAAC,UAAU,EAAE,8DAA8D,EAAE,MAAM,EAAE,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YAC7H,WAAW,CAAC,kBAAkB,EAAE,oDAAoD,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACjH,WAAW,CAAC,yBAAyB,EAAE,oCAAoC,EAAE,MAAM,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;YAChH,WAAW,CAAC,iBAAiB,EAAE,iEAAiE,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;YAC7I,WAAW,CAAC,iBAAiB,EAAE,yCAAyC,EAAE,MAAM,EAAE,CAAC,iBAAiB,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;YAClI,WAAW,CAAC,yBAAyB,EAAE,uDAAuD,EAAE,MAAM,EAAE,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;YACrI,WAAW,CAAC,kBAAkB,EAAE,oDAAoD,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACjH,WAAW,CAAC,KAAK,EAAE,+BAA+B,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;YACpE,WAAW,CAAC,iBAAiB,EAAE,qCAAqC,EAAE,MAAM,EAAE,CAAC,iBAAiB,CAAC,CAAC;YAClG,YAAY,CAAC,yBAAyB,EAAE,0EAA0E,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAC7I,YAAY,CAAC,uBAAuB,EAAE,0EAA0E,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;YACzJ,SAAS,CAAC,wBAAwB,EAAE,yCAAyC,EAAE,KAAK,EAAE,CAAC,WAAW,CAAC,CAAC;YACpG,QAAQ,CAAC,eAAe,EAAE,8DAA8D,EAAE,MAAM,EAAE,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YACrH,QAAQ,CAAC,gBAAgB,EAAE,kCAAkC,EAAE,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC;YAC/E,QAAQ,CAAC,uBAAuB,EAAE,iDAAiD,EAAE,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC;SACvG;KACF;IACD,SAAS,EAAE;QACT,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,4EAA4E;QACzF,aAAa,EAAE;YACb,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,CAAC;YACX,KAAK,EAAE,CAAC;YACR,IAAI,EAAE,CAAC;YACP,MAAM,EAAE,CAAC;SACV;QACD,aAAa,EAAE;YACb,gFAAgF;YAChF,oFAAoF;YACpF,yEAAyE;SAC1E;QACD,gBAAgB,EAAE;YAChB,oBAAY,CAAC,GAAG;YAChB,oBAAY,CAAC,SAAS;YACtB,cAAc;YACd,YAAY;YACZ,iBAAiB;YACjB,aAAa;SACd;QACD,KAAK,EAAE;YACL,WAAW,CAAC,uBAAuB,EAAE,gEAAgE,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;YACjJ,WAAW,CAAC,YAAY,EAAE,0FAA0F,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YAClK,WAAW,CAAC,sBAAsB,EAAE,0EAA0E,EAAE,WAAW,EAAE,CAAC,IAAI,EAAE,aAAa,EAAE,QAAQ,CAAC,CAAC;YAC7J,WAAW,CAAC,uBAAuB,EAAE,4CAA4C,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;YAC7H,WAAW,CAAC,YAAY,EAAE,4EAA4E,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YACpJ,WAAW,CAAC,sBAAsB,EAAE,gDAAgD,EAAE,WAAW,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YACzH,WAAW,CAAC,yBAAyB,EAAE,uDAAuD,EAAE,WAAW,EAAE,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;YACzI,WAAW,CAAC,kBAAkB,EAAE,gEAAgE,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;YAC1I,WAAW,CAAC,kBAAkB,EAAE,iDAAiD,EAAE,WAAW,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACrH,WAAW,CAAC,iBAAiB,EAAE,+EAA+E,EAAE,KAAK,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC/I,YAAY,CAAC,0BAA0B,EAAE,gDAAgD,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;YACvI,YAAY,CAAC,oCAAoC,EAAE,+DAA+D,EAAE,WAAW,EAAE,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;YAC7J,YAAY,CAAC,kCAAkC,EAAE,iEAAiE,EAAE,WAAW,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;YACzJ,YAAY,CAAC,4BAA4B,EAAE,2CAA2C,EAAE,WAAW,EAAE,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YAC1H,YAAY,CAAC,sCAAsC,EAAE,iDAAiD,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC5H,SAAS,CAAC,6BAA6B,EAAE,+CAA+C,EAAE,WAAW,EAAE,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YAC/H,SAAS,CAAC,gCAAgC,EAAE,gDAAgD,EAAE,WAAW,EAAE,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;YACzI,SAAS,CAAC,2BAA2B,EAAE,wDAAwD,EAAE,WAAW,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YACvI,QAAQ,CAAC,qBAAqB,EAAE,2CAA2C,EAAE,WAAW,EAAE,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YACrH,QAAQ,CAAC,0BAA0B,EAAE,iEAAiE,EAAE,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACxI,UAAU,CAAC,wBAAwB,EAAE,0CAA0C,EAAE,WAAW,EAAE,0BAA0B,CAAC;YACzH,UAAU,CAAC,cAAc,EAAE,8CAA8C,EAAE,WAAW,EAAE,qBAAqB,CAAC;YAC9G,UAAU,CAAC,kBAAkB,EAAE,qCAAqC,EAAE,WAAW,EAAE,0BAA0B,CAAC;YAC9G,UAAU,CAAC,UAAU,EAAE,2CAA2C,EAAE,WAAW,EAAE,wBAAwB,CAAC;YAC1G,UAAU,CAAC,iBAAiB,EAAE,mCAAmC,EAAE,WAAW,EAAE,sBAAsB,CAAC;YACvG,UAAU,CAAC,gBAAgB,EAAE,yCAAyC,EAAE,WAAW,EAAE,8BAA8B,CAAC;SACrH;KACF;CACF,CAAC;AAEF,SAAgB,gBAAgB,CAAC,KAAyB,EAAE,WAAwB,OAAO;IACzF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAK,oBAAkC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACxD,OAAO,KAAoB,CAAC;IAC9B,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,sBAAsB,oBAAY,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAClG,CAAC;AAED,SAAgB,iBAAiB,CAAC,KAAyB,EAAE,WAAyB,KAAK;IACzF,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAK,qBAAmC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACzD,OAAO,KAAqB,CAAC;IAC/B,CAAC;IAED,MAAM,IAAI,KAAK,CAAC,0BAA0B,KAAK,sBAAsB,qBAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpG,CAAC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,OAAe,EAAE,QAAsB,EAAE,IAAc;IACzF,OAAO;QACL,IAAI,EAAE,SAAS;QACf,KAAK;QACL,OAAO;QACP,QAAQ;QACR,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,OAAe,EAAE,QAAsB,EAAE,IAAc;IACzF,OAAO;QACL,IAAI,EAAE,SAAS;QACf,KAAK;QACL,OAAO;QACP,QAAQ;QACR,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,KAAa,EAAE,OAAe,EAAE,QAAsB,EAAE,IAAc;IAC1F,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,KAAK;QACL,OAAO;QACP,QAAQ;QACR,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,SAAS,SAAS,CAAC,KAAa,EAAE,OAAe,EAAE,QAAsB,EAAE,IAAc;IACvF,OAAO;QACL,IAAI,EAAE,OAAO;QACb,KAAK;QACL,OAAO;QACP,QAAQ;QACR,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,KAAa,EAAE,OAAe,EAAE,QAAsB,EAAE,IAAc;IACtF,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,KAAK;QACL,OAAO;QACP,QAAQ;QACR,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAAC,KAAa,EAAE,OAAe,EAAE,QAAsB,EAAE,IAAY;IACtF,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK;QACL,OAAO;QACP,QAAQ;QACR,IAAI;QACJ,IAAI,EAAE,YAAY,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;KAC/C,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,IAAc,EAAE,QAAsB;IAC1D,MAAM,WAAW,GAAG,oBAAY,CAAC,QAAQ,CAAC,CAAC;IAC3C,OAAO,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,WAAW,CAAC,CAAC,CAAC;AACrE,CAAC"}

package/dist/core/renderer.d.ts

@@ -0,0 +1,8 @@
+export declare const generatedNotice = "<!-- Generated by Wikiwiki from .wikiwiki/records. Edit structured records instead, then run `wk render`. -->";
+export declare const wikiPageFileNames: readonly ["index.md", "articles.md", "concepts.md", "decisions.md", "devlog.md", "notes.md", "symbols.md", "links.md"];
+export type RenderedPage = {
+    fileName: string;
+    content: string;
+};
+export declare function buildWikiPages(root: string): RenderedPage[];
+export declare function renderWiki(root: string): string[];

package/dist/core/renderer.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wikiPageFileNames = exports.generatedNotice = void 0;
+exports.buildWikiPages = buildWikiPages;
+exports.renderWiki = renderWiki;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const config_1 = require("./config");
+const articles_1 = require("./articles");
+const articlesPage_1 = require("../templates/articlesPage");
+const decisionsPage_1 = require("../templates/decisionsPage");
+const conceptsPage_1 = require("../templates/conceptsPage");
+const devlogPage_1 = require("../templates/devlogPage");
+const indexPage_1 = require("../templates/indexPage");
+const linksPage_1 = require("../templates/linksPage");
+const notesPage_1 = require("../templates/notesPage");
+const symbolsPage_1 = require("../templates/symbolsPage");
+const store_1 = require("./store");
+const paths_1 = require("./paths");
+const schemas_1 = require("./schemas");
+exports.generatedNotice = "<!-- Generated by Wikiwiki from .wikiwiki/records. Edit structured records instead, then run `wk render`. -->";
+exports.wikiPageFileNames = [
+    "index.md",
+    "articles.md",
+    "concepts.md",
+    "decisions.md",
+    "devlog.md",
+    "notes.md",
+    "symbols.md",
+    "links.md"
+];
+function buildWikiPages(root) {
+    const records = (0, store_1.readAllRecords)(root);
+    const theme = (0, config_1.readWikiwikiSiteTheme)(root);
+    const repoName = theme.project_name?.trim() || path_1.default.basename(root);
+    const description = theme.project_description?.trim() || "A project wiki generated from durable repo knowledge.";
+    const sourceRecords = new Map();
+    for (const type of schemas_1.recordTypes) {
+        for (const record of records[type]) {
+            sourceRecords.set(record.id, record);
+        }
+    }
+    const pages = [
+        {
+            fileName: "index.md",
+            content: withNotice((0, indexPage_1.indexPage)(records, { repoName, description }))
+        },
+        {
+            fileName: "articles.md",
+            content: withNotice((0, articlesPage_1.articlesPage)(records.article))
+        },
+        {
+            fileName: "concepts.md",
+            content: withNotice((0, conceptsPage_1.conceptsPage)(records.concept))
+        },
+        {
+            fileName: "decisions.md",
+            content: withNotice((0, decisionsPage_1.decisionsPage)(records.decision))
+        },
+        {
+            fileName: "devlog.md",
+            content: withNotice((0, devlogPage_1.devlogPage)(records.event))
+        },
+        {
+            fileName: "notes.md",
+            content: withNotice((0, notesPage_1.notesPage)(records.note))
+        },
+        {
+            fileName: "symbols.md",
+            content: withNotice((0, symbolsPage_1.symbolsPage)(records.symbol))
+        },
+        {
+            fileName: "links.md",
+            content: withNotice((0, linksPage_1.linksPage)(records.link))
+        }
+    ];
+    for (const article of records.article) {
+        pages.push({
+            fileName: `articles/${(0, articles_1.articleMarkdownFileName)(article)}`,
+            content: withNotice((0, articlesPage_1.articlePage)(article, article.source_record_ids.map((id) => sourceRecords.get(id)).filter(isRecord)))
+        });
+    }
+    return pages;
+}
+function renderWiki(root) {
+    const pages = buildWikiPages(root);
+    const outputPath = (0, paths_1.wikiPath)(root);
+    fs_1.default.mkdirSync(outputPath, { recursive: true });
+    fs_1.default.rmSync(path_1.default.join(outputPath, "articles"), { recursive: true, force: true });
+    return pages.map((page) => {
+        const file = path_1.default.join(outputPath, page.fileName);
+        fs_1.default.mkdirSync(path_1.default.dirname(file), { recursive: true });
+        fs_1.default.writeFileSync(file, page.content, "utf8");
+        return file;
+    });
+}
+function withNotice(content) {
+    return `${exports.generatedNotice}\n\n${content.trimEnd()}\n`;
+}
+function isRecord(record) {
+    return record !== undefined;
+}
+//# sourceMappingURL=renderer.js.map

package/dist/core/renderer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderer.js","sourceRoot":"","sources":["../../src/core/renderer.ts"],"names":[],"mappings":";;;;;;AAmCA,wCAsDC;AAED,gCAYC;AAvGD,4CAAoB;AACpB,gDAAwB;AACxB,qCAAiD;AACjD,yCAAqD;AACrD,4DAAsE;AACtE,8DAA2D;AAC3D,4DAAyD;AACzD,wDAAqD;AACrD,sDAAmD;AACnD,sDAAmD;AACnD,sDAAmD;AACnD,0DAAuD;AACvD,mCAAyC;AACzC,mCAAmC;AACnC,uCAAwD;AAE3C,QAAA,eAAe,GAC1B,+GAA+G,CAAC;AAErG,QAAA,iBAAiB,GAAG;IAC/B,UAAU;IACV,aAAa;IACb,aAAa;IACb,cAAc;IACd,WAAW;IACX,UAAU;IACV,YAAY;IACZ,UAAU;CACF,CAAC;AAOX,SAAgB,cAAc,CAAC,IAAY;IACzC,MAAM,OAAO,GAAG,IAAA,sBAAc,EAAC,IAAI,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,IAAA,8BAAqB,EAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,cAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IACnE,MAAM,WAAW,GAAG,KAAK,CAAC,mBAAmB,EAAE,IAAI,EAAE,IAAI,uDAAuD,CAAC;IACjH,MAAM,aAAa,GAAG,IAAI,GAAG,EAAqB,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,qBAAW,EAAE,CAAC;QAC/B,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,aAAa,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAmB;QAC5B;YACE,QAAQ,EAAE,UAAU;YACpB,OAAO,EAAE,UAAU,CAAC,IAAA,qBAAS,EAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,CAAC,CAAC;SACnE;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,OAAO,EAAE,UAAU,CAAC,IAAA,2BAAY,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACnD;QACD;YACE,QAAQ,EAAE,aAAa;YACvB,OAAO,EAAE,UAAU,CAAC,IAAA,2BAAY,EAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACnD;QACD;YACE,QAAQ,EAAE,cAAc;YACxB,OAAO,EAAE,UAAU,CAAC,IAAA,6BAAa,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;SACrD;QACD;YACE,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE,UAAU,CAAC,IAAA,uBAAU,EAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC/C;QACD;YACE,QAAQ,EAAE,UAAU;YACpB,OAAO,EAAE,UAAU,CAAC,IAAA,qBAAS,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC7C;QACD;YACE,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,UAAU,CAAC,IAAA,yBAAW,EAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SACjD;QACD;YACE,QAAQ,EAAE,UAAU;YACpB,OAAO,EAAE,UAAU,CAAC,IAAA,qBAAS,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SAC7C;KACF,CAAC;IAEF,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACtC,KAAK,CAAC,IAAI,CAAC;YACT,QAAQ,EAAE,YAAY,IAAA,kCAAuB,EAAC,OAAO,CAAC,EAAE;YACxD,OAAO,EAAE,UAAU,CAAC,IAAA,0BAAW,EAAC,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;SACzH,CAAC,CAAC;IACL,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAgB,UAAU,CAAC,IAAY;IACrC,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACnC,MAAM,UAAU,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,CAAC;IAClC,YAAE,CAAC,SAAS,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC9C,YAAE,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAE/E,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,MAAM,IAAI,GAAG,cAAI,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAClD,YAAE,CAAC,SAAS,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,YAAE,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,UAAU,CAAC,OAAe;IACjC,OAAO,GAAG,uBAAe,OAAO,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC;AACxD,CAAC;AAED,SAAS,QAAQ,CAAC,MAA6B;IAC7C,OAAO,MAAM,KAAK,SAAS,CAAC;AAC9B,CAAC"}