markdown-magic 3.0.10 → 3.2.0

package/lib/transforms/code/index.js

@@ -1,9 +1,9 @@
 const fs = require('fs')
 const path = require('path')
-const remoteRequest = require('../../utils/remoteRequest')
+const { remoteRequest } = require('../../utils/remoteRequest')
 const { isLocalPath } = require('../../utils/fs')
 const { deepLog } = require('../../utils/logs')
-const { getLineCount, getTextBetweenLines } = require('../../utils/text')
+const { getLineCount, getTextBetweenLines, stripOutMultiLineDoubleDashComments } = require('../../utils/text')
 const { resolveGithubContents, isGithubLink } = require('./resolve-github-file')
 
 const GITHUB_LINK = /https:\/\/github\.com\/([^/\s]*)\/([^/\s]*)\/blob\//
@@ -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 {boolean} [trimDeadCode] - Remove multi-line comments that start with `//` from the code.
  * @example
    ```md
    <!-- doc-gen CODE src="./relative/path/to/code.js" -->
@@ -163,6 +164,10 @@ module.exports = async function CODE(api) {
     header = `\n${options.header}`
   }
 
+  if (options.trimDeadCode) {
+    code = stripOutMultiLineDoubleDashComments(code)
+  }
+
   return `\`\`\`${syntax}${header}
 ${code}
 \`\`\``
@@ -183,7 +188,7 @@ async function resolveRemoteContent(options, settings, srcPath) {
 
   // Try initial remote request if public url
   if (!remoteContent) {
-    remoteContent = remoteRequest(src, settings, srcPath)
+    remoteContent = await remoteRequest(src, settings, srcPath)
   }
 
   return remoteContent

package/lib/transforms/remote.js

@@ -1,11 +1,11 @@
-const remoteRequest = require('../utils/remoteRequest')
+const { remoteRequest } = require('../utils/remoteRequest')
 
-module.exports = function REMOTE(api) {
+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 = remoteRequest(options.url, settings, api.srcPath)
+  const remoteContent = await remoteRequest(options.url, settings, api.srcPath)
   if (!remoteContent) {
     return content
   }

package/lib/utils/remoteRequest.js

@@ -1,8 +1,13 @@
+const fetch = require('node-fetch')
 const request = require('sync-request')
 
-module.exports = function remoteRequest(url, settings = {}, srcPath) {
+function formatUrl(url = '') {
+  return url.match(/^https?:\/\//) ? url : `https://${url}`
+}
+
+function remoteRequestSync(url, settings = {}, srcPath) {
   let body
-  const finalUrl = (url.match(/^https?:\/\//)) ? url : `https://${url}`
+  const finalUrl = formatUrl(url)
   try {
     // @ts-expect-error
     const res = request('GET', finalUrl)
@@ -18,6 +23,28 @@ module.exports = function remoteRequest(url, settings = {}, srcPath) {
   return body
 }
 
+async function remoteRequest(url, settings = {}, srcPath) {
+  let body
+  const finalUrl = formatUrl(url)
+  try {
+    const res = await fetch(finalUrl)
+    body = await res.text()
+  } catch (e) {
+    console.log(`⚠️  WARNING: REMOTE URL "${finalUrl}" NOT FOUND`)
+    const msg = (e.message || '').split('\n')[0] + `\nFix "${url}" value in ${srcPath}`
+    console.log(msg)
+    if (settings.failOnMissingRemote) {
+      throw new Error(msg)
+    }
+  }
+  return body
+}
+
+module.exports = {
+  remoteRequestSync,
+  remoteRequest
+}
+
 /*
 TODO add file caching?
 */

package/lib/utils/syntax.js

@@ -1,7 +1,6 @@
 const html = {
   tags: [
-    '<!--', 
-    '-->'
+    '<!--', '-->'
   ],
   pattern: [
     '<!-{2,}', 
@@ -13,7 +12,9 @@ const html = {
 
 // JS https://regex101.com/r/XKHU18/5
 const js = {
-  tags: ['/*', '*/'],
+  tags: [
+    '/*', '*/'
+  ],
   pattern: [
     '\/\\*+',
     // Old ^ '\/\\*{1,}[\n\\*]*',     // '\/\\*+', '\/\*[\*\n\s\t]+', // 
@@ -27,8 +28,7 @@ const js = {
 
 const jsx = {
   tags: [
-    '{/*', 
-    '*/}'
+    '{/*', '*/}'
   ],
   pattern: [
     '\{\/\\*+',
@@ -46,7 +46,7 @@ const yaml = {
   singleLinePattern: '#+',
   singleLine: '#.*$',
   content: '[ \\t\\S]*?',
-  converter: (str) => {
+  converter: (str = '') => {
     return str.split('\n').map((line) => {
       return line[0] === '#' ? line : `#${line}`
     }).join()

package/lib/utils/text.js

@@ -191,8 +191,21 @@ function stripComments(str, syntax = 'md') {
   return str.replace(/\s?[ \t]*\/\*[\s\S]*?\*\/|\s?[ \t]*\/\/.*$|\/\*{1,}[\n\*]*(\s?[\s\S]*?)?\*+\//gm, '')
 }
 
+
+// https://regex101.com/r/nCnt2J/1
+function stripOutMultiLineDoubleDashComments(str = '') {
+  return str.replace(/(?:\n\s*\/\/.*){2,}/g, '')
+}
+
+// https://regex101.com/r/plpXmr/1
+function stripOutMultilineJsComments(str = '') {
+  return str.replace(/\/\*[\s\S]+?\*\/\s*\n?/g, (match) => {
+    return match.trim().includes('\n') ? '' : match
+  })
+}
+
 // @TODO export as util to import into CODE
-function stripAllComments(block) {
+function stripAllHTMLComments(block) {
   // ([^\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')
@@ -328,6 +341,7 @@ module.exports = {
   dedentString,
   stripComments,
   convertCommentSyntax,
+  stripOutMultiLineDoubleDashComments,
   // stripCommentBlockJS,
   trimString,
   // future https://github.com/junfengliang/autowrap

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-magic",
-  "version": "3.0.10",
+  "version": "3.2.0",
   "description": "Automatically update markdown files with content from external sources",
   "main": "lib/index.js",
   "bin": {
@@ -53,6 +53,7 @@
     "is-valid-path": "^0.1.1",
     "micro-mdx-parser": "^1.1.0",
     "mri": "^1.2.0",
+    "node-fetch": "^2.7.0",
     "oparser": "^3.0.13",
     "smart-glob": "^1.0.2",
     "sync-request": "^6.1.0"