hlint-test: Run hlint in test suite

[ bsd3, library, program, test ] [ Propose Tags ]

Allows you to write small hlint test runner; so you will not forget to run hlint before pushing to master.


[Skip to Readme]
Versions 0.1.0.0
Change log CHANGES.md
Dependencies base (>=4.7 && <5), hlint (>=2.0), hlint-test [details]
License BSD-3-Clause
Copyright 2017 Tomáš Janoušek, Jan Šipr
Author Tomáš Janoušek <tomi@nomi.cz>, Jan Šipr <sipr.jan@gmail.com>
Maintainer Jan Šipr <sipr.jan@gmail.com>
Category test
Home page https://github.com/Siprj/hlint-test#readme
Bug tracker https://github.com/Siprj/hlint-test/issues
Source repo head: git clone https://github.com/Siprj/hlint-test
Uploaded by yrid at Fri Dec 29 13:16:59 UTC 2017
Distributions NixOS:0.1.0.0
Executables hlint-test
Downloads 195 total (10 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-12-29 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
pedantic

Pass additional warning flags and -Werror to GHC.

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for hlint-test-0.1.0.0

[back to package description]

hlint-test

Build Status Hackage Hackage Dependencies Stackage LTS Stackage Nightly BSD3 License

This package aims to make easy to automatically run hlint as part of unit tests. That means hlint will be run when you execute cabal test or stack test.

How to make it work

Hlint-test package contains GHC preprocessor which will generate the code containing hlint runner. To invoke the preprocessor, create new test and put following line into it:

{-# OPTIONS_GHC -F -pgmF hlint-test #-}

Don't forget to add the test into cabal file (or package.yaml respectively) as separated test runner ;).

Now you can run the test simply by stack test or cabal test.

Hlint options

If you need to you can use the preprocessor macro to pass some additional arguments to the hlint. As it's shown on following line:

{-# OPTIONS_GHC -F -pgmF hlint-test -optF src -optF -r #-}

This will tell hlint to look for source codes only in src directory and to generate html report if some suggestions are found.

Also you can use hlint configuration file too ;).

Example

Simple example of the use can be seen in this package.