| CARVIEW |
krank: Krank checks issue tracker link status in your source code
Krank checks issue tracker link status in your source code. When you implement a workaround because of an upstream issue, you often put a link in comment in your code. Krank will tell you when the issue associated with your workaround is closed, meaning that you may get ride of your workaround.
[Skip to Readme]
Modules
[Index] [Quick Jump]
Downloads
- krank-0.3.1.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
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, 0.3.1 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=2), base (>=4.9 && <=4.23.0.0), bytestring, containers, http-client (>=0.6), http-types (>=0.12), krank, lifted-async, mtl, optparse-applicative (>=0.14), pcre-heavy, pretty-terminal, process, 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 |
| Uploaded | by guibou at 2025-12-07T12:30:33Z |
| Category | quality |
| Home page | https://github.com/guibou/krank |
| Bug tracker | https://github.com/guibou/krank/issues |
| Distributions | |
| Executables | krank |
| Downloads | 1514 total (16 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating |
|
| Status | Docs available [build log] Last success reported on 2025-12-07 [all 1 reports] |
Readme for krank-0.3.1
[back to package description]Krank
Krank checks your code source comments for link to issue trackers, such as gitlab or github.
Krank will then outputs a report of the status of theses issues, if they are closed or still open.
Why
You are blocked on upstream ticket, there you write a nice comment in your code such as:
# blocked on upstream ticket https//github.com/Foo/Bar/issues/1234
# This workaround should be removed once the upstream ticket is closed
if workaround:
pass
And, this stays in your codebase for the next ten years, even if the upstream issue is closed.
Now you can run krank on your codebase, and it will tells you that issue
#1234 in project Foo/Bar has been closed. Time to remove your workaround.
Usage
Just launch the krank command, optionally 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
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.
Specific documentation
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
- Krank is available on Hackage, but you can also build it manually.
- If you want to contribute or add a new checker, you can read the Contributions guidelines or open an issue.