markdown-magic 3.6.5 → 4.0.0

package/cli.js

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

package/package.json

@@ -1,41 +1,21 @@
 {
   "name": "markdown-magic",
-  "version": "3.6.5",
+  "version": "4.0.0",
   "description": "Automatically update markdown files with content from external sources",
-  "main": "src/index.js",
+  "main": "index.js",
   "bin": {
     "markdown": "./cli.js",
     "md-magic": "./cli.js",
     "mdm": "./cli.js"
   },
+  "types": "types/index.d.ts",
   "files": [
     "README.md",
     "package.json",
     "package-lock.json",
-    "cli.js",
-    "src"
+    "src",
+    "cli.js"
   ],
-  "scripts": {
-    "types": "tsc",
-    "emit-types": "tsc --noEmit false --emitDeclarationOnly true",
-    "docs": "node examples/generate-readme.js",
-    "test": "npm run test:src && npm run test:test && echo 'tests done'",
-    "test:src": "uvu src '.test.([mc]js|[jt]sx?)$'",
-    "test:test": "uvu test '.test.([mc]js|[jt]sx?)$'",
-    "test:block": "uvu src 'block-parser.test.([mc]js|[jt]sx?)$'",
-    "test:cli": "uvu src 'cli.test.([mc]js|[jt]sx?)$'",
-    "test:md": "uvu src 'md.test.([mc]js|[jt]sx?)$'",
-    "test:fs": "uvu src 'fs.test.([mc]js|[jt]sx?)$'",
-    "test:js": "uvu src 'block-parser-js.test.([mc]js|[jt]sx?)$'",
-    "test:errors": "uvu test 'errors.test.([mc]js|[jt]sx?)$'",
-    "test:transforms": "uvu test 'transforms.test.([mc]js|[jt]sx?)$'",
-    "test:text": "uvu src 'text.test.([mc]js|[jt]sx?)$'",
-    "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
-    "publish": "git push origin && git push origin --tags",
-    "release:patch": "npm version patch && npm publish",
-    "release:minor": "npm version minor && npm publish",
-    "release:major": "npm version major && npm publish"
-  },
   "author": "David Wells",
   "license": "MIT",
   "homepage": "https://github.com/DavidWells/markdown-magic#readme",
@@ -44,7 +24,7 @@
     "url": "https://github.com/DavidWells/markdown-magic"
   },
   "dependencies": {
-    "@davidwells/md-utils": "0.0.52",
+    "@davidwells/md-utils": "0.0.53",
     "globrex": "^0.1.2",
     "gray-matter": "^4.0.3",
     "is-glob": "^4.0.3",
@@ -58,7 +38,10 @@
     "punycode": "^2.3.1",
     "smart-glob": "^1.0.2",
     "string-width": "^4.2.3",
-    "sync-request": "^6.1.0"
+    "sync-request": "^6.1.0",
+    "comment-block-transformer": "0.1.1",
+    "comment-block-replacer": "0.1.0",
+    "comment-block-parser": "1.0.7"
   },
   "devDependencies": {
     "ansi-styles": "^4.2.1",
@@ -68,5 +51,17 @@
     "safe-chalk": "^1.0.0",
     "typescript": "^5.0.2",
     "uvu": "^0.5.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "types": "tsc --emitDeclarationOnly --outDir types",
+    "docs": "node examples/generate-readme.js",
+    "test": "uvu . '.test.([mc]js|[jt]sx?)$'",
+    "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
+    "release:patch": "pnpm publish --version patch && git push origin && git push origin --tags",
+    "release:minor": "pnpm publish --version minor && git push origin && git push origin --tags",
+    "release:major": "pnpm publish --version major && git push origin && git push origin --tags"
   }
-}
+}

package/src/{cli.test.js → cli-run.test.js}

@@ -1,7 +1,7 @@
 const { test } = require('uvu') 
 const assert = require('uvu/assert')
 const { deepLog } = require('./utils/logs')
-const { getGlobGroupsFromArgs, runCli } = require('./cli')
+const { getGlobGroupsFromArgs, runCli } = require('./cli-run')
 
 const DEBUG = true
 const logger = (DEBUG) ? console.log : () => {}

package/src/defaults.js

@@ -1,7 +1,7 @@
 
 const SYNTAX = 'md'
-const OPEN_WORD = 'doc-gen'
-const CLOSE_WORD = 'end-doc-gen'
+const OPEN_WORD = 'docs'
+const CLOSE_WORD = '/docs'
 const DEFAULT_GLOB_PATTERN = '**/**.md'
 
 module.exports = {

package/src/index.js

@@ -1,10 +1,11 @@
 const path = require('path')
 // @TODO remove this once we have swapped out node-fetch@2.7
-const moduleAlias = require('module-alias') // "Fix" for puncode dep warning in node 22+
-moduleAlias.addAlias('punycode', 'punycode/') // "Fix" for puncode dep warning in node 22+
+const moduleAlias = require('module-alias') // "Fix" for punycode dep warning in node 22+
+moduleAlias.addAlias('punycode', 'punycode/') // "Fix" for punycode dep warning in node 22+
 const { glob, globWithGit } = require('smart-glob')
 const codeTransform = require('./transforms/code')
 const fileTransform = require('./transforms/file')
+const fileTreeTransform = require('./transforms/fileTree')
 const tocTransform = require('./transforms/toc')
 const sectionTocTransform = require('./transforms/sectionToc')
 const wordCountTransform = require('./transforms/wordCount')
@@ -14,15 +15,15 @@ const { getSyntaxInfo } = require('./utils/syntax')
 const { onlyUnique, getCodeLocation, pluralize } = require('./utils')
 const { readFile, resolveOutputPath, resolveFlatPath } = require('./utils/fs')
 const stringBreak = require('./utils/string-break')
-const { processFile } = require('./process-file')
-const { processContents } = require('./process-contents')
+const { processFile } = require('comment-block-replacer')
+const { blockTransformer } = require('comment-block-transformer')
 const { parseMarkdown } = require('@davidwells/md-utils')
 const { success, error, info, convertHrtime, deepLog } = require('./utils/logs')
 const { OPEN_WORD, CLOSE_WORD, DEFAULT_GLOB_PATTERN } = require('./defaults')
-const { getBlockRegex, parseBlocks } = require('./block-parser')
+const { getBlockRegex, parseBlocks } = require('comment-block-parser')
 const toposort = require('./utils/toposort')
 // const { hashFile } = require('./utils/hash-file')
-// const { getBlockRegex } = require('./block-parser')
+// const { getBlockRegex } = require('comment-block-parser')
 // const diff = require('../misc/old-test/utils/diff')
 
 // old https://raw.githubusercontent.com/DavidWells/markdown-magic/add-package-scripts-plugin/index.js
@@ -32,6 +33,7 @@ const LINE = '──────────────────────
 const defaultTransforms = {
   CODE: codeTransform,
   FILE: fileTransform,
+  fileTree: fileTreeTransform,
   TOC: tocTransform,
   sectionToc: sectionTocTransform,
   wordCount: wordCountTransform,
@@ -44,16 +46,20 @@ const defaultOptions = {
   failOnMissingRemote: true,
 }
 
-/**!
+/**
  * Allowed file syntaxes
  * @typedef {'md' | 'js' | 'yml' | 'yaml'} SyntaxType
  */
 
-/**!
+/**
  * Path to file, files or Glob string or Glob Array
  * @typedef {string|Array<string>} FilePathsOrGlobs
  */
 
+/**
+ * @typedef {import('comment-block-replacer').ProcessFileOptions} ProcessFileOptions
+ */
+
 /**
  * Configuration for markdown magic
  * 
@@ -61,20 +67,21 @@ const defaultOptions = {
  * 
  * @typedef {object} MarkdownMagicOptions
  * @property {FilePathsOrGlobs} [files] - Files to process.
- * @property {Array} [transforms = defaultTransforms] - Custom commands to transform block contents, see transforms & custom transforms sections below.
- * @property {OutputConfig} [output] - Output configuration
+ * @property {Object} [transforms = defaultTransforms] - Custom commands to transform block contents, see transforms & custom transforms sections below.
+ * @property {OutputConfig|string} [output] - Output configuration object or directory path
  * @property {SyntaxType} [syntax = 'md'] - Syntax to parse
- * @property {string} [open = 'doc-gen'] - Opening match word
- * @property {string} [close = 'end-doc-gen'] - Closing match word. If not defined will be same as opening word.
- * @property {string} [cwd = process.cwd() ] - Current working directory. Default process.cwd()
+ * @property {string}  [open = 'docs'] - Opening match word. Default is 'docs'.
+ * @property {string}  [close = '/docs'] - Closing match word. Default is '/docs'. If not defined will be same as opening word with closing slash added.
+ * @property {string}  [cwd = process.cwd() ] - Current working directory. Default process.cwd()
  * @property {boolean} [outputFlatten] - Flatten files that are output
  * @property {boolean} [useGitGlob] - Use git glob for LARGE file directories
- * @property {boolean} [dryRun = false] - See planned execution of matched blocks
+ * @property {boolean} [dry = false] - See planned execution of matched blocks
  * @property {boolean} [debug = false] - See debug details
  * @property {boolean} [silent = false] - Silence all console output
  * @property {boolean} [applyTransformsToSource = true] - Apply transforms to source file. Default is true.
  * @property {boolean} [failOnMissingTransforms = false] - Fail if transform functions are missing. Default skip blocks.
  * @property {boolean} [failOnMissingRemote = true] - Fail if remote file is missing.
+ * @property {string}  [outputDir] - Deprecated: Use `output` instead. Output directory path.
  */
 
 /**
@@ -128,7 +135,7 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
   const {
     transforms,
     // open,
-    /** lol @type {OutputConfig} */
+    /** @type {OutputConfig} */
     output = {},
     outputFlatten = false,
     useGitGlob = false, 
@@ -138,8 +145,9 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     syntax = 'md',
     silent = false,
   } = opts
-
-  let dryRun = opts.dryRun || opts.dry || opts.plan || false
+  
+  // @ts-ignore
+  let dryRun = opts.dry || opts.dryRun || opts.plan || false
 
   // @ts-ignore 
   const outputDir = output.directory || opts.outputDir
@@ -495,8 +503,8 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
       const issues = item.missingTransforms.map((trn) => {
         // logger('trn', trn)
         // const rowData = getRowAndColumnFromCharPos(item.updatedContents, trn.open.start)
-        const location = `${item.srcPath}:${trn.block.lines[0]}:0`
-        const message = `Transform "${trn.transform}" at line ${trn.block.lines[0]} does not exist. → ${location}`
+        const location = `${item.srcPath}:${trn.lines[0]}:0`
+        const message = `Transform "${trn.transform}" at line ${trn.lines[0]} does not exist. → ${location}`
         return {
           message,
           location
@@ -533,11 +541,11 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     planTotal = planTotal + transformsToRun.length
     // logger(`Found ${transformsToRun.length} transforms in ${item.srcPath}`)
     transformsToRun.forEach((trn) => {
-      const line = trn.block.lines[0]
+      const line = trn.lines[0]
       const location = getCodeLocation(item.srcPath, line)
       const planData = `      - "${trn.transform}" at line ${line} → ${location}`
       planMsg += `\n${planData}`
-      // logger(` - "${trn.transform}" at line ${trn.block.lines[0]}`)
+      // logger(` - "${trn.transform}" at line ${trn.lines[0]}`)
     })
     const newLine = plan.length !== i + 1 ? '\n' : ''
     return `${planMsg}${newLine}`
@@ -761,7 +769,7 @@ const stringUtils = {
 module.exports = {
   markdownMagic,
   parseMarkdown,
-  processContents,
+  blockTransformer,
   processFile,
   stringUtils
 }

package/src/index.test.js

@@ -1,10 +1,10 @@
 const { test } = require('uvu') 
 const assert = require('uvu/assert')
-const { markdownMagic, processContents, processFile } = require('./')
+const { markdownMagic, blockTransformer, processFile } = require('./')
 
 test('Main API', () => {
   assert.equal(typeof markdownMagic, 'function')
-  assert.equal(typeof processContents, 'function')
+  assert.equal(typeof blockTransformer, 'function')
   assert.equal(typeof processFile, 'function')
 })