YAML Linter for ROS

[emersonknapp]

There isn't a good YAML linter for ROS, but there is a whole lot of of yaml.

I'm using a YAML linter but it doesn't autoformat, which makes it pretty high friction. Others have inflexible options around array. I wish I still had my survey notes of the YAML formatters/linters I tried but which didn't quite fit the need.

maybe an ament_yamllint, with available precommit hook, Python main, CMake function.

Top of mind feature is just to enforce a common spacing/indentation requirement.

[frozenreboot]

Hi @emersonknapp,

I also felt the need for this. I have actually already submitted a PR implementing a YAML linter: #567 (feat: Add 'ament_yamllint' package for YAML style validation).

The main feature integrates yamllint, and the custom configuration is applied as follows (referencing the yamllint docs):

extends: default

rules:
  document-start: disable
  indentation:
    indent-sequences: consistent
  line-length: disable
  new-lines: disable

Since this PR is a modernized revival of the original proposal (#351), I kept the rule configurations identical to the original PR.

If you have any better ideas or suggestions for refining these options to better fit the ROS 2 ecosystem, I would really appreciate your input!

P.S. Current PR is experiencing some Windows build failures in CI. I am currently working on a fix for this (I think it is related to line endings/CRLF).