# yaml-front-matter

> yaml front matter for JS. Parse yaml or JSON from the beginning of files.

Latest version **4.1.1** (published 2020-12-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install yaml-front-matter
pnpm add yaml-front-matter
yarn add yaml-front-matter
bun add yaml-front-matter
```

Provides the command `yaml-front-matter`.

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2020-12-13 |
| First published | 2012-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/yaml-front-matter) |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 208.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 194 |
| Author | Derek Worthen |
| Maintainers | dworthen |
| Keywords | yaml, front matter, json |

## Links

- npm: https://www.npmjs.com/package/yaml-front-matter
- Repository: https://github.com/dworthen/js-yaml-front-matter
- Homepage: https://github.com/dworthen/js-yaml-front-matter#readme
- Issues: https://github.com/dworthen/js-yaml-front-matter/issues
- npm.io page: https://npm.io/package/yaml-front-matter

## Dependencies (2)

- [js-yaml](https://npm.io/package/js-yaml.md) ^3.14.1
- [commander](https://npm.io/package/commander.md) ^6.2.0

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 4.1.1 (latest) — 2020-12-13
- 4.0.0-4 (next) — 2018-02-28
- 4.1.0 — 2019-12-24
- 4.0.0 — 2018-03-09
- 4.0.0-3 — 2018-02-27
- 3.4.1 — 2018-02-27
- 4.0.0-2 — 2018-02-27
- 4.0.0-1 — 2018-02-27
- 4.0.0-0 — 2018-02-27
- 3.4.0 — 2016-02-17
- 3.3.0 — 2016-01-30
- 3.2.3 — 2014-12-14
- 3.0.1 — 2014-02-28
- 2.2.0 — 2014-02-17
- 2.1.11 — 2013-10-26
- … 5 more at https://npm.io/package/yaml-front-matter/versions

## README

# Yaml Front Matter

Parses yaml or json at the front of a string. Places the parsed content, plus the rest of the string content, into an object literal.

[Online Demo](https://dworthen.github.io/js-yaml-front-matter/).

#### Breaking Changes

This readme is for the 4.x release, which introduces breaking changes. View the [changelog](CHANGELOG.md) for more information.

[3.x readme](https://github.com/dworthen/js-yaml-front-matter/tree/v3.4.0)

## Example

This

```yaml
---
name: Derek Worthen
age: 127
contact:
  email: email@domain.com
  address: some location
pets:
  - cat
  - dog
  - bat
match: !!js/regexp /pattern/gim
run: !!js/function function() { }
---
Some Other content
```

```js
var fs = require('fs');
var yamlFront = require('yaml-front-matter');

fs.readFile('./some/file.txt', 'utf8', function(fileContents) {
    console.log(yamlFront.loadFront(fileContents));
});

```

outputs

```js
{ 
    name: 'Derek Worthen',
    age: 127,
    contact: { email: 'email@domain.com', address: 'some location' },
    pets: [ 'cat', 'dog', 'bat' ],
    match: /pattern/gim,
    run: [Function],
    __content: '\nSome Other Content' 
}
```

May also use JSON

```json
---
{
    "name": "Derek Worthen",
    "age": "young",
    "anArray": ["one","two"],
    "subObj":{"field1": "one"}
}
---
Some content
```

> __NOTE:__ The `---` are required to denote the start and end of front matter. There must be a newline after the opening `---` and a newline preceding the closing `---`.

## Install

### npm

```shell
$ npm install yaml-front-matter
```

Use the `-g` flag if you plan on using the command line tool.

```shell
$ npm install yaml-front-matter -g
```

### Node or client with module bundler (webpack or browsify)

```js
var yamlFront = require('yaml-front-matter');
```
    
### Browser Bundle

The [dist/yamlFront.js](dist/yamlFront.js) client script will expose the yaml-front-matter library as a global, `yamlFront`. The client script for [js-yaml](https://github.com/nodeca/js-yaml) is also required. May need to load espirma for some use cases. See [js-yaml](https://github.com/nodeca/js-yaml) for more information.

```html
<script src="https://unpkg.com/js-yaml@3.10.0/dist/js-yaml.js"></script>
<script src="yamlFront.js"></script>
<script>
  // parse front matter with yamlFront.loadFront(String);
</script>
```

> **Note**: yaml-front-matter is delivered as a umd package so it should work within commonjs, amd and browser (as a global) environments.

## Running Browser Example

```shell
$ npm install --dev && npm start
```

Then visit `localhost:8080`.

## Building from source

Outputs build files to `dist/`.

```shell
$ npm install --dev && npm run build
```

## Running Tests

```shell
npm install --dev && npm test
```

## Command Line

```shell
Usage: yaml-front-matter [options] <yaml-front-matter content>

Options:

-h, --help            output usage information
-v, --version         output the version number
-c, --content [name]  set the property name for the files contents [__content]
--pretty              formats json output with spaces. 
```

> **Note** The cli uses `safeLoadFront` and therefore will not parse yaml containing regexps, functions or undefined values.

### Example

```shell
# Piping content from one file, through yaml parser and into another file
cat ./some/file.txt | yaml-front-matter > output.txt
```

## JS-YAML

Yaml front matter wraps [js-yaml](https://github.com/nodeca/js-yaml) to support parsing yaml front-matter.

## API

### loadFront(string, [options])

```js
var input = [
        '---\npost: title one\n',
        'anArray:\n - one\n - two\n',
        'subObject:\n prop1: cool\n prop2: two',
        '\nreg: !!js/regexp /pattern/gim',
        '\nfun: !!js/function function() {  }\n---\n',
        'content\nmore'
    ].join('');

var results = yamlFront.loadFront(input);
console.log(results);
```

outputs

```shell
{ post: 'title one',
  anArray: [ 'one', 'two' ],
  subObject: { obj1: 'cool', obj2: 'two' },
  reg: /pattern/gim,
  fun: [Function],
  __content: '\ncontent\nmore' }
```

Front-matter is optional.

```js
yamlFront.loadFront('Hello World');
// => { __content: "Hello World!" }
```

Content is optional

```js
yamlFront.loadFront('');
// => { __content: '' }
```

### safeLoadFront(string, [options])

Same api as loadFront except it does not support regexps, functions or undefined. See [js-yaml](https://github.com/nodeca/js-yaml) for more information.

### Options

The options object supports the same options available to [js-yaml](https://github.com/nodeca/js-yaml) and adds support for an additional key.

- `options.contentKeyName`: Specify the object key where to store content not parsed by yaml-front-matter. defaults to `__content`.

```js
yamlFront.loadFront('Hello World', {
    contentKeyName: 'fileContents' 
});
// => { fileContents: "Hello World" }
```

---
_Source: https://npm.io/package/yaml-front-matter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._