markdown-magic 3.2.0 → 3.3.1

package/lib/transforms/code/index.js

@@ -3,12 +3,12 @@ const path = require('path')
 const { remoteRequest } = require('../../utils/remoteRequest')
 const { isLocalPath } = require('../../utils/fs')
 const { deepLog } = require('../../utils/logs')
-const { getLineCount, getTextBetweenLines, stripOutMultiLineDoubleDashComments } = require('../../utils/text')
+const { getLineCount, getTextBetweenLines, stripMultiLineDoubleDashComments, stripHTMLComments } = require('../../utils/text')
 const { resolveGithubContents, isGithubLink } = require('./resolve-github-file')
 
 const GITHUB_LINK = /https:\/\/github\.com\/([^/\s]*)\/([^/\s]*)\/blob\//
 const GIST_LINK = /https:\/\/gist\.github\.com\/([^/\s]*)\/([^/\s]*)(\/)?/
-const RAW_URL_LIKE = /^([A-Za-z0-9_]*)\.([A-Za-z0-9_]*)\/(.*)/
+const RAW_URL_LIKE = /^([A-Za-z0-9_]+)\.([A-Za-z0-9_]*)\/(.*)/
 
 /**
  * Options for specifying source code to include in documentation.
@@ -17,6 +17,7 @@ const RAW_URL_LIKE = /^([A-Za-z0-9_]*)\.([A-Za-z0-9_]*)\/(.*)/
  * @property {string} [syntax] - The syntax of the code. If not specified, it will be inferred by fileType.
  * @property {string} [header] - The header comment to add to the code snippet. Useful for pointing to relative source directory or adding live doc links.
  * @property {string} [lines] - A range of lines of code to include from the file. The line range should be defined like "lines=22-44".
+ * @property {string} [section] - A section of code to include from the file. Defined like "section=SECTION_NAME". The code should have "// SECTION_NAME" surrounding the block of text.
  * @property {boolean} [trimDeadCode] - Remove multi-line comments that start with `//` from the code.
  * @example
    ```md
@@ -65,7 +66,7 @@ module.exports = async function CODE(api) {
     const fileDir = (srcPath) ? path.dirname(srcPath) : process.cwd()
     codeFilePath = path.resolve(fileDir, src)
     /* If the path looks like a URL, attempt to resolve it */
-    const isUrlLike = src.match(RAW_URL_LIKE)
+    const isUrlLike = !src.startsWith('./') && !src.startsWith('../') && src.match(RAW_URL_LIKE)
     if (isUrlLike) {
       remoteContent = await resolveRemoteContent(options, settings, srcPath)
       code = remoteContent
@@ -81,8 +82,12 @@ module.exports = async function CODE(api) {
         if (isUrlLike) {
           throw new Error(`Unable to resolve ${src}`)
         }
-        console.log(`FILE NOT FOUND ${codeFilePath}`)
-        throw e
+        if (src === './relative/path/to/code.js') {
+          return api.content
+        } else {
+          console.log(`FILE NOT FOUND ${codeFilePath}`)
+          throw e
+        }
       }
     }
   } else {
@@ -133,6 +138,17 @@ module.exports = async function CODE(api) {
     }
   }
 
+  if (options.section) {
+    code = findInnerBlock(code, options.section)
+  }
+
+  if (options.symbol && syntax === 'js') {
+    // Code to get function block or class block or variable block
+  }
+
+  /* Ensure lowercase on syntax */
+  syntax = (syntax || '').toLowerCase()
+
   /* Check for Id */
   if (id) {
     const lines = code.split("\n")
@@ -157,15 +173,19 @@ module.exports = async function CODE(api) {
   }
 
   // trim leading and trailing spaces/line breaks in code and keeps the indentation of the first non-empty line
-  code = code.replace(/^(?:[\t ]*(?:\r?\n|\r))+|\s+$/g, '')
+  code = (code || '').replace(/^(?:[\t ]*(?:\r?\n|\r))+|\s+$/g, '')
 
   let header = ''
   if (options.header) {
     header = `\n${options.header}`
   }
-
+  
   if (options.trimDeadCode) {
-    code = stripOutMultiLineDoubleDashComments(code)
+    if (syntax === 'js' || syntax === 'ts' || syntax === 'javascript' || syntax === 'typescript') {
+      code = stripMultiLineDoubleDashComments(code)
+    } else if (syntax === 'html') {
+      code = stripHTMLComments(code, { multilineOnly: true })
+    }
   }
 
   return `\`\`\`${syntax}${header}
@@ -192,4 +212,34 @@ async function resolveRemoteContent(options, settings, srcPath) {
   }
 
   return remoteContent
+}
+
+
+function findInnerBlock(str, text) {
+  const matches = matchInnerContent(str, text, text)
+  if (!matches.length) {
+    throw new Error(`No blocks match ${text} in code`)
+  }
+  if (matches.length > 1) {
+    throw new Error(`Multiple blocks match ${text} in code`)
+  }
+
+  return matches[0]
+}
+
+function matchInnerContent(str, open, close) {
+  const pattern = new RegExp(`\\/\\/ ${open}\\n([\\s\\S]*?)\\n\\/\\/ ${close}`, 'g')
+
+  // console.log('closeTagRegex', closeTagRegex)
+  var matches
+  var blocks = []
+  while ((matches = pattern.exec(str)) !== null) {
+    if (matches.index === pattern.lastIndex) {
+      pattern.lastIndex++ // avoid infinite loops with zero-width matches
+    }
+    const [ _match, innerContent ] = matches
+    console.log('matches', matches)
+    blocks.push(innerContent)
+  }
+  return blocks
 }

package/lib/transforms/file.js

@@ -5,7 +5,6 @@ const isLocalPath = require('is-local-path')
 module.exports = function FILE(api) {
   /*
   console.log('FILE API', api)
-
   /** */
   const { options, srcPath } = api
   if (!options.src) {
@@ -19,6 +18,10 @@ module.exports = function FILE(api) {
       // console.log('READFILE', resolvedFilePath)
       fileContents = fs.readFileSync(resolvedFilePath, 'utf8')
     } catch (e) {
+      // if demo path. Todo probably remove
+      if (options.src === './path/to/file') {
+        return api.content
+      }
       console.log(`FILE NOT FOUND ${resolvedFilePath}`)
       throw e
     }

package/lib/transforms/remote.js

@@ -4,6 +4,7 @@ module.exports = async function REMOTE(api) {
   // console.log('REMOTE api', api)
   const { options, content, settings } = api
   const { regex } = settings
+
   // console.log('MAKE REMOTE REQUEST')
   const remoteContent = await remoteRequest(options.url, settings, api.srcPath)
   if (!remoteContent) {

package/lib/utils/remoteRequest.js

@@ -26,6 +26,10 @@ function remoteRequestSync(url, settings = {}, srcPath) {
 async function remoteRequest(url, settings = {}, srcPath) {
   let body
   const finalUrl = formatUrl(url)
+  // ignore demo url todo remove one day
+  if (finalUrl === 'http://url-to-raw-md-file.md') {
+    return
+  }
   try {
     const res = await fetch(finalUrl)
     body = await res.text()

package/lib/utils/text.js

@@ -1,3 +1,4 @@
+const { match } = require('uvu/assert')
 const { syntaxMap } = require('./syntax')
 
 function getLines(str = '') {
@@ -77,7 +78,7 @@ function getTextBetweenLines(content, startLine, endLine) {
   if (startDefined && !endDefined) {
     return lines.slice(startLine - 1, startLine).join('')
   }
-  if ((startLine) && (endLine) && parseInt(startLine, 10) <= parseInt(endLine, 10)) {
+  if (startLine && endLine && parseInt(startLine, 10) <= parseInt(endLine, 10)) {
     return lines.slice(startLine - 1, endLine).join('\n')
   }
 }
@@ -119,7 +120,11 @@ function indentString(string, count = 1, options = {}) {
 		includeEmptyLines = false
 	} = options;
 	if (count === 0) return string
-	const regex = includeEmptyLines ? /^/gm : /^(?!\s*$)/gm
+	// const regex = includeEmptyLines ? /^/gm : /^(?!\s*$)/gm
+  const indentPattern = indent.repeat(count)
+  const regex = includeEmptyLines
+    ? new RegExp(`^(?!${indentPattern})`, 'gm')
+    : new RegExp(`^(?!${indentPattern})(?!\\s*$)`, 'gm')
 	return string.replace(regex, indent.repeat(count))
 }
 
@@ -133,14 +138,14 @@ function dedentString(str) {
   str = str.replace(/^[ \t]*\r?\n/, ''); // remove leading blank line
   var indent = /^[ \t]+/m.exec(str); // detected indent
   if (indent) str = str.replace(new RegExp('^' + indent[0], 'gm'), ''); // remove indent
-  return str.replace(/(\r?\n)[ \t]+$/, '$1'); // remove trailling blank line
+  return str.replace(/(\r?\n)[ \t]+$/, '$1'); // remove trailing blank line
 }
 
 /**
  * Strip out comment blocks
  * @param {string} str 
  * @param {'md' | 'js'} syntax 
- * @returns {string} clean commentless string
+ * @returns {string} clean comment-less string
  */
 function stripCommentBlockOld(str, syntax = 'md') {
   const [ openPattern, closePattern ] = syntaxMap[syntax].pattern
@@ -177,7 +182,7 @@ function stripCommentBlockOld(str, syntax = 'md') {
  * Strip out comment blocks
  * @param {string} str 
  * @param {typeof import('../types')['syntaxType']} syntax 
- * @returns {string} clean commentless string
+ * @returns {string} clean comment-less string
  */
 function stripComments(str, syntax = 'md') {
   const syntaxData = syntaxMap[syntax]
@@ -193,7 +198,7 @@ function stripComments(str, syntax = 'md') {
 
 
 // https://regex101.com/r/nCnt2J/1
-function stripOutMultiLineDoubleDashComments(str = '') {
+function stripMultiLineDoubleDashComments(str = '') {
   return str.replace(/(?:\n\s*\/\/.*){2,}/g, '')
 }
 
@@ -204,8 +209,10 @@ function stripOutMultilineJsComments(str = '') {
   })
 }
 
+
 // @TODO export as util to import into CODE
-function stripAllHTMLComments(block) {
+function stripHTMLComments(block, opts) {
+  const options = opts || {}
   // ([^\s]*)?([ \t]*)?(\/\*{1,}[\n\*]*(\s?[\s\S]*?)?\*\/)([^\s<]*)?(\n{1,2})?
   // https://regex101.com/r/WSioZ7/1
   const pattern = new RegExp(`([^\\s]*)?([ \\t]*)?(<!-{2,}(\\s?[\\s\\S]*?)?-{2,}>)([^\\s<]*)?(\n{1,2})?`, 'gi')
@@ -230,8 +237,12 @@ function stripAllHTMLComments(block) {
     console.log('trailingNewLine', trailingNewLine)
     /** */
     const newLineCount = (trailingNewLine || '').length
-    const trailing = (!trailingText && newLineCount > 1) ? `${trailingNewLine || ''}` : ''
-    const leading = (leadingSpace) ? leadingSpace.slice(1) : ''
+    const trailing = (!trailingText && !leadingText && newLineCount >= 1) ? `${trailingNewLine || ''}` : ''
+    let leading = (leadingSpace) ? leadingSpace : ''
+
+    if (options.multilineOnly && comment.indexOf('\n') === -1) {
+      continue
+    }
     remove.push(`${leading}${comment}${trailing}`)
   }
   return remove.reduce((acc, curr) => {
@@ -341,7 +352,8 @@ module.exports = {
   dedentString,
   stripComments,
   convertCommentSyntax,
-  stripOutMultiLineDoubleDashComments,
+  stripMultiLineDoubleDashComments,
+  stripHTMLComments,
   // stripCommentBlockJS,
   trimString,
   // future https://github.com/junfengliang/autowrap

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-magic",
-  "version": "3.2.0",
+  "version": "3.3.1",
   "description": "Automatically update markdown files with content from external sources",
   "main": "lib/index.js",
   "bin": {
@@ -21,7 +21,6 @@
     "test": "npm run test:lib && npm run test:test && echo 'tests done'",
     "test:lib": "uvu lib '.test.([mc]js|[jt]sx?)$'",
     "test:test": "uvu test '.test.([mc]js|[jt]sx?)$'",
-    "test:options": "uvu lib 'options-parser.test.([mc]js|[jt]sx?)$'",
     "test:block": "uvu lib 'block-parser.test.([mc]js|[jt]sx?)$'",
     "test:cli": "uvu lib 'cli.test.([mc]js|[jt]sx?)$'",
     "test:md": "uvu lib 'md.test.([mc]js|[jt]sx?)$'",
@@ -54,7 +53,7 @@
     "micro-mdx-parser": "^1.1.0",
     "mri": "^1.2.0",
     "node-fetch": "^2.7.0",
-    "oparser": "^3.0.13",
+    "oparser": "^3.0.22",
     "smart-glob": "^1.0.2",
     "sync-request": "^6.1.0"
   },