@eagleoutice/flowr 2.6.0 → 2.6.2

package/control-flow/semantic-cfg-guided-visitor.js

@@ -69,7 +69,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      *
      * This function is called for every use of a variable in the program and dispatches the appropriate event.
      * You probably do not have to overwrite it and just use {@link SemanticCfgGuidedVisitor#onVariableUse|`onVariableUse`} instead.
-     *
      * @protected
      */
     visitVariableUse(vertex) {
@@ -81,7 +80,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      *
      * This function is called for every variable definition in the program and dispatches the appropriate event.
      * You probably do not have to overwrite it and just use {@link SemanticCfgGuidedVisitor#onVariableDefinition|`onVariableDefinition`} instead.
-     *
      * @protected
      */
     visitVariableDefinition(vertex) {
@@ -93,7 +91,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      *
      * This function is called for every function definition in the program and dispatches the appropriate event.
      * You probably do not have to overwrite it and just use {@link SemanticCfgGuidedVisitor#onFunctionDefinition|`onFunctionDefinition`} instead.
-     *
      * @protected
      */
     visitFunctionDefinition(vertex) {
@@ -113,7 +110,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * You probably do not have to overwrite it and just use {@link SemanticCfgGuidedVisitor#onUnnamedCall|`onUnnamedCall`} for anonymous calls,
      * or {@link SemanticCfgGuidedVisitor#onDispatchFunctionCallOrigins|`onDispatchFunctionCallOrigins`} for named calls (or just overwrite
      * the events you are interested in directly).
-     *
      * @protected
      */
     visitFunctionCall(vertex) {
@@ -130,7 +126,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * This function is called for every unknown vertex in the program.
      * It dispatches the appropriate event based on the type of the vertex.
      * In case you have to overwrite this function please make sure to still call this implementation to get a correctly working {@link SemanticCfgGuidedVisitor#onProgram|`onProgram`}.
-     *
      * @protected
      */
     visitUnknown(vertex) {
@@ -146,7 +141,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * and aggregating their results (which is just additive by default).
      * If you want to change the behavior in case of multiple potential function definition targets, simply overwrite this function
      * with the logic you desire.
-     *
      * @protected
      */
     onDispatchFunctionCallOrigins(call, origins) {
@@ -158,9 +152,7 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * This function is responsible for dispatching the appropriate event
      * based on a given dataflow vertex. The default serves as a backend
      * for the event functions, but you may overwrite and extend this function at will.
-     *
      * @see {@link onDispatchFunctionCallOrigins} for the aggregation in case the function call target is ambiguous.
-     *
      * @protected
      */
     onDispatchFunctionCallOrigin(call, origin) {
@@ -263,7 +255,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
     }
     /**
      * This event is called for the root program node, i.e., the program that is being analyzed.
-     *
      * @protected
      */
     onProgram(_data) { }
@@ -335,7 +326,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * This is separate from {@link SemanticCfgGuidedVisitor#onDefaultFunctionCall|`onDefaultFunctionCall`} which is used for named function calls that do not trigger any of these events.
      * The main differentiation for these calls is that you may not infer their semantics from any name alone and probably _have_
      * to rely on {@link SemanticCfgGuidedVisitor#getOrigins|`getOrigins`} to get more information.
-     *
      * @protected
      */
     onUnnamedCall(_data) { }
@@ -356,7 +346,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * This explicitly will not trigger for scenarios in which the function has no name (i.e., if it is anonymous).
      * For such cases, you may rely on the {@link SemanticCfgGuidedVisitor#onUnnamedCall|`onUnnamedCall`} event.
      * The main reason for this separation is part of flowR's handling of these functions, as anonymous calls cannot be resolved using the active environment.
-     *
      * @protected
      */
     onDefaultFunctionCall(_data) { }
@@ -366,7 +355,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, `eval` in `eval(parse(text = "x + 1"))`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onEvalFunctionCall(_data) { }
@@ -376,7 +364,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, `lapply` in `lapply(1:10, function(x) { x + 1 })`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onApplyFunctionCall(_data) { }
@@ -385,7 +372,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      *
      * For example, this triggers for the expression list created by `{` and `}` in `ìf (TRUE) { x <- 1; y <- 2; }`. But also for the implicit
      * expression list `x <- x + 1` in `for(x in 1:10) x <- x + 1`.
-     *
      * @protected
      */
     onExpressionList(_data) { }
@@ -397,19 +383,16 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * By default, this does not provide the resolved source file. Yet you can access the {@link DataflowGraph} to ask for sourced files.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onSourceCall(_data) { }
     /**
      * This event triggers for every subsetting call, i.e., for every call to `[[`, `[`, or `$`.
-     *
      * @protected
      */
     onAccessCall(_data) { }
     /**
      * This event triggers for every call to the `if` function, which is used to implement the `if-then-else` control flow.
-     *
      * @protected
      */
     onIfThenElseCall(_data) { }
@@ -420,7 +403,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      *
      * Please be aware, that with flowR resolving the `get` during the dataflow analysis,
      * this may very well trigger a {@link SemanticCfgGuidedVisitor#onVariableUse|`onVariableUse`} event as well.
-     *
      * @protected
      */
     onGetCall(_data) { }
@@ -428,7 +410,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * This event triggers for every call to the `rm` function, which is used to remove variables from the environment.
      *
      * For example, `rm` in `rm(x)`.
-     *
      * @protected
      */
     onRmCall(_data) { }
@@ -438,7 +419,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, `library` in `library(dplyr)`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onLibraryCall(_data) { }
@@ -458,13 +438,11 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, this triggers for`%in%` in `x %in% y`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onSpecialBinaryOpCall(_data) { }
     /**
      * This event triggers for every call to R's pipe operator, i.e., for every call to `|>`.
-     *
      * @protected
      */
     onPipeCall(_data) { }
@@ -474,7 +452,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, `quote` in `quote(x + 1)`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onQuoteCall(_data) { }
@@ -484,7 +461,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, this triggers for `for` in `for(i in 1:10) { print(i) }`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onForLoopCall(_data) { }
@@ -494,7 +470,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, this triggers for `while` in `while(i < 10) { i <- i + 1 }`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onWhileLoopCall(_data) { }
@@ -504,7 +479,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, this triggers for `repeat` in `repeat { i <- i + 1; if(i >= 10) break }`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onRepeatLoopCall(_data) { }
@@ -526,7 +500,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, this triggers for `list` in `list(1, 2, 3)`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onListCall(_data) { }
@@ -536,7 +509,6 @@ class SemanticCfgGuidedVisitor extends dfg_cfg_guided_visitor_1.DataflowAwareCfg
      * For example, this triggers for `c` in `c(1, 2, 3)`.
      *
      * More specifically, this relates to the corresponding {@link BuiltInProcessorMapper} handler.
-     *
      * @protected
      */
     onVectorCall(_data) { }

package/control-flow/simple-visitor.d.ts

@@ -1,4 +1,4 @@
-import type { ControlFlowGraph } from './control-flow-graph';
+import { type ControlFlowGraph } from './control-flow-graph';
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 export type SimpleCfgVisitor = (graph: ControlFlowGraph, nodes: readonly NodeId[], visitor: (node: NodeId) => boolean | void) => void;
 /**
@@ -8,7 +8,6 @@ export type SimpleCfgVisitor = (graph: ControlFlowGraph, nodes: readonly NodeId[
  * @param visitor   - The visitor function to call for each node, if you return true the traversal from this node will be stopped.
  *
  * This function is of type {@link SimpleCfgVisitor}.
- *
  * @see {@link visitCfgInOrder} for a traversal in order
  */
 export declare function visitCfgInReverseOrder(graph: ControlFlowGraph, startNodes: readonly NodeId[], visitor: (node: NodeId) => boolean | void): void;
@@ -19,7 +18,6 @@ export declare function visitCfgInReverseOrder(graph: ControlFlowGraph, startNod
  * @param visitor    - The visitor function to call for each node, if you return true the traversal from this node will be stopped.
  *
  * This function is of type {@link SimpleCfgVisitor}.
- *
  * @see {@link visitCfgInReverseOrder} for a traversal in reversed order
  */
 export declare function visitCfgInOrder(graph: ControlFlowGraph, startNodes: readonly NodeId[], visitor: (node: NodeId) => boolean | void): void;

package/control-flow/simple-visitor.js

@@ -11,7 +11,6 @@ const control_flow_graph_1 = require("./control-flow-graph");
  * @param visitor   - The visitor function to call for each node, if you return true the traversal from this node will be stopped.
  *
  * This function is of type {@link SimpleCfgVisitor}.
- *
  * @see {@link visitCfgInOrder} for a traversal in order
  */
 function visitCfgInReverseOrder(graph, startNodes, 
@@ -48,7 +47,6 @@ visitor) {
  * @param visitor    - The visitor function to call for each node, if you return true the traversal from this node will be stopped.
  *
  * This function is of type {@link SimpleCfgVisitor}.
- *
  * @see {@link visitCfgInReverseOrder} for a traversal in reversed order
  */
 function visitCfgInOrder(graph, startNodes, 

package/control-flow/syntax-cfg-guided-visitor.d.ts

@@ -1,8 +1,7 @@
 import type { CfgExpressionVertex, CfgStatementVertex, ControlFlowInformation } from './control-flow-graph';
 import type { NodeId } from '../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { NormalizedAst, ParentInformation } from '../r-bridge/lang-4.x/ast/model/processing/decorate';
-import type { BasicCfgGuidedVisitorConfiguration } from './basic-cfg-guided-visitor';
-import { BasicCfgGuidedVisitor } from './basic-cfg-guided-visitor';
+import { type BasicCfgGuidedVisitorConfiguration, BasicCfgGuidedVisitor } from './basic-cfg-guided-visitor';
 import type { RAccess } from '../r-bridge/lang-4.x/ast/model/nodes/r-access';
 import type { RArgument } from '../r-bridge/lang-4.x/ast/model/nodes/r-argument';
 import type { RBinaryOp } from '../r-bridge/lang-4.x/ast/model/nodes/r-binary-op';

package/control-flow/useless-loop.d.ts

@@ -6,9 +6,6 @@ import type { ControlFlowInformation } from './control-flow-graph';
 export declare const loopyFunctions: Set<"builtin:default" | "builtin:eval" | "builtin:apply" | "builtin:expression-list" | "builtin:source" | "builtin:access" | "builtin:if-then-else" | "builtin:get" | "builtin:rm" | "builtin:library" | "builtin:assignment" | "builtin:special-bin-op" | "builtin:pipe" | "builtin:function-definition" | "builtin:quote" | "builtin:for-loop" | "builtin:repeat-loop" | "builtin:while-loop" | "builtin:replacement" | "builtin:list" | "builtin:vector">;
 /**
  * Checks whether a loop only loops once
- *
- *
- *
  * @param loop        - nodeid of the loop to analyse
  * @param dataflow    - dataflow graph
  * @param controlflow - control flow graph

package/control-flow/useless-loop.js

@@ -13,9 +13,6 @@ const semantic_cfg_guided_visitor_1 = require("./semantic-cfg-guided-visitor");
 exports.loopyFunctions = new Set(['builtin:for-loop', 'builtin:while-loop', 'builtin:repeat-loop']);
 /**
  * Checks whether a loop only loops once
- *
- *
- *
  * @param loop        - nodeid of the loop to analyse
  * @param dataflow    - dataflow graph
  * @param controlflow - control flow graph
@@ -93,9 +90,9 @@ class CfgSingleIterationLoopDetector extends semantic_cfg_guided_visitor_1.Seman
                     stack.unshift(to);
                 }
             }
-            this.onlyLoopyOnce ||= this.encounteredLoopBreaker && (0, info_1.happensInEveryBranch)(this.loopCds);
+            this.onlyLoopyOnce ||= this.encounteredLoopBreaker && (0, info_1.happensInEveryBranch)(this.loopCds?.filter(c => !c.byIteration));
         }
-        this.onlyLoopyOnce ||= this.encounteredLoopBreaker && (0, info_1.happensInEveryBranch)(this.loopCds);
+        this.onlyLoopyOnce ||= this.encounteredLoopBreaker && (0, info_1.happensInEveryBranch)(this.loopCds?.filter(c => !c.byIteration));
     }
     app(cds) {
         if (cds === undefined) {

package/core/pipeline-executor.d.ts

@@ -1,5 +1,4 @@
-import type { PipelineStepName } from './steps/pipeline-step';
-import { PipelineStepStage } from './steps/pipeline-step';
+import { type PipelineStepName, PipelineStepStage } from './steps/pipeline-step';
 import type { Pipeline, PipelineInput, PipelineOutput, PipelinePerRequestInput, PipelineStepOutputWithName } from './steps/pipeline/pipeline';
 import type { FlowrConfigOptions } from '../config';
 /**
@@ -22,13 +21,13 @@ import type { FlowrConfigOptions } from '../config';
  * ```ts
  * const stepper = new PipelineExecutor( ... )
  * while(stepper.hasNextStep()) {
- *     await stepper.nextStep()
+ * await stepper.nextStep()
  * }
  *
  * stepper.switchToRequestStage()
  *
  * while(stepper.hasNextStep()) {
- *     await stepper.nextStep()
+ * await stepper.nextStep()
  * }
  *
  * const result = stepper.getResults()
@@ -66,10 +65,10 @@ import type { FlowrConfigOptions } from '../config';
  *
  * ```ts
  * const slicer = new PipelineExecutor(DEFAULT_SLICING_PIPELINE, {
- *    parser:    new RShell(),
- *    // of course, the criterion and request given here are just examples, you can use whatever you want to slice!
- *    criterion: ['2@b'],
- *    request:   requestFromInput('b <- 3; x <- 5\ncat(b)'),
+ * parser:    new RShell(),
+ * // of course, the criterion and request given here are just examples, you can use whatever you want to slice!
+ * criterion: ['2@b'],
+ * request:   requestFromInput('b <- 3; x <- 5\ncat(b)'),
  * })
  * const result = await slicer.allRemainingSteps()
  * ```
@@ -80,12 +79,10 @@ import type { FlowrConfigOptions } from '../config';
  * stepper.updateRequest({ criterion: ['1@x'] })
  * const result2 = await stepper.allRemainingSteps()
  * ```
- *
  * @note Even though using the pipeline executor introduces a small performance overhead, we consider
  * it to be the baseline for performance benchmarking. It may very well be possible to squeeze out a little bit more by
  * directly constructing the steps in the right order. However, we consider this to be negligible when compared with the time required
  * for, for example, the dataflow analysis of larger files.
- *
  * @see PipelineExecutor#allRemainingSteps
  * @see PipelineExecutor#nextStep
  */
@@ -103,7 +100,6 @@ export declare class PipelineExecutor<P extends Pipeline> {
      *
      * Please see {@link createDataflowPipeline} and friends for engine agnostic shortcuts to create a pipeline executor.
      * And in general, please prefer using the {@link FlowrAnalyzer} and its {@link FlowrAnalyzerBuilder|builder} to create and use an analyzer instance.
-     *
      * @param pipeline - The {@link Pipeline} to execute, probably created with {@link createPipeline}.
      * @param input    - External {@link PipelineInput|configuration and input} required to execute the given pipeline.
      * @param flowrConfig   - The flowr config containing the built-in definitions
@@ -115,7 +111,6 @@ export declare class PipelineExecutor<P extends Pipeline> {
     getPipeline(): P;
     /**
      * Retrieve the current {@link PipelineStepStage|stage} the pipeline executor is in.
-     *
      * @see currentExecutionStage
      * @see switchToRequestStage
      * @see PipelineStepStage
@@ -126,7 +121,6 @@ export declare class PipelineExecutor<P extends Pipeline> {
      *
      * This will fail if either a step change is currently not valid (as not all steps have been executed),
      * or if there is no next stage (i.e., the pipeline is already completed or in the last stage).
-     *
      * @see PipelineExecutor
      * @see getCurrentStage
      */
@@ -144,9 +138,8 @@ export declare class PipelineExecutor<P extends Pipeline> {
      * Execute the next {@link IPipelineStep|step} and return the name of the {@link IPipelineStep|step} that was executed,
      * so you can guard if the {@link IPipelineStep|step} differs from what you are interested in.
      * Furthermore, it returns the {@link IPipelineStep|step's} result.
-     *
      * @param expectedStepName - A safeguard if you want to retrieve the result.
-     * 												   If given, it causes the execution to fail if the next step is not the one you expect.
+     *                           If given, it causes the execution to fail if the next step is not the one you expect.
      *
      * _Without `expectedStepName`, please refrain from accessing the result, as you have no safeguards if the pipeline changes._
      */
@@ -158,7 +151,6 @@ export declare class PipelineExecutor<P extends Pipeline> {
     /**
      * This only makes sense if you have already run a request and want to re-use the per-file results for a new one.
      * (or if for whatever reason, you did not pass information for the pipeline with the constructor).
-     *
      * @param newRequestData - Data for the new request
      */
     updateRequest(newRequestData: PipelinePerRequestInput<P>): void;

package/core/pipeline-executor.js

@@ -22,13 +22,13 @@ const assert_1 = require("../util/assert");
  * ```ts
  * const stepper = new PipelineExecutor( ... )
  * while(stepper.hasNextStep()) {
- *     await stepper.nextStep()
+ * await stepper.nextStep()
  * }
  *
  * stepper.switchToRequestStage()
  *
  * while(stepper.hasNextStep()) {
- *     await stepper.nextStep()
+ * await stepper.nextStep()
  * }
  *
  * const result = stepper.getResults()
@@ -66,10 +66,10 @@ const assert_1 = require("../util/assert");
  *
  * ```ts
  * const slicer = new PipelineExecutor(DEFAULT_SLICING_PIPELINE, {
- *    parser:    new RShell(),
- *    // of course, the criterion and request given here are just examples, you can use whatever you want to slice!
- *    criterion: ['2@b'],
- *    request:   requestFromInput('b <- 3; x <- 5\ncat(b)'),
+ * parser:    new RShell(),
+ * // of course, the criterion and request given here are just examples, you can use whatever you want to slice!
+ * criterion: ['2@b'],
+ * request:   requestFromInput('b <- 3; x <- 5\ncat(b)'),
  * })
  * const result = await slicer.allRemainingSteps()
  * ```
@@ -80,12 +80,10 @@ const assert_1 = require("../util/assert");
  * stepper.updateRequest({ criterion: ['1@x'] })
  * const result2 = await stepper.allRemainingSteps()
  * ```
- *
  * @note Even though using the pipeline executor introduces a small performance overhead, we consider
  * it to be the baseline for performance benchmarking. It may very well be possible to squeeze out a little bit more by
  * directly constructing the steps in the right order. However, we consider this to be negligible when compared with the time required
  * for, for example, the dataflow analysis of larger files.
- *
  * @see PipelineExecutor#allRemainingSteps
  * @see PipelineExecutor#nextStep
  */
@@ -103,7 +101,6 @@ class PipelineExecutor {
      *
      * Please see {@link createDataflowPipeline} and friends for engine agnostic shortcuts to create a pipeline executor.
      * And in general, please prefer using the {@link FlowrAnalyzer} and its {@link FlowrAnalyzerBuilder|builder} to create and use an analyzer instance.
-     *
      * @param pipeline - The {@link Pipeline} to execute, probably created with {@link createPipeline}.
      * @param input    - External {@link PipelineInput|configuration and input} required to execute the given pipeline.
      * @param flowrConfig   - The flowr config containing the built-in definitions
@@ -122,7 +119,6 @@ class PipelineExecutor {
     }
     /**
      * Retrieve the current {@link PipelineStepStage|stage} the pipeline executor is in.
-     *
      * @see currentExecutionStage
      * @see switchToRequestStage
      * @see PipelineStepStage
@@ -135,7 +131,6 @@ class PipelineExecutor {
      *
      * This will fail if either a step change is currently not valid (as not all steps have been executed),
      * or if there is no next stage (i.e., the pipeline is already completed or in the last stage).
-     *
      * @see PipelineExecutor
      * @see getCurrentStage
      */
@@ -146,10 +141,9 @@ class PipelineExecutor {
     }
     /**
      * Returns the results of the pipeline.
-     *
      * @param intermediate - Normally you can only receive the results *after* the stepper completed the step of interested.
-     * 		 However, if you pass `true` to this parameter, you can also receive the results *before* the {@link PipelineExecutor|pipeline executor}
-     * 		 completed, although the typing system then cannot guarantee which of the steps have already happened.
+     *                       However, if you pass `true` to this parameter, you can also receive the results *before* the {@link PipelineExecutor|pipeline executor}
+     *                       completed, although the typing system then cannot guarantee which of the steps have already happened.
      */
     getResults(intermediate = false) {
         (0, assert_1.guard)(intermediate || this.stepCounter >= this.length, 'Without the intermediate flag, the pipeline must be completed before providing access to the results.');
@@ -168,9 +162,8 @@ class PipelineExecutor {
      * Execute the next {@link IPipelineStep|step} and return the name of the {@link IPipelineStep|step} that was executed,
      * so you can guard if the {@link IPipelineStep|step} differs from what you are interested in.
      * Furthermore, it returns the {@link IPipelineStep|step's} result.
-     *
      * @param expectedStepName - A safeguard if you want to retrieve the result.
-     * 												   If given, it causes the execution to fail if the next step is not the one you expect.
+     *                           If given, it causes the execution to fail if the next step is not the one you expect.
      *
      * _Without `expectedStepName`, please refrain from accessing the result, as you have no safeguards if the pipeline changes._
      */
@@ -193,7 +186,6 @@ class PipelineExecutor {
     /**
      * This only makes sense if you have already run a request and want to re-use the per-file results for a new one.
      * (or if for whatever reason, you did not pass information for the pipeline with the constructor).
-     *
      * @param newRequestData - Data for the new request
      */
     updateRequest(newRequestData) {
@@ -214,7 +206,6 @@ class PipelineExecutor {
      * @param canSwitchStage - If true, automatically switch to the request stage if necessary
      *       (i.e., this is what you want if you have never executed {@link nextStep} and you want to execute *all* steps).
      *       However, passing false allows you to only execute the steps of the 'once-per-file' stage (i.e., the steps that can be cached).
-     *
      * @note There is a small type difference if you pass 'false' and already have manually switched to the 'once-per-request' stage.
      *       Because now, the results of these steps are no longer part of the result type (although they are still included).
      *       In such a case, you may be better off with simply passing 'true' as the function will detect that the stage is already switched.

package/core/print/dataflow-printer.d.ts

@@ -2,6 +2,25 @@ import type { DataflowInformation } from '../../dataflow/info';
 import type { QuadSerializationConfiguration } from '../../util/quads';
 /** Should work with larger things as well */
 export declare function dataflowGraphToJson(df: DataflowInformation): string;
+/**
+ * Convert the dataflow graph to a mermaid string.
+ * @see {@link graphToMermaid}
+ * @see {@link dataflowGraphToMermaidUrl}
+ * @see {@link dataflowGraphToJson}
+ */
 export declare function dataflowGraphToMermaid(df: DataflowInformation): string;
+/**
+ * Convert the dataflow graph to a mermaid URL.
+ * @see {@link graphToMermaidUrl}
+ * @see {@link dataflowGraphToMermaid}
+ * @see {@link dataflowGraphToJson}
+ */
 export declare function dataflowGraphToMermaidUrl(df: DataflowInformation): string;
+/**
+ * Transforms the dataflow graph into a quad serialization.
+ * @see {@link df2quads}
+ * @see {@link dataflowGraphToMermaidUrl}
+ * @see {@link dataflowGraphToMermaid}
+ * @see {@link dataflowGraphToJson}
+ */
 export declare function dataflowGraphToQuads(df: DataflowInformation, config: QuadSerializationConfiguration): string;

package/core/print/dataflow-printer.js

@@ -52,12 +52,31 @@ function objectJson(df) {
 function dataflowGraphToJson(df) {
     return objectJson(df);
 }
+/**
+ * Convert the dataflow graph to a mermaid string.
+ * @see {@link graphToMermaid}
+ * @see {@link dataflowGraphToMermaidUrl}
+ * @see {@link dataflowGraphToJson}
+ */
 function dataflowGraphToMermaid(df) {
     return (0, dfg_1.graphToMermaid)({ graph: df.graph }).string;
 }
+/**
+ * Convert the dataflow graph to a mermaid URL.
+ * @see {@link graphToMermaidUrl}
+ * @see {@link dataflowGraphToMermaid}
+ * @see {@link dataflowGraphToJson}
+ */
 function dataflowGraphToMermaidUrl(df) {
     return (0, dfg_1.graphToMermaidUrl)(df.graph);
 }
+/**
+ * Transforms the dataflow graph into a quad serialization.
+ * @see {@link df2quads}
+ * @see {@link dataflowGraphToMermaidUrl}
+ * @see {@link dataflowGraphToMermaid}
+ * @see {@link dataflowGraphToJson}
+ */
 function dataflowGraphToQuads(df, config) {
     return (0, quads_1.df2quads)(df.graph, config);
 }

package/core/print/normalize-printer.d.ts

@@ -1,7 +1,27 @@
-import type { QuadSerializationConfiguration } from '../../util/quads';
+import { type QuadSerializationConfiguration } from '../../util/quads';
 import type { NormalizedAst } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
 /** Should work with larger things as well */
 export declare function normalizedAstToJson(ast: NormalizedAst): string;
+/**
+ * Normalized AST to quads serialization
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 export declare function normalizedAstToQuads(ast: NormalizedAst, config: QuadSerializationConfiguration): string;
+/**
+ * Serialize the normalized AST to mermaid format
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 export declare function printNormalizedAstToMermaid(ast: NormalizedAst): string;
+/**
+ * Serialize the normalized AST to a mermaid URL
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaid}
+ */
 export declare function printNormalizedAstToMermaidUrl(ast: NormalizedAst): string;

package/core/print/normalize-printer.js

@@ -17,12 +17,32 @@ function normalizedAstToJson(ast) {
         return (0, json_1.jsonReplacer)(k, v);
     });
 }
+/**
+ * Normalized AST to quads serialization
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 function normalizedAstToQuads(ast, config) {
     return (0, quads_1.serialize2quads)(ast.ast, config);
 }
+/**
+ * Serialize the normalized AST to mermaid format
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaidUrl}
+ */
 function printNormalizedAstToMermaid(ast) {
     return (0, ast_1.normalizedAstToMermaid)(ast.ast);
 }
+/**
+ * Serialize the normalized AST to a mermaid URL
+ * @see {@link normalizedAstToMermaid}
+ * @see {@link normalizedAstToMermaidUrl}
+ * @see {@link printNormalizedAstToMermaid}
+ */
 function printNormalizedAstToMermaidUrl(ast) {
     return (0, ast_1.normalizedAstToMermaidUrl)(ast.ast);
 }

package/core/print/parse-printer.d.ts

@@ -1,2 +1,7 @@
-import type { QuadSerializationConfiguration } from '../../util/quads';
+import { type QuadSerializationConfiguration } from '../../util/quads';
+/**
+ * Parse R code and serialize it to quads
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ */
 export declare function parseToQuads(code: string, config: QuadSerializationConfiguration): string;

package/core/print/parse-printer.js

@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseToQuads = parseToQuads;
 const quads_1 = require("../../util/quads");
 const format_1 = require("../../r-bridge/lang-4.x/ast/parser/json/format");
+/**
+ * Parse R code and serialize it to quads
+ * @see {@link serialize2quads}
+ * @see {@link QuadSerializationConfiguration}
+ */
 function parseToQuads(code, config) {
     return (0, quads_1.serialize2quads)((0, format_1.convertPreparedParsedData)((0, format_1.prepareParsedData)(code)), config);
 }

package/core/print/print.d.ts

@@ -37,7 +37,6 @@ export declare const enum StepOutputFormat {
 }
 /**
  * Helper function to support the {@link Internal} format, as it is simply returning the input.
- *
  * @see IPipelineStepPrinter
  */
 export declare function internalPrinter<Input>(input: Input): Input;

package/core/print/print.js

@@ -5,7 +5,6 @@ exports.printStepResult = printStepResult;
 const assert_1 = require("../../util/assert");
 /**
  * Helper function to support the {@link Internal} format, as it is simply returning the input.
- *
  * @see IPipelineStepPrinter
  */
 function internalPrinter(input) {

package/core/print/slice-diff-ansi.d.ts

@@ -1,3 +1,6 @@
 import type { NodeId } from '../../r-bridge/lang-4.x/ast/model/processing/node-id';
 import type { NormalizedAst } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
+/**
+ * Print a slice diff with ANSI colors
+ */
 export declare function sliceDiffAnsi(slice: ReadonlySet<NodeId>, normalized: NormalizedAst, criteriaIds: ReadonlySet<NodeId>, originalCode: string): string;