quarto-dev / quarto-dev/quarto-cli

quarto emits ANSI cursor-control sequences when stderr is not a terminal

Open Beginner friendly
#14,419 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

When quarto's stderr is piped, redirected to a file, or consumed by an editor build tool (e.g. Emacs M-x compile, VS Code tasks), progress and spinner helpers still emit ANSI cursor-control sequences. These appear as raw escape bytes in the output buffer:

^[[0G^[[2K^[[J^[[0G^[[2K^[[J^[[0G

Reported in https://github.com/orgs/quarto-dev/discussions/14403

Root cause

src/core/console.ts emits cursor-control bytes without checking whether the output stream is a terminal. Specifically, clearLine() calls ansi.eraseLine.cursorLeft() unconditionally, and spinner() and progressBar() gate their output on runningInCI() but not on whether stderr is actually a TTY. withSpinner()'s cancel path always calls clearLine(), regardless of where output goes.

https://github.com/quarto-dev/quarto-cli/blob/d5c1f1d51a9628b065da0c1a9f45009bcc8fd00e/src/core/console.ts#L180-L182

https://github.com/quarto-dev/quarto-cli/blob/d5c1f1d51a9628b065da0c1a9f45009bcc8fd00e/src/core/console.ts#L110-L124

NO_COLOR does not cover this — it governs colors only. --log-format plain governs the log file format, not console output.

The codebase already has the right helper: isInteractiveTerminal() in src/core/platform.ts, which returns Deno.stderr.isTerminal(). It is already used in command/create/cmd.ts and command/publish/cmd.ts to gate interactive prompts, but not in src/core/console.ts.

https://github.com/quarto-dev/quarto-cli/blob/d5c1f1d51a9628b065da0c1a9f45009bcc8fd00e/src/core/platform.ts#L97-L99

src/core/log.ts's LogFileHandler.format() already handles this for file output — messages starting with \r are dropped because they are progress lines. The same "progress is terminal-only" notion is not applied to the stderr console handler or to clearLine().

https://github.com/quarto-dev/quarto-cli/blob/d5c1f1d51a9628b065da0c1a9f45009bcc8fd00e/src/core/log.ts#L232-L237

Reproduction

Any quarto command that uses withSpinner or progressBar shows this when stderr is piped. The cleanest CLI-only form:

quarto check versions 2>&1 | cat -v
quarto install tinytex 2>&1 | cat -v

leading to something like

$ quarto check versions 2>&1 | cat -v
Quarto 1.10.3
^M[>] Checking versions of quarto binary dependencies...
      Pandoc version 3.8.3: OK
      Dart Sass version 1.87.0: OK
      Deno version 2.4.5: OK
      Typst version 0.14.2: OK
^M[>] Checking versions of quarto dependencies......OK

Or via Emacs M-x compile running quarto render example.qmd --to html, where the compilation buffer is not a TTY.

Suggested direction

Gate clearLine(), spinner(), and progressBar() on isInteractiveTerminal() (extending the !runningInCI() check that is already there to also require a TTY). This matches the idiom already used for interactive prompts in create/publish, and aligns console behavior with the file-handler behavior in log.ts.

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 in src/core/console.ts, then read isInteractiveTerminal() in src/core/platform.ts and the related handling in src/core/log.ts. Reproduce the issue with quarto check versions 2>&1 | cat -v, then gate cursor-control and progress output on an interactive stderr terminal. Done means redirected or piped output contains no raw ANSI cursor-control sequences while terminal behavior remains interactive.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.