doctest-extract: Alternative doctest implementation that extracts comments to modules

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]

doctest-extract lets you write test examples and QuickCheck properties in Haddock comments and extracts them to test modules. It means that the user sees your tests in the documentation and knows that the examples and properties are machine-tested, or at least, she can run the tests herself.

I found the barrier to write tests much lower when I do not need to write new test modules but just add some lines to the Haddock comments. I do not need to think of test names or filling test data structures. The test identifier is the module name and the line number and if a test fails I can easily jump to the failing code.

Differences to the original GHCi-based implementation of doctest:

Pros:

Cons:

Properties

Versions 0.1, 0.1, 0.1.0.1, 0.1.1, 0.1.1.1, 0.1.2
Change log None available
Dependencies base (>=4.5 && <5), doctest-lib (>=0.0 && <0.2), non-empty (>=0.3.3 && <0.4), optparse-applicative (>=0.11 && <0.17), pathtype (>=0.8 && <0.9), semigroups (>=0.18.5 && <0.20), transformers (>=0.5.6 && <0.6), utility-ht (>=0.0.16 && <0.1) [details]
License BSD-3-Clause
Author Henning Thielemann <haskell@henning-thielemann.de>
Maintainer Henning Thielemann <haskell@henning-thielemann.de>
Category Testing
Home page https://hub.darcs.net/thielema/doctest-extract/
Source repo this: darcs get https://hub.darcs.net/thielema/doctest-extract/ --tag 0.1
head: darcs get https://hub.darcs.net/thielema/doctest-extract/
Uploaded by HenningThielemann at 2021-03-14T20:47:06Z

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees