markdown-magic 2.6.0 → 3.0.0

package/lib/cli.js

@@ -0,0 +1,234 @@
+
+const path = require('path')
+const isGlob = require('is-glob')
+const isValidFilePath = require('is-valid-path')
+const { loadConfig } = require('./utils/load-config')
+const { findUp } = require('./utils/fs')
+const { markdownMagic } = require('./')
+const { optionsParse, isArrayLike } = require('./options-parser')
+const { deepLog } = require('./utils/logs')
+const { REGEX_REGEX, escapeRegexString } = require('./utils/regex')
+const { getFirstCharacter, isUpperCase } = require('./utils/text')
+const argv = process.argv.slice(2)
+const cwd = process.cwd()
+const defaultConfigPath = 'md.config.js'
+
+async function getBaseDir(currentDir = cwd) {
+  const gitDir = await findUp(currentDir, '.git')
+  return (gitDir) ? path.dirname(gitDir) : currentDir
+}
+
+function stringLooksLikeFile(value) {
+  return !value.match(/^-+/) // isn't option looking
+  && isValidFilePath(value)
+  && (
+    path.basename(value).indexOf('.') > -1 // has period
+    || getFirstCharacter(value) === '_' // starts with _
+    // || isUpperCase(value) // is all caps
+    )
+}
+
+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) {
+    const [ match, pattern, flags ] = isRegex
+    return new RegExp(escapeRegexString(pattern, flags))
+  }
+  return str
+}
+
+function convertToArray(str = '') {
+  const { fixedArray } = optionsParse(`fixedArray=${str}`)
+  return (fixedArray || [])
+}
+
+function addValue(value, currentCollection) {
+  if (isArrayLike(value)) {
+    const array = convertToArray(value)
+    // uniquify returned array
+    return Array.from(new Set(currentCollection.concat(array)))
+  }
+  if (currentCollection.indexOf(value) > -1) {
+    return currentCollection
+  }
+  return currentCollection.concat(value)
+}
+
+/*
+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
+*/
+function getGlobGroupsFromArgs(args, opts = {}) {
+  const globKeys = opts.globKeys || []
+  let proceding = ['', '']
+  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) // @TODO verify file exists?
+    // console.log('looksLikeFile', looksLikeFile)  
+    // console.log('cacheKey', cacheKey)
+    // console.log('arg', arg)
+
+    if (looksLikeFile && typeof cacheKey !== 'undefined') {      
+      // @TODO verify file exists?
+      collection.push(arg)
+    } else if (arg.match(/^-+/)) {
+      cacheKey = arg
+      if (collection.length) {
+        const val = getValue(proceding)
+        reserved.push(val)
+        globGroups.push({
+          key: trimLeadingDashes(val),
+          raw: val,
+          values: collection.filter(removeNodeModules).map((x) => coerceStringToRegex(x))
+        })
+        collection = []
+      }
+      proceding = [ prevArg, arg ]
+    } else if (cacheKey && arg.match(/=/)) {
+      // console.log('FOOO', arg)
+      cacheKey = undefined
+    }
+
+    const cleanKey = trimLeadingDashes(cacheKey || '')
+    const isDefinedGlobKey = globKeys.includes(cleanKey) || globKeys.includes(cacheKey)
+    // console.log(`isDefinedGlobKey: ${cleanKey}`, isDefinedGlobKey)
+    if (isDefinedGlobKey && (isGlob(arg) || looksLikeFile)) {
+      /*
+      console.log('ADD collection.push', arg)
+      /** */
+      collection = addValue(arg, collection)
+    } else {
+      if (!cacheKey && isGlob(arg)) {
+        collection = addValue(arg, collection)
+      } else if (!looksLikeFile) {
+        /* Pass through non matching args */
+        /*
+        console.log('ADD otherOpts', arg)
+        /** */
+        otherOpts.push(arg)
+      }
+    }
+
+    if (isLastArg && collection.length) {
+      const val = getValue(proceding)
+      reserved.push(val)
+      globGroups.push({
+        key: trimLeadingDashes(val),
+        raw: val,
+        values: collection.filter(removeNodeModules).map((x) => coerceStringToRegex(x))
+      })
+      collection = []
+    }
+  }
+
+  return {
+    globGroups,
+    otherOpts: otherOpts.filter((opt) => !reserved.includes(opt))
+  }
+}
+
+// const unique = Array.from(new Set(dismiss.concat(nodeSlug)))
+
+
+async function runCli(options = {}) {
+  let configFile
+  let opts = {}
+  /*
+  console.log('argv', argv)
+  console.log('options', options)
+  /** */
+  /* 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
+    // deepLog(globParse)
+    // console.log('globParse', globParse)
+    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.glob = globGroupByKey.file.values
+      } else if (globGroupByKey['']) {
+        options.glob = globGroupByKey[''].values
+      }
+
+      if (globGroupByKey.ignore) {
+        options.ignore = globGroupByKey.ignore.values
+      }
+      
+      /*
+      deepLog(options)
+      /** */
+    }
+
+    /* Parse for weird CLI inputs */
+    const extraParse = optionsParse(otherOpts.join(' '))
+
+    /*
+    console.log('otherOpts', otherOpts)
+    console.log('extraParse', extraParse)
+    /** */
+
+    delete options._
+    opts = {
+      ...options,
+      ...extraParse
+    }
+    // console.log('opts', opts)
+  }
+  if (opts.config) {
+    configFile = opts.config
+  } else {
+    const baseDir = await getBaseDir()
+    configFile = await findUp(baseDir, defaultConfigPath)
+  }
+  const config = (configFile) ? loadConfig(configFile) : {}
+  const mergedConfig = {
+    ...config,
+    ...opts,
+  }
+
+  mergedConfig.outputDir = mergedConfig.output || mergedConfig.outputDir
+  /*
+  console.log('mergedConfig', mergedConfig)
+  // return
+  /** */
+  await markdownMagic(mergedConfig)
+}
+
+module.exports = {
+  getGlobGroupsFromArgs,
+  runCli
+}

package/lib/cli.test.js

@@ -0,0 +1,409 @@
+const { test } = require('uvu') 
+const assert = require('uvu/assert')
+const { deepLog } = require('./utils/logs')
+const { getGlobGroupsFromArgs, runCli } = require('./cli')
+
+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('Exports API', () => {
+  assert.equal(typeof runCli, 'function', 'undefined val')
+  assert.equal(typeof getGlobGroupsFromArgs, 'function', 'undefined val')
+})
+
+test('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 rawArgv = [
+    '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'
+  ]
+
+  const globData = getGlobGroupsFromArgs(rawArgv)
+  //*
+  logInput(rawArgv)
+  deepLogger(globData)
+  /** */
+  assert.equal(globData.globGroups, [
+    {
+      key: '',
+      raw: '',
+      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',
+      raw: '--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',
+      raw: '--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',
+      raw: '--whatever',
+      values: [
+        'test/fixtures/md/syntax-legacy-colon.md',
+        'test/fixtures/md/syntax-legacy-query.md'
+      ]
+    },
+    { key: 'fun', raw: '--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', raw: '--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: '',
+        raw: '',
+        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: '',
+        raw: '',
+        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', raw: '--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',
+        raw: '--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',
+        raw: '--file',
+        values: [ '**.md', /xyz\*\*\.md/, 'funky**.md' ]
+      },
+      {
+        key: 'fuzz',
+        raw: '--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/defaults.js

@@ -0,0 +1,12 @@
+
+const SYNTAX = 'md'
+const OPEN_WORD = 'doc-gen'
+const CLOSE_WORD = 'end-doc-gen'
+const DEFAULT_GLOB_PATTERN = '**/**.md'
+
+module.exports = {
+  SYNTAX,
+  OPEN_WORD,
+  CLOSE_WORD,
+  DEFAULT_GLOB_PATTERN
+}