feat(lint): add pre-commit linting setup

[rriski]

Best reviewed commit by commit.

• run linting with pre-commit
• add markdownlint check
• add codespell check
• add yamllint check
• add yamlfix check
• add hadolint check

Most of the diff is autofixed.

[Serpentiel]

can we please have markdownlint added to the CI pipeline?

[Serpentiel]

also, please rename it to docs(readme): run markdownlint or something like that

[Serpentiel]

WDYT about reusing our existing linting solutions, such as this one, which is then used like that?

[Serpentiel]

this isn't how YAML should start

[rriski]

In fact it is, see section 2.2 of the YAML specification: https://yaml.org/spec/1.2.2/

[Serpentiel]

It's only mandatory to have them if you use directives in the YAML document. Directives are optional for usage, please see section 3.2.3.4 of the YAML specification. Please see examples in section 6.8.1 to have a better understanding.

[rriski]

Indeed its not mandatory and we can choose to leave it out. But stating "this isn't how YAML should start" isn't constructive.

[Serpentiel]

we can choose to leave it out

If we choose not to, then we also need to add directives. I think leaving it out is the best option, WDYT?

[rriski]

WDYT about reusing our existing linting solutions, such as this one, which is then used like that?

I don't mink trunk vs pre-commit. It looks like trunk doesn't support autofixable yaml linter which might be annoying. Trunk i a for-profit company whereas pre-commit is more open. It also looks like trunk is missing some of the nice trailing whitespace, end-of-file, and shebang checks that come with pre-commit, didn't find any reference to something like that in their docs.Pre-commit also seems to be more widely used within Aiven.

I can create an alternate version of this PR that utilizes trunk.

[Serpentiel]

looks like trunk doesn't support autofixable yaml linter which might be annoying

there's a YAML linter and it's autofixable, you can see it in the example that I linked to you, it's called yamllint (https://github.com/trunk-io/plugins/tree/main/linters/yamllint)

Trunk i a for-profit company

it's free for Open Source usage :)

trailing whitespace, end-of-file, and shebang checks

trailing whitespace checks are included in golangci-lint; end-of-file and shebang checks aren't needed—it's very hard to justify need of an empty file, because those aren't generally needed/used, and bash files aren't used either because they're not cross-platform, while Go is

Pre-commit also seems to be more widely used within Aiven.

in our Go projects it's not really used, and the only such solution that we ever used is Trunk

I can create an alternate version of this PR that utilizes trunk.

sounds good; you can as well adjust this PR if you feel like it

[rriski]

looks like trunk doesn't support autofixable yaml linter which might be annoying

there's a YAML linter and it's autofixable, you can see it in the example that I linked to you, it's called yamllint (https://github.com/trunk-io/plugins/tree/main/linters/yamllint)

Trunk i a for-profit company

it's free for Open Source usage :)

trailing whitespace, end-of-file, and shebang checks

trailing whitespace checks are included in golangci-lint; end-of-file and shebang checks aren't needed—it's very hard to justify need of an empty file, because those aren't generally needed/used, and bash files aren't used either because they're not cross-platform, while Go is

Pre-commit also seems to be more widely used within Aiven.

in our Go projects it's not really used, and the only such solution that we ever used is Trunk

I can create an alternate version of this PR that utilizes trunk.

sounds good; you can as well adjust this PR if you feel like it

Yep, makes sense. Alternate Trunk based approach can be found here: #578.

[rriski]

Closed in favor of #578