You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+16-2Lines changed: 16 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,6 +58,8 @@ With this extension, you gain access to the following features (as the extension
58
58
59
59
</details>
60
60
61
+
7. 📦 [**Package Information**](#package-information): Hover over a call to see which package it comes from and its version from flowR's bundled [package database](#package-database), and get a [Project](#project-view) overview of your declared libraries.
62
+
61
63
If you notice anything that could be improved, have a feature request, or notice a bug, please [open an issue](#issues-and-feature-requests)!
62
64
63
65
<details><summary>Reporting an Issue</summary>
@@ -113,7 +115,7 @@ Additionally, we recommend using the [R extension](https://marketplace.visualstu
113
115
114
116
### Linting
115
117
116
-
By default, the extension ships with all linting rules that are available in *flowR*, extensive information about which can be found on the [wiki page](https://github.com/flowr-analysis/flowr/wiki/Linter). Some linters additionally ship with code actions in the form of quick fixes which, once invoked, automatically edit or remove the relevant code snippet.
118
+
By default, the extension enables all linting rules available in *flowR* except `naming-convention` and `roxygen-arguments`; extensive information about the rules can be found on the [wiki page](https://github.com/flowr-analysis/flowr/wiki/Linter). The package-structure rules `software-has-license` and `software-has-tests` are only applied when the file is part of an R package (i.e. a `DESCRIPTION` file is present up the directory tree), so they do not add noise to standalone scripts. You can adjust the enabled rules under `vscode-flowr.linter.enabledRules`. Some linters additionally ship with code actions in the form of quick fixes which, once invoked, automatically edit or remove the relevant code snippet.
117
119
118
120
To manually invoke the linter, you can use the "Code Quality Analysis (Linter)" command. Additionally, you can modify under what conditions the linter automatically refreshes its results in the extension's settings.
119
121
@@ -158,7 +160,19 @@ To clear the slice highlighting, use the "Clear Current Slice Presentation" comm
158
160
159
161

160
162
161
-
Using the extension, the sidebar should contain a flowR icon which holds more information on the current file, listing the libraries loaded, the files read and written, and the sourced scripts. If you expand the respective sections, clicking on the found entries should open them in the editor. The context menu (available with a right click) allows you to [slice](#slicing) for the selected entry.
163
+
Using the extension, the sidebar should contain a flowR icon whose **Overview** view holds more information on the current file, listing the libraries loaded, the files read and written, and the sourced scripts. If you expand the respective sections, clicking on the found entries should open them in the editor. The context menu (available with a right click) allows you to [slice](#slicing) for the selected entry.
164
+
165
+
### Package Information
166
+
167
+
Hovering over a call in an R file tells you which package it stems from — for example, hovering over `map` after `library(purrr)` shows *`map` is provided by the `purrr` package*, together with the version recorded in flowR's [package database](#package-database) and a link to the package's CRAN page. Hovering over the package name inside `library(pkg)`/`require(pkg)` shows that package's database version and CRAN link. For locally defined functions and variables, <kbd>Ctrl</kbd>/<kbd>Cmd</kbd>+click (Go to Definition) jumps to their definition.
168
+
169
+
### Project View
170
+
171
+
When the open workspace contains an R project manifest — a `renv.lock`, a `DESCRIPTION`, or an `rv.lock`/`rproject.toml` — a **Project** tab appears in the flowR sidebar. It lists the libraries each manifest declares and, for every one, whether flowR's [package database](#package-database) knows it: matched (with the database version), a base package bundled with R, unmatched, or unavailable. The tab is hidden when no manifest is detected.
172
+
173
+
### Package Database
174
+
175
+
flowR resolves the exports, definitions and versions of external packages from a precomputed *package database* that ships with the extension, so package attribution works out of the box without a local R installation. It powers the [package information](#package-information) hovers, the [project view](#project-view) matching, and dependency resolution. The active database (scope and date) is shown when hovering the flowR status-bar item and in the REPL banner. You can toggle it or point at a custom database under the `vscode-flowr.config.solver.pkgdb.*` settings.
0 commit comments