Skip to content

Commit c292b15

Browse files
committed
[skip ci] doc: update generated wiki pages (wiki/Interface,wiki/Linter)
1 parent 65f911e commit c292b15

11 files changed

+73
-73
lines changed

wiki/Interface.md

Lines changed: 19 additions & 19 deletions
Large diffs are not rendered by default.

wiki/Linter.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 10:38:06 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:33:30 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22

33
This page describes the flowR linter, which is a tool that utilizes flowR's dataflow analysis to find common issues in R scripts. The linter can currently be used through the linter [query](https://github.com/flowr-analysis/flowr/wiki/Query%20API).
44
For example:
@@ -32,7 +32,7 @@ Query: linter (2 ms)
3232
╰ **Unused Definitions** (unused-definitions):
3333
╰ _Metadata_: <code>{"totalConsidered":0,"searchTimeMs":0,"processTimeMs":0}</code>
3434
╰ **Naming Convention** (naming-convention):
35-
╰ _Metadata_: <code>{"numMatches":0,"numBreak":0,"searchTimeMs":0,"processTimeMs":1}</code>
35+
╰ _Metadata_: <code>{"numMatches":0,"numBreak":0,"searchTimeMs":0,"processTimeMs":0}</code>
3636
╰ **Dataframe Access Validation** (dataframe-access-validation):
3737
╰ _Metadata_: <code>{"numOperations":0,"numAccesses":0,"totalAccessed":0,"searchTimeMs":0,"processTimeMs":0}</code>
3838
╰ **Dead Code** (dead-code):
@@ -61,34 +61,34 @@ Formatted more nicely, this returns:
6161

6262
_Results (prettified and summarized):_
6363

64-
Query: **linter** (14 ms)\
64+
Query: **linter** (13 ms)\
6565
&nbsp;&nbsp;&nbsp;**Deprecated Functions** (deprecated-functions):\
66-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalDeprecatedCalls":0,"totalDeprecatedFunctionDefinitions":0,"searchTimeMs":2,"processTimeMs":0}</code>\
66+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalDeprecatedCalls":0,"totalDeprecatedFunctionDefinitions":0,"searchTimeMs":1,"processTimeMs":1}</code>\
6767
&nbsp;&nbsp;&nbsp;**File Path Validity** (file-path-validity):\
6868
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
6969
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Path `/root/x.txt` at 1.1-23\
70-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":4,"processTimeMs":1}</code>\
70+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalReads":1,"totalUnknown":0,"totalWritesBeforeAlways":0,"totalValid":0,"searchTimeMs":4,"processTimeMs":0}</code>\
7171
&nbsp;&nbsp;&nbsp;**Seeded Randomness** (seeded-randomness):\
72-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consumerCalls":0,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":0,"processTimeMs":1}</code>\
72+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consumerCalls":0,"callsWithFunctionProducers":0,"callsWithAssignmentProducers":0,"callsWithNonConstantProducers":0,"searchTimeMs":0,"processTimeMs":0}</code>\
7373
&nbsp;&nbsp;&nbsp;**Absolute Paths** (absolute-file-paths):\
7474
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
7575
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Path `/root/x.txt` at 1.1-23\
76-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":1,"processTimeMs":1}</code>\
76+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalConsidered":1,"totalUnknown":0,"searchTimeMs":2,"processTimeMs":0}</code>\
7777
&nbsp;&nbsp;&nbsp;**Unused Definitions** (unused-definitions):\
7878
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"totalConsidered":0,"searchTimeMs":0,"processTimeMs":0}</code>\
7979
&nbsp;&nbsp;&nbsp;**Naming Convention** (naming-convention):\
80-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"numMatches":0,"numBreak":0,"searchTimeMs":0,"processTimeMs":0}</code>\
80+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"numMatches":0,"numBreak":0,"searchTimeMs":0,"processTimeMs":1}</code>\
8181
&nbsp;&nbsp;&nbsp;**Dataframe Access Validation** (dataframe-access-validation):\
8282
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"numOperations":0,"numAccesses":0,"totalAccessed":0,"searchTimeMs":0,"processTimeMs":2}</code>\
8383
&nbsp;&nbsp;&nbsp;**Dead Code** (dead-code):\
8484
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consideredNodes":5,"searchTimeMs":1,"processTimeMs":0}</code>\
8585
&nbsp;&nbsp;&nbsp;**Useless Loops** (useless-loop):\
86-
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"numOfUselessLoops":0,"searchTimeMs":0,"processTimeMs":1}</code>\
87-
_All queries together required ≈14 ms (1ms accuracy, total 24 ms)_
86+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"numOfUselessLoops":0,"searchTimeMs":0,"processTimeMs":0}</code>\
87+
_All queries together required ≈14 ms (1ms accuracy, total 26 ms)_
8888

8989
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
9090

91-
The analysis required _24.4 ms_ (including parsing and normalization and the query) within the generation environment.
91+
The analysis required _26.0 ms_ (including parsing and normalization and the query) within the generation environment.
9292

9393
In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR.
9494
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.
@@ -105,8 +105,8 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
105105
".meta": {
106106
"totalDeprecatedCalls": 0,
107107
"totalDeprecatedFunctionDefinitions": 0,
108-
"searchTimeMs": 2,
109-
"processTimeMs": 0
108+
"searchTimeMs": 1,
109+
"processTimeMs": 1
110110
}
111111
},
112112
"file-path-validity": {
@@ -128,7 +128,7 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
128128
"totalWritesBeforeAlways": 0,
129129
"totalValid": 0,
130130
"searchTimeMs": 4,
131-
"processTimeMs": 1
131+
"processTimeMs": 0
132132
}
133133
},
134134
"seeded-randomness": {
@@ -139,7 +139,7 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
139139
"callsWithAssignmentProducers": 0,
140140
"callsWithNonConstantProducers": 0,
141141
"searchTimeMs": 0,
142-
"processTimeMs": 1
142+
"processTimeMs": 0
143143
}
144144
},
145145
"absolute-file-paths": {
@@ -158,8 +158,8 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
158158
".meta": {
159159
"totalConsidered": 1,
160160
"totalUnknown": 0,
161-
"searchTimeMs": 1,
162-
"processTimeMs": 1
161+
"searchTimeMs": 2,
162+
"processTimeMs": 0
163163
}
164164
},
165165
"unused-definitions": {
@@ -176,7 +176,7 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
176176
"numMatches": 0,
177177
"numBreak": 0,
178178
"searchTimeMs": 0,
179-
"processTimeMs": 0
179+
"processTimeMs": 1
180180
}
181181
},
182182
"dataframe-access-validation": {
@@ -202,12 +202,12 @@ Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Inte
202202
".meta": {
203203
"numOfUselessLoops": 0,
204204
"searchTimeMs": 0,
205-
"processTimeMs": 1
205+
"processTimeMs": 0
206206
}
207207
}
208208
},
209209
".meta": {
210-
"timing": 14
210+
"timing": 13
211211
}
212212
},
213213
".meta": {
@@ -239,7 +239,7 @@ The following linting rules are available:
239239

240240

241241

242-
**[Absolute Paths](https://github.com/flowr-analysis/flowr/wiki/lint-absolute-file-paths):** Checks whether file paths are absolute. [see <a href="https://github.com/flowr-analysis/flowr/tree/main//src/linter/rules/absolute-path.ts#L115">src/linter/rules/absolute-path.ts</a>]\
242+
**[Absolute Paths](https://github.com/flowr-analysis/flowr/wiki/lint-absolute-file-paths):** Checks whether file paths are absolute. [see <a href="https://github.com/flowr-analysis/flowr/tree/main//src/linter/rules/absolute-path.ts#L116">src/linter/rules/absolute-path.ts</a>]\
243243
<span title="This rule is used to detect issues that do not directly affect the semantics of the code, but are still considered bad practice."><a href='#smell'>![smell](https://img.shields.io/badge/smell-yellow) </a></span> <span title="This rule may provide quickfixes to automatically fix the issues it detects."><a href='#quickfix'>![quickfix](https://img.shields.io/badge/quickfix-lightgray) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the portability of the code. For example, platform-specific code, or code that relies on specific R versions or packages."><a href='#robustness'>![robustness](https://img.shields.io/badge/robustness-teal) </a></span>
244244

245245
**[Dataframe Access Validation](https://github.com/flowr-analysis/flowr/wiki/lint-dataframe-access-validation):** Validates the existance of accessed columns and rows of dataframes. [see <a href="https://github.com/flowr-analysis/flowr/tree/main//src/linter/rules/dataframe-access-validation.ts#L59">src/linter/rules/dataframe-access-validation.ts</a>]\

wiki/lint-absolute-file-paths.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 10:38:07 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:33:31 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="absolute-file-paths">Absolute Paths&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect issues that do not directly affect the semantics of the code, but are still considered bad practice."><a href='#smell'>![smell](https://img.shields.io/badge/smell-yellow) </a></span> <span title="This rule may provide quickfixes to automatically fix the issues it detects."><a href='#quickfix'>![quickfix](https://img.shields.io/badge/quickfix-lightgray) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the portability of the code. For example, platform-specific code, or code that relies on specific R versions or packages."><a href='#robustness'>![robustness](https://img.shields.io/badge/robustness-teal) </a></span>
@@ -7,7 +7,7 @@ _This document was generated from '[src/documentation/print-linter-wiki.ts](http
77
This rule is a `best-effort` rule.
88

99
Checks whether file paths are absolute.\
10-
_This linting rule is implemented in <a href="https://github.com/flowr-analysis/flowr/tree/main//src/linter/rules/absolute-path.ts#L115">src/linter/rules/absolute-path.ts</a>._
10+
_This linting rule is implemented in <a href="https://github.com/flowr-analysis/flowr/tree/main//src/linter/rules/absolute-path.ts#L116">src/linter/rules/absolute-path.ts</a>._
1111

1212

1313
### Configuration

wiki/lint-dataframe-access-validation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 10:38:09 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:33:33 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="dataframe-access-validation">Dataframe Access Validation&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect bugs in the code. Everything that affects the semantics of the code, such as incorrect function calls, wrong arguments, etc. is to be considered a bug. Otherwise, it may be a smell or a style issue."><a href='#bug'>![bug](https://img.shields.io/badge/bug-red) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the (re-)usability of the code. For example, missing or incorrect error handling, or missing or incorrect user interface elements."><a href='#usability'>![usability](https://img.shields.io/badge/usability-teal) </a></span>
@@ -53,7 +53,7 @@ _All queries together required ≈3 ms (1ms accuracy, total 9 ms)_
5353

5454
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5555

56-
The analysis required _8.7 ms_ (including parsing and normalization and the query) within the generation environment.
56+
The analysis required _8.8 ms_ (including parsing and normalization and the query) within the generation environment.
5757

5858
In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR.
5959
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.

wiki/lint-dead-code.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 10:38:10 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:33:33 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="dead-code">Dead Code&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect issues that do not directly affect the semantics of the code, but are still considered bad practice."><a href='#smell'>![smell](https://img.shields.io/badge/smell-yellow) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the (re-)usability of the code. For example, missing or incorrect error handling, or missing or incorrect user interface elements."><a href='#usability'>![usability](https://img.shields.io/badge/usability-teal) </a></span>
@@ -46,11 +46,11 @@ Query: **linter** (1 ms)\
4646
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ certain:\
4747
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;╰ Code at 1.17\
4848
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;_Metadata_: <code>{"consideredNodes":7,"searchTimeMs":1,"processTimeMs":0}</code>\
49-
_All queries together required ≈1 ms (1ms accuracy, total 5 ms)_
49+
_All queries together required ≈1 ms (1ms accuracy, total 6 ms)_
5050

5151
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5252

53-
The analysis required _5.3 ms_ (including parsing and normalization and the query) within the generation environment.
53+
The analysis required _5.5 ms_ (including parsing and normalization and the query) within the generation environment.
5454

5555
In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR.
5656
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.

wiki/lint-deprecated-functions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 10:38:06 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
1+
_This document was generated from '[src/documentation/print-linter-wiki.ts](https://github.com/flowr-analysis/flowr/tree/main//src/documentation/print-linter-wiki.ts)' on 2025-08-20, 14:33:30 UTC presenting an overview of flowR's linter (v2.4.3, using R v4.5.0). Please do not edit this file/wiki page directly._
22
<h2 id="deprecated-functions">Deprecated Functions&emsp;<sup>[<a href="https://github.com/flowr-analysis/flowr/wiki/Linter">overview</a>]</sup></h2>
33

44
<span title="This rule is used to detect issues that do not directly affect the semantics of the code, but are still considered bad practice."><a href='#smell'>![smell](https://img.shields.io/badge/smell-yellow) </a></span> <span title="This signals the use of deprecated functions or features."><a href='#deprecated'>![deprecated](https://img.shields.io/badge/deprecated-teal) </a></span> <span title="This rule is used to detect issues that are related to the reproducibility of the code. For example, missing or incorrect random seeds, or missing data."><a href='#reproducibility'>![reproducibility](https://img.shields.io/badge/reproducibility-teal) </a></span> <span title="This rule is used to detect issues that are related to the (re-)usability of the code. For example, missing or incorrect error handling, or missing or incorrect user interface elements."><a href='#usability'>![usability](https://img.shields.io/badge/usability-teal) </a></span>
@@ -53,7 +53,7 @@ _All queries together required ≈0 ms (1ms accuracy, total 11 ms)_
5353

5454
<details> <summary style="color:gray">Show Detailed Results as Json</summary>
5555

56-
The analysis required _11.1 ms_ (including parsing and normalization and the query) within the generation environment.
56+
The analysis required _10.6 ms_ (including parsing and normalization and the query) within the generation environment.
5757

5858
In general, the JSON contains the Ids of the nodes in question as they are present in the normalized AST or the dataflow graph of flowR.
5959
Please consult the [Interface](https://github.com/flowr-analysis/flowr/wiki/Interface) wiki page for more information on how to get those.

0 commit comments

Comments
 (0)