markdown-magic 4.0.5 → 4.2.0

package/cli.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "markdown-magic",
-  "version": "4.0.5",
+  "version": "4.2.0",
   "description": "Automatically update markdown files with content from external sources",
   "main": "src/index.js",
   "bin": {
@@ -42,9 +42,9 @@
   "dependencies": {
     "@davidwells/md-utils": "0.0.53",
     "color-convert": "^2.0.1",
-    "comment-block-parser": "1.1.2",
-    "comment-block-replacer": "0.1.4",
-    "comment-block-transformer": "0.2.3",
+    "comment-block-parser": "1.1.3",
+    "comment-block-replacer": "0.1.5",
+    "comment-block-transformer": "0.2.4",
     "globrex": "^0.1.2",
     "gray-matter": "^4.0.3",
     "is-glob": "^4.0.3",
@@ -70,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7d81950b7a6d27d1192b1bc2d0f19d1d5ff0f321"
+  "gitHead": "966eb812a9044c8bcf7d5caf04a860dade0506af"
 }

package/src/cli-run.js

@@ -1,8 +1,11 @@
 const path = require('path')
+const fs = require('fs')
 const { loadConfig } = require('./utils/load-config')
 const { findUp } = require('./utils/fs')
 const { markdownMagic } = require('./')
+const { processFile } = require('comment-block-replacer')
 const { parse } = require('oparser')
+const defaultTransforms = require('./transforms')
 const { getGlobGroupsFromArgs } = require('./globparse')
 // const { deepLog } = require('./utils/logs')
 // const { uxParse } = require('./argparse/argparse')
@@ -10,6 +13,87 @@ const argv = process.argv.slice(2)
 const cwd = process.cwd()
 const defaultConfigPath = 'md.config.js'
 
+/**
+ * Render markdown with ANSI styling for terminal output
+ * @param {string} content
+ */
+// async function renderMarkdown(content) {
+//   const { render, themes } = await import('markdansi')
+//   const githubDark = {
+//     ...themes.default,
+//     heading: { color: 'white', bold: true },
+//     strong: { bold: true },
+//     emph: { italic: true },
+//     inlineCode: { color: 'yellow' },
+//     blockCode: { color: 'white' },
+//     link: { color: 'cyan', underline: true },
+//     quote: { color: 'gray', italic: true },
+//     hr: { color: 'gray', dim: true },
+//     listMarker: { color: 'blue' },
+//     tableHeader: { color: 'white', bold: true },
+//     tableCell: { color: 'white' },
+//   }
+//   return render(content, { theme: githubDark })
+// }
+
+/**
+ * Read all data from stdin
+ * @returns {Promise<string>}
+ */
+function readStdin() {
+  return new Promise((resolve, reject) => {
+    let data = ''
+    process.stdin.setEncoding('utf8')
+    process.stdin.on('data', chunk => data += chunk)
+    process.stdin.on('end', () => resolve(data))
+    process.stdin.on('error', reject)
+  })
+}
+
+/**
+ * Interpret escape sequences in string (e.g., \n -> newline)
+ * @param {string} str
+ * @returns {string}
+ */
+function interpretEscapes(str) {
+  if (!str) return str
+  return str.replace(/\\n/g, '\n').replace(/\\t/g, '\t')
+}
+
+/**
+ * JSON.stringify replacer that handles RegExp objects
+ * @param {string} key
+ * @param {any} value
+ */
+function jsonReplacer(key, value) {
+  if (value instanceof RegExp) {
+    return value.toString()
+  }
+  return value
+}
+
+/**
+ * Check if string looks like markdown content vs a file path
+ * @param {string} str
+ * @returns {boolean}
+ */
+function isMarkdownContent(str) {
+  if (!str) return false
+  // Has newlines (real or escaped) = likely content
+  if (str.includes('\n') || str.includes('\\n')) return true
+  // Has markdown comment blocks = likely content
+  if (str.includes('<!--')) return true
+  // Check if file exists
+  try {
+    if (fs.existsSync(str)) return false
+  } catch (e) {
+    // ignore
+  }
+  // Has markdown heading at start = likely content
+  if (str.startsWith('#')) return true
+  return false
+}
+
 async function getBaseDir(opts = {}) {
   const { currentDir = cwd } = opts
   const gitDir = await findUp(currentDir, '.git')
@@ -29,6 +113,10 @@ Options:
   --files, --file    Files or glob patterns to process
   --config           Path to config file (default: md.config.js)
   --output           Output directory
+  --open             Opening comment keyword (default: docs)
+  --close            Closing comment keyword (default: /docs)
+  --json             Output full result as JSON
+  --pretty           Render output with ANSI styling
   --dry              Dry run - show what would be changed
   --debug            Show debug output
   --help, -h         Show this help message
@@ -38,16 +126,73 @@ Examples:
   md-magic README.md
   md-magic --files "**/*.md"
   md-magic --config ./my-config.js
+
+Stdin/stdout mode:
+  cat file.md | md-magic
+  echo "<!-- docs TOC --><!-- /docs -->" | md-magic
+  md-magic "# Title\\n<!-- docs TOC --><!-- /docs -->"
 `)
     return
   }
 
   if (options.version || options.v) {
+    // @ts-ignore
     const pkg = require('../package.json')
-    console.log(pkg.version)
+    console.log(`${pkg.name} v${pkg.version}`)
     return
   }
 
+  // Check if first positional arg is markdown content (before stdin check)
+  // Handle case where mri assigns content to a flag (e.g., --json '# content')
+  let firstArg = options._ && options._[0]
+  const outputJson = options.json === true || (typeof options.json === 'string' && isMarkdownContent(options.json))
+  if (typeof options.json === 'string' && isMarkdownContent(options.json)) {
+    firstArg = options.json
+  }
+  const openKeyword = options.open || 'docs'
+  const closeKeyword = options.close || (options.open && options.open !== 'docs' ? `/${options.open}` : '/docs')
+  if (firstArg && isMarkdownContent(firstArg)) {
+    const content = interpretEscapes(firstArg)
+    const result = await processFile({
+      content,
+      syntax: 'md',
+      open: openKeyword,
+      close: closeKeyword,
+      transforms: defaultTransforms,
+      dryRun: true,
+    })
+    console.log('result', result)
+    if (outputJson) {
+      console.log(JSON.stringify(result, jsonReplacer, 2))
+    } else {
+      console.log(result.updatedContents)
+    }
+    return
+  }
+
+  // Check for stdin pipe (when no positional file args provided)
+  const hasNoFileArgs = !options._ || options._.length === 0
+  const hasPipedInput = !process.stdin.isTTY && hasNoFileArgs
+  if (hasPipedInput) {
+    const content = await readStdin()
+    if (content.trim()) {
+      const result = await processFile({
+        content,
+        syntax: 'md',
+        open: openKeyword,
+        close: closeKeyword,
+        transforms: defaultTransforms,
+        dryRun: true, // Don't write files
+      })
+      if (outputJson) {
+        console.log(JSON.stringify(result, jsonReplacer, 2))
+      } else {
+        console.log(result.updatedContents)
+      }
+      return
+    }
+  }
+
   let configFile
   let opts = {}
 

package/src/index.js

@@ -13,7 +13,7 @@ const remoteTransform = require('./transforms/remote')
 const installTransform = require('./transforms/install')
 const { getSyntaxInfo } = require('./utils/syntax')
 const { onlyUnique, getCodeLocation, pluralize } = require('./utils')
-const { readFile, resolveOutputPath, resolveFlatPath } = require('./utils/fs')
+const { readFile, resolveOutputPath, resolveFlatPath, hasIgnoreFile } = require('./utils/fs')
 const stringBreak = require('./utils/string-break')
 const { processFile } = require('comment-block-replacer')
 const { blockTransformer } = require('comment-block-transformer')
@@ -257,7 +257,10 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
 
   let files = []
   try {
-    files = (await Promise.all(pathsPromise)).flat().filter(onlyUnique)
+    files = (await Promise.all(pathsPromise))
+      .flat()
+      .filter(onlyUnique)
+      .filter((f) => !hasIgnoreFile(f))
     // opts.files = files
   } catch (e) {
     // console.log(e.message)
@@ -541,12 +544,16 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     let planMsg = `${count} Found ${transformsToRun.length} transforms in ${item.srcPath}`
     planTotal = planTotal + transformsToRun.length
     // logger(`Found ${transformsToRun.length} transforms in ${item.srcPath}`)
+    const maxPrefixLen = Math.max(...transformsToRun.map((t) => {
+      return `"${t.transform}" on line ${t.lines[0]}`.length
+    }))
     transformsToRun.forEach((trn) => {
       const line = trn.lines[0]
+      const prefix = `"${trn.transform}" on line ${line}`
+      const paddedPrefix = prefix.padEnd(maxPrefixLen)
       const location = getCodeLocation(item.srcPath, line)
-      const planData = `      - "${trn.transform}" at line ${line} → ${location}`
+      const planData = `      - ${paddedPrefix}  →  ${location}`
       planMsg += `\n${planData}`
-      // logger(` - "${trn.transform}" at line ${trn.lines[0]}`)
     })
     const newLine = plan.length !== i + 1 ? '\n' : ''
     return `${planMsg}${newLine}`

package/src/transforms/code/index.js

@@ -91,8 +91,9 @@ module.exports = async function CODE(api) {
         if (src === './relative/path/to/code.js') {
           return api.content
         } else {
-          console.log(`FILE NOT FOUND ${codeFilePath}`)
-          throw e
+          const err = new Error(`FILE NOT FOUND: ${codeFilePath}\n  Referenced in: ${srcPath}\n  src="${src}"`)
+          err.code = 'ENOENT'
+          throw err
         }
       }
     }

package/src/transforms/file.js

@@ -23,8 +23,15 @@ module.exports = function FILE(api) {
       if (options.src === './path/to/file') {
         return api.content
       }
-      console.log(`FILE NOT FOUND ${resolvedFilePath}`)
-      throw e
+      const err = new Error(`FILE NOT FOUND: ${resolvedFilePath}
+      
+Referenced in: ${srcPath}
+
+Via the "src" attribute: src="${options.src}"
+
+`)
+      err.code = 'ENOENT'
+      throw err
     }
   }
 

package/src/utils/fs.js

@@ -192,11 +192,34 @@ function isLocalPath(filePath) {
   return _isLocalPath(filePath)
 }
 
+const fsSync = require('fs')
+
+/**
+ * Check if file's directory or any parent has .md-ignore
+ * @param {string} filePath - Absolute path to file
+ * @returns {boolean} True if should be ignored
+ */
+function hasIgnoreFile(filePath) {
+  let dir = dirname(filePath)
+  const root = resolve('/')
+  while (dir !== root) {
+    const ignoreFile = join(dir, '.md-ignore')
+    if (fsSync.existsSync(ignoreFile)) {
+      return true
+    }
+    const parent = dirname(dir)
+    if (parent === dir) break
+    dir = parent
+  }
+  return false
+}
+
 module.exports = {
   isLocalPath,
   writeFile,
-  readFile, 
+  readFile,
   findUp,
+  hasIgnoreFile,
   resolveOutputPath,
   resolveFlatPath,
   resolveCommonParent,