markdown-magic 2.6.0 → 3.0.0

package/lib/transforms/index.js

@@ -1,114 +0,0 @@
-const code = require('./code')
-const file = require('./file')
-const remoteContent = require('./remote')
-const toc = require('./toc')
-
-const transforms = {
-  /**
-   * ### > TOC
-   *
-   * Generate table of contents from markdown file
-   *
-   * **Options:**
-   * - `firsth1` - *boolean* - (optional): Show first h1 of doc in table of contents. Default `false`
-   * - `collapse` - *boolean* - (optional): Collapse the table of contents in a detail accordian. Default `false`
-   * - `collapseText` - *string* - (optional): Text the toc accordian summary
-   * - `excludeText` - *string* - (optional): Text to exclude in the table of contents. Default `Table of Contents`
-   * - `maxDepth` - *number* - (optional): Max depth of headings. Default 4
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (TOC) -->
-   * toc will be generated here
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated content to place in the content block
-   */
-  TOC: toc,
-  /**
-   * ### > CODE
-   *
-   * Get code from file or URL and put in markdown
-   *
-   * **Options:**
-   * - `src`: The relative path to the code to pull in, or the `URL` where the raw code lives
-   * - `syntax` (optional): Syntax will be inferred by fileType if not specified
-   * - `header` (optional): Will add header comment to code snippet. Useful for pointing to relative source directory or adding live doc links
-   * - `lines` (optional): a range with lines of code which will then be replaced with code from the file. The line range should be defined as: "lines=*startLine*-*EndLine*" (for example: "lines=22-44"). Please see the example below
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (CODE:src=./relative/path/to/code.js) -->
-   * This content will be dynamically replaced with code from the file
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * ```md
-   *  <!-- AUTO-GENERATED-CONTENT:START (CODE:src=./relative/path/to/code.js&lines=22-44) -->
-   *  This content will be dynamically replaced with code from the file lines 22 through 44
-   *  <!-- AUTO-GENERATED-CONTENT:END -->
-   *  ```
-   * 
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated inner contents of the comment block
-   */
-  CODE: code,
-  /**
-   * ### > FILE
-   *
-   * Get local file contents.
-   *
-   * **Options:**
-   * - `src`: The relative path to the file to pull in
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (FILE:src=./path/to/file) -->
-   * This content will be dynamically replaced from the local file
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated content to place in the content block
-   */
-  FILE: file,
-  /**
-   * ### > REMOTE
-   *
-   * Get any remote Data and put in markdown
-   *
-   * **Options:**
-   * - `url`: The URL of the remote content to pull in
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (REMOTE:url=http://url-to-raw-md-file.md) -->
-   * This content will be dynamically replaced from the remote url
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated content to place in the content block
-   */
-  REMOTE: remoteContent,
-}
-
-module.exports = transforms

package/lib/updateContents.js

@@ -1,125 +0,0 @@
-const regexUtils = require('./utils/regex')
-
-/*
- Update contents between Comment tags
-*/
-module.exports = async function updateContents(block, config) {
-  let newContent
-  const openingTag = getOpeningTags(block, config)
-  const closingTag = getClosingTags(block, config)
-
-  if (!openingTag.transform) {
-    // no transform command return original block
-    return block
-  }
-  const contentStart = openingTag.openTag.length
-  const endStart = block.indexOf(closingTag.closeTag, openingTag.openTag.length)
-  const originalContent = block.slice(contentStart, endStart).replace(/^\s+|\s+$/g, '')
-
-  if (openingTag.transform) {
-    const cmd = openingTag.transform.cmd
-    const cmdOptions = openingTag.transform.cmdOptions || {}
-    // check if command exists
-    if (cmd && config.transforms && config.transforms[cmd]) {
-      let updatedContent = await config.transforms[cmd](originalContent, cmdOptions, config)
-      if (typeof updatedContent === 'function') {
-        // if plugin has no options defined, invoke it with defaults
-        updatedContent = await updatedContent(originalContent, cmdOptions, config)
-      }
-      newContent = updatedContent
-      if (!newContent) {
-        console.log(`COMMAND '${cmd}' is returning undefined value. using original content instead. Make sure you return a value from your transform`)
-      }
-    }
-    if (!config.transforms[cmd]) {
-      console.warn(`Error '${cmd}' transform function not found in \`config.transforms\``)
-      console.warn(`Comment block skipped: <!-- ${config.matchWord}:START (${cmd}) -->`)
-      // throw new Error(errMsg)
-    }
-  }
-
-  // if no transform matches
-  if (!newContent) {
-    newContent = originalContent
-  }
-  
-  // If original block or new content contains a new line, preserve it
-  if (block.indexOf('\n') > -1 || newContent.indexOf('\n') > -1) {
-    return `${openingTag.openTag}
-${newContent}
-${closingTag.closeTag}`
-}
-
-  // Block has no newline, inline contents
-  return `${openingTag.openTag}${newContent}${closingTag.closeTag}`
-}
-
-function parseOptions(options) {
-  if (!options) {
-    return null
-  }
-  const returnOptions = {}
-  options.split('&').map((opt, i) => { // eslint-disable-line
-    const getValues = opt.split(/=(.+)/)
-    if (getValues[0] && getValues[1]) {
-      returnOptions[getValues[0]] = getValues[1]
-    }
-  })
-  return returnOptions
-}
-
-function processTransforms(hasCommand) {
-  const hasOptions = hasCommand[1].match(/([^:]*):(.*)/)
-  const cmd = (hasOptions) ? hasOptions[1] : hasCommand[1]
-  // no options found, run command with no options
-  const cmdOptions = (hasOptions) ? hasOptions[2] : null
-  return {
-    cmd: cmd,
-    cmdOptions: parseOptions(cmdOptions)
-  }
-}
-
-function getOpeningTags(block, config) {
-  const openTagRegex = regexUtils.matchOpeningCommentTag(config.matchWord)
-  let matches
-  while ((matches = openTagRegex.exec(block)) !== null) { // eslint-disable-line
-    // This is necessary to avoid infinite loops with zero-width matches
-    if (matches.index === openTagRegex.lastIndex) {
-      openTagRegex.lastIndex++
-    }
-    /*
-    console.log('FULL Open Tag >>>>>', matches[0])
-    console.log('openTag Start', "'"+matches[1]+"'");
-    console.log('openTag End', "'"+matches[2]+"'");
-    /**/
-    const hasCommand = matches[0].match(/\((.*)\)/)
-    const cmd = (hasCommand) ? processTransforms(hasCommand) : false
-    return {
-      openTag: matches[0],
-      openTagStart: matches[1],
-      openTagEnd: matches[2],
-      transform: cmd
-    }
-  }
-}
-
-function getClosingTags(block, config) {
-  const closeTagRegex = regexUtils.matchClosingCommentTag(config.matchWord)
-  let matches
-  while ((matches = closeTagRegex.exec(block)) !== null) { // eslint-disable-line
-    // This is necessary to avoid infinite loops with zero-width matches
-    if (matches.index === closeTagRegex.lastIndex) {
-      closeTagRegex.lastIndex++
-    }
-    /*
-    console.log('FULL CLOSE Tag >>>>>', matches[0])
-    console.log('closeTag Start', "'"+matches[1]+"'");
-    console.log('closeTag End', "'"+matches[2]+"'");
-    /**/
-    return {
-      closeTag: matches[1] + matches[2],
-      closeTagStart: matches[1],
-      closeTagEnd: matches[2]
-    }
-  }
-}

package/lib/utils/_md.test.js

@@ -1,63 +0,0 @@
-const { test } = require('uvu') 
-const assert = require('uvu/assert')
-const { parseBlocks, replaceContent } = require('./new-parser')
-
-const defaultOpts = {
-  syntax: 'md',
-  open: 'DOCS:START',
-  close: 'DOCS:END',
-}
-
-test('Returns empty array', () => {
-  assert.equal(parseBlocks('', defaultOpts).transforms, [])
-  assert.equal(parseBlocks(' ', defaultOpts).transforms, [])
-  assert.equal(parseBlocks(`
-  
-  
-  `, defaultOpts).transforms, [])
-  assert.equal(parseBlocks(`
-# No block in here
-
-nope  
-  `, defaultOpts).transforms, [])
-})
-
-const md = `
-Very nice
-
-<!-- DOCS:START(TOC) foo={{ rad: 'orange' }} ------>
-ok
-<!-- DOCS:END -->`
-
-test('Parse md blocks', () => {
-  const parsedValue = parseBlocks(md, defaultOpts)
-  console.log('parsedValue', parsedValue)
-  assert.equal(parsedValue.transforms, [
-    {
-      transform: 'TOC',
-      args: { foo: { rad: 'orange' } },
-      block: {
-        indentation: '',
-        start: 12,
-        end: 85,
-        contentStart: 64,
-        contentEnd: 68,
-        contentIndent: 0,
-        openTag: "<!-- DOCS:START(TOC) foo={{ rad: 'orange' }} ------>\n",
-        content: 'ok',
-        closeTag: '\n<!-- DOCS:END -->'
-      },
-      raw: {
-        transform: '(TOC)',
-        args: "foo={{ rad: 'orange' }} ----",
-        content: '\nok\n',
-        block: "<!-- DOCS:START(TOC) foo={{ rad: 'orange' }} ------>\n" +
-          'ok\n' +
-          '<!-- DOCS:END -->'
-      },
-      meta: { isMultiline: true }
-    }
-  ], '')
-})
-
-test.run()