redhat-developer / redhat-developer/yaml-language-server

Some instructions for running a formatter

Open
#700 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

formatter
Dominant language
TypeScript
Stars
1.5k
Forks
352
Avg merge
2d 7h
Merged PRs (30d)
11

Description

Summary

I'm not sure exactly how to setup prettier to execute formatting on a yml file. I don't understand how prettier and the lsp config for formatting relate to each other. Could you add some instructions to the README about how this should be done please?

Relevant information

Using nvim native lsp

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 with the README and the issue's references to Prettier, YAML files, and native Neovim LSP formatting. Document how Prettier and the LSP formatting configuration relate, including the setup needed to format YAML; the README should let users configure and run formatting without further clarification.

Written by the indexing model from the issue text.

Assessment

Tech stack
neovim
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.