@eagleoutice/flowr 2.2.2 → 2.2.3

package/documentation/print-linting-and-testing-wiki.js

@@ -1,10 +1,21 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const log_1 = require("../../test/functionality/_helper/log");
 const doc_code_1 = require("./doc-util/doc-code");
 const doc_files_1 = require("./doc-util/doc-files");
 const doc_structure_1 = require("./doc-util/doc-structure");
+const doc_types_1 = require("./doc-util/doc-types");
+const path_1 = __importDefault(require("path"));
 function getText() {
+    const { info } = (0, doc_types_1.getTypesFromFolderAsMermaid)({
+        rootFolder: path_1.default.resolve('./test'),
+        files: [path_1.default.resolve('./src/dataflow/graph/dataflowgraph-builder.ts')],
+        typeName: 'parameter',
+        inlineTypes: doc_types_1.mermaidHide
+    });
     return `
 For the latest code coverage information, see [codecov.io](${doc_files_1.FlowrCodecovRef}), 
 for the latest benchmark results, see the [benchmark results](${doc_files_1.FlowrSiteBaseRef}/wiki/stats/benchmark) wiki page.
@@ -53,7 +64,7 @@ If you want to run the tests without the watch mode, you can use:
 
 ${(0, doc_code_1.codeBlock)('shell', 'npm run test -- --no-watch')}
 
-To run all tests, including a coverage report and label summary, run: 
+To run all tests, including a coverage report and label summary, run:
 
 ${(0, doc_code_1.codeBlock)('shell', 'npm run test-full')}
 
@@ -64,7 +75,7 @@ It is up to the [ci](#ci-pipeline) to run the tests on different systems to ensu
 
 #### Test Structure
 
-All functionality tests are to be located under [test/functionality](${doc_files_1.RemoteFlowrFilePathBaseRef}test/functionality).
+All functionality tests are to be located under [test/functionality](${doc_files_1.RemoteFlowrFilePathBaseRef}/test/functionality).
 
 This folder contains three special and important elements:
 
@@ -76,19 +87,23 @@ ${(0, doc_structure_1.block)({
         type: 'WARNING',
         content: `
 We name all test files using the \`.test.ts\` suffix and try to run them in parallel.
-Whenever this is not possible (e.g., when using \`withShell\`), please use \`describe.sequential\`
+Whenever this is impossible (e.g., when using ${(0, doc_types_1.shortLink)('withShell', info)}), please use _\`describe.sequential\`_
 to disable parallel execution for the respective test (otherwise, such tests are flaky).
 `
     })}
 
 #### Writing a Test
 
-Currently, this is heavily dependent on what you want to test (normalization, dataflow, quad-export, ...) 
+Currently, this is heavily dependent on what you want to test (normalization, dataflow, quad-export, …) 
 and it is probably best to have a look at existing tests in that area to get an idea of what comfort functionality is available.
 
-Generally, tests should be [labeled](${doc_files_1.RemoteFlowrFilePathBaseRef}test/functionality/_helper/label.ts) according to the *flowR* capabilities they test. The set of currently supported capabilities and their IDs can be found in ${(0, doc_files_1.getFilePathMd)('../r-bridge/data/data.ts')}. The resulting labels are used in the test report that is generated as part of the test output. They group tests by the capabilities they test and allow the report to display how many tests ensure that any given capability is properly supported. 
+Generally, tests should be [labeled](${doc_files_1.RemoteFlowrFilePathBaseRef}test/functionality/_helper/label.ts) according to the *flowR* capabilities they test. 
+The set of currently supported capabilities and their IDs can be found in ${(0, doc_files_1.getFilePathMd)('../r-bridge/data/data.ts')}. 
+The resulting labels are used in the test report that is generated as part of the test output. 
+They group tests by the capabilities they test and allow the report to display how many tests ensure that any given capability is properly supported.
 
-Various helper functions are available to ease in writing tests with common behaviors, like testing for dataflow, slicing or query results. These can be found in [the \`_helper\` subdirectory](${doc_files_1.RemoteFlowrFilePathBaseRef}test/functionality/_helper).
+Various helper functions are available to ease in writing tests with common behaviors, like testing for dataflow, slicing or query results. 
+These can be found in [the \`_helper\` subdirectory](${doc_files_1.RemoteFlowrFilePathBaseRef}test/functionality/_helper).
 
 For example, an [existing test](${doc_files_1.RemoteFlowrFilePathBaseRef}test/functionality/dataflow/processing-of-elements/atomic/dataflow-atomic.test.ts) that tests the dataflow graph of a simple variable looks like this:
 ${(0, doc_code_1.codeBlock)('typescript', `
@@ -96,11 +111,14 @@ assertDataflow(label('simple variable', ['name-normal']), shell,
 	'x', emptyGraph().use('0', 'x')
 );
 `)}
+Have a look at ${(0, doc_types_1.shortLink)('assertDataflow', info)}, ${(0, doc_types_1.shortLink)('label', info)}, and ${(0, doc_types_1.shortLink)('emptyGraph', info)} for more information.
 
 When writing dataflow tests, additional settings can be used to reduce the amount of graph data that needs to be pre-written. Notably:
 
-- \`expectIsSubgraph\` indicates that the expected graph is a subgraph, rather than the full graph that the test should generate. The test will then only check if the supplied graph is contained in the result graph, rather than an exact match.
-- \`resolveIdsAsCriterion\` indicates that the ids given in the expected (sub)graph should be resolved as [slicing criteria](${doc_files_1.FlowrWikiBaseRef}/Terminology#slicing-criterion) rather than actual ids. For example, passing \`12@a\` as an id in the expected (sub)graph will cause it to be resolved as the corresponding id.
+- ${(0, doc_types_1.shortLink)('expectIsSubgraph', info)} indicates that the expected graph is a subgraph, rather than the full graph that the test should generate. 
+  The test will then only check if the supplied graph is contained in the result graph, rather than an exact match.
+- ${(0, doc_types_1.shortLink)('resolveIdsAsCriterion', info)} indicates that the ids given in the expected (sub)graph should be resolved as [slicing criteria](${doc_files_1.FlowrWikiBaseRef}/Terminology#slicing-criterion) rather than actual ids. 
+  For example, passing \`12@a\` as an id in the expected (sub)graph will cause it to be resolved as the corresponding id.
 
 The following example shows both in use:
 ${(0, doc_code_1.codeBlock)('typescript', `

package/documentation/print-normalized-ast-wiki.js

@@ -19,21 +19,21 @@ const retriever_1 = require("../r-bridge/retriever");
 const visitor_1 = require("../r-bridge/lang-4.x/ast/model/processing/visitor");
 const collect_1 = require("../r-bridge/lang-4.x/ast/model/collect");
 const normalized_ast_fold_1 = require("../abstract-interpretation/normalized-ast-fold");
+const default_pipelines_1 = require("../core/steps/pipeline/default-pipelines");
 async function getText(shell) {
     const rversion = (await shell.usedRVersion())?.format() ?? 'unknown';
     const now = performance.now();
     const types = (0, doc_types_1.getTypesFromFolderAsMermaid)({
-        rootFolder: path_1.default.resolve('./src/r-bridge/lang-4.x/ast/model/'),
-        files: [path_1.default.resolve('./src/abstract-interpretation/normalized-ast-fold.ts'), path_1.default.resolve('./src/core/steps/pipeline/default-pipelines.ts')],
+        rootFolder: path_1.default.resolve('./src'),
         typeName: 'RNode',
         inlineTypes: doc_types_1.mermaidHide
     });
     const elapsed = performance.now() - now;
     return `${(0, doc_auto_gen_1.autoGenHeader)({ filename: module.filename, purpose: 'normalized ast', rVersion: rversion })}
 
-_flowR_ produces a normalized version of R's abstract syntax tree (AST), 
+_flowR_ produces a normalized version of R's abstract syntax tree (AST),
 offering the following benefits:
- 
+
 1. abstract away from intricacies of the R parser
 2. provide a version-independent representation of the program
 3. decorate the AST with additional information, e.g., parent relations and nesting information
@@ -49,12 +49,10 @@ Each edge is labeled with the type of the parent-child relationship (the "role")
 
 ${await (0, doc_normalized_ast_1.printNormalizedAstForCode)(shell, 'x <- 2 * 3 + 1', { showCode: false, prefix: 'flowchart LR\n' })}
 
-&nbsp;
-
 > [!TIP]
 > If you want to investigate the normalized AST, 
 > you can either use the [Visual Studio Code extension](${doc_files_1.FlowrGithubBaseRef}/vscode-flowr) or the ${(0, doc_cli_option_1.getReplCommand)('normalize*')} 
-> command in the REPL (see the [Interface wiki page](${doc_files_1.FlowrWikiBaseRef}/Interface) for more information). 
+> command in the REPL (see the [Interface wiki page](${doc_files_1.FlowrWikiBaseRef}/Interface) for more information).
 
 Indicative of the normalization is the root expression list node, which is present in every normalized AST.
 In general, we provide node types for:
@@ -84,7 +82,7 @@ Most notably, the \`info\` field holds the \`id\` of the node, which is used to
 
 In summary, we have the following types:
 
-${(0, doc_structure_1.details)('Normalized AST Node Types', (0, doc_types_1.printHierarchy)({ program: types.program, hierarchy: types.info, root: 'RNode', collapseFromNesting: Number.MAX_VALUE }))}
+${(0, doc_structure_1.details)('Normalized AST Node Types', (0, doc_types_1.printHierarchy)({ program: types.program, info: types.info, root: 'RNode', collapseFromNesting: Number.MAX_VALUE }))}
 
 The following segments intend to give you an overview of how to work with the normalized AST:
 
@@ -94,7 +92,7 @@ The following segments intend to give you an overview of how to work with the no
 ## How Get a Normalized AST
 
 As explained alongside the [Interface](${doc_files_1.FlowrWikiBaseRef}/Interface#the-pipeline-executor) wiki page, you can use the 
-\`${pipeline_executor_1.PipelineExecutor.name}\` to get the ${(0, doc_types_1.shortLink)('NormalizedAst', types.info)}. If you are only interested in the normalization,
+${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, types.info)} to get the ${(0, doc_types_1.shortLink)('NormalizedAst', types.info)}. If you are only interested in the normalization,
 a pipeline like the ${(0, doc_types_1.shortLink)('DEFAULT_NORMALIZE_PIPELINE', types.info)} suffices:
 
 ${(0, doc_code_1.codeBlock)('ts', `
@@ -106,7 +104,7 @@ async function getAst(code: string): Promise<RNode> {
     return result.normalize.ast;
 }`)}
 
-From the REPL, you can use the ${(0, doc_cli_option_1.getReplCommand)('normalize')} command. 
+From the REPL, you can use the ${(0, doc_cli_option_1.getReplCommand)('normalize')} command.
 
 ## Traversing the Normalized AST
 
@@ -114,12 +112,11 @@ We provide two ways to traverse the normalized AST: [Visitors](#visitors) and [F
 
 ### Visitors
 
-If you want a simple visitor which traverses the AST, the \`${visitor_1.visitAst.name}\` function from 
-${(0, doc_files_1.getFilePathMd)('../r-bridge/lang-4.x/ast/model/processing/visitor.ts')} is a good starting point.
+If you want a simple visitor which traverses the AST, the ${(0, doc_types_1.shortLink)(visitor_1.visitAst.name, types.info)} function is a good starting point.
 You may specify functions to be called whenever you enter and exit a node during the traversal, and any
 computation is to be done by side effects.
 For example, if you want to collect all the \`id\`s present within a normalized (sub-)ast,
-as it is done by the ${collect_1.collectAllIds.name} function, you can use the following visitor:
+as it is done by the ${(0, doc_types_1.shortLink)(collect_1.collectAllIds.name, types.info)} function, you can use the following visitor:
 
 ${(0, doc_code_1.codeBlock)('ts', `
 const ids = new Set<NodeId>();
@@ -131,12 +128,12 @@ return ids;
 
 ### Folds
 
-We formulate a fold with the base class \`${normalized_ast_fold_1.DefaultNormalizedAstFold.name}\` in ${(0, doc_files_1.getFilePathMd)('../abstract-interpretation/normalized-ast-fold.ts')}.
+We formulate a fold with the base class ${(0, doc_types_1.shortLink)(normalized_ast_fold_1.DefaultNormalizedAstFold.name, types.info)} in ${(0, doc_files_1.getFilePathMd)('../abstract-interpretation/normalized-ast-fold.ts')}.
 Using this class, you can create your own fold behavior by overwriting the default methods.
 By default, the class provides a monoid abstraction using the _empty_ from the constructor and the _concat_ method.
 
  
-${(0, doc_types_1.printHierarchy)({ program: types.program, hierarchy: types.info, root: 'DefaultNormalizedAstFold' })}
+${(0, doc_types_1.printHierarchy)({ program: types.program, info: types.info, root: 'DefaultNormalizedAstFold' })}
 
 Now, of course, we could provide hundreds of examples here, but we use tests to verify that the fold behaves as expected
 and happily point to them at ${(0, doc_files_1.getFilePathMd)('../../test/functionality/r-bridge/normalize-ast-fold.test.ts')}.
@@ -173,8 +170,8 @@ class MyMathFold<Info> extends ${normalized_ast_fold_1.DefaultNormalizedAstFold.
 }
 `)}
 
-Now, we can use the \`${pipeline_executor_1.PipelineExecutor.name}\` to get the normalized AST and apply the fold:
-  
+Now, we can use the ${(0, doc_types_1.shortLink)(pipeline_executor_1.PipelineExecutor.name, types.info)} to get the normalized AST and apply the fold:
+ 
 ${(0, doc_code_1.codeBlock)('ts', `
 const shell = new ${shell_1.RShell.name}();
 const ast = (await new ${pipeline_executor_1.PipelineExecutor.name}(DEFAULT_NORMALIZE_PIPELINE, {
@@ -185,6 +182,14 @@ const result = new MyMathFold().fold(ast);
 console.log(result); // -> 7
 `)}
 
+${(0, doc_structure_1.block)({
+        type: 'NOTE',
+        content: `
+If you want to retrieve the normalized AST with the [Tree-Sitter Engine](${doc_files_1.FlowrWikiBaseRef}/Engines),
+you may use the ${(0, doc_types_1.shortLink)('TREE_SITTER_NORMALIZE_PIPELINE', types.info)} or directly rely on one of the
+helper functions like ${(0, doc_types_1.shortLink)(default_pipelines_1.createNormalizePipeline.name, types.info)}.
+		`
+    })}
 `;
 }
 /** if we run this script, we want a Markdown representation of the capabilities */

package/documentation/print-query-wiki.js

@@ -59,9 +59,9 @@ Besides this, we provide the following ways to automatically categorize and link
 It's also possible to filter the results based on the following properties:
 
 1. **File** (\`fileFilter\`): This allows you to filter the results based on the file in which the call is located. This can be useful if you are only interested in calls in, e.g., specific folders.
-  The \`fileFilter\` property is an object made up of two properties:
-  - **Filter** (\`filter\`): A regular expression that a node's file attribute must match to be considered.
-  - **Include Undefined Files** (\`includeUndefinedFiles\`): If \`fileFilter\` is set, but a node's file attribute is not present, should we include it in the results? Defaults to \`true\`.
+   The \`fileFilter\` property is an object made up of two properties:
+     - **Filter** (\`filter\`): A regular expression that a node's file attribute must match to be considered.
+     - **Include Undefined Files** (\`includeUndefinedFiles\`): If \`fileFilter\` is set, but a node's file attribute is not present, should we include it in the results? Defaults to \`true\`.
 
 Re-using the example code from above, the following query attaches all calls to \`mean\` to the kind \`visualize\` and the subkind \`text\`,
 all calls that start with \`read_\` to the kind \`input\` but only if they are not locally overwritten, and the subkind \`csv-file\`, and links all calls to \`points\` to the last call to \`plot\`:
@@ -164,7 +164,7 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
             }], { showCode: false })}
 
 In this simple scenario, the _lineage_ is equivalent to the slice (and in-fact the complete code). 
-In general the lineage is smaller and makes no executability guarantees. 
+In general the lineage is smaller and makes no guarantees on executability. 
 It is just a quick and neither complete nor sound way to get information on where the variable originates from.
 
 This query replaces the old [\`request-lineage\`](${doc_files_1.FlowrWikiBaseRef}/Interface#message-request-lineage) message.
@@ -368,7 +368,7 @@ ${await (0, doc_query_1.showQuery)(shell, exampleCode, [{
                 criteria: ['3@x']
             }], { showCode: false })}
 
-In general you may be uninterested in seeing the reconstructed version and want to save some computation time, for this,
+In general, you may be uninterested in seeing the reconstructed version and want to save some computation time, for this,
 you can use the \`noReconstruction\` flag.
 
 ${(0, doc_structure_1.details)('No Reconstruction Example', await (0, doc_query_1.showQuery)(shell, exampleCode, [{
@@ -449,7 +449,7 @@ ${await (0, doc_query_1.showQuery)(shell, longerCode, [{
         });
         const exampleCode = 'x + 1\nx * 2';
         return `
-A query like the ${(0, doc_query_1.linkToQueryOfName)('id-map')} query can return a really big result, especially for larger scripts.
+A query like the ${(0, doc_query_1.linkToQueryOfName)('id-map')} query can return a huge result, especially for larger scripts.
 If you are not interested in all of the information contained within the full map, you can use the location map query to get a simple mapping of ids to their location in the source file.   
 
 Consider you have the following code:
@@ -489,7 +489,7 @@ Queries are JSON arrays of query objects, each of which uses a \`type\` property
 In general, we separate two types of queries:
 
 1. **Active Queries**: Are exactly what you would expect from a query (e.g., the ${(0, doc_query_1.linkToQueryOfName)('call-context')}). They fetch information from the dataflow graph.
-2. **Virtual Queries**: Are used to structure your queries (e.g., the ${(0, doc_query_1.linkToQueryOfName)('compound')}). 
+2. **Virtual Queries**: Are used to structure your queries (e.g., the ${(0, doc_query_1.linkToQueryOfName)('compound')}).
 
 We separate these from a concept perspective. 
 For now, we support the following **active** queries (which we will refer to simply as a \`query\`):

package/documentation/print-search-wiki.js

@@ -12,6 +12,7 @@ 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.getTypesFromFolderAsMermaid)({
@@ -24,7 +25,7 @@ async function getText(shell) {
 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)('runSearch', types.info)} function.
+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:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eagleoutice/flowr",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "description": "Static Dataflow Analyzer and Program Slicer for the R Programming Language",
   "types": "dist/src/index.d.ts",
   "repository": {
@@ -28,6 +28,7 @@
     "wiki:df-graph": "ts-node src/documentation/print-dataflow-graph-wiki.ts",
     "wiki:normalized-ast": "ts-node src/documentation/print-normalized-ast-wiki.ts",
     "wiki:query-api": "ts-node src/documentation/print-query-wiki.ts",
+    "wiki:core": "ts-node src/documentation/print-core-wiki.ts",
     "wiki:engines": "ts-node src/documentation/print-engines-wiki.ts",
     "wiki:search-api": "ts-node src/documentation/print-search-wiki.ts",
     "wiki:linting-and-testing": "ts-node src/documentation/print-linting-and-testing-wiki.ts",
@@ -196,7 +197,7 @@
     "@types/ws": "^8.5.10",
     "@typescript-eslint/eslint-plugin": "^7.8.0",
     "@vitest/coverage-v8": "^2.1.4",
-    "esbuild": "^0.23.1",
+    "esbuild": "^0.25.0",
     "eslint": "^8.57.1",
     "license-checker": "^25.0.1",
     "npm-run-all": "^4.1.5",

package/queries/catalog/happens-before-query/happens-before-query-format.js

@@ -22,6 +22,6 @@ exports.HappensBeforeQueryDefinition = {
         type: joi_1.default.string().valid('happens-before').required().description('The type of the query.'),
         a: joi_1.default.string().required().description('The first slicing criterion.'),
         b: joi_1.default.string().required().description('The second slicing criterion.')
-    }).description('The id map query retrieves the id map from the normalized AST.')
+    }).description('Happens-Before tracks whether a always happens before b.')
 };
 //# sourceMappingURL=happens-before-query-format.js.map

package/queries/catalog/resolve-value-query/resolve-value-query-executor.js

@@ -19,7 +19,7 @@ function executeResolveValueQuery({ dataflow: { graph, environment }, ast }, que
         }
         const values = query.criteria
             .map(criteria => (0, node_id_1.recoverName)((0, parse_1.slicingCriterionToId)(criteria, ast.idMap), ast.idMap))
-            .flatMap(ident => (0, resolve_by_name_1.resolveToValues)(ident, environment, graph));
+            .flatMap(ident => (0, resolve_by_name_1.resolveToValues)(ident, environment, graph.idMap ?? ast.idMap));
         results[key] = {
             values: [...new Set(values)]
         };

package/queries/catalog/resolve-value-query/resolve-value-query-format.js

@@ -44,6 +44,6 @@ exports.ResolveValueQueryDefinition = {
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('resolve-value').required().description('The type of the query.'),
         criteria: joi_1.default.array().items(joi_1.default.string()).min(1).required().description('The slicing criteria to use.'),
-    }).description('Resolve Value query used to get definitions of an identifier')
+    }).description('The resolve value query used to get definitions of an identifier')
 };
 //# sourceMappingURL=resolve-value-query-format.js.map

package/queries/catalog/search-query/search-query-format.js

@@ -24,6 +24,6 @@ exports.SearchQueryDefinition = {
     schema: joi_1.default.object({
         type: joi_1.default.string().valid('search').required().description('The type of the query.'),
         search: joi_1.default.object().required().description('The search query to execute.')
-    }).description('The id map query retrieves the id map from the normalized AST.')
+    }).description('The search query searches the normalized AST and dataflow graph for nodes that match the given search query.')
 };
 //# sourceMappingURL=search-query-format.js.map

package/r-bridge/data/data.d.ts

@@ -1,10 +1,12 @@
 export declare const flowrCapabilities: {
     readonly name: "Capabilities of flowR";
     readonly description: "This is an evolving representation of what started with #636 to formulate capabilities in a structured format.";
-    readonly version: "0.0.1";
+    readonly version: "0.0.2";
     readonly capabilities: readonly [{
         readonly name: "Names and Identifiers";
         readonly id: "names-and-identifiers";
+        readonly description: "The recognition of syntactical and non-syntactical names, including their resolutions to corresponding definitions.";
+        readonly example: (parser: import("../parser").KnownParser) => Promise<string>;
         readonly capabilities: readonly [{
             readonly name: "Form";
             readonly id: "form";
@@ -12,17 +14,41 @@ export declare const flowrCapabilities: {
                 readonly name: "Normal";
                 readonly id: "name-normal";
                 readonly supported: "fully";
-                readonly description: "_Recognize constructs like `a`, `plot`, ..._";
+                readonly description: "_Recognize symbol uses like `a`, `plot`, ..._  (i.e., \"normal variables or function calls\").";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/names-values.html#binding-basics";
+                }, {
+                    readonly name: string;
+                    readonly href: "https://cran.r-project.org/doc/manuals/r-release/R-lang.html#Identifiers-1";
+                }];
             }, {
                 readonly name: "Quoted";
                 readonly id: "name-quoted";
                 readonly supported: "fully";
-                readonly description: "_Recognize `\"a\"`, `'plot'`, ..._";
+                readonly description: "_Recognize `\"a\"`, `'plot'`, ..._ In general, R allows to envelop names in quotations to allow for special characters such as spaces in variable names. However, this only works in the context of definitions. To access these names as variables, one has to either use function such as `get` or escape the name with backticks.";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/names-values.html#non-syntactic";
+                }];
             }, {
                 readonly name: "Escaped";
                 readonly id: "name-escaped";
                 readonly supported: "fully";
                 readonly description: "_Recognize `` `a` ``, `` `plot` ``, ..._";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/names-values.html#non-syntactic";
+                }];
+            }, {
+                readonly name: "Created";
+                readonly id: "name-created";
+                readonly supported: "partially";
+                readonly description: "_Recognize functions which resolve strings as identifiers, such as `get`, ..._";
+                readonly url: [{
+                    readonly name: "flowr#633";
+                    readonly href: string;
+                }];
             }];
         }, {
             readonly name: "Resolution";
@@ -538,25 +564,40 @@ export declare const flowrCapabilities: {
             readonly capabilities: readonly [{
                 readonly name: "S3";
                 readonly id: "oop-s3";
-                readonly note: "https://adv-r.hadley.nz/s3.html";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/s3.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle S3 classes and methods as one unit (with attributes etc.). Including Dispatch and Inheritance._ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }, {
                 readonly name: "S4";
                 readonly id: "oop-s4";
-                readonly note: "https://adv-r.hadley.nz/s4.html";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/s4.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle S4 classes and methods as one unit. Including Dispatch and Inheritance_ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }, {
                 readonly name: "R6";
                 readonly id: "oop-r6";
-                readonly note: "https://adv-r.hadley.nz/r6.html";
+                readonly url: [{
+                    readonly name: string;
+                    readonly href: "https://adv-r.hadley.nz/r6.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle R6 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Access Control, Finalizers, and Introspection._ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }, {
                 readonly name: "R7/S7";
                 readonly id: "r7-s7";
-                readonly note: "https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/, https://cran.r-project.org/web/packages/S7/index.html";
+                readonly url: [{
+                    readonly name: "R7";
+                    readonly href: "https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/";
+                }, {
+                    readonly name: "S7";
+                    readonly href: "https://cran.r-project.org/web/packages/S7/index.html";
+                }];
                 readonly supported: "not";
                 readonly description: "_Handle R7 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Validators, ..._ We do not support typing currently and do not handle objects of these classes \"as units.\"";
             }];

package/r-bridge/data/data.js

@@ -1,14 +1,40 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.flowrCapabilities = void 0;
+const doc_files_1 = require("../../documentation/doc-util/doc-files");
+const doc_code_1 = require("../../documentation/doc-util/doc-code");
+const doc_dfg_1 = require("../../documentation/doc-util/doc-dfg");
+const Joiner = '/';
+const AdvancedR = (subname) => 'Advanced R' + Joiner + subname;
+const RLang = (subname) => 'R Definition' + Joiner + subname;
+const Issue = (num) => `${doc_files_1.FlowrGithubBaseRef}/flowr/issues/${num}`;
+const LinkTo = (id, label = id) => `[${label}](#${id})`;
 exports.flowrCapabilities = {
     name: 'Capabilities of flowR',
     description: 'This is an evolving representation of what started with #636 to formulate capabilities in a structured format.',
-    version: '0.0.1',
+    version: '0.0.2',
     capabilities: [
         {
             name: 'Names and Identifiers',
             id: 'names-and-identifiers',
+            description: 'The recognition of syntactical and non-syntactical names, including their resolutions to corresponding definitions.',
+            example: async (parser) => {
+                const code = '"f" <- function(x) { get("x") } \n`y x` <- 2\nprint(`y x` + f(3))';
+                return `
+Consider the following R code:
+${(0, doc_code_1.codeBlock)('r', code)}
+Identifiers of interest are:
+
+- The symbols \`x\` (${LinkTo('name-normal')}), \`f\` (${LinkTo('name-quoted')}), and \`\` \`y x\` \`\` (${LinkTo('name-escaped')}).
+- The function calls \`<-\`, \`function\`, \`{\`, \`get\`, \`+\`, and \`print\` (${LinkTo('function-calls')}, all given with ${LinkTo('name-normal')}).
+  Especially \`{\` is identified as a ${LinkTo('grouping')} of the ${LinkTo('function-definitions', 'function-definitions\'')} body.
+- The quoted name created by a function call \`get\` (${LinkTo('name-created')}).
+
+Besides the parameter \`x\`, which is resolved in its ${LinkTo('lexicographic-scope')}, the other identifiers are resolved in the ${LinkTo('global-scope')}.
+
+${await (0, doc_dfg_1.printDfGraphForCode)(parser, code, { simplified: true })}
+			`;
+            },
             capabilities: [
                 {
                     name: 'Form',
@@ -18,19 +44,38 @@ exports.flowrCapabilities = {
                             name: 'Normal',
                             id: 'name-normal',
                             supported: 'fully',
-                            description: '_Recognize constructs like `a`, `plot`, ..._'
+                            description: '_Recognize symbol uses like `a`, `plot`, ..._  (i.e., "normal variables or function calls").',
+                            url: [
+                                { name: AdvancedR('Bindings'), href: 'https://adv-r.hadley.nz/names-values.html#binding-basics' },
+                                { name: RLang('Identifiers'), href: 'https://cran.r-project.org/doc/manuals/r-release/R-lang.html#Identifiers-1' }
+                            ]
                         },
                         {
                             name: 'Quoted',
                             id: 'name-quoted',
                             supported: 'fully',
-                            description: "_Recognize `\"a\"`, `'plot'`, ..._"
+                            description: "_Recognize `\"a\"`, `'plot'`, ..._ In general, R allows to envelop names in quotations to allow for special characters such as spaces in variable names. However, this only works in the context of definitions. To access these names as variables, one has to either use function such as `get` or escape the name with backticks.",
+                            url: [
+                                { name: AdvancedR('Non-Syntactic Names'), href: 'https://adv-r.hadley.nz/names-values.html#non-syntactic' }
+                            ]
                         },
                         {
                             name: 'Escaped',
                             id: 'name-escaped',
                             supported: 'fully',
-                            description: '_Recognize `` `a` ``, `` `plot` ``, ..._'
+                            description: '_Recognize `` `a` ``, `` `plot` ``, ..._',
+                            url: [
+                                { name: AdvancedR('Non-Syntactic Names'), href: 'https://adv-r.hadley.nz/names-values.html#non-syntactic' }
+                            ]
+                        },
+                        {
+                            name: 'Created',
+                            id: 'name-created',
+                            supported: 'partially',
+                            description: '_Recognize functions which resolve strings as identifiers, such as `get`, ..._',
+                            url: [
+                                { name: 'flowr#633', href: Issue(633) }
+                            ]
                         }
                     ]
                 },
@@ -671,28 +716,37 @@ exports.flowrCapabilities = {
                         {
                             name: 'S3',
                             id: 'oop-s3',
-                            note: 'https://adv-r.hadley.nz/s3.html',
+                            url: [
+                                { name: AdvancedR('S3'), href: 'https://adv-r.hadley.nz/s3.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle S3 classes and methods as one unit (with attributes etc.). Including Dispatch and Inheritance._ We do not support typing currently and do not handle objects of these classes "as units."'
                         },
                         {
                             name: 'S4',
                             id: 'oop-s4',
-                            note: 'https://adv-r.hadley.nz/s4.html',
+                            url: [
+                                { name: AdvancedR('S4'), href: 'https://adv-r.hadley.nz/s4.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle S4 classes and methods as one unit. Including Dispatch and Inheritance_ We do not support typing currently and do not handle objects of these classes "as units."'
                         },
                         {
                             name: 'R6',
                             id: 'oop-r6',
-                            note: 'https://adv-r.hadley.nz/r6.html',
+                            url: [
+                                { name: AdvancedR('R6'), href: 'https://adv-r.hadley.nz/r6.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle R6 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Access Control, Finalizers, and Introspection._ We do not support typing currently and do not handle objects of these classes "as units."'
                         },
                         {
                             name: 'R7/S7',
                             id: 'r7-s7',
-                            note: 'https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/, https://cran.r-project.org/web/packages/S7/index.html',
+                            url: [
+                                { name: 'R7', href: 'https://www.r-bloggers.com/2022/12/what-is-r7-a-new-oop-system-for-r/' },
+                                { name: 'S7', href: 'https://cran.r-project.org/web/packages/S7/index.html' }
+                            ],
                             supported: 'not',
                             description: '_Handle R7 classes and methods as one unit. Including Dispatch and Inheritance, as well as its Reference Semantics, Validators, ..._ We do not support typing currently and do not handle objects of these classes "as units."'
                         }

package/r-bridge/data/types.d.ts

@@ -1,3 +1,4 @@
+import type { KnownParser } from '../parser';
 declare const enum RequiredFeature {
     /** https://github.com/flowr-analysis/flowr/labels/typing */
     Typing = 0,
@@ -15,7 +16,12 @@ export interface FlowrCapability {
     /** A list of features that are required for the capability, extend at need. */
     readonly needs?: RequiredFeature[];
     readonly description?: string;
-    readonly note?: string;
+    readonly example?: string | ((parser: KnownParser) => Promise<string>);
+    /** A list of URLs that provide additional information about the capability */
+    readonly url?: {
+        name: string;
+        href: string;
+    }[];
     /** The level of support for the capability, undefined if it is a meta-capability that does not need such an attribute */
     readonly supported?: 'not' | 'partially' | 'fully';
     readonly capabilities?: readonly FlowrCapability[];

package/r-bridge/lang-4.x/ast/model/processing/decorate.d.ts

@@ -74,6 +74,8 @@ export interface NormalizedAst<OtherInfo = ParentInformation, Node = RNode<Other
     idMap: AstIdMap<OtherInfo>;
     /** The root of the AST with parent information */
     ast: Node;
+    /** marks whether the AST contains potential syntax errors */
+    hasError?: boolean;
 }
 export interface NormalizedAstDecorationConfiguration<OtherInfo> {
     /** The id generator: must generate a unique id für each passed node */

package/r-bridge/lang-4.x/ast/model/processing/node-id.js

@@ -27,10 +27,7 @@ function recoverName(id, idMap) {
  */
 function recoverContent(id, graph) {
     const vertex = graph.getVertex(id);
-    if (vertex === undefined) {
-        return undefined;
-    }
-    if (vertex.tag === vertex_1.VertexType.FunctionCall && vertex.name) {
+    if (vertex && vertex.tag === vertex_1.VertexType.FunctionCall && vertex.name) {
         return vertex.name;
     }
     const node = graph.idMap?.get(id);
@@ -38,7 +35,7 @@ function recoverContent(id, graph) {
         return undefined;
     }
     const lexeme = node.lexeme ?? node.info.fullLexeme ?? '';
-    if (vertex.tag === vertex_1.VertexType.Use) {
+    if (vertex?.tag === vertex_1.VertexType.Use) {
         return (0, retriever_1.removeRQuotes)(lexeme);
     }
     return lexeme;