markdown-magic 4.0.4 → 4.1.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.4",
+  "version": "4.1.0",
   "description": "Automatically update markdown files with content from external sources",
   "main": "src/index.js",
   "bin": {
@@ -22,6 +22,11 @@
     "docs": "node examples/generate-readme.js",
     "test": "uvu . '.test.([mc]js|[jt]sx?)$'",
     "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
+    "bundle": "npm run bundle:all",
+    "bundle:all": "npm run bundle:mac && npm run bundle:linux && npm run bundle:windows",
+    "bundle:mac": "bun build ./cli.js --compile --minify --target=bun-darwin-arm64 --outfile dist/md-magic-darwin-arm64 && bun build ./cli.js --compile --minify --target=bun-darwin-x64 --outfile dist/md-magic-darwin-x64",
+    "bundle:linux": "bun build ./cli.js --compile --minify --target=bun-linux-x64 --outfile dist/md-magic-linux-x64 && bun build ./cli.js --compile --minify --target=bun-linux-arm64 --outfile dist/md-magic-linux-arm64",
+    "bundle:windows": "bun build ./cli.js --compile --minify --target=bun-windows-x64 --outfile dist/md-magic-windows-x64.exe",
     "postpublish": "git push origin && git push origin --tags",
     "release:patch": "pnpm version patch --git-tag-version && pnpm publish",
     "release:minor": "pnpm version minor --git-tag-version && pnpm publish",
@@ -36,9 +41,10 @@
   },
   "dependencies": {
     "@davidwells/md-utils": "0.0.53",
-    "comment-block-parser": "1.1.1",
-    "comment-block-replacer": "0.1.3",
-    "comment-block-transformer": "0.2.2",
+    "color-convert": "^2.0.1",
+    "comment-block-parser": "1.1.2",
+    "comment-block-replacer": "0.1.4",
+    "comment-block-transformer": "0.2.3",
     "globrex": "^0.1.2",
     "gray-matter": "^4.0.3",
     "is-glob": "^4.0.3",
@@ -48,11 +54,10 @@
     "module-alias": "^2.2.3",
     "mri": "^1.2.0",
     "node-fetch": "^2.7.0",
-    "oparser": "^3.0.22",
+    "oparser": "^3.0.24",
     "punycode": "^2.3.1",
     "smart-glob": "^1.0.2",
-    "string-width": "^4.2.3",
-    "sync-request": "^6.1.0"
+    "string-width": "^4.2.3"
   },
   "devDependencies": {
     "concordance": "^5.0.1",
@@ -65,5 +70,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c67e6884103de807711ff608e100e1e0a211c2d8"
+  "gitHead": "4c7432d3518d9c6eac0019df43863ffc5857d417"
 }

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,75 @@ 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')
+}
+
+/**
+ * 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')
@@ -21,6 +93,93 @@ function findSingleDashStrings(arr) {
 }
 
 async function runCli(options = {}, rawArgv) {
+  if (options.help || options.h) {
+    console.log(`
+Usage: md-magic [options] [files...]
+
+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)
+  --pretty           Render output with ANSI styling
+  --dry              Dry run - show what would be changed
+  --debug            Show debug output
+  --help, -h         Show this help message
+  --version, -v      Show version
+
+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.name} v${pkg.version}`)
+    return
+  }
+
+  // Check if first positional arg is markdown content (before stdin check)
+  const firstArg = options._ && options._[0]
+  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,
+    })
+    // TODO future pretty option
+    // if (options.pretty) {
+    //   console.log(await renderMarkdown(result.updatedContents))
+    // } else {
+    //   console.log()
+    //   console.log(result.updatedContents)
+    // }
+    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
+      })
+      // TODO future pretty option
+      // if (options.pretty) {
+      //   console.log(await renderMarkdown(result.updatedContents))
+      // } else {
+      //   console.log()
+      //   console.log(result.updatedContents)
+      // }
+      console.log(result.updatedContents)
+      return
+    }
+  }
+
   let configFile
   let opts = {}
 

package/src/utils/fs.test.js

@@ -39,6 +39,7 @@ test('getGitignoreContents', async () => {
     'yarn-error.log*',
     'test/fixtures/output',
     '_out.md',
+    'dist',
     'misc',
     'misc/**/**.js',
     "__misc",

package/src/utils/remoteRequest.js

@@ -1,28 +1,9 @@
 const fetch = require('node-fetch')
-const request = require('sync-request')
 
 function formatUrl(url = '') {
   return url.match(/^https?:\/\//) ? url : `https://${url}`
 }
 
-function remoteRequestSync(url, settings = {}, srcPath) {
-  let body
-  const finalUrl = formatUrl(url)
-  try {
-    // @ts-expect-error
-    const res = request('GET', finalUrl)
-    body = res.getBody('utf8')
-  } 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
-}
-
 async function remoteRequest(url, settings = {}, srcPath) {
   let body
   const finalUrl = formatUrl(url)
@@ -45,7 +26,6 @@ async function remoteRequest(url, settings = {}, srcPath) {
 }
 
 module.exports = {
-  remoteRequestSync,
   remoteRequest
 }