quarto-dev / quarto-dev/quarto-cli

Confusing error with quarto render when swapping input and args

Open
#2,146 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

Bug description

The following mistake was entirely my fault but I found the behavior slightly unexpected compared to standard command line interfaces and the error message made it difficult to immediately identify what the issue was. Running the following render command produces the below error.

$ quarto render --to html unvotes.ipynb
ERROR: The specified directory ('.') is not a Quarto project

I'm fine with the ordering of input vs args but it seems like swapping the order is an easy mistake to make and more helpful error message would be appreciated (e.g. invalid file path, --to does not exist, or something similar).

Checklist
  • Please include a minimal, fully reproducible example in a single .qmd file? Please provide the whole file rather than the snippet you believe is causing the issue.
  • Please format your issue so it is easier for us to read the bug report.
  • Please document the RStudio IDE version you're running (if applicable), by providing the value displayed in the "About RStudio" main menu dialog?
  • Please document the operating system you're running. If on Linux, please provide the specific distribution.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the quarto render --to html unvotes.ipynb command and inspect the quarto render CLI argument handling. The issue is addressed when this swapped-order mistake produces a clear diagnostic identifying the invalid input or argument instead of reporting that . is not a Quarto project.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.