Skip to content

Yamllint: update config to fix (ignore) warnings#280

Merged
jrfnl merged 2 commits into
mainfrom
feature/yamllint-fix-config
Jun 20, 2026
Merged

Yamllint: update config to fix (ignore) warnings#280
jrfnl merged 2 commits into
mainfrom
feature/yamllint-fix-config

Conversation

@jrfnl

@jrfnl jrfnl commented Mar 7, 2026

Copy link
Copy Markdown
Member

Proposed Changes

Yamllint 1.37.1 introduced a new check which check the number of spaces between the Yaml and trailing comments on the same line.

In their wisdom, they have elected to make the expected number of spaces default to 2, while we use 1 in practice.

This commit updates the configuration to check for 1 space instead of 2.

Ref:

Suggested changelog entry

N/A

Yamllint 1.37.1 introduced a new check which check the number of spaces between the Yaml and trailing comments on the same line.

In their wisdom, they have elected to make the expected number of spaces default to `2`, while we use `1` in practice.

This commit updates the configuration to check for 1 space instead of 2.

Ref:
* https://github.com/adrienverge/yamllint/blob/master/CHANGELOG.rst#1371-2025-05-04
* https://yamllint.readthedocs.io/en/stable/rules.html#module-yamllint.rules.comments
@jrfnl jrfnl added this to the 1.3.0 milestone Mar 7, 2026
@jrfnl jrfnl requested a review from Potherca March 7, 2026 05:04
@jrfnl

jrfnl commented May 6, 2026

Copy link
Copy Markdown
Member Author

Just in case anyone is wondering - the warnings I'm talking about can be seen here: https://github.com/PHPCSStandards/composer-installer/actions/runs/25436575221

@Potherca Potherca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I just encountered the wall of Yaml warnings. 😿

Merge at will.

@jrfnl jrfnl merged commit 5f97386 into main Jun 20, 2026
207 of 210 checks passed
@jrfnl jrfnl deleted the feature/yamllint-fix-config branch June 20, 2026 23:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants