seancorfield.readme

Liking cljdoc? Tell your friends :D

Clojure only.

-main
defreadme
readme->test

Turn a README file into a test namespace.

Turn a README file into a test namespace.

raw docstring

-main^clj

(-main & [readme readme-test])

A useful default test behavior that can be invoked from the command line via -m seancorfield.readme

This turns README.md (if it exists) into src/readme.clj, then requires it and runs its tests, and finally deletes src/readme.clj.

Optional arguments for the readme file and the generated test can override the defaults.

A useful default test behavior that can be invoked from the command
line via `-m seancorfield.readme`

This turns `README.md` (if it exists) into `src/readme.clj`, then
requires it and runs its tests, and finally deletes `src/readme.clj`.

Optional arguments for the readme file and the generated test can override
the defaults.

source raw docstring

defreadme^cljmacro

(defreadme name & body)

Wrapper for deftest that understands readme examples.

Wrapper for deftest that understands readme examples.

source raw docstring

readme->test^clj

(readme->test readme readme-test)

Given the path to a README, generate a plain old clojure.test file at the specified path. If the test path exists, it will be overwritten.

Given the path to a README, generate a plain old `clojure.test` file
at the specified path. If the test path exists, it will be overwritten.

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close