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 ...
.
# Some title
some markdown content
``` shell
$ echo foo; echo bar; echo baz; echo qux
foo
...
qux
```
some more content
Make sure you're on master
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.
cabal sdist
and cabal upload --publish ./dist/snipcheck-...
tosnipcheck
to hackage
snipcheck.cabal
file.