markdown-magic 3.0.5 → 3.0.7

package/README.md

@@ -273,7 +273,7 @@ Generate table of contents from markdown file
 
 **Example:**
 ```md
-<!-- doc-gen (TOC) -->
+<!-- doc-gen TOC -->
 toc will be generated here
 <!-- end-doc-gen -->
 ```
@@ -299,13 +299,13 @@ Get code from file or URL and put in markdown
 
 **Example:**
 ```md
-<!-- doc-gen (CODE:src=./relative/path/to/code.js) -->
+<!-- doc-gen CODE src="./relative/path/to/code.js" -->
 This content will be dynamically replaced with code from the file
 <!-- end-doc-gen -->
 ```
 
 ```md
- <!-- doc-gen (CODE:src=./relative/path/to/code.js&lines=22-44) -->
+ <!-- doc-gen 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
  <!-- end-doc-gen -->
  ```
@@ -328,7 +328,7 @@ Get local file contents.
 
 **Example:**
 ```md
-<!-- doc-gen (FILE:src=./path/to/file) -->
+<!-- doc-gen FILE src=./path/to/file -->
 This content will be dynamically replaced from the local file
 <!-- end-doc-gen -->
 ```
@@ -351,7 +351,7 @@ Get any remote Data and put in markdown
 
 **Example:**
 ```md
-<!-- doc-gen (REMOTE:url=http://url-to-raw-md-file.md) -->
+<!-- doc-gen REMOTE url=http://url-to-raw-md-file.md -->
 This content will be dynamically replaced from the remote url
 <!-- end-doc-gen -->
 ```
@@ -479,7 +479,6 @@ const config = {
           }).forEach((tag) => {
             const optionalText = tag.isOptional ? ' (optional) ' : ' '
             const defaultValueText = (typeof tag.defaultValue !== 'undefined') ? ` Default: \`${tag.defaultValue}\` ` : ' '
-            console.log('tag', tag)
             table += `| \`${tag.name}\`${optionalText}`
             table += `| \`${tag.type.replace('|', 'or')}\` `
             table += `| ${tag.description.replace(/\.\s?$/, '')}.${defaultValueText}|\n`

package/cli.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 const mri = require('mri')
 const { runCli } = require('./lib/cli')
 const argv = process.argv.slice(2)

package/lib/process-contents.js

@@ -150,6 +150,7 @@ async function processContents(text, config) {
       // console.log('config', config)
 
       // console.log('returnedContent', returnedContent)
+      // process.exit(1)
      
       if (returnedContent) {
         tempContent = returnedContent
@@ -166,6 +167,10 @@ async function processContents(text, config) {
         }
       }
     }, md, afterMiddleware)
+    /*
+    console.log('afterContent', afterContent)
+    process.exit(1)
+    /** */
 
     if (debug) {
       console.log('afterContent', afterContent)
@@ -181,7 +186,11 @@ async function processContents(text, config) {
     // console.log('formattedNewContent', formattedNewContent)
     /* Remove any conflicting imported comments */
     const fix = removeConflictingComments(formattedNewContent, COMMENT_OPEN_REGEX, COMMENT_CLOSE_REGEX)
-    // console.log('fix', fix)
+    /*
+    console.log('fix')
+    deepLog(fix)
+    process.exit(1)
+    /** */
     if (options.removeComments) {
       // console.log('removeComments', options.removeComments)
     }
@@ -194,10 +203,19 @@ async function processContents(text, config) {
     const indent = indentString(fix, preserveIndent)
     const newCont = `${openTag}${indent}${closeTag}`
     /* Replace original contents */
-    const newContents = md.replace(block.value, newCont)
+    // Must use replacer function because strings get coearced to regex or something
+    const newContents = md.replace(block.value, () => newCont)
+    /*
+    deepLog(newContents)
+    process.exit(1)
+    /** */
     return Promise.resolve(newContents)
   }, Promise.resolve(text))
 
+  // console.log('updatedContents')
+  // deepLog(updatedContents)
+  // process.exit(1)
+
   // if (debug) {
   //   console.log('Output Markdown')
   //   console.log(updatedContents)
@@ -245,8 +263,11 @@ async function processContents(text, config) {
     originalContents: text,
     updatedContents,
   }
-  // console.log('result')
-  // deepLog(result)
+  /*
+  console.log('result')
+  deepLog(result)
+  process.exit(1)
+  /** */
   return result
 }
 

package/lib/transforms/code.js

@@ -96,8 +96,11 @@ module.exports = function CODE(api) {
   /* Check for Id */
   if (id) {
     const lines = code.split("\n")
-    const startLine = lines.findIndex(line => line.includes(`CODE_SECTION:${id}:START`)) ?? 0
-    const endLine = lines.findIndex(line => line.includes(`CODE_SECTION:${id}:END`)) ?? lines.length - 1
+    const startLineIndex = lines.findIndex(line => line.includes(`CODE_SECTION:${id}:START`));
+    const startLine = startLineIndex !== -1 ? startLineIndex : 0;
+
+    const endLineIndex = lines.findIndex(line => line.includes(`CODE_SECTION:${id}:END`));
+    const endLine = endLineIndex !== -1 ? endLineIndex : lines.length - 1;
     // console.log('startLine', startLine)
     // console.log('endLineendLine', endLine)
     if (startLine === -1 && endLine === -1) {
@@ -106,7 +109,8 @@ module.exports = function CODE(api) {
   
     const selectedLines = lines.slice(startLine + 1, endLine)
   
-    const trimBy = selectedLines[0]?.match(/^(\s*)/)?.[1]?.length
+    const firstMatch = selectedLines[0] && selectedLines[0].match(/^(\s*)/);
+    const trimBy = firstMatch && firstMatch[1] ? firstMatch[1].length : 0;
     const newValue = `${selectedLines.map(line => line.substring(trimBy).replace(/^\/\/ CODE_SECTION:INCLUDE /g, "")).join("\n")}`
     // console.log('newValue', newValue)
     code = newValue

package/lib/transforms/index.js

@@ -18,7 +18,7 @@ const transforms = {
    *
    * **Example:**
    * ```md
-   * <!-- doc-gen (TOC) -->
+   * <!-- doc-gen TOC -->
    * toc will be generated here
    * <!-- end-doc-gen -->
    * ```
@@ -44,13 +44,13 @@ const transforms = {
    *
    * **Example:**
    * ```md
-   * <!-- doc-gen (CODE:src=./relative/path/to/code.js) -->
+   * <!-- doc-gen CODE src="./relative/path/to/code.js" -->
    * This content will be dynamically replaced with code from the file
    * <!-- end-doc-gen -->
    * ```
    *
    * ```md
-   *  <!-- doc-gen (CODE:src=./relative/path/to/code.js&lines=22-44) -->
+   *  <!-- doc-gen 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
    *  <!-- end-doc-gen -->
    *  ```
@@ -73,7 +73,7 @@ const transforms = {
    *
    * **Example:**
    * ```md
-   * <!-- doc-gen (FILE:src=./path/to/file) -->
+   * <!-- doc-gen FILE src=./path/to/file -->
    * This content will be dynamically replaced from the local file
    * <!-- end-doc-gen -->
    * ```
@@ -96,7 +96,7 @@ const transforms = {
    *
    * **Example:**
    * ```md
-   * <!-- doc-gen (REMOTE:url=http://url-to-raw-md-file.md) -->
+   * <!-- doc-gen REMOTE url=http://url-to-raw-md-file.md -->
    * This content will be dynamically replaced from the remote url
    * <!-- end-doc-gen -->
    * ```

package/package.json

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