marktable/lib/marktable.js

Markdown table parser, editor and formater

// Import
var re = require('./regex')
var Table = require('./Table')

// Export
module.exports = marktable

/**
 * Format each table in a markdown source
 *
 * @param  {String} src Markdown source
 * @param  {Object} [options] Formating option (not used yet)
 * @return {String}
 */
function marktable (src) {
  // TODO: without src (and eventually options)
  // this function may return a transform stream
  // that bufferize only table data
  return marktable.parse(src, function (table) {
    return table.toMarkdown(/*options*/)
  })
}

/**
 * Parse synchronously a source and call a function on each table object found
 *
 * @param  {String} src
 *         Markdown source
 *
 * @param  {Function} handleTable
 *         A function that receive two arguments: a table object and the offset
 *         This function may return undefined or a transformed table source to
 *         replace the table in the body
 *
 * @return {String}
 *         The source after transformation
 */
marktable.parse = function (src, handleTable) {
  var trim = false
  if (!/\n$/.test(src)) {
    // No empty line before EOF, (\Z do not work in JS)
    // We add an EOL (removed later if needed)
    src += '\n'
    trim = true
  }

  return src.replace(new RegExp(re.wholeTable.source, 'g'), function (rawTable) {
    var args = Array.prototype.slice.call(arguments)
    var offset = args[args.length - 2]
    // var rest = args[args.length - 3]
    var rest = ''
    var parseResult = {
      offset: offset,
      offsetEnd: offset + args[0].length,
      raw: args[0],
      caption: args[1],
      headers: args[2],
      columns: args[3],
      rows: args[4]
    }

    var table = new Table()
    table.handleParseResult(parseResult)

    var result = handleTable(table, parseResult)
    result = result !== undefined ? (result + rest) : rawTable
    if (trim) {
      result = result.trim()
    }
    return result
  })
}

/**
 * Return a transform stream
 *
 * @param  {Function} handleTable
 *         A function that receive two arguments: a table object and the offset
 *         This function may return undefined or a transformed table source to
 *         replace the table in the body
 *
 * @return {Stream.Transform}
 */
marktable.transform = function (handleTable) {
  // TODO: Return a transform stream
}

// Expose API
marktable.Document = require('./Document')
marktable.Cell = require('./Cell')
marktable.Colgroup = require('./Colgroup')
marktable.Column = require('./Column')
marktable.MultilineRow = require('./MultilineRow')
marktable.Row = require('./Row')
marktable.Table = require('./Table')
marktable.TBody = require('./TBody')
marktable.Cursor = require('./Cursor')