https://github.com/boxed/midje-readme

A Leiningen plugin to pull tests from your README.md into midje.
https://github.com/boxed/midje-readme

Last synced: 2 months ago
JSON representation

A Leiningen plugin to pull tests from your README.md into midje.

• Host: GitHub
• URL: https://github.com/boxed/midje-readme
• Owner: boxed
• License: epl-1.0
• Created: 2014-07-22T14:35:35.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-26T03:07:13.000Z (about 9 years ago)
• Last Synced: 2024-10-10T17:32:49.739Z (3 months ago)
• Language: Clojure
• Size: 20.5 KB
• Stars: 10
• Watchers: 6
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# midje-readme

A Leiningen plugin to pull tests from your README.md into midje automatically. This will make it easy to make sure your readme doesn't contain any errors.

## Latest version

[![Clojars Project](http://clojars.org/midje-readme/latest-version.svg)](http://clojars.org/midje-readme)

## Usage

Put `[midje-readme "1.0.8"]` into the `:plugins` vector of your project.clj.

By default midje-readme will put

`

(:require [your-project-namespace :refer :all])

`

into the test file, attempting to guess at the namespace to use according the "lein new" default.

You can override this by putting

`

:midje-readme {:require "[your-project.something-else :refer [whatever]]"}

`

into your project.clj.

When you run a leiningen command the plugin will create a file "test/readme.clj" that contains the code in your readme. Line numbers will be the same as in your readme so debugging should be pretty easy.

You might want to add test/readme.clj to your .gitignore too.

You can show that your README is tested with this badge: [![Examples tested with midje-readme](http://img.shields.io/badge/readme-tested-brightgreen.svg)](https://github.com/boxed/midje-readme) Copy paste the markdown syntax below:

    [![Examples tested with midje-readme](http://img.shields.io/badge/readme-tested-brightgreen.svg)](https://github.com/boxed/midje-readme)