Hackage :: [Package]

snipcheck: Markdown tester

[ development, library, mit ] [ Propose Tags ] [ Report a vulnerability ]

Markdown snippet runner and checker

[Skip to Readme]

Modules

[Index]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3
Dependencies base (>=4.7 && <5), containers (>=0.5.7.1 && <0.6), pandoc (>=1.19.2.1 && <1.20), process (>=1.4.3.0 && <1.5) [details]
License MIT
Copyright 2017 Nicolas Mattia
Author Nicolas Mattia
Maintainer nicolas@nmattia.com
Uploaded by nmattia at 2017-06-04T09:06:33Z
Category Development
Home page https://github.com/nmattia/snipcheck#readme
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 2888 total (11 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-06-04 [all 1 reports]

Readme for snipcheck-0.1.0.2

[back to package description]

Snipcheck

https://travis-ci.org/nmattia/snipcheck.svg?branch=master

Snipcheck makes sure that the code snippets in markdown files are up-to-date.

This is very much a work in progress. The only function currently available is

checkMarkdownFile :: FilePath -> IO ()

that will run shell snippets and errored out if the output doesn't match the snippet. You can skip some of the output with ....

Example:

# Some title

some markdown content

``` shell
$ echo foo; echo bar; echo baz; echo qux
foo
...
qux
```

some more content

Release check-list

  1. Make sure you're on master

  2. Bump the version in snipcheck.cabal:

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible API changes, MINOR version when you add functionality in a backwards-compatible manner, and PATCH version when you make backwards-compatible bug fixes.

  1. Run stack update --pvp-bounds both . to upload snipcheck to hackage
  2. Commit the updated snipcheck.cabal file.