hexo/lib/util/yfm.js

A fast, simple & powerful blog framework, powered by Node.js.

/**
* See {% crosslink util.yfm/parse %}.
*
* @method yfm
* @param {String} source
* @return {Object}
* @for util
* @static
*/

/**
* YAML front-matter parser.
*
* @class yfm
* @namespace util
* @module hexo
* @static
*/

var _ = require('lodash'),
  yaml = require('yamljs'),
  escape = require('./escape').yaml;

var yfm = module.exports = function(source){
  var content = source.replace(/^-{3}/, '').split('---'),
    result = {};

  if (content.length === 1){
    result = {_content: content[0]};
  } else {
    result = yaml.parse(escape(content.shift()));
    result._content = content.join('---').replace(/^\n*/, '');
  }

  return result;
};

/**
* Parses YAML front-matter.
*
* @method parse
* @param {String} source
* @return {Object}
* @static
*/

yfm.parse = function(source){
  return yfm(source);
};

/**
* Converts the object to YAML front-matter string.
*
* @method stringify
* @param {Object} data
* @return {String}
* @static
*/

yfm.stringify = function(obj){
  return yaml.stringify(_.omit(obj, '_content')) + '\n---\n' + obj._content;
};