automatic format

[Huarong]

Hope this tool can format the code automatic, just like yapf -i for Python.

[adrienverge]

No sorry, it doesn't. yamllint is only a linter: it reports potential problems but doesn't fix them (mainly because there could be ambiguities in fixing).

[adius]

This would be really great. If the warning is that there is a trailing newline missing, it would be really easy to fix ;-)

[adius]

Tools like ESlint also only provide auto fixing for a subset or rules...

[zanona]

yamlint --fix would indeed be great. Not all errors would have support for fixing, just as eslint but at least a few of them like, adding --- on beginning of files, etc.

[jayvdb]

Building a new auto-fixing tool around yamllint would be a good approach for anyone wanting this.

e.g. autoflake wraps pyflakes, and autopep8 wraps pycodestyle.

Where the linter doesnt expose enough information to aide fixing, that is a valid problem with the linter.

[jayvdb]

It is probably worthwhile adding a note to the readme that reformatting is out of scope.

Maybe include some recommendations on existing Python yaml reformatters , and non-Python ones (jq?), which support the yamllint default style.

The jq wrappers for python are probably the best options IMO , but yq has a problem with indentation kislyuk/yq#52 .

At https://stackoverflow.com/questions/30642317/how-to-automatically-re-indent-a-yaml-file , @ruamel recommends his ruamel.yaml.cmd which utilises his now well recognised ruamel.yaml library - but then I run into https://bitbucket.org/ruamel/yaml.cmd/issues/4/stack-trace-when-using-save-patch-linked

https://github.com/dbohdan/remarshal is popular, and could be used to convert yaml2toml , and then toml2yaml , however note indentation is an issue there too remarshal-project/remarshal#13 .

And another issue mmlb/yamlfmt#10

Hmm..

[jayvdb]

https://github.com/mk-fg/pretty-yaml works for several files I've tried, and has very basic cli, but it does discard comments.

$ python -m pyaml /path/to/some/file.yaml

[jayvdb]

@ruamel fixed and released a new version of https://pypi.org/project/ruamel.yaml.cmd/ , and I've packaged it for openSUSE https://build.opensuse.org/project/show/home:jayvdb:ruamel

It prefers single quotes over double quotes, and likes \ line continuations within quoted strings, but it does do indents nicely.

[dudicoco]

I've been breaking my head over finding a formatter that would provide more or less the same features as yamllint via cli or via VSS, i've already tried all of the suggestions mentioned here.

Can someone suggest a tool that would provide formatting similar to the following rules in yamllint:

rules:
  colons: enable
  empty-lines:
    max: 1
  empty-values: enable
  hyphens: enable
  indentation:
    spaces: 2
    indent-sequences: false
  key-duplicates: enable
  new-line-at-end-of-file: enable
  new-lines:
    type: unix
  trailing-spaces: enable

Thanks!

[yvele]

No sorry, it doesn't. yamllint is only a linter: it reports potential problems but doesn't fix them (mainly because there could be ambiguities in fixing).

@adrienverge can the issue be reconsidered? Most of linters supports auto fixing today, for example:

• ESLint: https://eslint.org/docs/user-guide/command-line-interface#fixing-problems
• stylelint: https://stylelint.io/user-guide/usage/options#fix

Not to mention prettier and go fmt that are more code formatters.

I don't want to find an alternative to yamllint, because I find it awesome.. but the lack of autofixing feature will make us find another tool or fork.. I'm using yamllint at an enterprise scale and it's very painful to ask developers manually fixing problems that can "easily" be automated 😓

yamlint --fix would indeed be great. Not all errors would have support for fixing, just as eslint

@adrienverge if you main concern is "mainly because there could be ambiguities in fixing" we can do like ESLint and styleling and ONLY fix errors that are fixable without ambiguities 🤷

This should be more than enough

[adrienverge]

Hey @yvele,

I agree such a feature would be great. It could be in a separated command like yamlfix.

Would you want to implement and maintain this?

Here are the 4 main issues I see:

1. The fix feature would apply unquestionably for some rules (ones about whitespaces).
   But as you point out, for other rules there would be ambiguity. Still, users will want us to fix them anyway (with they would reasonably be right).
2. There would also be inter-rules ambiguities. For example, a badly-indented key-value pair would be reindented to the next level, while the user wanted it at the previous (parent) level.
3. Fixing code while respecting rules options (like ignore-shebangs, indent-sequences: consistent, etc.) is a real challenge.
4. Based on my experience, creating + maintaining such a tool would be much more work than for yamllint itself.
   Moreover, if there's a bug in yamllint, it's OK. But if there's a bug in a tool that modifies users files, you have to be extra careful and reactive to fix bugs, because you could be blamed for ruining users work.

[dudicoco]

My solution was to use yamllint as a pre-commit hook along with the yamlfmt hook: https://github.com/jumanjihouse/pre-commit-hook-yamlfmt

[solarmosaic-kflorence]

Just FYI https://github.com/lyz-code/yamlfix

[tamere-allo-peter]

FYI another fixer with a different approach : https://github.com/opt-nc/yamlfixer

[paul-civitas]

Not every rule can be fixed, but some can be trivially fixed without ambiguities for example trailing-spaces

[oussjarrousse]

Why not combine efforts with one of the yamlfix projects to provide both checking and fixing functionality?

[RukshanJS]

Just FYI https://github.com/lyz-code/yamlfix

Tested, works perfectly. Thanks a bunch!

[socherbyc]

Man, this yamlfix broke many of my yaml files. For example, it changes

  example: 'foo #bar'

to

  example: 'foo # bar'

I just can't use it :/

[andrewimeson]

@socherbyc - wrong repo, old closed issue. This is yamllint, not yamlfix.