mdast/lib/cli/file-pipeline/parse.js

Markdown processor powered by plugins

/**
 * @author Titus Wormer
 * @copyright 2015 Titus Wormer
 * @license MIT
 * @module mdast:cli:file-pipeline:parse
 * @version 2.2.2
 * @fileoverview Parse a file into an AST.
 */

'use strict';

/* eslint-env node */

/*
 * Dependencies.
 */

var debug = require('debug')('mdast:cli:file-pipeline:parse');

/**
 * Fill a file with an ast.
 *
 * @example
 *   var file = new File({
 *     'contents': '# Hello'
 *   });
 *
 *   vat settings = {'position': false};
 *
 *   parse({'file': file, 'settings': settings});
 *
 *   file.namespace('mdast').tree.type; // 'root'
 *
 * @param {Object} context
 */
function parse(context) {
    var file = context.file;

    if (file.hasFailed()) {
        return;
    }

    debug('Parsing document');

    context.processor.parse(file, context.settings);

    debug('Parsed document');
}

/*
 * Expose.
 */

module.exports = parse;