@canonical/code-standards 0.1.0

package/src/scripts/generate-docs.ts

@@ -0,0 +1,131 @@
+#!/usr/bin/env bun
+/**
+ * Transforms code standards from TTL to readable markdown per category.
+ * Usage: bun src/scripts/generate-docs.ts [output-dir]
+ */
+
+import { readFileSync, writeFileSync, mkdirSync, readdirSync } from "fs";
+import { join, basename } from "path";
+
+const DATA_DIR = join(import.meta.dir, "../../data");
+const DEFAULT_OUTPUT = "./docs";
+
+interface Standard {
+  name: string;
+  description: string;
+  dos: string;
+  donts: string;
+}
+
+interface Category {
+  label: string;
+  slug: string;
+  standards: Standard[];
+}
+
+// Minimal TTL parser - extracts string literals
+function extractLiteral(content: string, predicate: string): string {
+  const regex = new RegExp(`${predicate}\\s+"""([\\s\\S]*?)"""`, "g");
+  const match = regex.exec(content);
+  if (match) return match[1].trim();
+
+  const singleLine = new RegExp(`${predicate}\\s+"([^"]*)"`, "g");
+  const singleMatch = singleLine.exec(content);
+  return singleMatch ? singleMatch[1].trim() : "";
+}
+
+function parseCategory(content: string): { label: string; slug: string } {
+  const label =
+    content.match(/rdfs:label\s+"([^"]+)"/)?.[1] ||
+    content.match(/rdfs:label\s+"([^"]+)"@en/)?.[1] ||
+    "";
+  const slug = content.match(/cs:slug\s+"([^"]+)"/)?.[1] || "";
+  return { label, slug };
+}
+
+function parseStandards(content: string): Standard[] {
+  // Split by standard definitions
+  const blocks = content.split(/\n(?=\w+:\w+\s+a\s+cs:CodeStandard)/);
+  const standards: Standard[] = [];
+
+  for (const block of blocks) {
+    if (!block.includes("a cs:CodeStandard")) continue;
+
+    const name = extractLiteral(block, "cs:name");
+    const description = extractLiteral(block, "cs:description");
+    const dos = extractLiteral(block, "cs:dos");
+    const donts = extractLiteral(block, "cs:donts");
+
+    if (name) {
+      standards.push({ name, description, dos, donts });
+    }
+  }
+
+  return standards.sort((a, b) => a.name.localeCompare(b.name));
+}
+
+function generateMarkdown(category: Category): string {
+  const lines: string[] = [
+    `# ${category.label} Standards`,
+    "",
+    `Standards for ${category.slug} development.`,
+    "",
+  ];
+
+  for (const std of category.standards) {
+    lines.push(`## ${std.name}`, "", std.description, "");
+
+    if (std.dos) {
+      lines.push("### Do", "", std.dos, "");
+    }
+    if (std.donts) {
+      lines.push("### Don't", "", std.donts, "");
+    }
+    lines.push("---", "");
+  }
+
+  return lines.join("\n");
+}
+
+function main() {
+  const outputDir = process.argv[2] || DEFAULT_OUTPUT;
+  mkdirSync(outputDir, { recursive: true });
+
+  const files = readdirSync(DATA_DIR).filter((f) => f.endsWith(".ttl"));
+  const categories: Category[] = [];
+
+  for (const file of files) {
+    const content = readFileSync(join(DATA_DIR, file), "utf-8");
+    const { label, slug } = parseCategory(content);
+    const standards = parseStandards(content);
+
+    if (!label || standards.length === 0) continue;
+
+    const category = { label, slug: slug || basename(file, ".ttl"), standards };
+    categories.push(category);
+
+    const markdown = generateMarkdown(category);
+    const outFile = join(outputDir, `${category.slug}.md`);
+    writeFileSync(outFile, markdown);
+    console.log(`Generated ${outFile} (${standards.length} standards)`);
+  }
+
+  // Generate index
+  const index = [
+    "# Code Standards",
+    "",
+    "Standards documentation generated from the code-standards ontology.",
+    "",
+    "## Categories",
+    "",
+    ...categories
+      .sort((a, b) => a.label.localeCompare(b.label))
+      .map((c) => `- [${c.label}](./${c.slug}.md) (${c.standards.length})`),
+    "",
+  ].join("\n");
+
+  writeFileSync(join(outputDir, "index.md"), index);
+  console.log(`Generated ${join(outputDir, "index.md")}`);
+}
+
+main();

package/src/scripts/index.ts

@@ -0,0 +1,19 @@
+#!/usr/bin/env bun
+/**
+ * Code standards scripts entry point.
+ * Routes to specific scripts based on command.
+ */
+
+const command = process.argv[2];
+
+switch (command) {
+  case "docs":
+  case "generate-docs":
+    await import("./generate-docs.ts");
+    break;
+  default:
+    console.log("Usage: bun src/scripts/index.ts <command>");
+    console.log("");
+    console.log("Commands:");
+    console.log("  docs [output-dir]  Generate markdown docs (default: ./docs)");
+}