markdown-magic 3.3.0 → 3.3.2

package/lib/cli.test.js

@@ -19,391 +19,4 @@ test('Exports API', () => {
   assert.equal(typeof getGlobGroupsFromArgs, 'function', 'undefined val')
 })
 
-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/globparse.js

@@ -0,0 +1,170 @@
+const path = require('path')
+const isGlob = require('is-glob')
+const isValidFilePath = require('is-valid-path')
+const { parse } = require('oparser')
+const { getFirstCharacter } = require('./utils/text')
+const { REGEX_REGEX, escapeRegexString } = require('./utils/regex')
+
+const ARRAY_REGEX = /^\[(.*)\]$/
+const NOT_OBJECT_LIKE = /^{[^:,]*}/
+const IS_KEY_VALUE_NON_ARRAY = /^([A-Za-z0-9_.-]*)=\s?([^\[\{]]*)([^\[\{]*)$/
+const IS_KEY_VALUE_IN_QUOTES = /^([A-Za-z0-9_.-]*)=\s?("|')(.*)(\2)$/
+const IS_KEY_VALUE_START_WITH_QUOTE = /^([A-Za-z0-9_.-]*)=\s?("|')(.*)/
+const IS_INTEGER = /^([A-Za-z0-9_.-]*)=\s?-?\d*(\.(?=\d))?\d*$/
+const IS_BOOLEAN_OR_NULL = /^([A-Za-z0-9_.-]*)=\s?true|false|null|undefined\s?/
+
+function isArrayLike(str) {
+  if (typeof str !== 'string') return false
+  return Boolean(ARRAY_REGEX.test(str))
+}
+
+function stringLooksLikeFile(value) {
+  return !value.match(/^-+/) // isn't option looking
+    && isValidFilePath(value)
+    && (
+      path.basename(value).indexOf('.') > -1 // has period
+      || getFirstCharacter(value) === '_' // starts with _
+    )
+}
+
+function getValue(val) {
+  return (val[1] !== '=') ? val[1] : val[0]
+}
+
+function trimLeadingDashes(value) {
+  return value.replace(/^-+/, '')
+}
+
+function removeNodeModules(value = '') {
+  if (typeof value !== 'string') {
+    return true
+  }
+  return !value.match(/node_modules\//)
+}
+
+function coerceStringToRegex(str) {
+  const isRegex = str.match(REGEX_REGEX)
+  if (!isRegex) {
+    return str
+  }
+  const [ _match, pattern, flags ] = isRegex
+  return new RegExp(escapeRegexString(pattern), flags)
+}
+
+function convertToArray(str = '') {
+  const { fixedArray } = parse(`fixedArray=${str}`)
+  return (fixedArray || [])
+}
+
+function addValue(value, currentCollection) {
+  if (isArrayLike(value)) {
+    const array = convertToArray(value)
+    return Array.from(new Set(currentCollection.concat(array)))
+  }
+  if (currentCollection.indexOf(value) > -1) {
+    return currentCollection
+  }
+  return currentCollection.concat(value)
+}
+
+function customIsGlob(arg) {
+  // If looks like json object, return false
+  if (arg.match(/^{[^}]*:[^}]*}/)) {
+    return false
+  }
+  return isGlob(arg)
+}
+
+function getGlobGroupsFromArgs(args, opts = {}) {
+  const globKeys = opts.globKeys || []
+  let preceding = ['', '']
+  let collection = []
+  let globGroups = []
+  let reserved = []
+  let otherOpts = []
+  let cacheKey = ''
+
+  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)
+
+    if (looksLikeFile && typeof cacheKey !== 'undefined') {      
+      collection.push(arg)
+    } else if (arg.match(/^-+/) && !arg.match(/=/)) {
+      cacheKey = arg
+      if (collection.length) {
+        const val = getValue(preceding)
+        reserved.push(val)
+        globGroups.push({
+          key: trimLeadingDashes(val),
+          rawKey: val,
+          values: collection.filter(removeNodeModules).map((x) => coerceStringToRegex(x))
+        })
+        collection = []
+      }
+      preceding = [ prevArg, arg ]
+    } else if (cacheKey && arg.match(/=/)) {
+      cacheKey = undefined
+    }
+
+    const cleanKey = trimLeadingDashes(cacheKey || '')
+    const isDefinedGlobKey = globKeys.includes(cleanKey) || globKeys.includes(cacheKey)
+
+    if (isDefinedGlobKey && (isGlob(arg) || looksLikeFile)) {
+      collection = addValue(arg, collection)
+    } else {
+      const notObjectLike = arg.match(NOT_OBJECT_LIKE) && !isArrayLike(arg)
+      if (
+        (notObjectLike) ||
+        !cacheKey && customIsGlob(arg) && !arg.match(/=/)
+      ) {
+        collection = addValue(arg, collection)
+      } else if (!looksLikeFile) {
+        if (
+            arg.match(IS_KEY_VALUE_IN_QUOTES) 
+            || arg.match(IS_KEY_VALUE_START_WITH_QUOTE) 
+            || arg.match(IS_INTEGER)
+            || arg.match(IS_BOOLEAN_OR_NULL)
+          ) {
+          otherOpts.push(arg)
+        } else if (arg.match(IS_KEY_VALUE_NON_ARRAY)) {
+          otherOpts.push(arg.replace(IS_KEY_VALUE_NON_ARRAY, '$1="$2$3"'))
+        } else {
+          otherOpts.push(arg)
+        }
+      }
+    }
+    
+    if (isLastArg && collection.length) {
+      const val = getValue(preceding)
+      reserved.push(val)
+      globGroups.push({
+        key: trimLeadingDashes(val),
+        rawKey: val,
+        values: collection.filter(removeNodeModules).map((x) => coerceStringToRegex(x)),
+      })
+      collection = []
+    }
+  }
+
+  return {
+    globGroups,
+    otherOpts: otherOpts.filter((opt) => !reserved.includes(opt))
+  }
+}
+
+module.exports = {
+  getGlobGroupsFromArgs,
+  // Export helpers for testing
+  isArrayLike,
+  stringLooksLikeFile,
+  getValue,
+  trimLeadingDashes,
+  removeNodeModules,
+  coerceStringToRegex,
+  convertToArray,
+  addValue,
+  customIsGlob
+}