Add hlint configuration?

[philderbeast]

Linting was clean with #51 but now there are warnings:

# Warnings currently triggered by your code
- ignore: {name: "Empty single-line comment"} # 49 hints
- ignore: {name: "Redundant bracket"} # 4 hints
- ignore: {name: "Use intercalate"} # 10 hints
- ignore: {name: "Use map once"} # 4 hints
- ignore: {name: "Use zipWith"} # 1 hint

How about adding configuration (and a gh-action?) to help maintain this project in a lint-clean state?

I've seen the no-pull request note. If you want to pick up the configuration, I've done it over on typechecker@b42073e. The command for creating a default configuration is:

hlint --default -j . > .hlint.yaml

[ivanperez-keera]

Thanks for this. Sorry that it took so long to act on it.

ogma-cli does have an .hlint.yaml file. hlint produces a lot of suggestions, some of which are valid concerns that should be fixed. I'll open separate tickets to address or silence the suggestions that hlint gives for each individual package.

[philderbeast]

If you're accepting pull requests now. I'd be happy to help.

I see .hlint.yaml files associated with most but not all packages. I would find a single project-wide .hlint.yaml in the root easier to manage.

$ git rev-parse HEAD
1b4bfd100d3914317c8691855b647cb10558c050

$ tree -a -P '.hlint.yaml|*.cabal' --prune
.
├── ogma-cli
│   ├── .hlint.yaml
│   └── ogma-cli.cabal
├── ogma-core
│   ├── .hlint.yaml
│   └── ogma-core.cabal
├── ogma-extra
│   └── ogma-extra.cabal
├── ogma-language-c
│   ├── .hlint.yaml
│   └── ogma-language-c.cabal
├── ogma-language-copilot
│   └── ogma-language-copilot.cabal
├── ogma-language-csv
│   └── ogma-language-csv.cabal
├── ogma-language-jsonspec
│   └── ogma-language-jsonspec.cabal
├── ogma-language-lustre
│   ├── .hlint.yaml
│   └── ogma-language-lustre.cabal
├── ogma-language-smv
│   ├── .hlint.yaml
│   └── ogma-language-smv.cabal
├── ogma-language-xlsx
│   └── ogma-language-xlsx.cabal
├── ogma-language-xmlspec
│   └── ogma-language-xmlspec.cabal
└── ogma-spec
    └── ogma-spec.cabal

13 directories, 17 files

An unintrusive approach I like is to silence (ignore) all triggered HLint suggestions and then deal with each in turn. This is the approach we're using with Cabal that works well with the simple GitHub HLint workflow:

$ git remote -v
...
upstream	git@github.com:haskell/cabal.git (fetch)
upstream	git@github.com:haskell/cabal.git (push)

$ tree -a -P ".hlint.yaml|lint.yml" --prune
.
├── .github
│   └── workflows
│       └── lint.yml
└── .hlint.yaml

3 directories, 2 files

A benefit of the simple workflow is that it gives the same result as running hlint -j . from the project root. This is not the case currently with the ogma project:

$ hlint -j .
...
ogma-language-lustre/src/Language/Lustre/ErrM.hs:20:1-42: Warning: Use fewer imports
Found:
  import Control.Monad ( MonadPlus(..) )
  import Control.Monad ( MonadFail(..) )
  
Perhaps:
  import Control.Monad ( MonadPlus(..), MonadFail(..) )
...
5 errors
57 hints

$ hlint -j ogma-language-lustre
ogma-language-lustre/src/Language/Lustre/ErrM.hs:20:1-42: Warning: Use fewer imports
Found:
  import Control.Monad ( MonadPlus(..) )
  import Control.Monad ( MonadFail(..) )
  
Perhaps:
  import Control.Monad ( MonadPlus(..), MonadFail(..) )

1 hint

$ cd ogma-language-lustre

$ hlint -j .
No hints

[philderbeast]

I find HLint configuration easier to manage if it is all within a root .hlint.yaml file. Per-module ignores can be handled centrally too, with something like;

- ignore: {name: "Functor law", within: [Test.Laws]}

haskell/cabal/.hlint.yaml

I see Ogma has some configuration in its *.hs modules.

$ grep --ignore-case "{-.*HLINT" **/*.hs
ogma-cli/src/CLI/CommandTop.hs:{-# ANN command "HLint: ignore Functor law" #-}
ogma-cli/src/CLI/Result.hs:{- HLINT ignore "Use exitSuccess" -}
ogma-core/src/Command/CFSApp.hs:{- HLINT ignore "Functor law" -}
ogma-core/src/Command/FPrimeApp.hs:{- HLINT ignore "Functor law" -}
ogma-core/src/Command/ROSApp.hs:{- HLINT ignore "Functor law" -}