markdown-magic 4.8.0 → 4.10.0

package/src/cli-run.js

@@ -4,14 +4,11 @@ const { loadConfig } = require('./utils/load-config')
 const { findUp } = require('./utils/fs')
 const { markdownMagic } = require('./')
 const { processFile } = require('comment-block-replacer')
-const { parse } = require('oparser')
 const defaultTransforms = require('./transforms')
-const { getGlobGroupsFromArgs } = require('./globparse')
-// const { deepLog } = require('./utils/logs')
-// const { uxParse } = require('./argparse/argparse')
+const { dxParse, getGlobGroupsFromArgs } = require('@davidwells/dx-args')
 const argv = process.argv.slice(2)
 const cwd = process.cwd()
-const defaultConfigPath = 'md.config.js'
+const defaultConfigPaths = ['md.config.js', 'markdown.config.js']
 
 /**
  * Render markdown with ANSI styling for terminal output
@@ -100,18 +97,31 @@ async function getBaseDir(opts = {}) {
   return (gitDir) ? path.dirname(gitDir) : currentDir
 }
 
-function findSingleDashStrings(arr) {
-  return arr.filter(str => str.match(/^-[^-]/))
+/**
+ * Find the first config file that exists in parent dirs
+ * @param {string} baseDir
+ * @param {Array<string>} configPaths
+ * @returns {Promise<string|undefined>}
+ */
+async function findFirstConfig(baseDir, configPaths = []) {
+  for (let i = 0; i < configPaths.length; i++) {
+    const configPath = configPaths[i]
+    const found = await findUp(baseDir, configPath)
+    if (found) {
+      return found
+    }
+  }
 }
 
-async function runCli(options = {}, rawArgv) {
+async function runCli(options = {}, rawArgv, deps = {}) {
   if (options.help || options.h) {
     console.log(`
 Usage: md-magic [options] [files...]
 
 Options:
-  --files, --file    Files or glob patterns to process
-  --config           Path to config file (default: md.config.js)
+  --files, --file, --path
+                      Files or glob patterns to process
+  --config           Path to config file (default: md.config.js or markdown.config.js)
   --output           Output directory
   --open             Opening comment keyword (default: docs)
   --close            Closing comment keyword (default: /docs)
@@ -125,6 +135,7 @@ Options:
 Examples:
   md-magic README.md
   md-magic --files "**/*.md"
+  md-magic --path "**/*.md"   # alias for --files
   md-magic --config ./my-config.js
 
 Stdin/stdout mode:
@@ -196,165 +207,15 @@ Stdin/stdout mode:
   let configFile
   let opts = {}
 
-  /*
-  const result = uxParse(rawArgv)
-  console.log('───────────────────────────────')
-  deepLog(result)
-  process.exit(1)
-  // process.exit(1)
-  /** */
-
-  /*
-  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])) {
-    //   console.log('glob', argv[0])
-    //   options.glob = argv[0]
-    // }
-    const globParse = getGlobGroupsFromArgs(argv, {
-      /* CLI args that should be glob keys */
-      globKeys: ['files', 'file']
-    })
-    const { globGroups, otherOpts } = globParse
-    /*
-    console.log('globGroups', globGroups)
-    console.log('globParse', globParse)
-    // deepLog(globParse)
-    process.exit(1)
-    /** */
-    /* Parse for weird CLI inputs */
-
-    /* Handle -- and - flags */
-    let newArray = [] 
-    for (let i = 0; i < otherOpts.length; i++) {
-      const curr = otherOpts[i]
-      const prev = newArray[i - 1]
-      const next = otherOpts[i + 1] || ''
-      const isLast = otherOpts.length === i + 1
-      // console.log('curr', curr)
-      // console.log('prev', prev)
-      if (curr.match(/^-+/)) {
-        const cleanX = curr.replace(/^-+/, '')
-        if (next.match(/^-+/) || isLast) {
-          newArray.push(cleanX + '= true ')
-          continue
-        }
-        // If the current option is the last option, don't add an equal sign
-        const equal = (cleanX.indexOf('=') === -1 || isLast) ? '=' : ' '
-        const final = cleanX + equal
-        newArray.push(final)
-        continue
-      }
-      if (prev && prev.match(/=\s?$/) && (curr.match(/^\s?=/) || curr.trim() === '=')) {
-        continue
-      }
-      newArray.push(curr + ' ')
-    }
-
-    const optString = newArray.join('')
-    const extraParse = parse(optString)
-    const singleDashStrings = findSingleDashStrings(otherOpts).map((x) => x.replace(/^-+/, ''))
-    // console.log('singleDashStrings', singleDashStrings)
-    // console.log('before options', options)
-    // console.log('before extraParse', extraParse)
-    
-    const STRIP_SINGLE_DASH_OPTIONS = true
-    if (STRIP_SINGLE_DASH_OPTIONS && singleDashStrings.length) {
-      for (let i = 0; i < singleDashStrings.length; i++) {
-        const word = singleDashStrings[i]
-        // Loop over all letters of single dash options -word and remove any corresponding letter: true
-        for (let j = 0; j < word.length; j++) {
-          const letter = word[j]
-          if (options[letter]) {
-            delete options[letter]
-          }
-        }
-      }
-      // console.log('after options', options)
-    }
-
-    if (extraParse.test) {
-      /*
-      console.log('optStringArr', newArray)
-      console.log('optString', optString)
-      console.log('otherOpts strings', otherOpts)
-      console.log('nicely handed CLI args')
-      console.log('extraParse', extraParse)
-      process.exit(1)
-      /** */
-    }
-  
-
-    if (globGroups.length) {
-      const globGroupByKey = globGroups.reduce((acc, curr, i) => {
-        acc[curr.key] = globGroups[i]
-        return acc
-      }, {})
-      // console.log('globGroupByKey', globGroupByKey)
-
-  
-      if (globGroupByKey.file) {
-        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) {
-        options.ignore = globGroupByKey.ignore.values
-      }
-      
-      /*
-      deepLog(options)
-      /** */
-    }
-
-    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)
+  const cliArgv = Array.isArray(rawArgv) ? rawArgv : argv
+  if (cliArgv.length) {
+    opts = parseCliArgv(cliArgv)
   }
   if (opts.config) {
     configFile = opts.config
   } else {
     const baseDir = await getBaseDir()
-    configFile = await findUp(baseDir, defaultConfigPath)
+    configFile = await findFirstConfig(baseDir, defaultConfigPaths)
   }
   const config = (configFile) ? loadConfig(configFile) : {}
   const mergedConfig = {
@@ -371,7 +232,75 @@ Stdin/stdout mode:
   process.exit(1)
   // return
   /** */
-  return markdownMagic(mergedConfig)
+  const runMarkdownMagic = deps.markdownMagic || markdownMagic
+  return runMarkdownMagic(mergedConfig)
+}
+
+function parseCliArgv(rawArgv = []) {
+  return normalizeCliOptions(dxParse(rawArgv, {
+    globKeys: ['files', 'file', 'path', 'ignore']
+  }))
+}
+
+function normalizeCliOptions(parsed) {
+  const mergedOptions = parsed.mergedOptions || {}
+  const opts = {
+    ...mergedOptions,
+    files: []
+  }
+  const globGroupByKey = parsed.globGroups.reduce((acc, curr) => {
+    acc[curr.key] = curr
+    return acc
+  }, {})
+
+  if (globGroupByKey.file) {
+    opts.files = opts.files.concat(globGroupByKey.file.values)
+  }
+  if (globGroupByKey.files) {
+    opts.files = opts.files.concat(globGroupByKey.files.values)
+  }
+  if (globGroupByKey.path) {
+    opts.files = opts.files.concat(globGroupByKey.path.values)
+  }
+  if (globGroupByKey['']) {
+    opts.files = opts.files.concat(globGroupByKey[''].values)
+  }
+  if (globGroupByKey.ignore) {
+    opts.ignore = globGroupByKey.ignore.values
+  }
+
+  if (mergedOptions.file) {
+    opts.files = opts.files.concat(mergedOptions.file)
+    delete opts.file
+  }
+  if (mergedOptions.files) {
+    opts.files = opts.files.concat(mergedOptions.files)
+  }
+  if (mergedOptions.path) {
+    opts.files = opts.files.concat(mergedOptions.path)
+    delete opts.path
+  }
+  if (mergedOptions['--files']) {
+    opts.files = opts.files.concat(mergedOptions['--files'])
+    delete opts['--files']
+  }
+
+  delete opts._
+  delete opts.file
+  delete opts.path
+  opts.files = normalizeFileList(opts.files)
+  return opts
+}
+
+function normalizeFileList(files = []) {
+  return files.map((x) => {
+    if (typeof x === 'string' && x.match(/,/)) {
+      return x.split(',')
+    }
+    return x
+  })
+  .flat()
+  .filter(onlyUnique)
 }
 
 function onlyUnique(value, index, self) {
@@ -380,5 +309,7 @@ function onlyUnique(value, index, self) {
 
 module.exports = {
   getGlobGroupsFromArgs,
+  parseCliArgv,
+  normalizeCliOptions,
   runCli
-}
+}

package/src/cli-run.test.js

@@ -1,9 +1,10 @@
 const { test } = require('uvu') 
 const assert = require('uvu/assert')
+const path = require('path')
 const { deepLog } = require('./utils/logs')
-const { getGlobGroupsFromArgs, runCli } = require('./cli-run')
+const { getGlobGroupsFromArgs, parseCliArgv, runCli } = require('./cli-run')
 
-const DEBUG = true
+const DEBUG = process.argv.includes('--debug')
 const logger = (DEBUG) ? console.log : () => {}
 const deepLogger = (DEBUG) ? deepLog : () => {}
 
@@ -16,7 +17,74 @@ function logInput(rawArgs) {
 
 test('Exports API', () => {
   assert.equal(typeof runCli, 'function', 'undefined val')
+  assert.equal(typeof parseCliArgv, 'function', 'undefined val')
   assert.equal(typeof getGlobGroupsFromArgs, 'function', 'undefined val')
 })
 
-test.run()
+test('CLI parser uses dxParse for forgiving single-dash file and config options', () => {
+  const rawArgv = [ '-files', 'README.md', '-config', 'md.config.js', '-dry' ]
+  const result = parseCliArgv(rawArgv)
+  deepLogger('result', result)
+  assert.equal(result, {
+    files: ['README.md'],
+    config: 'md.config.js',
+    dry: true
+  })
+})
+
+test('CLI parser maps file/path globs and ignore groups into markdown-magic options', () => {
+  const rawArgv = [
+    '--path',
+    'docs/**/*.md',
+    '--file',
+    'README.md',
+    '--ignore',
+    'dist/**/*.md',
+    '--output',
+    'out'
+  ]
+  const result = parseCliArgv(rawArgv)
+  deepLogger('result', result)
+  assert.equal(result, {
+    files: ['README.md', 'docs/**/*.md'],
+    ignore: ['dist/**/*.md'],
+    output: 'out'
+  })
+})
+
+test('CLI parser keeps shell-expanded files out of command options', () => {
+  const rawArgv = [
+    'CONTRIBUTING.md',
+    'NOTES.md',
+    'README.md',
+    'foo',
+    'bar',
+    '=',
+    'false'
+  ]
+  const result = parseCliArgv(rawArgv)
+  deepLogger('result', result)
+  assert.equal(result, {
+    files: ['CONTRIBUTING.md', 'NOTES.md', 'README.md'],
+    foo: true,
+    bar: false
+  })
+})
+
+test('runCli sends dxParse-normalized options to markdownMagic', async () => {
+  const configFile = path.join(__dirname, '..', '..', '..', 'md.config.js')
+  const rawArgv = [ '-files', 'README.md', '-config', configFile, '-dry' ]
+  let receivedConfig
+  const result = await runCli({ _: ['README.md'] }, rawArgv, {
+    markdownMagic: async (config) => {
+      receivedConfig = config
+      return config
+    }
+  })
+  assert.equal(result, receivedConfig)
+  assert.equal(receivedConfig.files, ['README.md'])
+  assert.equal(receivedConfig.config, configFile)
+  assert.equal(receivedConfig.dry, true)
+})
+
+test.run()

package/src/globparse.js

@@ -1,163 +1,18 @@
-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))
-  }
-}
+const {
+  getGlobGroupsFromArgs,
+  isArrayLike,
+  stringLooksLikeFile,
+  getValue,
+  trimLeadingDashes,
+  removeNodeModules,
+  coerceStringToRegex,
+  convertToArray,
+  addValue,
+  customIsGlob,
+} = require('@davidwells/dx-args')
 
 module.exports = {
   getGlobGroupsFromArgs,
-  // Export helpers for testing
   isArrayLike,
   stringLooksLikeFile,
   getValue,
@@ -166,5 +21,5 @@ module.exports = {
   coerceStringToRegex,
   convertToArray,
   addValue,
-  customIsGlob
-} 
+  customIsGlob,
+}

package/src/index.dependency-graph.test.js

@@ -0,0 +1,49 @@
+const { test } = require('uvu')
+const assert = require('uvu/assert')
+const { __private } = require('./')
+
+test('createDependencyGraph includes every known dependency edge', () => {
+  const blockItems = [
+    {
+      id: '/docs/main.md',
+      blocks: [{}],
+      dependencies: ['/docs/dep-a.md', '/docs/dep-z.md']
+    },
+    {
+      id: '/docs/dep-a.md',
+      blocks: [{}],
+      dependencies: []
+    },
+    {
+      id: '/docs/dep-z.md',
+      blocks: [{}],
+      dependencies: []
+    }
+  ]
+
+  const { graph } = __private.createDependencyGraph(blockItems)
+  assert.ok(graph.find((edge) => edge[0] === '/docs/main.md' && edge[1] === '/docs/dep-a.md'))
+  assert.ok(graph.find((edge) => edge[0] === '/docs/main.md' && edge[1] === '/docs/dep-z.md'))
+  assert.is(graph.filter((edge) => edge[0] === '/docs/main.md').length, 2)
+})
+
+test('createDependencyGraph skips dependencies outside the file set', () => {
+  const blockItems = [
+    {
+      id: '/docs/main.md',
+      blocks: [{}],
+      dependencies: ['/docs/dep-a.md', '/external/file.js']
+    },
+    {
+      id: '/docs/dep-a.md',
+      blocks: [{}],
+      dependencies: []
+    }
+  ]
+
+  const { graph } = __private.createDependencyGraph(blockItems)
+  assert.is(graph.length, 1)
+  assert.equal(graph[0], ['/docs/main.md', '/docs/dep-a.md'])
+})
+
+test.run()