Seeking pre-commit assistance

[braydonk]

I don't use pre-commit and have no desire to. No ill will to people who use it or the creator(s), it's just not for me. However, due to high demand a few years ago, I added support for running yamlfmt as a pre-commit hook (see #58).

All the way back then, I wrote the hook the best I could based on my limited understanding of the tool. But all this time, it worked in a totally unintended way. I attempted to fix it in v0.18.0 based on #267, but it was ended up broken thanks to my lack of knowledge (I would have caught it by testing, that was laziness on my part so I apologize to anyone who was broken by it).

In the (as of writing) upcoming v0.18.1, I'm making a final fix to how the hook works in #277. This should finally match the experience I'd intended for the hook all this time.

I am looking for people who are interested in maintaining specifically the pre-commit portion of this project. It takes quite a bit of mental energy for me to answer issues and requests related to pre-commit, and they are always subpar because I don't actually know much of anything about the nuances of the tool and how people use it. Users are destined to get subpar answers from me. If you are a pre-commit user with an interest in this tool, please reach out on this discussion and we can talk about establishing some kind of relationship for how to handle issues like this in the future to hopefully avoid breakages like v0.18.0.

[jorgepiloto]

Hi @braydonk!

I just discovered this amazing tool and I'm willing to help maintaining the pre-commit hook for it.

[braydonk]

Hi @jorgepiloto, nice to meet you. I will send you an email to the one listed in your website's contact page. Thanks!

[bonastreyair]

Hi @braydonk!

With v0.18.1 I am experiencing a breaking change (that you have documented): in local everything passes OK but when running it during the CI it detects undesired .cache/pre-commit files... failing the pre-commit run... this did not happen in v0.18.0 nor in previous versions...

It feels weird I do need to exclude now the folder .cache/pre-commit, when in local it works well...

yamlfmt..................................................................Failed
- hook id: yamlfmt
- exit code: 1
encountered the following formatting errors:
.cache/pre-commit/repouphkttvj/integrationtest/command/testdata/strip_directives/before/a.yaml: yaml: found unexpected non-alphabetical character
.cache/pre-commit/repolrxcjzju/test/markdownlint-cli2-yaml-example/.markdownlint-cli2.yaml: yaml: line 18: found unknown escape character
.cache/pre-commit/repoixl0ep8k/integrationtest/command/testdata/strip_directives/before/a.yaml: yaml: found unexpected non-alphabetical character
.cache/pre-commit/repouphkttvj/integrationtest/command/testdata/strip_directives/after/a.yaml: yaml: found unexpected non-alphabetical character
.cache/pre-commit/repolrxcjzju/test/markdownlint-yaml-mismatch/.markdownlint.yaml: yaml: line 2: did not find expected ',' or '}'
.cache/pre-commit/repolrxcjzju/test/markdownlint-cli2-yaml-mismatch/.markdownlint-cli2.yaml: yaml: line 1: did not find expected ',' or '}'
.cache/pre-commit/repoixl0ep8k/integrationtest/command/testdata/strip_directives/after/a.yaml: yaml: found unexpected non-alphabetical character

I wonder why this gets fixed only when setting:

entry: yamlfmt

but it fails with

entry: yamlfmt .

[braydonk]

I don't have a good answer for this. Forcing everyone to exclude this cache directory feels bad. I'm about this close to just reverting everything I've done and returning to the old experience because if never fucking ends with this tool.

To unblock for now, if you do provide a config file you can use exclude to exclude the .cache directory, or if not do it via the entry yamlfmt -exclude .cache.