Generate dev-docs

.github/workflows/pages.yaml

@@ -17,6 +17,9 @@ jobs:
       - name: "Build Demo Website"
         run: bun build-demo
 
+      - name: "Build docs"
+        run: bun typedocs --out ./dist/demo/devdocs
+
       - uses: actions/upload-pages-artifact@v3
         with:
           path: ./dist/demo

docs/Development.md

@@ -1,3 +1,10 @@
+---
+title: Development
+group: Documents
+category: Guides
+---
+
+
 # Development
 
 These are instructions for developing this project.

package.json

@@ -63,7 +63,8 @@
     "oxlint-ci": "bunx oxlint --ignore-pattern=\"*.svelte\" -D correctness -D perf -D suspicious -A no-await-in-loop",
     "lint": "bunx biome check --fix && bun oxlint-fix && bunx eslint --fix && bunx tsc --noEmit",
     "ci": "bunx biome ci && bun oxlint-ci && bunx eslint && bunx tsc --noEmit",
-    "generate-parsers": "bun run ./scripts/generate-parsers.ts"
+    "generate-parsers": "bun run ./scripts/generate-parsers.ts",
+    "typedoc": "bunx typedoc --treatWarningsAsErrors"
   },
   "//": "START EXTENSION ATTRIBUTES",
   "publisher": "tamir-bahar",

src/control-flow/generic-cfg-builder.ts

@@ -10,7 +10,7 @@ import {
 import { NodeMapper } from "./node-mapper";
 import { pairwise } from "./zip";
 
-interface Dispatch {
+export interface Dispatch {
   /**
    * Process a single AST node into a basic block
    * @param syntax
@@ -23,7 +23,7 @@ interface Dispatch {
    */
   many(statements: Parser.SyntaxNode[]): BasicBlock;
 }
-interface Link {
+export interface Link {
   syntaxToNode: InstanceType<typeof NodeMapper>["linkSyntaxToNode"];
   offsetToSyntax: InstanceType<typeof NodeMapper>["linkOffsetToSyntax"];
 }
@@ -43,7 +43,7 @@ export interface Context {
  * @param {Context} ctx - The context in which the statement is being handled
  * @returns {BasicBlock} A basic block representation of the AST node
  */
-type StatementHandler = (syntax: Parser.SyntaxNode, ctx: Context) => BasicBlock;
+export type StatementHandler = (syntax: Parser.SyntaxNode, ctx: Context) => BasicBlock;
 /**
  * Maps AST nodes to their matching `StatementHandler` functions.
  */

src/control-flow/graph-ops.ts

@@ -56,7 +56,7 @@ function collapseNode(
 }
 /**
  *
- * @param graph The graph to simplify
+ * @param cfg The graph to simplify
  */
 export function simplifyCFG(cfg: CFG, mergeAttrs?: AttrMerger): CFG {
   const graph = cfg.graph.copy();