quarto-dev / quarto-dev/quarto
Improve R package workspace detection and/or warn users
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 645
- Forks
- 62
- Avg merge
- 17h 42m
- Merged PRs (30d)
- 13
Description
Quarto Preview behaviour is changed depending on the context.
For instance, when a DESCRIPTION file (with Package or Type fields) is found at the root of the workspace/project, --embed-resources is added to the command which lead to issues if not in the context of single file project (default type), such as website, books, etc.
Users should be informed when an R package workspace has been detected.
Alternatively, the logic could be extended to look for _quarto.yml as this file should not be there in an R package which would mean it's a Quarto project not an R package.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with apps/vscode/src/providers/preview/preview.ts around line 453 and preview-util.ts around lines 62-74. Trace how a DESCRIPTION file with Package or Type fields changes Quarto Preview behavior and how _quarto.yml is considered. Done means R package workspace detection is handled appropriately and users are informed when that context is detected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100