more sketching

Author: rvedotrc

.github/workflows/lint.yml

@@ -23,17 +23,5 @@ jobs:
         run: npm install
       - name: Run the linter
         run: ./lint
-      - name: Create the diagram
-        run: ./diagram > diagram.md
-      - name: Save the diagram
-        run: |
-          git add diagram.md
-          git status
-          git remote -v
-          new_branch="${{ github.ref_name }}-diagram"
-          git branch -D "${new_branch}" || :
-          git checkout -b "${new_branch}"
-          git config user.name "${{ github.workflow }}"
-          git config user.email "github-actions@example.com"
-          git commit -m "Diagram saved by lint.yml workflow"
-          git push --set-upstream "$( git remote )" --force "${new_branch}"
+      - name: Check the diagram
+        run: ./diagram --check

diagram

@@ -1,15 +1,21 @@
 #!/bin/bash
 
-set -euo pipefail
+if [ $# -eq 1 -a "$1" == "--check" ] ; then
+  node diagram.js
+  git add diagram.md
+  if ! git diff --cached --exit-code diagram.md ; then
+    echo "Changes detected in diagram.md. Please run './diagram --write' and commit the results."
+    exit 1
+  fi
+  exit 0
+fi
 
-cat <<MERMAID
-\`\`\`mermaid
-graph TD;
-    A-->B;
-    A-->C;
-    B-->D;
-    C-->D;
-    D-->E;
-    E["generated at $( date )"]
-\`\`\`
-MERMAID
+if [ $# -eq 1 -a "$1" == "--write" ] ; then
+  node diagram.js
+  git add diagram.md
+  git status diagram.md
+  exit 0
+fi
+
+echo "Usage: './diagram --write' or './diagram --check'" >&2
+exit 1

diagram.js

@@ -1,3 +1,5 @@
+"use strict";
+
 import { exec } from "node:child_process";
 import * as path from "node:path";
 
@@ -73,10 +75,9 @@ const makeResolver = (filenameToNodeId) => {
   };
 };
 
-const main = async () => {
-  const markdownFilenames = await findMarkdownFiles();
-  const links = await scanForLinks(markdownFilenames);
-  const trimmed = localMarkdownToMarkdownLinks(links);
+const buildGraph = (markdownFilenames, trimmed) => {
+  const nodeLines = [];
+  const edgeLines = [];
 
   const filenameToNodeId = new Map(
     markdownFilenames.map((filename, index) => [filename, `id${index}`]),
@@ -86,12 +87,8 @@ const main = async () => {
   const targetResolver = makeResolver(filenameToNodeId);
   const seenEdges = new Set();
 
-  console.log("```mermaid");
-  //   console.log("graph TD;"); // top-down
-  console.log("graph LR;"); // left-right
-
   for (const [filename, nodeId] of filenameToNodeId.entries()) {
-    console.log(`  ${nodeId}[${JSON.stringify(filename)}]`);
+    nodeLines.push(`  ${nodeId}[${JSON.stringify(filename)}]`);
   }
 
   for (const links of trimmed) {
@@ -102,20 +99,32 @@ const main = async () => {
 
       if (r.isNew) {
         const label = `?? ${r.resolved} ??`;
-        console.log(`  ${r.id}[${JSON.stringify(label)}]`);
+        nodeLines.push(`  ${r.id}[${JSON.stringify(label)}]`);
       }
 
       const edgeKey = `${fromNodeId} to ${r.id}`;
       if (!seenEdges.has(edgeKey)) {
-        console.log(`  ${fromNodeId}-->${r.id}`);
+        edgeLines.push(`  ${fromNodeId}-->${r.id}`);
         seenEdges.add(edgeKey);
       }
     }
   }
 
-  console.log("```");
+  // Stable output
+  return [...nodeLines.toSorted(), ...edgeLines.toSorted()];
+};
+
+const main = async () => {
+  const markdownFilenames = await findMarkdownFiles();
+  const links = await scanForLinks(markdownFilenames);
+  const trimmed = localMarkdownToMarkdownLinks(links);
+
+  const graphLines = buildGraph(markdownFilenames, trimmed);
+  const graphContent =
+    ["```mermaid", "graph LR;", ...graphLines, "```"].join("\n") + "\n";
 
-  //   console.dir({ trimmed, e: [...m.entries()] }, { depth: 5 });
+  await writeFile("diagram.md", graphContent, "utf-8");
+  console.log("Wrote diagram.md");
 };
 
 main().catch((error) => {

diagram.md

@@ -0,0 +1,30 @@
+```mermaid
+graph LR;
+  id0["courses/Backend/README.md"]
+  id10["shared-modules/JavaScript/legacy-js1-week1.md"]
+  id11["shared-modules/JavaScript/legacy-js1-week2.md"]
+  id12["shared-modules/JavaScript/legacy-js1-week3.md"]
+  id13["shared-modules/JavaScript/legacy-js1-week4.md"]
+  id14["shared-modules/JavaScript/legacy-js2-week1.md"]
+  id15["shared-modules/JavaScript/legacy-js2-week2.md"]
+  id16["shared-modules/JavaScript/legacy-js2-week3.md"]
+  id17["shared-modules/JavaScript/legacy-js3-week1.md"]
+  id18["shared-modules/JavaScript/legacy-js3-week2.md"]
+  id19["shared-modules/JavaScript/legacy-js3-week3.md"]
+  id1["courses/Foundation/HTML-CSS/Pre-course/readme.md"]
+  id20["shared-modules/README.md"]
+  id21["shared-modules/legacy-git1.md"]
+  id22["shared-modules/legacy-git2.md"]
+  id2["courses/Foundation/HTML-CSS/The-one-and-only-week1/readme.md"]
+  id3["courses/Foundation/HTML-CSS/first-homework-submission.md"]
+  id4["courses/Foundation/HTML-CSS/homework.md"]
+  id5["courses/Foundation/HTML-CSS/readme.md"]
+  id6["courses/Foundation/README.md"]
+  id7["courses/Frontend/README.md"]
+  id8["courses/Pre-Course/README.md"]
+  id9["diagram.md"]
+  id5-->id1
+  id5-->id2
+  id5-->id4
+  id6-->id5
+```