quarto-dev / quarto-dev/quarto-cli

YAML error messages in the presence of parse errors are poor

Open
#385 0 comments 0 reactions 1 assignee View on GitHub

@cscheid is already working on this.

Since Mar 5, 2022.

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

Description

Consider this:

---
name:"mello"
title: "hello"
---

The YAML parsing fails, and hence we can't give the error message we would if instead we had

---
name:"mello"
---

I'm not sure how to fix this in general outside of writing a better YAML parser, and I really don't want to do that. We have a linting pass, and we could search for colons that don't have a space after them. But that might yield false positives, which are similarly annoying

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.