Ensuring no todo markers on main (#1628)

* refactor: prune slipped todos

* refactor: main lint guard

* refactor: fix gihub typo

Author: EagleoutIce

.github/workflows/qa.yaml

@@ -85,6 +85,30 @@ jobs:
       - name: "👩‍🏫 Run linter"
         run: bash .github/workflows/scripts/run-flowr-command.sh lint-local
 
+  lint-main:
+    needs: [ debug ]
+    name: "👩‍🏫 Linting on Main"
+    if: ${{ (github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main') || github.base_ref == 'main' }}
+    runs-on: ubuntu-22.04
+    steps:
+      - name: "🛒 Checkout Repository"
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: "🌍 Load Versions to Use"
+        id: doc-global-versions
+        run: bash .github/workflows/scripts/global-configuration.sh
+
+      - name: "⬇️ Use Node.js"
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.ACTION_NODE_VERSION }}
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: "👩‍🏫 Run linter"
+        run: bash .github/workflows/scripts/run-flowr-command.sh lint
+
   test:
     needs: [ debug ]
     name: "⚗️ Test Suite (coverage)"

src/control-flow/basic-cfg-guided-visitor.ts

@@ -32,7 +32,6 @@ export class BasicCfgGuidedVisitor<
 
 	constructor(config: Config) {
 		this.config = { ...config };
-		// TODO: as an optimization invert the CFG when default order is forward
 		this.visited = new Map<NodeId, number>();
 	}
 

src/control-flow/cfg-to-basic-blocks.ts

@@ -48,7 +48,6 @@ export function convertCfgToBasicBlocks(cfInfo: ControlFlowInformation): Control
 		}
 	}
 
-	// TODO: check in and outputs to attach entry and exit points
 	const findEntries = cfInfo.entryPoints.map(e => newCfg.getBasicBlock(e)?.id);
 	const findExits = cfInfo.exitPoints.map(e => newCfg.getBasicBlock(e)?.id);
 

src/control-flow/control-flow-graph.ts

@@ -251,7 +251,6 @@ export class ControlFlowGraph<Vertex extends CfgSimpleVertex = CfgSimpleVertex>
 		// remove all bbChildren with id as target
 		for(const [a, b] of this.bbChildren.entries()) {
 			if(b === id) {
-				// TODO: check for modify on iterate
 				this.bbChildren.delete(a);
 			}
 		}

src/control-flow/dfg-cfg-guided-visitor.ts

@@ -34,6 +34,4 @@ export class DataflowAwareCfgGuidedVisitor<
 	protected getDataflowGraph(id: NodeId): DataflowGraphVertexArgument | undefined {
 		return this.config.dataflow.graph.getVertex(id);
 	}
-
-	// TODO: check whether functions are overloaded, resolve calls, provide origin, ...
 }

src/control-flow/extract-cfg.ts

@@ -358,7 +358,6 @@ function cfgFunctionCallWithDataflow(graph: DataflowGraph): typeof cfgFunctionCa
 		/* try to resolve the call and link the target definitions */
 		const targets = getAllFunctionCallTargets(call.info.id, graph);
 
-		// TODO: use cfgFunctionCall with resolve-dcall exit and than link toi that so wthat we do not ahve multiple exit points
 		const exits: NodeId[] = [];
 		const callVertex = baseCFG.graph.getVertex(call.info.id);
 		guard(callVertex !== undefined, 'cfgFunctionCallWithDataflow: call vertex not found');

src/dataflow/origin/dfg-get-origin.ts

@@ -155,7 +155,6 @@ function getCallTarget(dfg: DataflowGraph, call: DataflowGraphVertexFunctionCall
 		if(get?.tag !== VertexType.FunctionDefinition && get?.tag !== VertexType.VariableDefinition) {
 			return undefined;
 		}
-		// TODO: if the _target_ resolve just returns a symbol and not a fd, we have to go transitive
 		return {
 			type: get.tag === VertexType.FunctionDefinition ? (OriginType.FunctionCallOrigin as const) : (OriginType.ReadVariableOrigin as const),
 			id:   target

test/functionality/control-flow/cfg-happens-before.test.ts

@@ -16,5 +16,4 @@ describe.sequential('Happens Before', withShell(shell => {
 		assertHappensBefore(shell, 'x<-1\nif(u) x <- 2\nx <- 3', a, b, t);
 	}
 	assertHappensBefore(shell, 'x<-1\nif(u) x <- 2 else x <- 3\nx <- 4', '1@x', '3@x', Ternary.Always);
-	// TODO: check for function calls
 }));