Popularity
2.6
Declining
Activity
0.0
Declining
1
2
1

Monthly Downloads: 17
Programming language: Haskell
License: MIT License
Tags: Development    

snipcheck alternatives and similar packages

Based on the "Development" category.
Alternatively, view snipcheck alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of snipcheck or a related project?

Add another 'Development' Package

README

Snipcheck

Build Status

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 cabal sdist and cabal upload --publish ./dist/snipcheck-... to upload snipcheck to hackage
  2. Commit the updated snipcheck.cabal file.