markdown-magic 3.0.3 → 3.0.4

package/lib/block-parser.js

@@ -12,26 +12,11 @@ const defaultOptions = {
 }
 
 function parseBlocks(contents, opts = {}) {
-  const options = Object.assign({}, defaultOptions, opts)
-  const { syntax, open, close } = options
-  if (!open) {
-    throw new Error('Missing options.open')
-  }
-  if (!close) {
-    throw new Error('Missing options.close')
-  }
-  if (!syntax) {
-    throw new Error('Missing options.syntax')
-  }
-  const syntaxInfo = getSyntaxInfo(syntax)
-  if (!syntaxInfo.pattern) {
-    throw new Error(`Unknown syntax "${syntax}"`)
-  }
-  const [ openComment, closeComment ] = syntaxInfo.pattern
+  const _options = Object.assign({}, defaultOptions, opts)
+  const { syntax, open, close } = _options
 
   const patterns = getBlockRegex({
-    openComment,
-    closeComment,
+    syntax,
     openText: open,
     closeText: close
   })
@@ -65,10 +50,13 @@ function parseBlocks(contents, opts = {}) {
   // console.log('isBalanced', isBalanced)
   const balanced = (closeCount > openCount) ? true : isBalanced
   if (!balanced) {
-    throw new Error(`Blocks are unbalanced.
-    ${openCount} "${open}" open tags.
-    ${closeCount} "${close}" close tags.
-    `)
+    throw new Error(`[Parsing error]
+
+Comment blocks are unbalanced in string
+
+Details:
+  - Found ${openCount} "${open}" open tags.
+  - Found ${closeCount} "${close}" close tags.\n\n`)
   }
 
   /* New regex works! */
@@ -131,7 +119,9 @@ function parseBlocks(contents, opts = {}) {
       options = legacyParseOptions(paramString)
       context.isLegacy = true
     } else {
-      // console.log('paramString', paramString)
+      if (paramString[0] === '(' && paramString[paramString.length - 1] === ')') {
+        paramString = paramString.replace(/^\(/, '').replace(/\)$/g, '')
+      }
       options = parse(paramString)
     }
 
@@ -238,22 +228,36 @@ function legacyParseOptions(options) {
 /**
  * Get Regex pattern to match block
  * @param {object} options
- * @param {string} [options.openEmoji] - emoji
- * @param {string} [options.openComment] - comment syntax open
- * @param {string} [options.closeComment] - comment syntax open
+ * @param {string} [options.syntax] - comment open text
  * @param {string} [options.openText] - comment open text
+ * @param {string} [options.openEmoji] - emoji
  * @param {string} [options.closeText] - comment close text
  * @param {boolean} [options.allowMissingTransforms] - Allow for missing transform key
  * @returns {RegexPatterns}
  */
 function getBlockRegex({
   openEmoji,
-  openComment,
-  closeComment, 
+  syntax = SYNTAX,
   openText = '', 
   closeText = '',
   allowMissingTransforms = false
 }) {
+  if (!openText) {
+    throw new Error('Missing options.open')
+  }
+  if (!closeText) {
+    throw new Error('Missing options.close')
+  }
+  if (!syntax) {
+    throw new Error('Missing options.syntax')
+  }
+
+  const syntaxInfo = getSyntaxInfo(syntax)
+  if (!syntaxInfo.pattern) {
+    throw new Error(`Unknown syntax "${syntax}"`)
+  }
+
+  const [ openComment, closeComment ] = syntaxInfo.pattern
   // https://regex101.com/r/SU2g1Q/1
   // https://regex101.com/r/SU2g1Q/2
   // https://regex101.com/r/SU2g1Q/3

package/lib/block-parser.test.js

@@ -404,7 +404,9 @@ This content will be dynamically replaced with code from the file lines 22 throu
 
 test('Parse md blocks', () => {
   const parsedValue = parseBlocks(mdText, defaultOpts)
+  /*
   deepLog(parsedValue)
+  /** */
   assert.equal(parsedValue.blocks,  [
     {
       index: 1,

package/lib/cli.js

@@ -14,6 +14,8 @@ const cwd = process.cwd()
 const defaultConfigPath = 'md.config.js'
 
 const ARRAY_REGEX = /^\[(.*)\]$/
+const NOT_OBJECT_LIKE = /^{[^:,]*}/
+const IS_KEY_VALUE_NON_ARRAY = /^([A-Za-z0-9_]*)=\s?([^\[\{]]*)([^\[\{]*)$/
 
 function isArrayLike(str) {
   if (typeof str !== 'string') return false
@@ -88,26 +90,34 @@ function getGlobGroupsFromArgs(args, opts = {}) {
   let reserved = []
   let otherOpts = []
   let /** @type {string|undefined} */ cacheKey = ''
+  // console.log('args', args)
   for (let i = 0; i < args.length; i++) {
     const isLastArg = (args.length - 1) === i
     const arg = args[i]
     const prevArg = args[i - 1]
     const looksLikeFile = stringLooksLikeFile(arg) // @TODO verify file exists?
-    // console.log('looksLikeFile', looksLikeFile)  
-    // console.log('cacheKey', cacheKey)
+    
     // console.log('arg', arg)
+    // console.log('looksLikeFile', looksLikeFile) 
+    // console.log('collection', collection)
+
+    // console.log('cacheKey', cacheKey)
 
     if (looksLikeFile && typeof cacheKey !== 'undefined') {      
       // @TODO verify file exists?
       collection.push(arg)
-    } else if (arg.match(/^-+/)) {
+    } else if (arg.match(/^-+/) && !arg.match(/=/)) {
       cacheKey = arg
+      // console.log('cacheKey', cacheKey)
+      // console.log('collection', collection)
+      // console.log('arg', arg)
       if (collection.length) {
         const val = getValue(preceding)
+        // console.log('val', val)
         reserved.push(val)
         globGroups.push({
           key: trimLeadingDashes(val),
-          raw: val,
+          rawKey: val,
           values: collection.filter(removeNodeModules).map((x) => coerceStringToRegex(x))
         })
         collection = []
@@ -127,24 +137,34 @@ function getGlobGroupsFromArgs(args, opts = {}) {
       /** */
       collection = addValue(arg, collection)
     } else {
-      if (!cacheKey && isGlob(arg)) {
+      if (!cacheKey && isGlob(arg) && !arg.match(/=/) || (arg.match(NOT_OBJECT_LIKE) && !isArrayLike(arg))) {
+        // console.log('GLOB MATCH', arg, isGlob(arg))
         collection = addValue(arg, collection)
       } else if (!looksLikeFile) {
         /* Pass through non matching args */
         /*
         console.log('ADD otherOpts', arg)
         /** */
-        otherOpts.push(arg)
+        if (arg.match(IS_KEY_VALUE_NON_ARRAY)) {
+          // quote quote wrap
+          otherOpts.push(arg.replace(IS_KEY_VALUE_NON_ARRAY, '$1="$2$3"'))
+        } else {
+          otherOpts.push(arg)
+        }
+
       }
     }
-
+    
+    // console.log('end', collection)
     if (isLastArg && collection.length) {
+      // console.log('isLastArg', isLastArg)
       const val = getValue(preceding)
       reserved.push(val)
       globGroups.push({
         key: trimLeadingDashes(val),
-        raw: val,
-        values: collection.filter(removeNodeModules).map((x) => coerceStringToRegex(x))
+        rawKey: val,
+        values: collection.filter(removeNodeModules).map((x) => coerceStringToRegex(x)),
+        // last: 'last'
       })
       collection = []
     }
@@ -163,6 +183,7 @@ async function runCli(options = {}) {
   console.log('argv', argv)
   console.log('options', options)
   /** */
+  options.files = []
   /* If raw args found, process them further */
   if (argv.length && (options._ && options._.length || (options.file || options.files))) {
     // if (isGlob(argv[0])) {
@@ -174,9 +195,11 @@ async function runCli(options = {}) {
       globKeys: ['files', 'file']
     })
     const { globGroups, otherOpts } = globParse
+    /*
     console.log('globGroups', globGroups)
+    console.log('globParse', globParse)
     // deepLog(globParse)
-    // console.log('globParse', globParse)
+    /** */
     if (globGroups.length) {
       const globGroupByKey = globGroups.reduce((acc, curr, i) => {
         acc[curr.key] = globGroups[i]
@@ -184,10 +207,16 @@ async function runCli(options = {}) {
       }, {})
       // console.log('globGroupByKey', globGroupByKey)
 
+  
       if (globGroupByKey.file) {
-        options.glob = globGroupByKey.file.values
-      } else if (globGroupByKey['']) {
-        options.glob = globGroupByKey[''].values
+        options.files = options.files.concat(globGroupByKey.file.values)
+        delete options.file
+      }
+      if (globGroupByKey.files) {
+        options.files = options.files.concat(globGroupByKey.files.values)
+      } 
+      if (globGroupByKey['']) {
+        options.files = options.files.concat(globGroupByKey[''].values)
       }
 
       if (globGroupByKey.ignore) {
@@ -200,21 +229,67 @@ async function runCli(options = {}) {
     }
 
     /* Parse for weird CLI inputs */
-    const extraParse = parse(otherOpts.join(' '))
 
+    /* Handle -- and - flags */
+    let newArray = [] 
+    for (let i = 0; i < otherOpts.length; i++) {
+      const curr = otherOpts[i]
+      const prev = newArray[i - 1]
+      if (curr.match(/^-+/)) {
+        const cleanX = curr.replace(/^-+/, '')
+        const equal = (cleanX.indexOf('=') === -1) ? '=' : ' '
+        newArray.push(cleanX + equal)
+        continue
+      }
+      if (prev && prev.match(/=\s?$/) && (curr.match(/^\s?=/) || curr.trim() === '=')) {
+        continue
+      }
+      newArray.push(curr + ' ')
+    }
+
+    const optString = newArray.join('')
+    const extraParse = parse(optString)
     /*
-    // console.log('otherOpts', otherOpts)
+    console.log('optStringArr', newArray)
+    console.log('optString', optString)
+    console.log('otherOpts strings', otherOpts)
     console.log('nicely handed CLI args')
-    console.log(extraParse)
+    console.log('extraParse', extraParse)
     process.exit(1)
     /** */
 
+    if (extraParse.file) {
+      options.files = options.files.concat(extraParse.file)
+      delete extraParse.file
+    }
+
+    if (extraParse.files) {
+      options.files = options.files.concat(extraParse.files)
+      delete extraParse.files
+    }
+
+    if (extraParse['--files']) {
+      options.files = options.files.concat(extraParse['--files'])
+      delete extraParse['--files']
+    }
+
+    // console.log('options.files', options.files)
+
+    options.files = options.files.map((x) => {
+      if (typeof x === 'string' && x.match(/,/)) {
+        return x.split(',')
+      }
+      return x
+    })
+    .flat()
+    .filter(onlyUnique)
+
     delete options._
     opts = {
       ...options,
       ...extraParse
     }
-    // console.log('opts', opts)
+    //console.log('opts', opts)
   }
   if (opts.config) {
     configFile = opts.config
@@ -228,12 +303,19 @@ async function runCli(options = {}) {
     ...opts,
   }
 
-  mergedConfig.outputDir = mergedConfig.output || mergedConfig.outputDir
+  if (mergedConfig.output || mergedConfig.outputDir) {
+    mergedConfig.outputDir = mergedConfig.output || mergedConfig.outputDir
+  }
   /*
   console.log('mergedConfig', mergedConfig)
+  process.exit(1)
   // return
   /** */
-  await markdownMagic(mergedConfig)
+  return markdownMagic(mergedConfig)
+}
+
+function onlyUnique(value, index, self) {
+  return self.indexOf(value) === index
 }
 
 module.exports = {

package/lib/cli.test.js

@@ -101,7 +101,7 @@ node ./cli.js test/fixtures/md/**.md debug --transform test/fixtures/md/transfor
   assert.equal(globData.globGroups, [
     {
       key: '',
-      raw: '',
+      rawKey: '',
       values: [
         'test/fixtures/md/basic.md',
         'test/fixtures/md/error-missing-transforms-two.md',
@@ -128,7 +128,7 @@ node ./cli.js test/fixtures/md/**.md debug --transform test/fixtures/md/transfor
     },
     {
       key: 'transform',
-      raw: '--transform',
+      rawKey: '--transform',
       values: [
         'test/fixtures/md/transform-code.md',
         'test/fixtures/md/transform-custom.md',
@@ -140,7 +140,7 @@ node ./cli.js test/fixtures/md/**.md debug --transform test/fixtures/md/transfor
     },
     {
       key: 'ignore',
-      raw: '--ignore',
+      rawKey: '--ignore',
       values: [
         'test/fixtures/output/basic.md',
         'test/fixtures/output/block-no-transform.md',
@@ -168,13 +168,13 @@ node ./cli.js test/fixtures/md/**.md debug --transform test/fixtures/md/transfor
     },
     {
       key: 'whatever',
-      raw: '--whatever',
+      rawKey: '--whatever',
       values: [
         'test/fixtures/md/syntax-legacy-colon.md',
         'test/fixtures/md/syntax-legacy-query.md'
       ]
     },
-    { key: 'fun', raw: '--fun', values: [ 'lol.md' ] }
+    { key: 'fun', rawKey: '--fun', values: [ 'lol.md' ] }
   ])
 })
 
@@ -193,7 +193,7 @@ test('test 2', () => {
   deepLogger(globData)
   /** */
   assert.equal(globData, {
-    globGroups: [ { key: 'file', raw: '--file', values: [ '**.md', 'funky**.md' ] } ],
+    globGroups: [ { key: 'file', rawKey: '--file', values: [ '**.md', 'funky**.md' ] } ],
     otherOpts: [ 'billy', '--foo', 'bar*123' ]
   })
 })
@@ -213,7 +213,7 @@ test('Handles multiple string values and groups them', () => {
     globGroups: [
       {
         key: '',
-        raw: '',
+        rawKey: '',
         values: [ 'test/fixtures/md/bar.md', 'test/fixtures/output/foo.md' ]
       }
     ],
@@ -236,7 +236,7 @@ test('Handles multiple string GLOB values and groups them', () => {
     globGroups: [
       {
         key: '',
-        raw: '',
+        rawKey: '',
         values: [ 'test/fixtures/md/**.md', 'test/fixtures/output/**.md' ]
       }
     ],
@@ -270,7 +270,7 @@ test('Handles globKey set with multiple file/glob like values supplied afterward
   deepLogger(globData)
   /** */
   assert.equal(globData, {
-    globGroups: [ { key: 'file', raw: '--file', values: [ 
+    globGroups: [ { key: 'file', rawKey: '--file', values: [ 
       'foobar.md',
       'funktown/bar.md',
       '**.md', 
@@ -308,7 +308,7 @@ node ./cli.js --file 'test/fixtures/md/**.md' 'test/fixtures/output/**.md' '[foo
     globGroups: [
       {
         key: 'file',
-        raw: '--file',
+        rawKey: '--file',
         values: [
           'funktown/bar.md',
           'test/fixtures/md/**.md',
@@ -370,12 +370,12 @@ test('Handles string arrays if globKeys set', () => {
     globGroups: [
       {
         key: 'file',
-        raw: '--file',
+        rawKey: '--file',
         values: [ '**.md', /xyz\*\*\.md/, 'funky**.md' ]
       },
       {
         key: 'fuzz',
-        raw: '--fuzz',
+        rawKey: '--fuzz',
         values: [
           'test/fixtures/output/basic.md',
           'test/fixtures/output/block-no-transform.md',