@eagleoutice/flowr 2.2.2 → 2.2.4

package/README.md

@@ -1,18 +1,414 @@
 [![flowR logo](https://raw.githubusercontent.com/wiki/flowr-analysis/flowr/img/flowR.png)](https://github.com/flowr-analysis/flowr/wiki)\
-[![QA (and potentially deploy)](https://github.com/flowr-analysis/flowr/actions/workflows/qa.yaml/badge.svg)](https://github.com/flowr-analysis/flowr/actions/workflows/qa.yaml) [![codecov](https://codecov.io/gh/flowr-analysis/flowr/graph/badge.svg)](https://codecov.io/gh/flowr-analysis/flowr) [![Docker Image Version (latest semver)](https://img.shields.io/docker/v/eagleoutice/flowr?logo=docker&logoColor=white&label=dockerhub)](https://hub.docker.com/r/eagleoutice/flowr) [![latest tag](https://badgen.net/github/tag/flowr-analysis/flowr?label=latest&color=purple)](https://github.com/flowr-analysis/flowr/releases/latest) [![Marketplace](https://badgen.net/vs-marketplace/v/code-inspect.vscode-flowr)](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr) [![All Contributors](https://img.shields.io/github/all-contributors/flowr-analysis/flowr)](#contributors)
+[![QA (and potentially deploy)](https://github.com/flowr-analysis/flowr/actions/workflows/qa.yaml/badge.svg)](https://github.com/flowr-analysis/flowr/actions/workflows/qa.yaml)
+[![codecov](https://codecov.io/gh/flowr-analysis/flowr/graph/badge.svg)](https://codecov.io/gh/flowr-analysis/flowr)
+[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/eagleoutice/flowr?logo=docker&logoColor=white&label=dockerhub)](https://hub.docker.com/r/eagleoutice/flowr)
+[![latest tag](https://badgen.net/github/tag/flowr-analysis/flowr?label=latest&color=purple)](https://github.com/flowr-analysis/flowr/releases/latest)
+[![Marketplace](https://badgen.net/vs-marketplace/v/code-inspect.vscode-flowr)](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr)
 [![DOI](https://zenodo.org/badge/624819038.svg)](https://zenodo.org/doi/10.5281/zenodo.13319290)
 
-_flowR_ is a static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) and [program slicer](https://github.com/flowr-analysis/flowr/wiki/Terminology#program-slice) for the [_R_](https://www.r-project.org/) programming language (currently tested for versions `4.x` and `3.6.x`). You can get and use _flowR_ as a [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr), [RStudio Addin](https://github.com/flowr-analysis/rstudio-addin-flowr), [R package](https://github.com/flowr-analysis/flowr-r-adapter), and as a [Docker image](https://hub.docker.com/r/eagleoutice/flowr).
+_flowR_ is a sophisticated, static [dataflow analyzer](https://en.wikipedia.org/wiki/Data-flow_analysis) for the [R programming language](https://www.r-project.org/).
+It offers a wide variety of features, for example:
 
+* 🍕 **program slicing**\
+   Given a point of interest like the visualization of a plot, _flowR_ reduces the program to just the parts which are relevant
+   for the computation of the point of interest.
+
+    
+    <details><summary style="">Example: Slicing with flowR</summary>
+    
+    
+    The simplest way to retrieve slices is with flowR's [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr). 
+    However, you can slice using the [REPL](https://github.com/flowr-analysis/flowr/wiki/Interface#using-the-repl) as well.
+    This can help you if you want to reuse specific parts of an existing analysis within another context or if you want to understand
+    what is happening in the code.
+    
+    For this, let's have a look at the example file, located at [test/testfiles/example.R](https://github.com/flowr-analysis/flowr/tree/main//test/testfiles/example.R):
+    
+    
+    ```r
+    sum <- 0
+    product <- 1
+    w <- 7
+    N <- 10
+    
+    for (i in 1:(N-1)) {
+      sum <- sum + i + w
+      product <- product * i
+    }
+    
+    cat("Sum:", sum, "\n")
+    cat("Product:", product, "\n")
+    ```
+    
+    
+    Let's suppose we are interested only in the sum which is printed in line 11.
+    To get a slice for this, you can use the following command:
+    
+    
+    
+    ```shell
+    $ docker run -it --rm eagleoutice/flowr # or npm run flowr 
+    flowR repl using flowR v2.2.3, R v4.4.0 (r-shell engine)
+    R> :slicer test/testfiles/example.R --criterion "11@sum"
+    ```
+    
+    <details>
+    <summary style='color:gray'>Output</summary>
+    
+    
+    ```text
+    sum <- 0
+    w <- 7
+    N <- 10
+    for(i in 1:(N-1)) sum <- sum + i + w
+    sum
+    ```
+    
+    
+    
+    
+    </details>
+    
+    
+       
+       
+    
+    </details>
+        
+
+* 📚 **dependency analysis**\
+  Given your analysis project, flowR offers a plethora of so-called [queries](https://github.com/flowr-analysis/flowr/wiki/Query-API) to get more information about your code.
+  An important query is the [dependencies query](https://github.com/flowr-analysis/flowr/wiki/Query-API#dependencies-query), which shows you the library your project needs,
+  the data files it reads, the scripts it sources, and the data it outputs.
+  
+      
+    <details><summary style="">Example: Dependency Analysis with flowR</summary>
+    
+    
+    The following showcases the dependency view of the [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr):
+    
+    ![Dependency Analysis](https://raw.githubusercontent.com/flowr-analysis/vscode-flowr/refs/heads/main/media/dependencies.png)
+      
+      
+    
+    </details>
+        
+
+* 🚀 **fast data and control-flow graphs**\
+  Within just <i><span title="This measurement is automatically fetched from the latest benchmarks!">120.6 ms</i></span> (as of Feb 12, 2025), 
+  _flowR_ can analyze the data- and control-flow of the average real-world R script. See the [benchmarks](https://flowr-analysis.github.io/flowr/wiki/stats/benchmark) for more information,
+  and consult the [wiki pages](https://github.com/flowr-analysis/flowr/wiki/Dataflow-Graph) for more details on the dataflow graph.
+
+    
+    <details><summary style="">Example: Generating a dataflow graph with flowR</summary>
+    
+    
+    You can investigate flowR's analyses using the [REPL](https://github.com/flowr-analysis/flowr/wiki/Interface#using-the-repl).
+    Commands like <span title="Description (Repl Command, starred version): Returns the URL to mermaid.live; Base Command: Get mermaid code for the dataflow graph of R code, start with 'file://' to indicate a file (aliases: :d*, :df*)">`:dataflow*`</span> allow you to view a dataflow graph for a given R script.
+    
+    Let's have a look at the following example:
+    
+    
+    ```r
+    sum <- 0
+    product <- 1
+    w <- 7
+    N <- 10
+    
+    for (i in 1:(N-1)) {
+      sum <- sum + i + w
+      product <- product * i
+    }
+    
+    cat("Sum:", sum, "\n")
+    cat("Product:", product, "\n")
+    ```
+    
+    
+    To get the dataflow graph for this script, you can use the following command:
+    
+    
+    
+    ```shell
+    $ docker run -it --rm eagleoutice/flowr # or npm run flowr 
+    flowR repl using flowR v2.2.3, R v4.4.0 (r-shell engine)
+    R> :dataflow* test/testfiles/example.R
+    ```
+    
+    <details>
+    <summary style='color:gray'>Output</summary>
+    
+    
+    ```text
+    https://mermaid.live/view#base64:eyJjb2RlIjoiZmxvd2NoYXJ0IFREXG4gICAgMChbXCJgIzkxO1JTeW1ib2wjOTM7IHRlc3RcbiAgICAgICgwKVxuICAgICAgKjEuMS00KmBcIl0pXG4gICAgMShbXCJgIzkxO1JTeW1ib2wjOTM7IHRlc3RmaWxlc1xuICAgICAgKDEpXG4gICAgICAqMS42LTE0KmBcIl0pXG4gICAgMltbXCJgIzkxO1JCaW5hcnlPcCM5MzsgL1xuICAgICAgKDIpXG4gICAgICAqMS4xLTE0KlxuICAgICgwLCAxKWBcIl1dXG4gICAgMyhbXCJgIzkxO1JTeW1ib2wjOTM7IGV4YW1wbGUuUlxuICAgICAgKDMpXG4gICAgICAqMS4xNi0yNCpgXCJdKVxuICAgIDRbW1wiYCM5MTtSQmluYXJ5T3AjOTM7IC9cbiAgICAgICg0KVxuICAgICAgKjEuMS0yNCpcbiAgICAoMiwgMylgXCJdXVxuICAgIDIgLS0+fFwicmVhZHMsIGFyZ3VtZW50XCJ8IDBcbiAgICAyIC0tPnxcInJlYWRzLCBhcmd1bWVudFwifCAxXG4gICAgNCAtLT58XCJyZWFkcywgYXJndW1lbnRcInwgMlxuICAgIDQgLS0+fFwicmVhZHMsIGFyZ3VtZW50XCJ8IDMiLCJtZXJtYWlkIjp7ImF1dG9TeW5jIjp0cnVlfX0=
+    ```
+    
+    
+    
+    Following the link output should show the following:
+    
+    
+    
+    ```mermaid
+    flowchart LR
+        1{{"`#91;RNumber#93; 0
+          (1)
+          *1.8*`"}}
+        0["`#91;RSymbol#93; sum
+          (0)
+          *1.1-3*`"]
+        2[["`#91;RBinaryOp#93; #60;#45;
+          (2)
+          *1.1-8*
+        (0, 1)`"]]
+        4{{"`#91;RNumber#93; 1
+          (4)
+          *2.12*`"}}
+        3["`#91;RSymbol#93; product
+          (3)
+          *2.1-7*`"]
+        5[["`#91;RBinaryOp#93; #60;#45;
+          (5)
+          *2.1-12*
+        (3, 4)`"]]
+        7{{"`#91;RNumber#93; 7
+          (7)
+          *3.6*`"}}
+        6["`#91;RSymbol#93; w
+          (6)
+          *3.1*`"]
+        8[["`#91;RBinaryOp#93; #60;#45;
+          (8)
+          *3.1-6*
+        (6, 7)`"]]
+        10{{"`#91;RNumber#93; 10
+          (10)
+          *4.6-7*`"}}
+        9["`#91;RSymbol#93; N
+          (9)
+          *4.1*`"]
+        11[["`#91;RBinaryOp#93; #60;#45;
+          (11)
+          *4.1-7*
+        (9, 10)`"]]
+        12["`#91;RSymbol#93; i
+          (12)
+          *6.6*`"]
+        13{{"`#91;RNumber#93; 1
+          (13)
+          *6.11*`"}}
+        16(["`#91;RSymbol#93; N
+          (16)
+          *6.14*`"])
+        17{{"`#91;RNumber#93; 1
+          (17)
+          *6.16*`"}}
+        18[["`#91;RBinaryOp#93; #45;
+          (18)
+          *6.14-16*
+        (16, 17)`"]]
+        19[["`#91;RExpressionList#93; (
+          (19)
+          *6.13*
+        (18)`"]]
+        20[["`#91;RBinaryOp#93; #58;
+          (20)
+          *6.11-17*
+        (13, 19)`"]]
+        24(["`#91;RSymbol#93; sum
+          (24, :may:36+)
+          *7.10-12*`"])
+        25(["`#91;RSymbol#93; i
+          (25, :may:36+)
+          *7.16*`"])
+        26[["`#91;RBinaryOp#93; #43;
+          (26, :may:36+)
+          *7.10-16*
+        (24, 25)`"]]
+        27(["`#91;RSymbol#93; w
+          (27, :may:36+)
+          *7.20*`"])
+        28[["`#91;RBinaryOp#93; #43;
+          (28, :may:36+)
+          *7.10-20*
+        (26, 27)`"]]
+        23["`#91;RSymbol#93; sum
+          (23, :may:)
+          *7.3-5*`"]
+        29[["`#91;RBinaryOp#93; #60;#45;
+          (29, :may:36+)
+          *7.3-20*
+        (23, 28)`"]]
+        31(["`#91;RSymbol#93; product
+          (31, :may:36+)
+          *8.14-20*`"])
+        32(["`#91;RSymbol#93; i
+          (32, :may:36+)
+          *8.24*`"])
+        33[["`#91;RBinaryOp#93; #42;
+          (33, :may:36+)
+          *8.14-24*
+        (31, 32)`"]]
+        30["`#91;RSymbol#93; product
+          (30, :may:)
+          *8.3-9*`"]
+        34[["`#91;RBinaryOp#93; #60;#45;
+          (34, :may:36+)
+          *8.3-24*
+        (30, 33)`"]]
+        35[["`#91;RExpressionList#93; #123;
+          (35, :may:36+)
+          *6.20*
+        (29, 34)`"]]
+        36[["`#91;RForLoop#93; for
+          (36)
+          *6.1-9.1*
+        (12, 20, 35)`"]]
+        38{{"`#91;RString#93; #34;Sum#58;#34;
+          (38)
+          *11.5-10*`"}}
+        40(["`#91;RSymbol#93; sum
+          (40)
+          *11.13-15*`"])
+        42{{"`#91;RString#93; #34;
+    #34;
+          (42)
+          *11.18-21*`"}}
+        44[["`#91;RFunctionCall#93; cat
+          (44)
+          *11.1-22*
+        (38, 40, 42)`"]]
+        46{{"`#91;RString#93; #34;Product#58;#34;
+          (46)
+          *12.5-14*`"}}
+        48(["`#91;RSymbol#93; product
+          (48)
+          *12.17-23*`"])
+        50{{"`#91;RString#93; #34;
+    #34;
+          (50)
+          *12.26-29*`"}}
+        52[["`#91;RFunctionCall#93; cat
+          (52)
+          *12.1-30*
+        (46, 48, 50)`"]]
+        0 -->|"defined-by"| 1
+        0 -->|"defined-by"| 2
+        2 -->|"argument"| 1
+        2 -->|"returns, argument"| 0
+        3 -->|"defined-by"| 4
+        3 -->|"defined-by"| 5
+        5 -->|"argument"| 4
+        5 -->|"returns, argument"| 3
+        6 -->|"defined-by"| 7
+        6 -->|"defined-by"| 8
+        8 -->|"argument"| 7
+        8 -->|"returns, argument"| 6
+        9 -->|"defined-by"| 10
+        9 -->|"defined-by"| 11
+        11 -->|"argument"| 10
+        11 -->|"returns, argument"| 9
+        12 -->|"defined-by"| 20
+        16 -->|"reads"| 9
+        18 -->|"reads, argument"| 16
+        18 -->|"reads, argument"| 17
+        19 -->|"returns, argument"| 18
+        20 -->|"reads, argument"| 13
+        20 -->|"reads, argument"| 19
+        24 -->|"reads"| 0
+        24 -->|"reads"| 23
+        24 -->|"CD-True"| 36
+        linkStyle 25 stroke:gray,color:gray;
+        25 -->|"reads"| 12
+        25 -->|"CD-True"| 36
+        linkStyle 27 stroke:gray,color:gray;
+        26 -->|"reads, argument"| 24
+        26 -->|"reads, argument"| 25
+        26 -->|"CD-True"| 36
+        linkStyle 30 stroke:gray,color:gray;
+        27 -->|"reads"| 6
+        27 -->|"CD-True"| 36
+        linkStyle 32 stroke:gray,color:gray;
+        28 -->|"reads, argument"| 26
+        28 -->|"reads, argument"| 27
+        28 -->|"CD-True"| 36
+        linkStyle 35 stroke:gray,color:gray;
+        23 -->|"defined-by"| 28
+        23 -->|"defined-by"| 29
+        29 -->|"argument"| 28
+        29 -->|"returns, argument"| 23
+        29 -->|"CD-True"| 36
+        linkStyle 40 stroke:gray,color:gray;
+        31 -->|"reads"| 3
+        31 -->|"reads"| 30
+        31 -->|"CD-True"| 36
+        linkStyle 43 stroke:gray,color:gray;
+        32 -->|"reads"| 12
+        32 -->|"CD-True"| 36
+        linkStyle 45 stroke:gray,color:gray;
+        33 -->|"reads, argument"| 31
+        33 -->|"reads, argument"| 32
+        33 -->|"CD-True"| 36
+        linkStyle 48 stroke:gray,color:gray;
+        30 -->|"defined-by"| 33
+        30 -->|"defined-by"| 34
+        34 -->|"argument"| 33
+        34 -->|"returns, argument"| 30
+        34 -->|"CD-True"| 36
+        linkStyle 53 stroke:gray,color:gray;
+        35 -->|"argument"| 29
+        35 -->|"returns, argument"| 34
+        35 -->|"CD-True"| 36
+        linkStyle 56 stroke:gray,color:gray;
+        36 -->|"reads, argument"| 12
+        36 -->|"reads, argument"| 20
+        36 -->|"argument, non-standard-evaluation"| 35
+        40 -->|"reads"| 0
+        40 -->|"reads"| 23
+        44 -->|"argument"| 38
+        44 -->|"reads, argument"| 40
+        44 -->|"argument"| 42
+        48 -->|"reads"| 3
+        48 -->|"reads"| 30
+        52 -->|"argument"| 46
+        52 -->|"reads, argument"| 48
+        52 -->|"argument"| 50
+    ```
+    	
+    (The analysis required _22.53 ms_ (including parse and normalize, using the [r-shell](https://github.com/flowr-analysis/flowr/wiki/Engines) engine) within the generation environment.)
+    
+    
+    
+    </details>
+    
+    
+       
+       
+    
+    </details>
+        
+
+If you want to use flowR and the features it provides, feel free to check out the:
+
+- [Visual Studio Code extension](https://marketplace.visualstudio.com/items?itemName=code-inspect.vscode-flowr): provides access to flowR's capabilities directly in VS Code (also works in [vscode.dev](https://vscode.dev/))
+- [RStudio Addin](https://github.com/flowr-analysis/rstudio-addin-flowr): integrates flowR into [RStudio](https://posit.co/downloads/)
+- [R package](https://github.com/flowr-analysis/flowr-r-adapter): allows you to use flowR in your R scripts
+- [Docker image](https://hub.docker.com/r/eagleoutice/flowr): run flowR in a container, this also includes [flowR's server](https://github.com/flowr-analysis/flowr/wiki/Interface#communicating-with-the-server)
+- [NPM package](https://www.npmjs.com/package/@eagleoutice/flowr): include flowR in your TypeScript and JavaScript projects (e.g., used for the VS Code extension)
+ 
 ## ⭐ Getting Started
 
-To get started with _flowR_ and its features, please check out the [Overview](https://github.com/flowr-analysis/flowr/wiki/Overview) page. The [Setup](https://github.com/flowr-analysis/flowr/wiki/Setup) wiki page explains how you can download and setup _flowR_ on your system. With docker&nbsp;🐳️, the following line should be enough (and drop you directly into the read-eval-print loop):
+To get started with _flowR_ and its features, please check out the [Overview](https://github.com/flowr-analysis/flowr/wiki/Overview) wiki page. 
+The [Setup](https://github.com/flowr-analysis/flowr/wiki/Setup) wiki page explains how you can download and setup _flowR_ on your system. 
+With docker&nbsp;🐳️, the following line should be enough (and drop you directly into the read-eval-print loop):
+
 
 ```shell
 docker run -it --rm eagleoutice/flowr
 ```
 
-You can enter `:help` to gain more information on its capabilities.
+
+You can enter <span title="Description (Repl Command): Show help information (aliases: :h, :?)">`:help`</span> to gain more information on its capabilities.
 
 <details>
 
@@ -33,43 +429,20 @@ We welcome every contribution! Please check out the [contributing guidelines](ht
 
 ### Contributors
 
-<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
-<!-- prettier-ignore-start -->
-<!-- markdownlint-disable -->
-<table>
-  <tbody>
-    <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/EagleoutIce"><img src="https://avatars.githubusercontent.com/u/9303573?v=4?s=100" width="100px;" alt="Florian Sihler"/><br /><sub><b>Florian Sihler</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=EagleoutIce" title="Code">💻</a> <a href="#ideas-EagleoutIce" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-EagleoutIce" title="Maintenance">🚧</a> <a href="#projectManagement-EagleoutIce" title="Project Management">📆</a> <a href="#research-EagleoutIce" title="Research">🔬</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=EagleoutIce" title="Tests">⚠️</a> <a href="#talk-EagleoutIce" title="Talks">📢</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://ellpeck.de/"><img src="https://avatars.githubusercontent.com/u/5741138?v=4?s=100" width="100px;" alt="Ell"/><br /><sub><b>Ell</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=Ellpeck" title="Code">💻</a> <a href="#maintenance-Ellpeck" title="Maintenance">🚧</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=Ellpeck" title="Tests">⚠️</a> <a href="#plugin-Ellpeck" title="Plugin/utility libraries">🔌</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/gigalasr"><img src="https://avatars.githubusercontent.com/u/25102989?v=4?s=100" width="100px;" alt="Lars"/><br /><sub><b>Lars</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=gigalasr" title="Code">💻</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=gigalasr" title="Tests">⚠️</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://lukas.pietzschmann.org/"><img src="https://avatars.githubusercontent.com/u/49213919?v=4?s=100" width="100px;" alt="Lukas Pietzschmann"/><br /><sub><b>Lukas Pietzschmann</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=LukasPietzschmann" title="Code">💻</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=LukasPietzschmann" title="Tests">⚠️</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/bjthehun"><img src="https://avatars.githubusercontent.com/u/38729215?v=4?s=100" width="100px;" alt="Benedikt Jutz"/><br /><sub><b>Benedikt Jutz</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=bjthehun" title="Code">💻</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=bjthehun" title="Tests">⚠️</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Core5563"><img src="https://avatars.githubusercontent.com/u/140061253?v=4?s=100" width="100px;" alt="Core5563"/><br /><sub><b>Core5563</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=Core5563" title="Code">💻</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=Core5563" title="Tests">⚠️</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ehcsan"><img src="https://avatars.githubusercontent.com/u/68707578?v=4?s=100" width="100px;" alt="Ehcsan"/><br /><sub><b>Ehcsan</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=Ehcsan" title="Code">💻</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=Ehcsan" title="Tests">⚠️</a></td>
-    </tr>
-    <tr>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Slartibartfass2"><img src="https://avatars.githubusercontent.com/u/40503329?v=4?s=100" width="100px;" alt="Felix Schlegel"/><br /><sub><b>Felix Schlegel</b></sub></a><br /><a href="https://github.com/flowr-analysis/flowr/commits?author=Slartibartfass2" title="Code">💻</a> <a href="https://github.com/flowr-analysis/flowr/commits?author=Slartibartfass2" title="Tests">⚠️</a></td>
-    </tr>
-  </tbody>
-  <tfoot>
-    <tr>
-      <td align="center" size="13px" colspan="7">
-        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
-          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
-        </img>
-      </td>
-    </tr>
-  </tfoot>
-</table>
-
-<!-- markdownlint-restore -->
-<!-- prettier-ignore-end -->
-
-<!-- ALL-CONTRIBUTORS-LIST:END -->
+<a href="https://github.com/flowr-analysis/flowr/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=flowr-analysis/flowr"  alt="flowR Contributors"/>
+</a>
 
 ----
 
-*flowr* is actively developed by *Florian Sihler* (contact at: <florian.sihler@uni-ulm.de>) under the
-[GPLv3 License](LICENSE).
+*flowr* is actively developed by [Florian Sihler](https://eagleoutice.github.io/portfolio/) under the
+[GPLv3 License](LICENSE).\
+It is partially supported by the German Research Foundation (DFG) under the grant [504226141](https://gepris.dfg.de/gepris/projekt/504226141) ("CodeInspector").
 
 ----
+
+### Generation Notice
+
+Please notice that this file was generated automatically using the file [src/documentation/print-readme.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-readme.ts) as a source.\
+If you want to make changes please edit the source file (the CI will take care of the rest).
+In fact, many files in the [wiki](https://github.com/flowr-analysis/flowr/wiki) are generated, so make sure to check for the source file if you want to make changes.

package/benchmark/slicer.js

@@ -172,7 +172,6 @@ class BenchmarkSlicer {
         (0, assert_1.guard)(!this.perSliceMeasurements.has(slicingCriteria), 'do not slice the same criteria combination twice');
         const measurements = new stopwatch_1.Measurements();
         const stats = {
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             measurements: undefined,
             slicingCriteria: [],
             numberOfDataflowNodesSliced: 0,

package/benchmark/summarizer/first-phase/process.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -200,7 +210,7 @@ async function summarizeSlicerStats(stats, report = () => {
                 normalized: (sliceTime + reconstructTime) / numberOfNormalizedTokens
             });
         }
-        catch (e) {
+        catch {
             console.error(`    ! Failed to re-parse the output of the slicer for ${JSON.stringify(criteria)}`); //, e
             console.error(`      Code: ${output}\n`);
             failedOutputs++;

package/benchmark/summarizer/summarizer.d.ts

@@ -7,7 +7,7 @@ import type { CommonSummarizerConfiguration } from '../../util/summarizer';
 import { Summarizer } from '../../util/summarizer';
 export interface BenchmarkSummarizerConfiguration extends CommonSummarizerConfiguration {
     /**
-     * If given, produce graph data output (e.g. for the benchmark visualization) to the given path
+     * If given, produce graph data output (e.g., for the benchmark visualization) to the given path
      */
     graphOutputPath?: string;
     /**

package/benchmark/summarizer/summarizer.js

@@ -65,7 +65,7 @@ class BenchmarkSummarizer extends summarizer_1.Summarizer {
             try {
                 fs_1.default.rmSync(path, { recursive: true });
             }
-            catch (e) {
+            catch {
                 log_1.log.error('failure in cleanup');
             }
         }

package/cli/benchmark-app.js

@@ -30,7 +30,7 @@ function removeIfExists(summarizedRaw) {
         try {
             fs_1.default.rmSync(summarizedRaw, { recursive: true });
         }
-        catch (e) {
+        catch {
             log_1.log.error('failure in cleanup');
         }
     }

package/cli/common/script.js

@@ -43,7 +43,6 @@ function processCommandLineArgs(script, requireAdditionally, help) {
     }
     else if (requireAdditionally.length > 0) {
         const keys = new Set(Object.keys(options));
-        // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- we know that they are not given if undefined
         const missing = requireAdditionally.filter(k => !keys.has(k) || options[k] === undefined);
         if (missing.length > 0) {
             console.error((0, ansi_1.italic)(`Missing required arguments: ${missing.join(', ')}. Showing help.`));

package/cli/repl/commands/repl-cfg.js

@@ -1,7 +1,37 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.controlflowStarCommand = exports.controlflowCommand = void 0;
 const cfg_1 = require("../../../util/cfg/cfg");
@@ -9,7 +39,7 @@ const default_pipelines_1 = require("../../../core/steps/pipeline/default-pipeli
 const retriever_1 = require("../../../r-bridge/retriever");
 const cfg_2 = require("../../../util/mermaid/cfg");
 const ansi_1 = require("../../../util/ansi");
-const clipboardy_1 = __importDefault(require("clipboardy"));
+const clipboard = Promise.resolve().then(() => __importStar(require('clipboardy')));
 async function controlflow(parser, remainingLine) {
     return await (0, default_pipelines_1.createDataflowPipeline)(parser, {
         request: (0, retriever_1.requestFromInput)(remainingLine.trim())
@@ -32,10 +62,10 @@ exports.controlflowCommand = {
         const mermaid = (0, cfg_2.cfgToMermaid)(cfg, result.normalize);
         output.stdout(mermaid);
         try {
-            clipboardy_1.default.writeSync(mermaid);
+            (await clipboard).default.writeSync(mermaid);
             output.stdout(formatInfo(output, 'mermaid code'));
         }
-        catch (e) { /* do nothing this is a service thing */ }
+        catch { /* do nothing this is a service thing */ }
     }
 };
 exports.controlflowStarCommand = {
@@ -49,10 +79,10 @@ exports.controlflowStarCommand = {
         const mermaid = (0, cfg_2.cfgToMermaidUrl)(cfg, result.normalize);
         output.stdout(mermaid);
         try {
-            clipboardy_1.default.writeSync(mermaid);
+            (await clipboard).default.writeSync(mermaid);
             output.stdout(formatInfo(output, 'mermaid url'));
         }
-        catch (e) { /* do nothing this is a service thing */ }
+        catch { /* do nothing this is a service thing */ }
     }
 };
 //# sourceMappingURL=repl-cfg.js.map

package/cli/repl/commands/repl-commands.js

@@ -93,7 +93,7 @@ function hasModule(path) {
         require.resolve(path);
         return true;
     }
-    catch (e) {
+    catch {
         return false;
     }
 }