markdown-magic 2.4.0 → 2.6.0

package/README.md

@@ -32,7 +32,9 @@ This `README.md` is generated with `markdown-magic` [view the raw file](https://
 - [Transforms](#transforms)
   - [> TOC](#-toc)
   - [> CODE](#-code)
+  - [> FILE](#-file)
   - [> REMOTE](#-remote)
+- [Inline transforms](#inline-transforms)
 - [🔌 Markdown magic plugins](#-markdown-magic-plugins)
 - [Adding Custom Transforms](#adding-custom-transforms)
 - [Plugin Example](#plugin-example)
@@ -189,6 +191,24 @@ Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
 
 ---
 
+### > 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`
+
+---
+
 ### > REMOTE
 
 Get any remote Data and put in markdown
@@ -199,7 +219,7 @@ Get any remote Data and put in markdown
 **Example:**
 ```md
 <!-- AUTO-GENERATED-CONTENT:START (REMOTE:url=http://url-to-raw-md-file.md) -->
-This content will be dynamically replace from the remote url
+This content will be dynamically replaced from the remote url
 <!-- AUTO-GENERATED-CONTENT:END -->
 ```
 
@@ -208,6 +228,17 @@ Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
 ---
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END - Do not remove or modify this section -->
 
+## Inline transforms
+
+Any transform, including custom transforms can be used inline as well to insert content into paragraphs and other places.
+
+The face symbol 👉 <!-- MD-MAGIC-EXAMPLE:START (INLINE_EXAMPLE) -->**⊂◉‿◉つ**<!-- MD-MAGIC-EXAMPLE:END --> is auto generated inline.
+
+**Example:**
+```md
+<!-- AUTO-GENERATED-CONTENT:START (FILE:src=./path/to/file) -->xyz<!-- AUTO-GENERATED-CONTENT:END -->
+```
+
 ## 🔌 Markdown magic plugins
 
 * [wordcount](https://github.com/DavidWells/markdown-magic-wordcount/) - Add wordcount to markdown files
@@ -266,6 +297,9 @@ const config = {
       })
       return updatedContent.replace(/^\s+|\s+$/g, '')
     },
+    INLINE_EXAMPLE: () => {
+      return '**⊂◉‿◉つ**'
+    },
     /* Match <!-- AUTO-GENERATED-CONTENT:START (pluginExample) --> */
     pluginExample: require('./plugin-example')({ addNewLine: true }),
     /* Include plugins from NPM */
@@ -359,3 +393,8 @@ This section was generated by the cli config markdown.config.js file
 
 - [Project using markdown-magic](https://github.com/search?o=desc&q=filename%3Apackage.json+%22markdown-magic%22&s=indexed&type=Code)
 - [Examples in md](https://github.com/search?l=Markdown&o=desc&q=AUTO-GENERATED-CONTENT&s=indexed&type=Code)
+
+
+## Misc Markdown helpers
+
+- https://github.com/azu/markdown-function

package/lib/index.js

@@ -0,0 +1,219 @@
+const path = require('path')
+const fs = require('fs').promises
+const { getTextBetween, parseBlocks } = require('./utils/new-parser')
+
+async function processContents({ 
+  filePath, 
+  syntax,
+  open,
+  close,
+  transforms,
+  beforeMiddelwares,
+  afterMiddelwares,
+  DEBUG = false
+}) {
+  const syntaxType = syntax || path.extname(filePath).replace(/^\./, '')
+  const originalContents = await fs.readFile(filePath, 'utf8')
+  
+  const foundBlocks = parseBlocks(originalContents, {
+    syntax: syntaxType,
+    open,
+    close,
+  })
+
+  if (DEBUG) {
+    console.log('foundBlocks')
+    console.log(foundBlocks)
+  }
+
+  const transformsToRun = sortPlugins(foundBlocks.transforms)
+  // console.log('transformsToRun', transformsToRun)
+
+  // if (!transformsToRun.length) {
+  //   process.exit(1)
+  // }
+
+  let missingTransforms = []
+  const updatedContents = await transformsToRun.reduce(async (updatedContent, ogmatch) => {
+    const md = await updatedContent
+    /* Apply Before middleware to all transforms */
+    const match = await applyMiddleware(ogmatch, md, beforeMiddelwares)
+    const { block, raw, transform, args } = match
+    const { openTag, closeTag, content, contentStart, contentEnd, start, end } = block
+    
+    /* Run transform plugins */
+    let tempContent = content
+    if (transforms[transform]) {
+      tempContent = await transforms[transform](match, md)
+    }
+
+    /* Apply After middleware to all transforms */
+    const afterContent = await applyMiddleware({
+      ...match,
+      ...{
+        block: {
+          ...match.block,
+          content: tempContent
+        }
+      }
+    }, md, afterMiddelwares)
+    if (DEBUG) {
+      console.log('afterContent', afterContent)
+    }
+
+    if (!transforms[transform]) {
+      missingTransforms.push(afterContent)
+      console.log(`Missing "${transform}" transform`)
+    }
+
+    const newContent = afterContent.block.content
+    const formattedNewContent = (args.noTrim) ? newContent : smartTrim(newContent)
+    /* Remove any conflicting imported comments */
+    // const fix = removeConflictingComments(formattedNewContent, foundBlocks.commentOpen, foundBlocks.commentClose)
+    const fix = stripAllComments(formattedNewContent, foundBlocks.commentOpen, foundBlocks.commentClose)
+    // console.log('foundBlocks.commentClose', foundBlocks.commentClose)
+    // console.log('formattedNewContent', formattedNewContent)
+    // console.log('fix', fix)
+    const preserveIndent = (true || args.preserveIndent) ? block.indentation.length + block.contentIndent : block.indentation.length
+    const indent = indentString(fix, preserveIndent)
+    const newCont = `${openTag}${indent}${closeTag}`
+    /* Replace original contents */
+    const newContents = md.replace(raw.block, newCont)
+    return Promise.resolve(newContents)
+  }, Promise.resolve(originalContents))
+
+  if (DEBUG) {
+    console.log('Output Markdown')
+    console.log(updatedContents)
+  }
+
+  /*
+  if (missingTransforms.length) {
+    console.log('missingTransforms', missingTransforms)
+    let matchOne = missingTransforms[1]
+    matchOne = missingTransforms[missingTransforms.length - 1]
+    // console.log('matchOne', matchOne)
+    const { block, transform, args } = matchOne
+    const { openTag, closeTag, content, contentStart, contentEnd, start, end} = block
+
+    // console.log('contentStart', contentStart)
+    // console.log('contentEnd', contentEnd)
+    // console.log('original text between', `"${getTextBetween(md, contentStart, contentEnd)}"`)
+    // console.log('original block between', `"${getTextBetween(md, start, end)}"`)
+  }
+  /** */
+
+  return {
+    filePath,
+    transforms: transformsToRun,
+    missingTransforms,
+    originalContents,
+    updatedContents
+  }
+}
+
+function applyMiddleware(data, md, middlewares) {
+  return middlewares.reduce(async (acc, curr) => {
+    const realAcc = await acc
+    // console.log(`Running "${curr.name}" Middleware on "${realAcc.transform}" block`)
+    const updatedContent = await curr.transform(realAcc, md)
+    // realAcc.block.content = updatedContent
+    return Promise.resolve({
+      ...realAcc,
+      ...{
+        block: {
+          ...realAcc.block,
+          content: updatedContent
+        }
+      }
+    })
+  }, Promise.resolve(data))
+}
+
+/**
+ * Trim leading & trailing spaces/line breaks in code and keeps the indentation of the first non-empty line
+ * @param {string} str 
+ * @returns string
+ */
+function smartTrim(str) {
+  return str.replace(/^(?:[\t ]*(?:\r?\n|\r))+|\s+$/g, '')
+}
+
+function stripAllComments(block) {
+  const pattern = new RegExp(`([^\\s]*)?([ \\t]*)?(<!-+\\s?([\\s\\S]*?)?-+>)([^\\s<]*)?(\n{1,2})?`, 'gi')
+
+  // console.log('closeTagRegex', closeTagRegex)
+  let matches
+  let remove = []
+  while ((matches = pattern.exec(block)) !== null) {
+    if (matches.index === pattern.lastIndex) {
+      pattern.lastIndex++ // avoid infinite loops with zero-width matches
+    }
+    const [ match, leadingText, leadingSpace, comment, insideComment, trailingText, trailingNewLine ] = matches
+    /*
+    console.log('match', match)
+    console.log('leadingText', leadingText)
+    console.log('leadingSpace', leadingSpace)
+    console.log('comment', comment)
+    console.log('insideComment', insideComment)
+    console.log('trailingText', trailingText)
+    console.log('trailingNewLine', trailingNewLine)
+    /** */
+    const newLineCount = (trailingNewLine || '').length
+    const trailing = (!trailingText && newLineCount > 1) ? `${trailingNewLine || ''}` : ''
+    const leading = (leadingSpace) ? leadingSpace.slice(1) : ''
+    remove.push(`${leading}${comment}${trailing}`)
+  }
+  return remove.reduce((acc, curr) => {
+    return acc.replaceAll(curr, '')
+  }, block)
+}
+
+/**
+ * Remove conflicting comments that might have been inserted from transforms
+ * @param {*} content 
+ * @param {*} openPattern 
+ * @param {*} closePattern 
+ * @returns 
+ */
+function removeConflictingComments(content, openPattern, closePattern) {
+  const removeOpen = content.replace(openPattern, '')
+  // TODO this probably needs to be a loop for larger blocks
+  closePattern.lastIndex = 0; // reset regex
+  const hasClose = closePattern.exec(content)
+  // console.log('closePattern', closePattern)
+  // console.log('has', content)
+  // console.log('hasClose', hasClose)
+  if (!hasClose) {
+    return removeOpen
+  }
+  const closeTag = `${hasClose[2]}${hasClose[3] || ''}`
+  // console.log('closeTag', closeTag)
+  return removeOpen
+    .replaceAll(closeTag, '')
+    /* Trailing new line */
+    .replace(/\n$/, '')
+}
+ 
+function sortPlugins(data) {
+  return data.sort((a, b) => {
+    // put table of contents (TOC) at end of tranforms
+    if (a.transform === 'TOC') return 1
+    if (b.transform === 'TOC') return -1
+    return 0
+  })
+}
+
+function indentString(string, count = 1, options = {}) {
+	const {
+		indent = ' ',
+		includeEmptyLines = false
+	} = options;
+	if (count === 0) return string
+	const regex = includeEmptyLines ? /^/gm : /^(?!\s*$)/gm
+	return string.replace(regex, indent.repeat(count))
+}
+
+module.exports = {
+  processContents
+}

package/lib/processFile.js

@@ -38,7 +38,7 @@ module.exports = async function processFile(filePath, config) {
     matchWord: 'AUTO-GENERATED-CONTENT',
     /**
      * - `DEBUG` - *Boolean* - (optional) set debug flag to `true` to inspect the process
-     * @type {string}
+     * @type {boolean}
      */
     DEBUG: false,
   }
@@ -55,6 +55,7 @@ module.exports = async function processFile(filePath, config) {
   mergedConfig.outputContent = content
 
   const regex = regexUtils.matchCommentBlock(mergedConfig.matchWord)
+  // console.log(regex)
   const match = content.match(regex)
   const transformsFound = []
 

package/lib/transforms/file.js

@@ -0,0 +1,37 @@
+const path = require('path')
+const fs = require('fs')
+const isLocalPath = require('is-local-path')
+
+module.exports = function FILE(content, options, config) {
+  let fileContents
+  let syntax = options.syntax
+  if (!options.src) {
+    return false
+  }
+  if (isLocalPath(options.src)) {
+    const fileDir = path.dirname(config.originalPath)
+    const filePath = path.join(fileDir, options.src)
+    try {
+      fileContents = fs.readFileSync(filePath, 'utf8', (err, contents) => {
+        if (err) {
+          console.log(`FILE NOT FOUND ${filePath}`)
+          console.log(err)
+           // throw err
+        }
+        return contents
+      })
+    } catch (e) {
+      console.log(`FILE NOT FOUND ${filePath}`)
+      throw e
+    }
+    if (!syntax) {
+      syntax = path.extname(filePath).replace(/^./, '')
+    }
+  }
+
+  // trim leading and trailing spaces/line breaks in code and keeps the indentation of the first non-empty line
+  fileContents = fileContents.replace(/^(?:[\t ]*(?:\r?\n|\r))+|\s+$/g, '')
+
+  return `<!-- The below content is automatically added from ${options.src} -->
+${fileContents}`
+}

package/lib/transforms/index.js

@@ -1,4 +1,5 @@
 const code = require('./code')
+const file = require('./file')
 const remoteContent = require('./remote')
 const toc = require('./toc')
 
@@ -62,6 +63,29 @@ const transforms = {
    * @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
    *
@@ -73,7 +97,7 @@ const transforms = {
    * **Example:**
    * ```md
    * <!-- AUTO-GENERATED-CONTENT:START (REMOTE:url=http://url-to-raw-md-file.md) -->
-   * This content will be dynamically replace from the remote url
+   * This content will be dynamically replaced from the remote url
    * <!-- AUTO-GENERATED-CONTENT:END -->
    * ```
    *

package/lib/transforms/toc.js

@@ -66,13 +66,14 @@ module.exports = async function TOC(content, options, config) {
     const [ lineText, lineIndex, isFirst, matchText ] = firstHeadingData
     
     // verify its h1
-
+    const matchTextEscaped = escapeStringRegexp(matchText)
+    // console.log('matchTextEscaped', matchTextEscaped)
     // /^#{1}\s+(.*)/
-    const FIRST_H1_REGEX = new RegExp(`^#\\s*${matchText}`, 'gim')
+    const FIRST_H1_REGEX = new RegExp(`^#\\s*\\[?${matchTextEscaped}\\]?(?:.*)?`, 'gim')
     // /^<h1\b[^>]*>([\s\S]*?)<\/h1>/
-    const FIRST_HTML_H1_REGEX = new RegExp(`^<h1\\b[^>]*>[\\s]*?(${matchText})[\\s]*?<\\/h1>`, 'gim') 
+    const FIRST_HTML_H1_REGEX = new RegExp(`^<h1\\b[^>]*>[\\s]*?(${matchTextEscaped})[\\s]*?<\\/h1>`, 'gim')
     // /^(.*)\n={3,}/
-    const FIRST_UNDERSCORE_H1 = new RegExp(`^(${matchText})\n={3,}`, 'gim')  
+    const FIRST_UNDERSCORE_H1 = new RegExp(`^(${matchTextEscaped})\n={3,}`, 'gim')
     
     let docHasHeading = false
     if (contents.match(FIRST_H1_REGEX)) {
@@ -245,7 +246,21 @@ function parseHtmlProps(mdContents) {
   return tags
 }
 
+function escapeStringRegexp(string) {
+	if (typeof string !== 'string') {
+		throw new TypeError('Expected a string');
+	}
+
+	// Escape characters with special meaning either inside or outside character sets.
+	// Use a simple backslash escape when it’s always valid, and a `\xnn` escape when the simpler form would be disallowed by Unicode patterns’ stricter grammar.
+	return string
+		.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&')
+		.replace(/-/g, '\\x2d');
+}
+
 function removeUndefined(output) {
   // remove undefined from new line and start of string if first H1 is missing
   return output.replace(/\nundefined/g, '\n-').replace(/^undefined/g, '-')
 }
+
+// Alt https://github.com/thlorenz/doctoc

package/lib/updateContents.js

@@ -42,12 +42,18 @@ module.exports = async function updateContents(block, config) {
   if (!newContent) {
     newContent = originalContent
   }
-
-  return `${openingTag.openTag}
+  
+  // 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

package/lib/utils/_md.test.js

@@ -0,0 +1,63 @@
+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()