lambdaisland / lambdaisland/kaocha-doctest

Run other doctest formats if dependencies are present

Open
#2 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Clojure
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

There are several formats for doctests:

  • "=>" followed by a form with the results on the next line (what testdoc calls "REPL style" )
  • A form followed by a "=>" with results ("Code-first style")
  • A comment form with "=>" with results (I guess we could call this rich comments style)

If we don't want to extend the parser to accept all these different types, we could look for libraries that provide them on the classpath and use those libraries to collect those tests. If these already support clojure.test, I think it would be quite easy.

I'm a little concerned this could lead to confusion, but projects generally shouldn't have multiple doctest formats or libraries present (and if they do, they're already in a confusing situation), unless they're migrating.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing doctest parser and how Kaocha-doctest discovers tests on the classpath. Investigate libraries supporting REPL-style, code-first, or rich-comments doctests and whether they integrate with clojure.test. Done means agreeing on supported formats or libraries and defining tests for the selected behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.