vfile-frontmatter

Extract a front matter from a VFile and assign parsed data to its data property

1const vfileGlob = require('vfile-frontmatter');
2
3vfileGlob('index.*').subscribe({
4  start() {
5    console.log('Glob started.');
6  },
7  next(file) {
8    file;
9    /*=> VFile {
10      data: {},
11      messages: [],
12      history: ['index.js'],
13      cwd: '/Users/shinnn/github/vfile-frontmatter',
14      contents: <Buffer ... >
15    } */
16  },
17  complete() {
18    console.log('Glob completed.');
19  }
20});

Installation

Use npm.

npm install vfile-frontmatter

API

1const vfileGlob = require('vfile-frontmatter');

vfileGlob(pattern [, options])

pattern: string (glob pattern)
options: Object (read-glob options) or string (encoding)
Return: Observable (zenparsing's implementation)

When the Observable is subscribed, it starts searching files matching the given glob pattern, create VFiles from matched files and successively sends them to its Observer.

1vfileGlob('hi.txt').subscribe(file => {
2  file.cwd; //=> '/Users/example'
3  file.path; //=> 'hi.txt',
4  file.contents; //=> <Buffer 48 69>
5});
6
7vfileGlob('exmaple/hi.txt', {
8  cwd: '..',
9  encoding: 'utf8'
10}).subscribe(file => {
11  file.cwd; //=> '/Users'
12  file.path; //=> 'example/hi.txt'
13  file.contents; //=> 'Hi'
14});

License

ISC License © 2018 Shinnosuke Watanabe