redhat-developer / redhat-developer/vscode-yaml

Format with document start `---` and document end `...`.

Open
#322 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
829
Forks
260
Avg merge
5h 43m
Merged PRs (30d)
1

Description

A YAML document begins with --- and ends with .... Both are optional, though a ... can only be followed by directives or ---.

Currently, only document start --- is automatically applied, but not document end .... It might be cumbersome for some people, but useful for some folks. Options to enable and disable document start and document end might be helpful.

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 locating the YAML formatting entry point and reviewing how document-start markers are currently inserted. Define the behavior for optional document-start and document-end markers, including the stated restriction on what may follow .... Done means formatting supports the requested marker choices without producing invalid YAML.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.