yaml-fm

About | Installation | API | Usage | License

About

yaml-fm is a Node.js module that converts a String with YAML frontmatter to an Object. It uses currying to be .map() friendly and converts non-YAML content to a trimmed Buffer. Use it to build your own personal static-site generator!

Turn this:

1---
2title: Hello world
3slug: post/hello_world/index.html
4tags:
5  - excellent
6  - adventure
7---
8
9Hello world!

Into this:

1{
2  title: 'Hello world',
3  slug: 'post/hello_world/index.html',
4  tags: ['excellent', 'adventure'],
5  content: <Buffer 48 65 6c 6c 6f 20 77 6f 72 6c 64 21>
6}

Installation

Install

$ npm install --save yaml-fm

Require

1var fm = require('yaml-fm')

API

yaml-fm(delim)

delim: string: required delimiter before and after YAML frontmatter

Returns an anonymous function.

fn(string)

string: string: string to parse containing YAML frontmatter

Returns a flat JS object. Non-frontmatter is trimmed, converted to a Buffer, and included in Object.content.

Usage

Without .map()

1// require module
2var fm = require('yaml-fm')
3
4// delimiter for YAML
5var delim = '---'
6
7// string containing YAML frontmatter
8var stringWithFm = `
9---
10title: Hello world
11slug: post/hello_world/index.html
12tags:
13  - excellent
14  - adventure
15---
16
17Hello world!
18`
19
20// parse string
21// NOTE: because fm is curried, it must be called twice
22var fmObj = fm(delim)(stringWithFm)
23
24/**
25 fmObj:
26  {
27    title: 'Hello world',
28    slug: 'post/hello_world/index.html',
29    tags: ['excellent', 'adventure'],
30    content: <Buffer 48 65 6c 6c 6f 20 77 6f 72 6c 64 21>
31  }
32 */
33

With .map()

See example.

1// modules
2var fm = require('../')
3var fs = require('fs')
4var globby = require('globby')
5var bb = require('bluebird')
6
7// promisify fs.readFile
8var read = path => bb.promisify(fs.readFile)(path, 'utf8')
9
10// glob -> paths -> strings -> objects
11globby('content/*.md')
12  .then(paths => bb.all(paths.map(read)))
13  .then(strs => strs.map(fm('---')))
14  .then(console.log)
15  .catch(console.log)
16
17/**
18  NOTE:
19  The fm transform could also look like this:
20
21  .then(strs => strs.map(str => fm('---')(str)))
22
23  Because yaml-fm uses currying, we can shorten that to the code seen above:
24
25  .then(strs => strs.map(fm('---')))
26 */

License

MIT