Lint YAML especially .hlint.yaml.

[philderbeast]

The vscode editor showed problems with .hlint.yaml. I was able to reproduce these before fixing them by installing and configuring yamllint for which I added a GitHub action. In reviewing .hlint.yaml I saw that we should have been adding our errors before any ignores. Added a comment introducing why we have the "Use alternative" ignore. The ignore for "Too strict maybe" was repeated so I reduced this duplication collecting the within modules together. For YAML linting I'm ignoring most of .gitub/workflows/, doc and test folders.

I pulled the hlint action out of the unit-tests action and used haskell/actions/setup-hlint for the set up.

[mpilgrem]

Looking at the files that have changed, some of them seem to have changed largely because indentation has been added or increased. May I ask, what is the rationale for those changes?

[philderbeast]

what is the rationale for those changes?

Within vscode I used format document (is that by the YAML extension?). I also have the linter extension. This fixed the linting problems in files other than .hlint.yaml, see c65226b.

[philderbeast]

This is what I first saw in vscode (or something similar), problems with the HLint configuration:

[mpilgrem]

On the linting of YAML, as you can see, historically, the stylistic preference here has been what I think yamllint refers to as indentation: {spaces: 2, indent-sequences: false}.

[philderbeast]

I use package.dhall with the same hpack phraseology. With dhall I get a formatter included out of the box.

> dhall-hpack-cabal --force
generated plugins-for-blobs.cabal
> dhall format package.dhall

The option of formatting package.yaml is new to me. I would guess the historical stylistic preference is to not use an automatic formatter and go with whatever is easiest to type or, if you're like me, copy an existing package.yaml from another project before adding and removing items.

[mpilgrem]

Thanks! I've merged that, with a little tinkering. It seemed to me sensible to apply it to all of the YAML files in the respository. It also seemed to me sensible to combine all linting (yamllint, HLint) into a single 'linting' workflow. I did change the .yamllint.yaml to be tolerant of (in fact, require) an indentation style that followed what was already used in the repository. I dealt with the truthy problem by turning it off for the keys (it was only GitHub Actions' on: key that was tripping it).

[philderbeast]

I did change the .yamllint.yaml to be tolerant of (in fact, require) an indentation style that followed what was already used in the repository.

@mpilgrem the github workflow sample code uses indented arrays.