@marp-team/marpit/lib/markdown/directives/parse.js

The skinny framework for creating slide deck from Markdown

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;

var _markdownItFrontMatter = _interopRequireDefault(require("markdown-it-front-matter"));

var _yaml = _interopRequireDefault(require("./yaml"));

var _directives = require("./directives");

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; var ownKeys = Object.keys(source); if (typeof Object.getOwnPropertySymbols === 'function') { ownKeys = ownKeys.concat(Object.getOwnPropertySymbols(source).filter(function (sym) { return Object.getOwnPropertyDescriptor(source, sym).enumerable; })); } ownKeys.forEach(function (key) { _defineProperty(target, key, source[key]); }); } return target; }

function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }

/**
 * Parse Marpit directives and store result to the slide token meta.
 *
 * Marpit comment plugin ans slide plugin requires already loaded to
 * markdown-it instance.
 *
 * @alias module:markdown/directives/parse
 * @param {MarkdownIt} md markdown-it instance.
 * @param {Marpit} marpit Marpit instance.
 * @param {Object} [opts]
 * @param {boolean} [opts.frontMatter=true] Switch feature to support YAML
 *     front-matter. If true, you can use Jekyll style directive setting to the
 *     first page.
 * @param {boolean} [opts.looseYAML=false] Allow loose YAML for directives.
 */
function parse(md, marpit, opts = {}) {
  // Front-matter support
  const frontMatter = opts.frontMatter === undefined ? true : !!opts.frontMatter;
  let frontMatterObject = {};

  if (frontMatter) {
    md.core.ruler.before('block', 'marpit_directives_front_matter', state => {
      frontMatterObject = {};
      if (!state.inlineMode) marpit.lastGlobalDirectives = {};
    });
    md.use(_markdownItFrontMatter.default, fm => {
      frontMatterObject.text = fm;
      const parsed = (0, _yaml.default)(fm, !!opts.looseYAML);
      if (parsed !== false) frontMatterObject.yaml = parsed;
    });
  }

  const isComment = token => token.type === 'marpit_comment' && token.meta.marpitParsedDirectives;

  const markAsParsed = token => {
    token.meta = token.meta || {};
    token.meta.marpitCommentParsed = 'directive';
  }; // Parse global directives


  md.core.ruler.after('inline', 'marpit_directives_global_parse', state => {
    if (state.inlineMode) return;
    let globalDirectives = {};

    const applyDirectives = obj => {
      let recognized = false;

      for (const key of Object.keys(obj)) {
        const globalKey = key.startsWith('$') ? key.slice(1) : key;

        if (_directives.globals[globalKey]) {
          recognized = true;
          globalDirectives = _objectSpread({}, globalDirectives, _directives.globals[globalKey](obj[key], marpit));
        }
      }

      return recognized;
    };

    if (frontMatterObject.yaml) applyDirectives(frontMatterObject.yaml);

    for (const token of state.tokens) {
      if (isComment(token) && applyDirectives(token.meta.marpitParsedDirectives)) {
        markAsParsed(token);
      } else if (token.type === 'inline') {
        for (const t of token.children) {
          if (isComment(t) && applyDirectives(t.meta.marpitParsedDirectives)) markAsParsed(t);
        }
      }
    }

    marpit.lastGlobalDirectives = _objectSpread({}, globalDirectives);
  }); // Parse local directives and apply meta to slide

  md.core.ruler.after('marpit_slide', 'marpit_directives_parse', state => {
    if (state.inlineMode) return;
    const slides = [];
    const cursor = {
      slide: undefined,
      local: {},
      spot: {}
    };

    const applyDirectives = obj => {
      let recognized = false;

      for (const key of Object.keys(obj)) {
        if (_directives.locals[key]) {
          recognized = true;
          cursor.local = _objectSpread({}, cursor.local, _directives.locals[key](obj[key], marpit));
        } // Spot directives
        // (Apply local directive to only current slide by prefix "_")


        if (key.startsWith('_')) {
          const spotKey = key.slice(1);

          if (_directives.locals[spotKey]) {
            recognized = true;
            cursor.spot = _objectSpread({}, cursor.spot, _directives.locals[spotKey](obj[key], marpit));
          }
        }
      }

      return recognized;
    };

    if (frontMatterObject.yaml) applyDirectives(frontMatterObject.yaml);

    for (const token of state.tokens) {
      if (token.meta && token.meta.marpitSlideElement === 1) {
        // Initialize Marpit directives meta
        token.meta.marpitDirectives = {};
        slides.push(token);
        cursor.slide = token;
      } else if (token.meta && token.meta.marpitSlideElement === -1) {
        // Assign local and spot directives to meta
        cursor.slide.meta.marpitDirectives = _objectSpread({}, cursor.slide.meta.marpitDirectives, cursor.local, cursor.spot);
        cursor.spot = {};
      } else if (isComment(token) && applyDirectives(token.meta.marpitParsedDirectives)) {
        markAsParsed(token);
      } else if (token.type === 'inline') {
        for (const t of token.children) {
          if (isComment(t) && applyDirectives(t.meta.marpitParsedDirectives)) markAsParsed(t);
        }
      }
    } // Assign global directives to meta


    for (const token of slides) token.meta.marpitDirectives = _objectSpread({}, token.meta.marpitDirectives, marpit.lastGlobalDirectives);
  });
}

var _default = parse;
exports.default = _default;