Improve error message when using orderly interactively.

[plietar]

It is quite easy and common for users to open up a file in RStudio and start running commands from it interactively, using Ctrl-Enter, without setting their working directory to match that file. When that happens, orderly would throw an unhelpful error, saying only Failed to detect orderly path: /path/to/workspace without any mention of working directories, or that the path should be a report directory (as opposed to eg. the top-level orderly workspace).

The error message is changed to look along the lines of:

! Working directory /path/to/workspace is not a valid orderly report.

This should be more helpful, by making it clear what is incorrect (the working directory), and what was expected (an orderly report).

Additionally, if running in RStudio and the current active editor is a file in what looks like an orderly report, it will augment the error message with a suggestion of what setwd command to run:

! Working directory /path/to/workspace is not a valid orderly report.
ℹ Use `setwd("/path/to/workspace/src/my-report")` to set the working directory
  to the report currently open in RStudio.

Finally, even if the working directory is a valid report, but it does not match the directory of the currently active editor (eg. the user has switched from one report to another), orderly commands will succeed as before, but will show a warning to the user:

Working directory /path/to/workspace/src/my-report does not match the report
currently open in RStudio.
ℹ Use `setwd("/path/to/workspace/src/other-report")` to switch working
  directories.

Frustratingly, while RStudio supports "click-to-run" snippets of code in its output, it restricts the syntax of these and in particular does not allow methods from the base package, such as setwd. Instead the user has to copy-paste the suggestion into the command prompt themselves. See rstudio/rstudio#11273 and rstudio/rstudio#11434. The restriction is pretty arbitrary and we could easily workaround it by re-exporting the setwd function in the orderly2 package if we really wanted to.

[plietar]

There’s a CI failure that looks unrelated, caused I think by a new version of the cli package that changed the output slightly:
r-lib/cli#569

Will look at fixing that

[richfitz]

Thanks, this is working well for me.

I don't mind if you fix that cli issue here or in another (or I can do it)

[richfitz]

You'll need to use paste() to fix lint about the line length.

We've not been consistent elsewhere about {.code ...} etc and usually just single quote:

"Use 'setwd("{suggested_wd}")' to set the working directory to the report currently open in RStudio."

I was thinking at some point we'd go through the whole lot. I'm not convinced that showing backticks to the user might not be confusing but at the same time I don't feel strongly.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d70a1dc) 100.00% compared to head (b6080ef) 100.00%.
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #120   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           40        40           
  Lines         3564      3589   +25     
=========================================
+ Hits          3564      3589   +25     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.