krank: Krank checks your code source comments for important markers

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

Comments are part of our code and are not usually tested correctly. Hence their content can become incoherent or obsolete. Krank tries to avoid that by running checkers on the comment themselves.


[Skip to Readme]
Versions [faq] 0.1.0
Change log CHANGELOG.md
Dependencies aeson (>=1.4.4 && <1.5), base (==4.12.*), krank, megaparsec, mtl, optparse-applicative (==0.14.*), PyF (>=0.8.1.0 && <0.9), replace-megaparsec, req (>=2.1.0 && <2.2), safe-exceptions, text (>=1.2.3 && <1.3), unordered-containers (==0.2.10.*), utf8-string (>=1.0.1.1 && <1.1) [details]
License BSD-3-Clause
Author Guillaume Bouchard
Maintainer guillaum.bouchard@gmail.com
Category quality
Home page https://github.com/guibou/krank
Bug tracker https://github.com/guibou/krank/issues
Uploaded by guibou at Wed Oct 23 15:00:37 UTC 2019
Distributions NixOS:0.1.0
Executables krank
Downloads 93 total (36 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-10-23 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for krank-0.1.0

[back to package description]

Krank

Krank checks your code source comments for important markers.

Comments are part of our code and are not usually tested correctly. Hence their content can become incoherent or obsolete. Krank tries to avoid that by running checkers on the comment themselves.

Usage

Just launch the krank command with a list of files as arguments. It works on any kind of source code file and print a reports of informations found in the comments:

$ krank $(git ls-files)

[Info] issue #2733 still Open
    in: NixOS/nix
    file: default.nix:20:20

[Error] issue #6313 is now Closed
    in: bazelbuild/bazel
    file: default.nix:67:11

[Error] issue #22 is now Closed
    in: guibou/PyF
    file: src/Foo.hs:100:4

Here krank is telling us that our source code links to github issues which are now closed. Time to remove some workarounds now that upstream issues are fixed!

You can check krank --help for a list of options.

Available checkers

  • IssueTracker is listing Github issue linked in comment. Issues which are still Open will be listed as info and Closed issues are listed as error. Convenient to know when to remove workarounds.

Misc