lambdaisland / lambdaisland/kaocha
List available reporters and validate selected reporters
Nobody has claimed this yet.
- Dominant language
- Clojure
- Stars
- 860
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Description
I couldn't find list of built-in reporters in the documentation and had to look at the source code. Reporter option docs should list the built-in reporters, and even better would be to provide --list-reporters option so the choices can be listed from CLI.
Also, some kind of validation for :reporters would be useful. E.g. kaocha.report.progress/progress seems to work mostly, but doesn't print failures. The correct value is kaocha.report.progress/report. (Or just ensure there aren't public vars that might be accidentally used in report namespaces).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the reporter option documentation and the reporter namespaces, including the progress reporter values mentioned in the issue. Done means the built-in reporters are documented, the CLI can list available reporters, and invalid or unintended reporter values are rejected or clearly handled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- clojure
- Domain
- cli, documentation, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100