markdown-magic 3.2.0 → 3.3.1

package/lib/globparse.test.js

@@ -0,0 +1,412 @@
+const { test } = require('uvu') 
+const assert = require('uvu/assert')
+const { deepLog } = require('./utils/logs')
+const { getGlobGroupsFromArgs } = require('./globparse')
+
+const DEBUG = true
+const logger = (DEBUG) ? console.log : () => {}
+const deepLogger = (DEBUG) ? deepLog : () => {}
+
+function logInput(rawArgs) {
+  logger('\n───────────────────────')
+  logger('Input:')
+  logger(rawArgs.join(" "))
+  logger('───────────────────────\n')
+}
+
+test('test 1', () => {
+  const rawArgv = [ 'whatever=[uno]', 'nice', '-f', 'no', 'word', '=', '{ foo: bar }' ] 
+  const globData = getGlobGroupsFromArgs(rawArgv)
+  //*
+  logInput(rawArgv)
+  deepLogger(globData)
+})
+
+const longArgs = [
+  'test/fixtures/md/basic.md',
+  'test/fixtures/md/error-missing-transforms-two.md',
+  'test/fixtures/md/error-missing-transforms.md',
+  'test/fixtures/md/error-no-block-transform-defined.md',
+  'test/fixtures/md/error-unbalanced.md',
+  'test/fixtures/md/format-inline.md',
+  'test/fixtures/md/format-with-wacky-indentation.md',
+  'test/fixtures/md/inline-two.md',
+  'test/fixtures/md/inline.md',
+  'test/fixtures/md/missing-transform.md',
+  'test/fixtures/md/mixed.md',
+  'test/fixtures/md/no-transforms.md',
+  'test/fixtures/md/string.md',
+  'test/fixtures/md/syntax-legacy-colon.md',
+  'test/fixtures/md/syntax-legacy-query.md',
+  'test/fixtures/md/transform-code.md',
+  'test/fixtures/md/transform-custom.md',
+  'test/fixtures/md/transform-file.md',
+  'test/fixtures/md/transform-remote.md',
+  'test/fixtures/md/transform-toc.md',
+  'test/fixtures/md/transform-wordCount.md',
+  'debug',
+  '--transform',
+  'test/fixtures/md/transform-code.md',
+  'test/fixtures/md/transform-custom.md',
+  'test/fixtures/md/transform-file.md',
+  'test/fixtures/md/transform-remote.md',
+  'test/fixtures/md/transform-toc.md',
+  'test/fixtures/md/transform-wordCount.md',
+  '1233535235',
+  '=',
+  'hahah',
+  'funky=hi',
+  '--ignore',
+  'test/fixtures/output/basic.md',
+  'test/fixtures/output/block-no-transform.md',
+  'test/fixtures/output/error-missing-transforms-two.md',
+  'test/fixtures/output/error-missing-transforms.md',
+  'test/fixtures/output/fixture-code.md',
+  'test/fixtures/output/format-inline.md',
+  'test/fixtures/output/format-with-wacky-indentation.md',
+  'test/fixtures/output/go-simple.md',
+  'test/fixtures/output/inline-two.md',
+  'test/fixtures/output/inline.md',
+  'test/fixtures/output/missing-transform.md',
+  'test/fixtures/output/mixed.md',
+  'test/fixtures/output/params.md',
+  'test/fixtures/output/remote.md',
+  'test/fixtures/output/toc.md',
+  'test/fixtures/output/transform-code.md',
+  'test/fixtures/output/transform-custom.md',
+  'test/fixtures/output/transform-file.md',
+  'test/fixtures/output/transform-remote.md',
+  'test/fixtures/output/transform-toc.md',
+  'test/fixtures/output/transform-wordCount.md',
+  'test/fixtures/output/with-wacky-indentation.md',
+  '--lol',
+  '--whatever',
+  'test/fixtures/md/syntax-legacy-colon.md',
+  'test/fixtures/md/syntax-legacy-query.md',
+  '--foo=bar',
+  '--fun',
+  'lol.md',
+  'what=no.md',
+  'x',
+  'xno.md',
+  'what'
+]
+
+test('getGlobGroupsFromArgs returns globs', () => {
+  /* CLI command with list of files already passed in
+node ./cli.js test/fixtures/md/**.md debug --transform test/fixtures/md/transform-**.md 1233535235 = hahah funky=hi --ignore test/fixtures/output/**.md --lol --whatever test/fixtures/md/syntax-**.md --foo=bar --fun lol.md what=no.md x 'xno.md' what
+  */
+  const globData = getGlobGroupsFromArgs(longArgs)
+  //*
+  logInput(longArgs)
+  deepLogger(globData)
+  /** */
+  assert.equal(globData.globGroups, [
+    {
+      key: '',
+      rawKey: '',
+      values: [
+        'test/fixtures/md/basic.md',
+        'test/fixtures/md/error-missing-transforms-two.md',
+        'test/fixtures/md/error-missing-transforms.md',
+        'test/fixtures/md/error-no-block-transform-defined.md',
+        'test/fixtures/md/error-unbalanced.md',
+        'test/fixtures/md/format-inline.md',
+        'test/fixtures/md/format-with-wacky-indentation.md',
+        'test/fixtures/md/inline-two.md',
+        'test/fixtures/md/inline.md',
+        'test/fixtures/md/missing-transform.md',
+        'test/fixtures/md/mixed.md',
+        'test/fixtures/md/no-transforms.md',
+        'test/fixtures/md/string.md',
+        'test/fixtures/md/syntax-legacy-colon.md',
+        'test/fixtures/md/syntax-legacy-query.md',
+        'test/fixtures/md/transform-code.md',
+        'test/fixtures/md/transform-custom.md',
+        'test/fixtures/md/transform-file.md',
+        'test/fixtures/md/transform-remote.md',
+        'test/fixtures/md/transform-toc.md',
+        'test/fixtures/md/transform-wordCount.md'
+      ]
+    },
+    {
+      key: 'transform',
+      rawKey: '--transform',
+      values: [
+        'test/fixtures/md/transform-code.md',
+        'test/fixtures/md/transform-custom.md',
+        'test/fixtures/md/transform-file.md',
+        'test/fixtures/md/transform-remote.md',
+        'test/fixtures/md/transform-toc.md',
+        'test/fixtures/md/transform-wordCount.md'
+      ]
+    },
+    {
+      key: 'ignore',
+      rawKey: '--ignore',
+      values: [
+        'test/fixtures/output/basic.md',
+        'test/fixtures/output/block-no-transform.md',
+        'test/fixtures/output/error-missing-transforms-two.md',
+        'test/fixtures/output/error-missing-transforms.md',
+        'test/fixtures/output/fixture-code.md',
+        'test/fixtures/output/format-inline.md',
+        'test/fixtures/output/format-with-wacky-indentation.md',
+        'test/fixtures/output/go-simple.md',
+        'test/fixtures/output/inline-two.md',
+        'test/fixtures/output/inline.md',
+        'test/fixtures/output/missing-transform.md',
+        'test/fixtures/output/mixed.md',
+        'test/fixtures/output/params.md',
+        'test/fixtures/output/remote.md',
+        'test/fixtures/output/toc.md',
+        'test/fixtures/output/transform-code.md',
+        'test/fixtures/output/transform-custom.md',
+        'test/fixtures/output/transform-file.md',
+        'test/fixtures/output/transform-remote.md',
+        'test/fixtures/output/transform-toc.md',
+        'test/fixtures/output/transform-wordCount.md',
+        'test/fixtures/output/with-wacky-indentation.md'
+      ]
+    },
+    {
+      key: 'whatever',
+      rawKey: '--whatever',
+      values: [
+        'test/fixtures/md/syntax-legacy-colon.md',
+        'test/fixtures/md/syntax-legacy-query.md'
+      ]
+    },
+    { key: 'fun', rawKey: '--fun', values: [ 'lol.md' ] }
+  ])
+})
+
+test('test 2', () => {
+  /* CLI command with list of files already passed in
+    node ./cli.js --file '**.md' 'funky**.md' billy --foo 'bar*123'  
+  */
+  const rawArgv = [ '--file', '**.md', 'funky**.md', 'billy', '--foo', 'bar*123' ]
+
+  logger(rawArgv.join(" "))
+
+  const globData = getGlobGroupsFromArgs(rawArgv, {
+    globKeys: ['file']
+  })
+  //*
+  deepLogger(globData)
+  /** */
+  assert.equal(globData, {
+    globGroups: [ { key: 'file', rawKey: '--file', values: [ '**.md', 'funky**.md' ] } ],
+    otherOpts: [ 'billy', '--foo', 'bar*123' ]
+  })
+})
+
+test('Handles multiple string values and groups them', () => {
+  /* CLI command with list of files already passed in
+    node ./cli.js 'test/fixtures/md/bar.md' 'test/fixtures/output/foo.md'
+  */
+  const rawArgv = [ 'test/fixtures/md/bar.md', 'test/fixtures/output/foo.md' ]
+
+  const globData = getGlobGroupsFromArgs(rawArgv)
+  //*
+  logInput(rawArgv)
+  deepLogger(globData)
+  /** */
+  assert.equal(globData, {
+    globGroups: [
+      {
+        key: '',
+        rawKey: '',
+        values: [ 'test/fixtures/md/bar.md', 'test/fixtures/output/foo.md' ]
+      }
+    ],
+    otherOpts: []
+  })
+})
+
+test('Handles multiple string GLOB values and groups them', () => {
+  /* CLI command with list of files already passed in
+    node ./cli.js 'test/fixtures/md/**.md' 'test/fixtures/output/**.md'
+  */
+  const rawArgv = [ 'test/fixtures/md/**.md', 'test/fixtures/output/**.md' ]
+
+  const globData = getGlobGroupsFromArgs(rawArgv)
+  //*
+  logInput(rawArgv)
+  deepLogger(globData)
+  /** */
+  assert.equal(globData, {
+    globGroups: [
+      {
+        key: '',
+        rawKey: '',
+        values: [ 'test/fixtures/md/**.md', 'test/fixtures/output/**.md' ]
+      }
+    ],
+    otherOpts: []
+  })
+})
+
+
+test('Handles globKey set with multiple file/glob like values supplied afterwards', () => {
+  /* CLI command with list of files already passed in
+    node ./cli.js --file 'foobar.md' "funktown/bar.md" '**.md' 'funky**.md' billy --foo 'bar*123'
+  */
+  const rawArgv = [
+    '--file',
+    'foobar.md',
+    'funktown/bar.md',
+    '**.md',
+    'funky**.md',
+    'billy',
+    '--foo',
+    'bar*123'
+  ]
+
+  logger(rawArgv.join(" "))
+
+  const globData = getGlobGroupsFromArgs(rawArgv, {
+    globKeys: ['file']
+  })
+  //*
+  logInput(rawArgv)
+  deepLogger(globData)
+  /** */
+  assert.equal(globData, {
+    globGroups: [ { key: 'file', rawKey: '--file', values: [ 
+      'foobar.md',
+      'funktown/bar.md',
+      '**.md', 
+      'funky**.md' 
+    ] 
+    } 
+    ],
+    otherOpts: [ 'billy', '--foo', 'bar*123' ]
+  })
+})
+
+test('Handles mixed strings, glob strings, array strings, and regex strings', () => {
+  /* CLI command with list of files already passed in
+node ./cli.js --file 'test/fixtures/md/**.md' 'test/fixtures/output/**.md' '[foo.md, bar.whatever.md, /patter.md/]'
+*/
+  const rawArgv = [
+    '--file',
+    'funktown/bar.md',
+    'test/fixtures/md/**.md',
+    'test/fixtures/output/**.md',
+    '[foo.md, bar.whatever.md, /patter.md/]',
+    '/funk.md/'
+  ]
+
+  logger(rawArgv.join(" "))
+
+  const globData = getGlobGroupsFromArgs(rawArgv, {
+    globKeys: ['file']
+  })
+  //*
+  logInput(rawArgv)
+  deepLogger(globData)
+  /** */
+  assert.equal(globData, {
+    globGroups: [
+      {
+        key: 'file',
+        rawKey: '--file',
+        values: [
+          'funktown/bar.md',
+          'test/fixtures/md/**.md',
+          'test/fixtures/output/**.md',
+          'foo.md',
+          'bar.whatever.md',
+          /patter\.md/,
+          /funk\.md/
+        ]
+      }
+    ],
+    otherOpts: []
+  })
+})
+
+test('Handles string arrays if globKeys set', () => {
+  /* CLI command with list of files already passed in
+  node ./cli.js --file '[**.md, /xyz**.md/]' 'funky**.md' billy --foo 'bar*123' --fuzz test/fixtures/output/**.md
+  */
+  const rawArgv = [
+    '--file',
+    '[**.md, /xyz**.md/]',
+    'funky**.md',
+    'billy',
+    '--foo',
+    'bar*123',
+    '--fuzz',
+    'test/fixtures/output/basic.md',
+    'test/fixtures/output/block-no-transform.md',
+    'test/fixtures/output/error-missing-transforms-two.md',
+    'test/fixtures/output/error-missing-transforms.md',
+    'test/fixtures/output/fixture-code.md',
+    'test/fixtures/output/format-inline.md',
+    'test/fixtures/output/format-with-wacky-indentation.md',
+    'test/fixtures/output/go-simple.md',
+    'test/fixtures/output/inline-two.md',
+    'test/fixtures/output/inline.md',
+    'test/fixtures/output/missing-transform.md',
+    'test/fixtures/output/mixed.md',
+    'test/fixtures/output/params.md',
+    'test/fixtures/output/remote.md',
+    'test/fixtures/output/toc.md',
+    'test/fixtures/output/transform-code.md',
+    'test/fixtures/output/transform-custom.md',
+    'test/fixtures/output/transform-file.md',
+    'test/fixtures/output/transform-remote.md',
+    'test/fixtures/output/transform-toc.md',
+    'test/fixtures/output/transform-wordCount.md',
+    'test/fixtures/output/with-wacky-indentation.md'
+  ]
+  const globData = getGlobGroupsFromArgs(rawArgv, {
+    globKeys: ['file']
+  })
+  //*
+  logInput(rawArgv)
+  deepLogger(globData)
+  /** */
+  assert.equal(globData, {
+    globGroups: [
+      {
+        key: 'file',
+        rawKey: '--file',
+        values: [ '**.md', /xyz\*\*\.md/, 'funky**.md' ]
+      },
+      {
+        key: 'fuzz',
+        rawKey: '--fuzz',
+        values: [
+          'test/fixtures/output/basic.md',
+          'test/fixtures/output/block-no-transform.md',
+          'test/fixtures/output/error-missing-transforms-two.md',
+          'test/fixtures/output/error-missing-transforms.md',
+          'test/fixtures/output/fixture-code.md',
+          'test/fixtures/output/format-inline.md',
+          'test/fixtures/output/format-with-wacky-indentation.md',
+          'test/fixtures/output/go-simple.md',
+          'test/fixtures/output/inline-two.md',
+          'test/fixtures/output/inline.md',
+          'test/fixtures/output/missing-transform.md',
+          'test/fixtures/output/mixed.md',
+          'test/fixtures/output/params.md',
+          'test/fixtures/output/remote.md',
+          'test/fixtures/output/toc.md',
+          'test/fixtures/output/transform-code.md',
+          'test/fixtures/output/transform-custom.md',
+          'test/fixtures/output/transform-file.md',
+          'test/fixtures/output/transform-remote.md',
+          'test/fixtures/output/transform-toc.md',
+          'test/fixtures/output/transform-wordCount.md',
+          'test/fixtures/output/with-wacky-indentation.md'
+        ]
+      }
+    ],
+    otherOpts: [ 'billy', '--foo', 'bar*123' ]
+  })
+})
+
+test.run()

package/lib/index.js

@@ -230,6 +230,15 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     })
   })
 
+  if (debug) {
+    // info(`pathsPromise:`)
+    // logger(pathsPromise)
+    // logger()
+    /*
+    process.exit(1)
+    /** */
+  }
+
   let files = []
   try {
     files = (await Promise.all(pathsPromise)).flat().filter(onlyUnique)
@@ -238,6 +247,8 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     // console.log(e.message)
     throw new Error(e)
   }
+
+
   // logger('files', files)
   // return
   // logger('globs', globs)
@@ -250,23 +261,42 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
   process.exit(1)
   /** */
 
+  if (debug) {
+    info(`files:`)
+    logger(files)
+    logger()
+    /*
+    process.exit(1)
+    /** */
+  }
   
 
+
   const patterns = getBlockRegex({
     syntax,
     openText: open,
     closeText: close
   })
 
-  const blocksByPath = files.map(async (file) => {
-    const text = await readFile(file, 'utf8')
+  if (debug) {
+    console.log(`patterns:`, patterns)
+  }
+
+
+  const fileContents = await Promise.all(files.map((file) => readFile(file, 'utf8')))
+
+  const blocksByPath = files.map((file, i) => {
+    const text = fileContents[i]
     let foundBlocks = {}
     try {
+      
+      // console.log('try, file', file)
       foundBlocks = parseBlocks(text, {
         syntax,
         open,
         close,
       })
+      // console.log('foundBlocks', foundBlocks.blocks.length)
     } catch (e) {
       throw new Error(`${e.message}\nFix content in ${file}\n`)
     }
@@ -278,7 +308,7 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     }
   })
 
-  const blocks = (await Promise.all(blocksByPath)).map((item) => {
+  const blocks = blocksByPath.map((item) => {
     const dir = path.dirname(item.srcPath)
     item.dependencies = []
     item.blocks.forEach((block) => {
@@ -292,6 +322,19 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
     })
     return item
   })
+
+
+  // logger(blocks[0].blocks)
+
+
+  if (debug) {
+    info(`Found blocks:`)
+    logger(blocks)
+    logger()
+    /*
+    process.exit(1)
+    /** */
+  }
   /*
   console.log('blocks')
   deepLog(blocks)
@@ -532,9 +575,8 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
       logger(planOutput.join('\n'))
     } else {
       info(`Execution plan:`, silent, "📑 ")
-      logger('\nNo transforms to run. Exiting early.')
-      logger('If you think this is incorrect. Verify your comment blocks in your src and the settings in your config.')
-      logger()
+      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.')
     }
   }
 
@@ -562,7 +604,7 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
 
   if (!dryRun && plan.length) {
     logger()
-    info(`Apply changes:`, silent, "✏️  ")
+    info(`Apply changes:`, silent, "✏️ ")
     
     /* Check for diffs in src vs output only */
     // if (outputDir) {
@@ -625,6 +667,8 @@ async function markdownMagic(globOrOpts = {}, options = {}) {
   /*
   process.exit(1)
   /** */
+  logger()
+  info(`Results:`, silent, "💫 ")
 
   /*
   TODO:

package/lib/process-contents.js

@@ -59,10 +59,10 @@ async function processContents(text, config) {
     throw new Error(`${e.message}\nFix content in ${srcPath}\n`)
   }
 
-  if (debug) {
-    console.log(`foundBlocks ${srcPath}`)
-    deepLog(foundBlocks)
-  }
+  // if (debug) {
+  //   console.log(`foundBlocks ${srcPath}`)
+  //   deepLog(foundBlocks)
+  // }
   /*
   deepLog(foundBlocks)
   process.exit(1)
@@ -173,7 +173,7 @@ async function processContents(text, config) {
     /** */
 
     if (debug) {
-      console.log('afterContent', afterContent)
+      // console.log('afterContent', afterContent)
     }
 
     if (!currentTransformFn) {
@@ -199,11 +199,18 @@ async function processContents(text, config) {
     // console.log('COMMENT_CLOSE_REGEX', COMMENT_CLOSE_REGEX)
     // console.log('formattedNewContent', formattedNewContent)
     // console.log('fix', fix)
-    const preserveIndent = (true || options.preserveIndent) ? block.indentation.length + match.content.indentation : block.indentation.length
+
+    let preserveIndent = 0
+    if (match.content.indentation) {
+      preserveIndent = match.content.indentation
+    } else if (preserveIndent === 0) {
+      preserveIndent = block.indentation.length
+    }
+    // console.log('preserveIndent', preserveIndent)
     const indent = indentString(fix, preserveIndent)
     const newCont = `${openTag}${indent}${closeTag}`
     /* Replace original contents */
-    // Must use replacer function because strings get coearced to regex or something
+    // Must use replacer function because strings get coerced to regex or something
     const newContents = md.replace(block.value, () => newCont)
     /*
     deepLog(newContents)