markdown-magic 3.6.3 → 3.6.5

package/package.json

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

package/src/index.js

@@ -113,7 +113,7 @@ const defaultOptions = {
   })
  */
 async function markdownMagic(globOrOpts = {}, options = {}) {
-  const hrstart = process.hrtime.bigint()
+  const hrStart = process.hrtime.bigint()
   let opts = options || {}
   let globPat
   if (typeof globOrOpts === 'string' || Array.isArray(globOrOpts)) {
@@ -134,12 +134,13 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     useGitGlob = false, 
     failOnMissingTransforms = false,
     failOnMissingRemote = true,
-    dryRun = false,
     debug = false,
     syntax = 'md',
     silent = false,
   } = opts
 
+  let dryRun = opts.dryRun || opts.dry || opts.plan || false
+
   // @ts-ignore 
   const outputDir = output.directory || opts.outputDir
   const removeComments = output.removeComments || false
@@ -203,19 +204,20 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
   opts.globPattern = globs
 
   logger(LINE)
-  success(` Markdown Magic Starting...`, silent, '✨ ')
+  const dryRunPostFix = (dryRun) ? ' - Dry run' : ''
+  success(` Markdown Magic Starting...${dryRunPostFix}`, silent, '✨ ')
   logger(`${LINE}\n`)
 
-  info(`Searching for comment blocks...`, silent, '🔎 ')
+  info(` Searching for comment blocks...`, silent, '🔎 ')
   logger(`\nSyntax:        ${syntax}`)
   logger(`Block Open:    ${open}`)
   logger(`Block Close:   ${close}`)
   logger(`Searching:    `, globs)
 
   if (dryRun || debug) {
+    logger()
     info(`Glob patterns:`, silent)
     logger(globs)
-    logger()
     /*
     process.exit(1)
     /** */
@@ -360,7 +362,7 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
   const sortedItems = sortedIds.map(id => blocks.find(item => item.id === id)).filter(Boolean);
 
   // topoSort(blocks)
-  const orderedFiles = sortedItems.map((item) => item.id)
+  const orderedFiles = sortedItems.map((block) => block.id)
   // console.log('sortedItems', sortedItems)
   // console.log('orderedFiles', orderedFiles)
 
@@ -465,9 +467,9 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
   }
 
   logger()
-  info(`Available Transforms:`, silent, '🔁 ') 
+  info(` Available Transforms:`, silent, '🔁 ') 
   logger(`\n${Object.keys(useTransforms).join(', ')}\n`)
-  info(`Syntax example:`, silent, '🧱 ') 
+  info(` Syntax example:`, silent, '🧱 ') 
   logger()
   logCommentBlockSyntax({
     syntax: syntax,
@@ -551,7 +553,7 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
       results: plan
     }
   } else  {
-    info(`Parse results:`, silent, "🟢 ")
+    info(` Parse results:`, silent, "🟢 ")
     const total = planTotal + missingTotal
     logger()
     logger(`Total transforms:        ${total}`)
@@ -576,11 +578,11 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     // logger('\nStats:')
 
     if (planOutput.length) {
-      info(`Execution plan:`, silent, "📑 ")
+      info(` Execution plan:`, silent, "📑 ")
       logger()
       logger(planOutput.join('\n'))
     } else {
-      info(`Execution plan:`, silent, "📑 ")
+      info(` Execution plan:`, silent, "📑 ")
       logger('\nNo transforms to run. Exiting markdown magic early.')
       logger('If you think this is incorrect, verify your comment blocks in your src and the settings in your config.')
     }
@@ -674,8 +676,17 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
   process.exit(1)
   /** */
   logger()
-  info(`Results:`, silent, "💫 ")
 
+  if (dryRun) {
+    logger('Dry run complete. Exiting markdown magic early.')
+    return {
+      errors,
+      filesChanged: [],
+      results: plan
+    }
+  }
+  
+  info(` Results:`, silent, "💫 ")
   /*
   TODO:
     - Output to new file
@@ -686,14 +697,14 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     logErrors(errors)
   }
 
-  const elasped = convertHrtime(process.hrtime.bigint() - hrstart)
+  const elapsed = convertHrtime(process.hrtime.bigint() - hrStart)
 
   logger()
   logger(`${LINE}`)
-  success(`Markdown Magic Done. ${elasped.seconds} seconds`, silent)
+  success(`Markdown Magic Done. ${elapsed.seconds} seconds`, silent)
   logger(`${LINE}`)
   return {
-    // @TODO maybe seperate changed and output files
+    // @TODO maybe separate changed and output files
     filesChanged: plan.filter(({ isChanged, isNewPath }) => isChanged || isNewPath).map(({ outputPath }) => outputPath),
     results: plan,
     errors,

package/src/transforms/install.js

@@ -24,7 +24,6 @@ const path = require('path')
  * @return {string} Updated content to place in the content block
  */
 function install(api) {
-  console.log('INSTALL API', api)
   const { options } = api
   const { isDev = false } = options
   let packageName = options.packageName