@eagleoutice/flowr 2.6.2 → 2.6.3

package/slicing/criterion/parse.js

@@ -27,14 +27,14 @@ function slicingCriterionToId(criterion, idMap) {
     if (criterion.startsWith('$')) {
         resolved = (0, node_id_1.normalizeIdToNumberIfPossible)(criterion.substring(1));
     }
-    else if (criterion.includes(':')) {
-        const [line, column] = criterion.split(':').map(c => parseInt(c));
-        resolved = locationToId([line, column], idMap);
-    }
     else if (criterion.includes('@')) {
         const [line, name] = criterion.split(/@(.*)/s); // only split at first occurrence
         resolved = conventionalCriteriaToId(parseInt(line), name, idMap);
     }
+    else if (criterion.includes(':')) {
+        const [line, column] = criterion.split(':').map(c => parseInt(c));
+        resolved = locationToId([line, column], idMap);
+    }
     if (resolved === undefined) {
         throw new CriteriaParseError(`invalid slicing criterion ${criterion}`);
     }

package/statistics/features/supported/assignments/assignments.js

@@ -17,7 +17,7 @@ const initialAssignmentInfo = {
 exports.AssignmentOperators = new Set(operators_1.Operators.filter(op => operators_1.OperatorDatabase[op].usedAs === 'assignment'));
 function visitAssignment(info, input) {
     const assignmentStack = [];
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(r => r.root), node => {
         if (node.type !== type_1.RType.BinaryOp || !exports.AssignmentOperators.has(node.operator)) {
             return;
         }

package/statistics/features/supported/control-flow/control-flow.js

@@ -20,7 +20,7 @@ const initialControlflowInfo = {
 };
 function visitIfThenElse(info, input) {
     const ifThenElseStack = [];
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(f => f.root), node => {
         if (node.type !== type_1.RType.IfThenElse) {
             if (node.type === type_1.RType.FunctionCall && node.named && node.functionName.content === 'switch') {
                 const initialArg = (0, unpack_argument_1.unpackArgument)(node.arguments[0]);

package/statistics/features/supported/data-access/data-access.js

@@ -46,7 +46,7 @@ function visitAccess(info, input) {
     const accessNest = [];
     const accessChain = [];
     const parentRoleCache = new Map();
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(f => f.root), node => {
         if (node.type !== type_1.RType.Access) {
             return;
         }

package/statistics/features/supported/defined-functions/defined-functions.js

@@ -45,7 +45,7 @@ function retrieveAllCallsites(input, node, recursiveCalls) {
 function visitDefinitions(info, input) {
     const definitionStack = [];
     const allDefinitions = [];
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(f => f.root), node => {
         if (node.type !== type_1.RType.FunctionDefinition) {
             return;
         }

package/statistics/features/supported/expression-list/statistics-expression-list.js

@@ -11,7 +11,7 @@ const initialExpressionListInfo = {
 function visitLists(info, input) {
     let nest = -1; // we start with nesting 0
     let total = 0;
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(f => f.root), node => {
         if (node.type === type_1.RType.ExpressionList) {
             nest++;
             total++;

package/statistics/features/supported/loops/loops.js

@@ -25,7 +25,7 @@ const isImplicitLoop = /[lsvmt]?apply/;
 function visitLoops(info, input) {
     // holds number of loops and their nesting depths
     const loopStack = [];
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(f => f.root), node => {
         switch (node.type) {
             case type_1.RType.Next:
                 info.nextStatements++;

package/statistics/features/supported/used-functions/used-functions.js

@@ -50,7 +50,7 @@ function classifyArguments(args, existing) {
 function visitCalls(info, input) {
     const calls = [];
     const allCalls = [];
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(f => f.root), node => {
         if (node.type !== type_1.RType.FunctionCall) {
             return;
         }

package/statistics/features/supported/variables/variables.js

@@ -15,7 +15,7 @@ const initialVariableInfo = {
     unknownVariables: 0
 };
 function visitVariables(info, input) {
-    (0, visitor_1.visitAst)(input.normalizedRAst.ast, node => {
+    (0, visitor_1.visitAst)(input.normalizedRAst.ast.files.map(f => f.root), node => {
         if (node.type !== type_1.RType.Symbol || (0, r_symbol_1.isSpecialSymbol)(node)) {
             return;
         }

package/statistics/statistics.js

@@ -14,6 +14,7 @@ const pipeline_executor_1 = require("../core/pipeline-executor");
 const default_pipelines_1 = require("../core/steps/pipeline/default-pipelines");
 const feature_1 = require("./features/feature");
 const convert_values_1 = require("../r-bridge/lang-4.x/convert-values");
+const flowr_analyzer_context_1 = require("../project/context/flowr-analyzer-context");
 /**
  * By default, {@link extractUsageStatistics} requires a generator, but sometimes you already know all the files
  * that you want to process. This function simply reps your requests as a generator.
@@ -82,8 +83,8 @@ function processMetaOnSuccessful(meta, request) {
 const parser = new xmldom_1.DOMParser();
 async function extractSingle(result, shell, request, features, suffixFilePath, config) {
     const slicerOutput = await new pipeline_executor_1.PipelineExecutor(default_pipelines_1.DEFAULT_DATAFLOW_PIPELINE, {
-        request, parser: shell
-    }, config).allRemainingSteps();
+        context: (0, flowr_analyzer_context_1.contextFromInput)(request, config), parser: shell
+    }).allRemainingSteps();
     // retrieve parsed xml through (legacy) xmlparsedata
     const suffix = request.request === 'file' ? ', encoding="utf-8"' : '';
     shell.sendCommands(`try(flowr_parsed<-parse(${request.request}=${JSON.stringify(request.content)},keep.source=TRUE${suffix}),silent=FALSE)`, 'try(flowr_output<-xmlparsedata::xml_parse_data(flowr_parsed,includeText=TRUE,pretty=FALSE),silent=FALSE)');

package/util/assert.d.ts

@@ -53,6 +53,10 @@ export declare function isUndefined<T>(x: T | undefined): x is undefined;
  * @see {@link isNotUndefined}
  */
 export declare function isNotNull<T>(x: T | null): x is T;
+/**
+ * Generates a GitHub issue URL for reporting guard errors
+ */
+export declare function getGuardIssueUrl(message: string): string;
 export type GuardMessage = string | (() => string);
 /**
  * @param assertion   - will be asserted

package/util/assert.js

@@ -5,6 +5,7 @@ exports.assertUnreachable = assertUnreachable;
 exports.isNotUndefined = isNotUndefined;
 exports.isUndefined = isUndefined;
 exports.isNotNull = isNotNull;
+exports.getGuardIssueUrl = getGuardIssueUrl;
 exports.guard = guard;
 /* v8 ignore next */
 const version_1 = require("./version");
@@ -86,6 +87,9 @@ function prepareStack(stack) {
     }
     return lines.map(l => l.replaceAll(/\(\/.*(src|test)/g, '(<>/$1')).join('\n');
 }
+/**
+ * Generates a GitHub issue URL for reporting guard errors
+ */
 function getGuardIssueUrl(message) {
     const body = encodeURIComponent(`<!-- Please describe your issue in more detail below! -->
 

package/util/files.d.ts

@@ -75,7 +75,7 @@ export declare function getParentDirectory(directory: string): string;
  * @param file - The file to parse
  * @returns Map containing the keys and values of the provided file.
  */
-export declare function parseDCF(file: FlowrFileProvider<string>): Map<string, string[]>;
+export declare function parseDCF(file: FlowrFileProvider): Map<string, string[]>;
 /**
  * Checks whether the given path-like object is a file that exists on the local filesystem.
  */

package/util/files.js

@@ -212,7 +212,7 @@ function parseDCF(file) {
     let currentValue = '';
     const indentRegex = new RegExp(/^\s/);
     const firstColonRegex = new RegExp(/:(.*)/s);
-    const fileContent = file.content().split(/\r?\n/);
+    const fileContent = file.content().toString().split(/\r?\n/);
     for (const line of fileContent) {
         if (indentRegex.test(line)) {
             currentValue += '\n' + line.trim();

package/util/mermaid/ast.d.ts

@@ -1,9 +1,10 @@
-import type { RNodeWithParent } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
+import type { ParentInformation, RNodeWithParent } from '../../r-bridge/lang-4.x/ast/model/processing/decorate';
+import type { RProject } from '../../r-bridge/lang-4.x/ast/model/nodes/r-project';
 /**
  * Serialize the normalized AST to mermaid format
  */
-export declare function normalizedAstToMermaid(ast: RNodeWithParent, prefix?: string): string;
+export declare function normalizedAstToMermaid(ast: RProject<ParentInformation> | RNodeWithParent, prefix?: string): string;
 /**
  * Use mermaid to visualize the normalized AST.
  */
-export declare function normalizedAstToMermaidUrl(ast: RNodeWithParent, prefix?: string): string;
+export declare function normalizedAstToMermaidUrl(ast: RProject<ParentInformation> | RNodeWithParent, prefix?: string): string;

package/util/mermaid/ast.js

@@ -6,6 +6,14 @@ const mermaid_1 = require("./mermaid");
 const visitor_1 = require("../../r-bridge/lang-4.x/ast/model/processing/visitor");
 const type_1 = require("../../r-bridge/lang-4.x/ast/model/type");
 const r_function_call_1 = require("../../r-bridge/lang-4.x/ast/model/nodes/r-function-call");
+const flowr_file_1 = require("../../project/context/flowr-file");
+function identifyMermaidDirection(prefix) {
+    const directionMatch = prefix.match(/flowchart (TD|LR|RL|BT)/);
+    if (directionMatch) {
+        return directionMatch[1];
+    }
+    return 'TD';
+}
 /**
  * Serialize the normalized AST to mermaid format
  */
@@ -24,17 +32,37 @@ function normalizedAstToMermaid(ast, prefix = 'flowchart TD\n') {
             output += `    n${n.info.id} -.-|"group-close"| n${n.grouping[1].info.id}\n`;
         }
     }
-    (0, visitor_1.visitAst)(ast, n => {
-        showNode(n);
-        if (n.type === 'RAccess' && (n.operator !== '[' && n.operator !== '[[')) {
-            for (const k of n.access) {
-                if (k !== r_function_call_1.EmptyArgument) {
-                    showNode(k);
+    function showAst(ast) {
+        (0, visitor_1.visitAst)(ast, n => {
+            showNode(n);
+            if (n.type === 'RAccess' && (n.operator !== '[' && n.operator !== '[[')) {
+                for (const k of n.access) {
+                    if (k !== r_function_call_1.EmptyArgument) {
+                        showNode(k);
+                    }
                 }
             }
+            return false;
+        });
+    }
+    if (ast.type === type_1.RType.Project) {
+        for (const f of ast.files) {
+            // add a subgraph for each file
+            if (ast.files.length !== 1 || (f.filePath && f.filePath !== flowr_file_1.FlowrFile.INLINE_PATH)) {
+                output += `    subgraph "File: ${(0, mermaid_1.escapeMarkdown)(f.filePath ?? flowr_file_1.FlowrFile.INLINE_PATH)}"\n`;
+                const direction = identifyMermaidDirection(prefix);
+                output += `        direction ${direction}\n`;
+                showAst(f.root);
+                output += '    end\n';
+            }
+            else {
+                showAst(f.root);
+            }
         }
-        return false;
-    });
+    }
+    else {
+        showAst(ast);
+    }
     return output;
 }
 /**

package/util/mermaid/cfg.js

@@ -43,7 +43,7 @@ function cfgToMermaid(cfg, normalizedAst, prefix = 'flowchart BT\n', simplify =
         if (vertex.type === control_flow_graph_1.CfgVertexType.Block) {
             if (simplify) {
                 const ids = vertex.elems?.map(e => e.id) ?? [];
-                const reconstruct = (0, reconstruct_1.reconstructToCode)(normalizedAst, new Set(ids), auto_select_defaults_1.doNotAutoSelect).code;
+                const reconstruct = (0, reconstruct_1.reconstructToCode)(normalizedAst, { nodes: new Set(ids) }, auto_select_defaults_1.doNotAutoSelect).code;
                 const name = `"\`Basic Block (${id})\n${(0, mermaid_1.escapeMarkdown)(reconstruct)}\`"`;
                 output += `    n${id}[[${name}]]\n`;
             }

package/util/version.js

@@ -6,7 +6,7 @@ exports.printVersionInformation = printVersionInformation;
 const semver_1 = require("semver");
 const assert_1 = require("./assert");
 // this is automatically replaced with the current version by release-it
-const version = '2.6.2';
+const version = '2.6.3';
 /**
  * Retrieves the current flowR version as a new {@link SemVer} object.
  */

package/documentation/print-analyzer-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-analyzer-wiki.js

@@ -1,141 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const shell_1 = require("../r-bridge/shell");
-const log_1 = require("../../test/functionality/_helper/log");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
-const doc_types_1 = require("./doc-util/doc-types");
-const path_1 = __importDefault(require("path"));
-const flowr_analyzer_1 = require("../project/flowr-analyzer");
-const flowr_analyzer_builder_1 = require("../project/flowr-analyzer-builder");
-const doc_structure_1 = require("./doc-util/doc-structure");
-const doc_files_1 = require("./doc-util/doc-files");
-async function analyzerQuickExample() {
-    const analyzer = await new flowr_analyzer_builder_1.FlowrAnalyzerBuilder()
-        .addRequestFromInput('x <- 1; print(x)')
-        .setEngine('tree-sitter')
-        .build();
-    // get the dataflow
-    const df = await analyzer.dataflow();
-    // obtain the identified loading order
-    console.log(analyzer.inspectContext().files.loadingOrder.getLoadingOrder());
-    // run a dependency query
-    const results = await analyzer.query([{ type: 'dependencies' }]);
-    return { analyzer, df, results };
-}
-async function getText(shell) {
-    const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
-    const types = (0, doc_types_1.getTypesFromFolder)({
-        rootFolder: path_1.default.resolve('src/'),
-        inlineTypes: doc_types_1.mermaidHide
-    });
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'analyzer', rVersion: rversion })}
-
-We are currently working on documenting the capabilities of the analyzer (with the plugins, their loading order, etc.). In general, the code documentation
-starting with the ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, types.info)} and the ${(0, doc_types_1.shortLink)(flowr_analyzer_builder_1.FlowrAnalyzerBuilder.name, types.info)} 
-should be the best starting point.
-
-${(0, doc_structure_1.collapsibleToc)({
-        'Overview': undefined,
-        'Builder Configuration': undefined,
-        'Plugins': {
-            'Plugin Types': {
-                'Dependency Identification': undefined,
-                'Project Discovery': undefined,
-                'File Loading': undefined,
-                'Loading Order': undefined
-            },
-            'How to add a new plugin': undefined,
-            'How to add a new plugin type': undefined
-        },
-        'Context Information': {
-            'Files Context': undefined,
-            'Loading Order Context': undefined,
-            'Dependencies Context': undefined
-        },
-        'Analyzer Internals': undefined
-    })}
-
-
-${(0, doc_structure_1.section)('Overview', 2)}
-
-No matter whether you want to analyze a single R script, a couple of R notebooks, or a complete project,
-your journey starts with the ${(0, doc_types_1.shortLink)(flowr_analyzer_builder_1.FlowrAnalyzerBuilder.name, types.info)} (further described in [Builder Configuration](#builder-configuration) below).
-This builder allows you to configure the analysis in many different ways, for example, by specifying which files to analyze, which plugins to use, or
-what [Engine](${doc_files_1.FlowrWikiBaseRef}/Engines) to use for the analysis.
- 
-${(0, doc_structure_1.block)({
-        type: 'NOTE',
-        content: `If you want to quickly try out the analyzer, you can use the following code snippet that analyzes a simple R expression:
-	
-${(0, doc_types_1.printCodeOfElement)({ program: types.program, info: types.info, dropLinesStart: 1, dropLinesEnd: 2, hideDefinedAt: true }, analyzerQuickExample.name)}
-		`
-    })} 
-
-In general, we work on providing a set of example repositories that demonstrate how to use the analyzer in different scenarios:
-
-* [${doc_files_1.FlowrGithubGroupName}/sample-analyzer-project-query](${doc_files_1.FlowrGithubBaseRef}/sample-analyzer-project-query) for an example project that runs queries on an R project
-
-**TODO**: mention [Context](#Context_Information) 
-
-${(0, doc_structure_1.section)('Builder Configuration', 2)}
-
-**TODO** also explain buildSync and that TreeSitter has to be initialized for this 
-
-${(0, doc_structure_1.section)('Plugins', 2)}
-
-${(0, doc_structure_1.section)('Plugin Types', 3)}
-
-During the construction of a new ${(0, doc_types_1.shortLink)(flowr_analyzer_1.FlowrAnalyzer.name, types.info)}, plugins of different types are applied at different stages of the analysis.
-These plugins are grouped by their ${(0, doc_types_1.shortLink)('PluginType', types.info)} and are applied in the following order (as shown in the documentation of the ${(0, doc_types_1.shortLink)('PluginType', types.info)}):
-
-${(() => {
-        const doc = (0, doc_types_1.getDocumentationForType)('PluginType', types.info);
-        // skip until the first ```text
-        const lines = doc.split('\n');
-        const start = lines.findIndex(l => l.trim().startsWith('```text'));
-        const end = lines.findIndex((l, i) => i > start && l.trim().startsWith('```'));
-        // github rendering pls fix xD
-        return start >= 0 && end > start ? '```text\n' + lines.slice(start + 1, end).join('\n').replaceAll('▶', '>') + '\n```' : doc;
-    })()}
-
-We describe the different plugin types in more detail below.
-
-
-${(0, doc_structure_1.section)('Project Discovery', 4)}
-
-${(0, doc_structure_1.section)('File Loading', 4)}
-
-${(0, doc_structure_1.section)('Dependency Identification', 4)}
-
-${(0, doc_structure_1.section)('Loading Order', 4)}
-
-${(0, doc_structure_1.section)('How to add a new plugin', 3)}
-
-${(0, doc_structure_1.section)('How to add a new plugin type', 3)}
-
-${(0, doc_structure_1.section)('Context Information', 2)}
-
-${(0, doc_structure_1.section)('Files Context', 3)}
-
-${(0, doc_structure_1.section)('Loading Order Context', 3)}
-
-${(0, doc_structure_1.section)('Dependencies Context', 3)}
-
-${(0, doc_structure_1.section)('Analyzer Internals', 2)}
-
-`;
-}
-/** if we run this script, we want a Markdown representation of the capabilities */
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    const shell = new shell_1.RShell();
-    void getText(shell).then(str => {
-        console.log(str);
-    }).finally(() => {
-        shell.close();
-    });
-}
-//# sourceMappingURL=print-analyzer-wiki.js.map

package/documentation/print-capabilities-markdown.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-cfg-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-core-wiki.d.ts

@@ -1,5 +0,0 @@
-import { FlowrAnalyzer } from '../project/flowr-analyzer';
-/**
- *
- */
-export declare function inspectContextExample(analyzer: FlowrAnalyzer): void;

package/documentation/print-dataflow-graph-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-engines-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-faq-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-faq-wiki.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const log_1 = require("../../test/functionality/_helper/log");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
-const faqs_1 = require("./data/faq/faqs");
-function print() {
-    const faqs = (0, faqs_1.registerFaqs)();
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'frequently asked questions' })}
-	
-	${faqs.toMarkdown()}
-
-    `.trim();
-}
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    console.log(print());
-}
-//# sourceMappingURL=print-faq-wiki.js.map

package/documentation/print-interface-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-linter-issue.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-linter-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-linting-and-testing-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-normalized-ast-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-onboarding-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-query-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-readme.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-search-wiki.d.ts

@@ -1 +0,0 @@
-export {};

package/documentation/print-search-wiki.js

@@ -1,74 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const shell_1 = require("../r-bridge/shell");
-const log_1 = require("../../test/functionality/_helper/log");
-const doc_files_1 = require("./doc-util/doc-files");
-const doc_auto_gen_1 = require("./doc-util/doc-auto-gen");
-const doc_search_1 = require("./doc-util/doc-search");
-const flowr_search_builder_1 = require("../search/flowr-search-builder");
-const vertex_1 = require("../dataflow/graph/vertex");
-const doc_types_1 = require("./doc-util/doc-types");
-const path_1 = __importDefault(require("path"));
-const flowr_search_executor_1 = require("../search/flowr-search-executor");
-async function getText(shell) {
-    const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
-    const types = (0, doc_types_1.getTypesFromFolder)({
-        rootFolder: path_1.default.resolve('./src/search/'),
-        inlineTypes: doc_types_1.mermaidHide
-    });
-    return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'search API', rVersion: rversion })}
-
-This page briefly summarizes flowR's search API which provides a set of functions to search for nodes in the [Dataflow Graph](${doc_files_1.FlowrWikiBaseRef}/Dataflow%20Graph) and the 
-[Normalized AST](${doc_files_1.FlowrWikiBaseRef}/Normalized%20AST) of a given R code (the search will always consider both, with respect to your search query).
-Please see the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface) wiki page for more information on how to access this API.
-Within code, you can execute a search using the ${(0, doc_types_1.shortLink)(flowr_search_executor_1.runSearch.name, types.info)} function.
-
-For an initial motivation, let's have a look at the following example:
-
-${await (0, doc_search_1.showSearch)(shell, 'x <- x * x', flowr_search_builder_1.Q.var('x'))}
-
-This returns all references to the variable \`x\` in the code.
-However, the search API is not limited to simple variable references and can do much more.
-
-For example, let's have every definition of \`x\` in the code but the first one:
-
-${await (0, doc_search_1.showSearch)(shell, 'x <- x * x\nprint(x)\nx <- y <- 3\nprint(x)\nx <- 2', flowr_search_builder_1.Q.var('x').filter(vertex_1.VertexType.VariableDefinition).skip(1))}
-
-In summary, every search has two parts. It is initialized with a _generator_ (such as \`Q.var('x')\`)
-and can be further refined with _transformers_ or _modifiers_.
-Such queries can be constructed starting from the ${(0, doc_types_1.shortLink)('Q', types.info)} object (backed by ${(0, doc_types_1.shortLink)('FlowrSearchGenerator', types.info)}) and
-are fully serializable so you can use them when communicating with the [Query API](${doc_files_1.FlowrWikiBaseRef}/Query%20API).
-
-We offer the following generators:
-
-${Object.keys(flowr_search_builder_1.Q).sort().map(key => `- ${(0, doc_types_1.shortLink)(`FlowrSearchGenerator::${key}`, types.info)}\\\n${(0, doc_types_1.getDocumentationForType)(`FlowrSearchGenerator::${key}`, types.info)}`).join('\n')}
-
-Likewise, we have a palette of _transformers_ and _modifiers_:
-
-${
-    /* let's iterate over all methods of FlowrSearchBuilder */
-    Object.getOwnPropertyNames(Object.getPrototypeOf(new flowr_search_builder_1.FlowrSearchBuilder(undefined)))
-        .filter(n => n !== 'constructor').sort().map(key => `- ${(0, doc_types_1.shortLink)(`FlowrSearchBuilder::${key}`, types.info)}\\\n${(0, doc_types_1.getDocumentationForType)(`FlowrSearchBuilder::${key}`, types.info)}`).join('\n')}
-
-Every search (and consequently the search pipeline) works with an array of ${(0, doc_types_1.shortLink)('FlowrSearchElement', types.info)} (neatly wrapped in ${(0, doc_types_1.shortLink)('FlowrSearchElements', types.info)}).
-Hence, even operations such as \`.first\` or \`.last\` return an array of elements (albeit with a single or no element).
-The search API does its best to stay typesafe wrt. to the return type and the transformers in use. 
-In addition, it offers optimizer passes to optimize the search pipeline before execution.
-They are executed with \`.build\` which may happen automatically, whenever you want to run a search using ${(0, doc_types_1.shortLink)('runSearch', types.info)}.
-
-`;
-}
-/** if we run this script, we want a Markdown representation of the capabilities */
-if (require.main === module) {
-    (0, log_1.setMinLevelOfAllLogs)(6 /* LogLevel.Fatal */);
-    const shell = new shell_1.RShell();
-    void getText(shell).then(str => {
-        console.log(str);
-    }).finally(() => {
-        shell.close();
-    });
-}
-//# sourceMappingURL=print-search-wiki.js.map

package/util/formats/adapter-format.d.ts

@@ -1,6 +0,0 @@
-import type { RParseRequest } from '../../r-bridge/retriever';
-export interface FileAdapter {
-    convertRequest(request: RParseRequest): RParseRequest;
-}
-export type SupportedFormats = 'R' | 'Rmd';
-export type SupportedDocumentTypes = '.r' | '.rmd';

package/util/formats/adapter-format.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=adapter-format.js.map

package/util/formats/adapter.d.ts

@@ -1,27 +0,0 @@
-import type { RParseRequest, RParseRequestFromText } from '../../r-bridge/retriever';
-import type { SupportedFormats } from './adapter-format';
-export declare const FileAdapters: {
-    readonly R: {
-        convertRequest: (request: RParseRequest) => RParseRequest;
-    };
-    readonly Rmd: {
-        convertRequest: (request: RParseRequest) => RParseRequestFromText<import("./adapters/rmd-adapter").RmdInfo>;
-    };
-};
-export declare const DocumentTypeToFormat: {
-    readonly '.r': "R";
-    readonly '.rmd': "Rmd";
-};
-export type AdapterReturnTypes = ReturnType<typeof FileAdapters[keyof typeof FileAdapters]['convertRequest']>;
-/**
- * Produce a parse request from a file path
- */
-export declare function requestFromFile(path: string): AdapterReturnTypes;
-/**
- * Produce a parse request from a text input
- */
-export declare function requestFromText(text: string, typeHint?: SupportedFormats): AdapterReturnTypes;
-/**
- * Infer the file type from a parse request, using file extension or info hints
- */
-export declare function inferFileType(request: RParseRequest): keyof typeof FileAdapters;