validate-noddity-post

Assert that a Noddity post file can be parsed by the butler, and rendered by Ractive.

Usage no npm install needed!

<script type="module">
  import validateNoddityPost from 'https://cdn.skypack.dev/validate-noddity-post';
</script>

README

Validate noddity posts so that you can be guaranteed that their metadata is valid/parseable, and the contents can be rendered by the templating engine.

API

Greenkeeper badge

const Validator = require('validate-noddity-post')
const validate = Validator({
    butler,
    linkifier,
    data
})

require returns a constructor function:

constructor({ butler, linkifier, data, [template] })

The constructor function returns a validator function:

validator function(post)

Returns a promise that resolves with an object. If there is anything wrong with the post it will have an error property.

If the promise is rejected, then something is wrong with the universe, which is a distinct possibility when you're interacting with physical disks and internets and whatnot.

Example

validate('my-newest-post.md').then(({ error }) => {
    if (error) {
        console.log('your post sucks!', error)
    }
})

License

WTFPL