Hackage :: [Package]

krank: Krank checks your code source comments for important markers

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

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]

Properties

Versions 0.1.0, 0.2.0, 0.2.0, 0.2.1, 0.2.2, 0.2.3, 0.3.0
Change log CHANGELOG.md
Dependencies aeson (>=1.4.4), base (>=4.9 && <=5.0), bytestring, containers, http-client (>=0.6), http-types (>=0.12), krank, lifted-async, mtl, optparse-applicative (>=0.14), pcre-heavy, pretty-terminal, PyF (>=0.8.1.0), req (>=2.1.0), safe-exceptions, text (>=1.2.3), unordered-containers (>=0.2.10) [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 2020-04-19T14:46:57Z

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Readme for krank-0.2.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)

default.nix:20:20: info:
  still Open: https://github.com/NixOS/nix/issues/2733

foo.hs:67:11: error:
  now Closed: https://github.com/bazelbuild/bazel/issues/6313

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

Red herring

If you want to ignore all krank checkers on a given line of code, add krank:ignore-line on this same line. Krank will then skip this line and not report anything on it

Misc