Hackage :: [Package]

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]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.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-06-30T10:08:07Z
Distributions
Executables krank
Downloads 1238 total (22 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2020-06-30 [all 1 reports]

Readme for krank-0.2.2

[back to package description]

Krank

Hackage CircleCI

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 comments themselves.

Usage

Just launch the krank command with a list of files as arguments. It works on any kind of source code file and prints a report 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

krank will fail (i.e. non-zero exit code) in case of any error.

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, such as configuring your API token for external services, such as github and gitlab.

Available checkers

  • IssueTracker is listing Github and Gitlab 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.

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