Merge pull request #9 from tmr232/fix-tsc-errors

Enable tsc typechecking

Author: tmr232

bun.lockb

@@ -37,7 +37,7 @@
     "vite": "^5.4.1"
   },
   "peerDependencies": {
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   },
   "scripts": {
     "dev": "echo 'Open this directory in VSCode and then run your extension with F5 or `Run and Debug > Run Extension`!'",
@@ -53,7 +53,7 @@
     "demo": "bun run --cwd ./src/demo/ vite",
     "build-demo": "bun run --cwd ./src/demo/ vite build --outDir ../../dist/demo --base '/function-graph-overview/'",
     "format": "bun prettier . --write --log-level silent",
-    "lint": "bun format && bun run eslint",
+    "lint": "bun format && bun run eslint || bun run tsc --noEmit",
     "generate-parsers": "bun run ./scripts/generate-parsers.ts"
   },
   "//": "START EXTENSION ATTRIBUTES",
@@ -104,4 +104,4 @@
   "engines": {
     "vscode": "^1.86.0"
   }
-}
+}

package.json

@@ -14,38 +14,36 @@ import {
 
 export class CFGBuilder {
   private graph: MultiDirectedGraph<GraphNode, GraphEdge>;
-  private entry: string;
   private nodeId: number;
   private readonly flatSwitch: boolean;
   private readonly markerPattern: RegExp | null;
 
   constructor(options?: BuilderOptions) {
     this.graph = new MultiDirectedGraph();
     this.nodeId = 0;
-    this.entry = null;
 
     this.flatSwitch = options?.flatSwitch ?? false;
     this.markerPattern = options?.markerPattern ?? null;
   }
 
   public buildCFG(functionNode: Parser.SyntaxNode): CFG {
-    const bodyNode = functionNode.childForFieldName("body");
-    if (bodyNode) {
+    const startNode = this.addNode("START", "START");
+
+    const bodySyntax = functionNode.childForFieldName("body");
+    if (bodySyntax) {
       const blockHandler = new BlockHandler();
       const { entry } = blockHandler.update(
-        this.processStatements(bodyNode.namedChildren),
+        this.processStatements(bodySyntax.namedChildren),
       );
 
       blockHandler.processGotos((gotoNode, labelNode) =>
         this.addEdge(gotoNode, labelNode),
       );
 
-      const startNode = this.addNode("START", "START");
       // `entry` will be non-null for any valid code
-      this.addEdge(startNode, entry);
-      this.entry = startNode;
+      if (entry) this.addEdge(startNode, entry);
     }
-    return { graph: this.graph, entry: this.entry };
+    return { graph: this.graph, entry: startNode };
   }
 
   private addNode(type: NodeType, code: string, lines: number = 1): string {

src/control-flow/cfg-c.ts

@@ -18,22 +18,22 @@ interface SwitchOptions {
 
 export class CFGBuilder {
   private graph: MultiDirectedGraph<GraphNode, GraphEdge>;
-  private entry: string;
   private nodeId: number;
   private readonly flatSwitch: boolean;
   private readonly markerPattern: RegExp | null;
 
   constructor(options?: BuilderOptions) {
     this.graph = new MultiDirectedGraph();
     this.nodeId = 0;
-    this.entry = null;
 
     this.flatSwitch = options?.flatSwitch ?? false;
     this.markerPattern = options?.markerPattern ?? null;
   }
 
   public buildCFG(functionNode: Parser.SyntaxNode): CFG {
+    const startNode = this.addNode("START", "START");
     const bodyNode = functionNode.childForFieldName("body");
+
     if (bodyNode) {
       const blockHandler = new BlockHandler();
       const { entry } = blockHandler.update(
@@ -44,12 +44,10 @@ export class CFGBuilder {
         this.addEdge(gotoNode, labelNode),
       );
 
-      const startNode = this.addNode("START", "START");
       // `entry` will be non-null for any valid code
-      this.addEdge(startNode, entry);
-      this.entry = startNode;
+      if (entry) this.addEdge(startNode, entry);
     }
-    return { graph: this.graph, entry: this.entry };
+    return { graph: this.graph, entry: startNode };
   }
 
   private addNode(type: NodeType, code: string, lines: number = 1): string {

src/control-flow/cfg-go.ts

@@ -17,36 +17,32 @@ import {
 export class CFGBuilder {
   private graph: MultiDirectedGraph<GraphNode, GraphEdge> =
     new MultiDirectedGraph();
-  private entry: string;
   private nodeId: number = 0;
   private clusterId: ClusterId = 0;
   private readonly flatSwitch: boolean;
   private readonly markerPattern: RegExp | null;
   private activeClusters: Cluster[] = [];
 
   constructor(options?: BuilderOptions) {
-    this.entry = null;
-
     this.flatSwitch = options?.flatSwitch ?? false;
     this.markerPattern = options?.markerPattern ?? null;
   }
 
   public buildCFG(functionNode: Parser.SyntaxNode): CFG {
+    const startNode = this.addNode("START", "START");
     const bodyNode = functionNode.childForFieldName("body");
     if (bodyNode) {
       const blockHandler = new BlockHandler();
       const { entry, exit } = blockHandler.update(
         this.processStatements(bodyNode.namedChildren),
       );
 
-      const startNode = this.addNode("START", "START");
       const endNode = this.addNode("RETURN", "implicit return");
       // `entry` will be non-null for any valid code
       if (entry) this.addEdge(startNode, entry);
       if (exit) this.addEdge(exit, endNode);
-      this.entry = startNode;
     }
-    return { graph: this.graph, entry: this.entry };
+    return { graph: this.graph, entry: startNode };
   }
 
   private startCluster(type: ClusterType): Cluster {

src/control-flow/cfg-python.ts

@@ -11,7 +11,7 @@ import { requirementTests } from "../../../test/commentTestHandlers";
 import { simplifyCFG, trimFor } from "../../../control-flow/graph-ops";
 import { mergeNodeAttrs } from "../../../control-flow/cfg-defs";
 import { graphToDot } from "../../../control-flow/render";
-import { Graphviz } from "@hpcc-js/wasm-graphviz";
+import { Graphviz, type Format } from "@hpcc-js/wasm-graphviz";
 async function initializeParser(language: Language) {
   await Parser.init({
     locateFile(_scriptName: string, _scriptDirectory: string) {
@@ -47,7 +47,7 @@ export async function initializeParsers(): Promise<Parsers> {
 }
 
 export function getFirstFunction(tree: Parser.Tree): Parser.SyntaxNode | null {
-  let functionNode: Parser.SyntaxNode = null;
+  let functionNode: Parser.SyntaxNode | null = null;
   const cursor = tree.walk();
 
   const funcTypes = [
@@ -93,7 +93,7 @@ export interface TestResults {
 export function runTest(record: TestFuncRecord): TestResults[] {
   const tree = parsers[record.language].parse(record.code);
   const testFunc: TestFunction = {
-    function: getFirstFunction(tree),
+    function: getFirstFunction(tree) as Parser.SyntaxNode,
     language: record.language,
     name: record.name,
     reqs: record.reqs,
@@ -125,8 +125,8 @@ export function processRecord(
 ): { dot?: string; ast: string; svg?: string; error?: Error } {
   const { trim, simplify, verbose, flatSwitch } = options;
   const tree = parsers[record.language].parse(record.code);
-  const functionSyntax = getFirstFunction(tree);
   const builder = newCFGBuilder(record.language, { flatSwitch });
+  const functionSyntax = getFirstFunction(tree) as Parser.SyntaxNode;
 
   const ast = functionSyntax.toString();
 
@@ -135,14 +135,17 @@ export function processRecord(
   try {
     cfg = builder.buildCFG(functionSyntax);
   } catch (error) {
-    return { ast, error };
+    return {
+      ast,
+      error: error instanceof Error ? error : new Error(`${error}`),
+    };
   }
 
-  if (!cfg) return null;
+  if (!cfg) return { ast };
   if (trim) cfg = trimFor(cfg);
   if (simplify) cfg = simplifyCFG(cfg, mergeNodeAttrs);
 
-  const dot = graphviz.dot(graphToDot(cfg, verbose), "canon");
+  const dot = graphviz.dot(graphToDot(cfg, verbose), "canon" as Format);
   const svg = graphviz.dot(dot);
 
   return { dot, ast, svg };