Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Configure cli file hyperlinks for R package dev tasks (#5850)
Addresses #5409 *Needed to wait for r-lib/cli#744, which is now merged* `@:r-pkg-development` ### QA Notes Pre-requisite: You need to install a very recent version of the cli package. At the time I write this, this means a dev version of cli, although I think we'll get a release out fairly soon. In the meantime, a good way to install is: ```r pak::pak("r-lib/cli") ``` Make sure the cli version is >= 3.6.3.9002: ``` r packageVersion("cli") #> [1] '3.6.3.9002' ``` There won't be any obvious error in the presence of an older cli version, but the new functionality just won't activate. Then you need to run tests on a package with one or more failing tests, in order to be able to click on the filepath when test failure is reported. This should take you directly to the relevant test location. I have made a toy package that could be obtained via [`usethis::create_from_github("jennybc/clilinks")`](https://github.com/jennybc/clilinks). It has a couple of snapshot tests that will always fail 😄 because they attempt to snapshot a random number. But really any package with a failing test will do. * Install dev cli: `pak::pak("r-lib/cli")` * Identify a package with a failing test and open it in Positron, perhaps via: `usethis::create_from_github("jennybc/clilinks")` * Use our gesture for running package tests: Ctrl/Cmd + Shift + T or select *R: Test R Package* from the command palette. * Click on a file hyperlink for a failing test: - Note this requires Ctrl/Cmd click! This is a VS Code convention, not specific to us. - Note that you might have to click twice. This is a bug (or 2 bugs?) for which fixes are making their way through the system (microsoft/vscode#230010). Again, not us. - You might need to grant permission to open the file hyperlink. I think I have long since checked some box always permitting this for local files. This is a VS Code feature. <img width="652" alt="file-hyperlink" src="https://github.com/user-attachments/assets/3c1c7a11-e545-4ae8-8891-991d3e22c032" /> --- Note that this PR removes the feature flag introduced in #5231, since now all hyperlinks work (if the cli version is recent enough). If you configured `positron://settings/positron.r.taskHyperlinks` in the interim, that setting can be removed and, indeed, no longer exists.
- Loading branch information