markdown-magic 3.1.0 → 3.3.0

package/lib/transforms/code/index.js

@@ -3,7 +3,7 @@ const path = require('path')
 const { remoteRequest } = require('../../utils/remoteRequest')
 const { isLocalPath } = require('../../utils/fs')
 const { deepLog } = require('../../utils/logs')
-const { getLineCount, getTextBetweenLines } = 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\//
@@ -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" -->
@@ -132,6 +133,9 @@ module.exports = async function CODE(api) {
     }
   }
 
+  /* Ensure lowercase on syntax */
+  syntax = (syntax || '').toLowerCase()
+
   /* Check for Id */
   if (id) {
     const lines = code.split("\n")
@@ -162,6 +166,14 @@ module.exports = async function CODE(api) {
   if (options.header) {
     header = `\n${options.header}`
   }
+  
+  if (options.trimDeadCode) {
+    if (syntax === 'js' || syntax === 'ts' || syntax === 'javascript' || syntax === 'typescript') {
+      code = stripMultiLineDoubleDashComments(code)
+    } else if (syntax === 'html') {
+      code = stripHTMLComments(code, { multilineOnly: true })
+    }
+  }
 
   return `\`\`\`${syntax}${header}
 ${code}

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,22 @@ 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 stripMultiLineDoubleDashComments(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 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')
@@ -219,6 +233,10 @@ function stripAllComments(block) {
     const newLineCount = (trailingNewLine || '').length
     const trailing = (!trailingText && newLineCount > 1) ? `${trailingNewLine || ''}` : ''
     const leading = (leadingSpace) ? leadingSpace.slice(1) : ''
+
+    if (options.multilineOnly && comment.indexOf('\n') === -1) {
+      continue
+    }
     remove.push(`${leading}${comment}${trailing}`)
   }
   return remove.reduce((acc, curr) => {
@@ -328,6 +346,8 @@ module.exports = {
   dedentString,
   stripComments,
   convertCommentSyntax,
+  stripMultiLineDoubleDashComments,
+  stripHTMLComments,
   // stripCommentBlockJS,
   trimString,
   // future https://github.com/junfengliang/autowrap

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-magic",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "description": "Automatically update markdown files with content from external sources",
   "main": "lib/index.js",
   "bin": {