YAML formatting not compliant with yamllint "spaces before comments" requirement

Describe the bug

yamllint, a linter used by many projects and companies, has a different requirement on the number of spaces before comments than what the YAML formatter in this plugin provides:

What yamllint requires is two spaces before the comment #:

    timeout: 1800  # value in seconds ~ 30m

Formatting of this plugin results in a single space:

    timeout: 1800 # value in seconds ~ 30m

Thus, YAML files saved (with Format on Save activated) with VS Code and this plugin enabled results in YAML files that are rejected by systems using yamllint to check for compliance (e.g. CI systems).

Expected Behavior

Files are formatted according to the yamllint requirements, e.g. double space before comments.

OR

Option to specify formatting requirements is given.

Current Behavior

Files are not formatted according to yamllint requirements, e.g. single space before comments.

Steps to Reproduce

• Create file test.yaml with contents:

- job:
    name: some-job
    timeout: 1800  # value in seconds ~ 30m

• Run yamllint test.yaml --> pass
• Apply formatting in VS Code which will reduce double-space to single-space
• Run yamllint test.yaml --> fail

Environment

• Windows
• Mac
• Linux
• other (please specify)

[linceaerian]

Hello, not a definitive solution but a workaround to use “prettier” format with https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.comments

• Create a .yamllint
• Add a custom rule:

 comments:
    min-spaces-from-content: 1

It will do the job of “not breaking the yamlint” but will still use a spacing of 1.

[ssbarnea]

@MarkusTeufelberger you forgot that prettier is not a linter, it is just a formatter. If you do not like its behavior I would invite you to raise a bug with it.

Based on popularity of prettier (42k stars) versus yamllint (1.9k) and the fact that this project has zero python code in it, I would say that what yamllint does by default, does not matter so much.

On the other hand we do have an example where yamllint (sole) maintainer refused to use indented sequences in its default settings, even if they are more popular around. So you do already have to change yamllint config if you want to also use it.

Keep in mind that this extension has nothing to do with Ansible or Python. Shortly if you don’t like its formatting, disable it. I doubt we see a change in this area on the foreseeable future, especially as I am aware of far more pressing bugs that need to be addressed.