egoist / front-matter

An ultra simple and light-weight library for extracting front-matter.

@egoist/front-matter

Why another front-matter library?

This library is only 200 bytes 🤯 It's ultra light-weight because it doesn't really parse the front-matter, you can choose your language of choice to parse it instead, e.g. Yaml or Toml or even simply JSON.parse.

Install

yarn add @egoist/front-matter

Usage

const frontMatter = require('@egoist/front-matter')

const { head, body } = frontMatter(`
---
title: Hell World
---

Hi there?
`)

assert(head === 'title: Hello World')
assert(body === '\nHi there?')

Parse head with js-yaml:

const yaml = require('js-yaml')
const frontMatter = require('@egoist/front-matter')

const { head, body } = frontMatter(str)
const parsedHead = yaml.safeLoad(head)

API

frontMatter(str, delimiter = '---')

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Author

@egoist/front-matter © egoist, Released under the MIT License.
Authored and maintained by egoist with help from contributors (list).

github.com/egoist · GitHub @egoist · Twitter @_egoistlily

front-matter's Issues

Regex Fail on String with Carriage Return

My markdown file that retrieved from fetch function always returned a newline with some "\r" symbol (carriage return). Example output:

---\r\norder: 4\r\n---\r\n\r\n#Heading 1\r\nLorem Ipsum

So the regex from this line won't work:

front-matter/src/index.js

Line 8 in 28433d2

const RE = new RegExp(`^${delimiter}\\n+([\\s\\S]+)\\n+${delimiter}(?:\\n([\\s\\S]*))?$`)

This is my code and my workaround to solve this:

const frontMatter = require('@egoist/front-matter')

const res = await window.fetch 'doc.md'
const str = res.text
const  { head, body } = frontMatter(str.replace(/\r?/g, '')) // Remove \r symbol

return { head: head, body: body }

End head on first closing

Hi, currently this lib parses the head until the last '---' (delimiter). But it should use the first close tag (send delimiter) to end the head.

Example markdown file:

---
title: "An example title"
---

Some content here

---

This is the end

What happens is that is parses only "This is the end" as body and everything above as head. But this isn't correct.