markdown-magic 3.0.0 → 3.0.2

package/lib/block-parser.test.js

@@ -32,6 +32,9 @@ nice
 lol
 <\!-- XYZ:END -->
 
+<!-- XYZ:START funky-key-here kldskjfjslfjs -->
+lol
+<!-- XYZ:END -->
 
 <\!-- xyz:start (lowerCase) foo=['one', 'two'] heading=false -->
 nice
@@ -185,6 +188,7 @@ test('verify parser', () => {
   /*
   console.log('parsedValue')
   deepLog(parsedValue)
+  // process.exit(1)
   /** */
   assert.equal(typeof parsedValue, 'object')
   assert.equal(parsedValue.blocks.length, 11)
@@ -391,7 +395,12 @@ Very nice
 
 <!-- DOCS:START(TOC) foo={{ rad: 'orange' }} ------>
 ok
-<!-- DOCS:END -->`
+<!-- DOCS:END -->
+
+<!-- DOCS:START (CODE:src=./relative/path/to/code.js&lines=22-44) -->
+This content will be dynamically replaced with code from the file lines 22 through 44
+<!-- DOCS:END -->
+`
 
 test('Parse md blocks', () => {
   const parsedValue = parseBlocks(mdText, defaultOpts)
@@ -405,22 +414,50 @@ test('Parse md blocks', () => {
       open: {
         value: "<!-- DOCS:START(TOC) foo={{ rad: 'orange' }} ------>\n",
         start: 12,
-        end: 64
+        end: 65
       },
-      content: { value: 'ok', start: 64, end: 68, indentation: 0 },
-      close: { value: '\n<!-- DOCS:END -->', start: 68, end: 85 },
+      content: { value: 'ok', start: 65, end: 67, indentation: 0 },
+      close: { value: '\n<!-- DOCS:END -->', start: 67, end: 85 },
       block: {
         indentation: '',
         lines: [ 4, 6 ],
         start: 12,
         end: 85,
-        rawType: '(TOC)',
         rawArgs: "foo={{ rad: 'orange' }}",
-        rawContent: '\nok\n',
+        rawContent: 'ok',
         value: "<!-- DOCS:START(TOC) foo={{ rad: 'orange' }} ------>\n" +
           'ok\n' +
           '<!-- DOCS:END -->'
       }
+    },
+    {
+      index: 2,
+      type: 'CODE',
+      options: { src: './relative/path/to/code.js', lines: '22-44' },
+      context: { isMultiline: true, isLegacy: true },
+      open: {
+        value: '<!-- DOCS:START (CODE:src=./relative/path/to/code.js&lines=22-44) -->\n',
+        start: 87,
+        end: 157
+      },
+      content: {
+        value: 'This content will be dynamically replaced with code from the file lines 22 through 44',
+        start: 157,
+        end: 242,
+        indentation: 0
+      },
+      close: { value: '\n<!-- DOCS:END -->', start: 242, end: 260 },
+      block: {
+        indentation: '',
+        lines: [ 8, 10 ],
+        start: 87,
+        end: 260,
+        rawArgs: 'src=./relative/path/to/code.js&lines=22-44',
+        rawContent: 'This content will be dynamically replaced with code from the file lines 22 through 44',
+        value: '<!-- DOCS:START (CODE:src=./relative/path/to/code.js&lines=22-44) -->\n' +
+          'This content will be dynamically replaced with code from the file lines 22 through 44\n' +
+          '<!-- DOCS:END -->'
+      }
     }
   ], 'Array contains details')
 })

package/lib/cli.js

@@ -5,7 +5,7 @@ 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 { parse } = require('oparser')
 const { deepLog } = require('./utils/logs')
 const { REGEX_REGEX, escapeRegexString } = require('./utils/regex')
 const { getFirstCharacter, isUpperCase } = require('./utils/text')
@@ -13,7 +13,18 @@ const argv = process.argv.slice(2)
 const cwd = process.cwd()
 const defaultConfigPath = 'md.config.js'
 
-async function getBaseDir(currentDir = cwd) {
+const ARRAY_REGEX = /^\[(.*)\]$/
+
+/** @type {BUILD_VERSION} */
+const x = 'f'
+
+function isArrayLike(str) {
+  if (typeof str !== 'string') return false
+  return Boolean(ARRAY_REGEX.test(str))
+}
+
+async function getBaseDir(opts = {}) {
+  const { currentDir = cwd } = opts
   const gitDir = await findUp(currentDir, '.git')
   return (gitDir) ? path.dirname(gitDir) : currentDir
 }
@@ -45,15 +56,15 @@ function removeNodeModules(value = '') {
 
 function coerceStringToRegex(str) {
   const isRegex = str.match(REGEX_REGEX)
-  if (isRegex) {
-    const [ match, pattern, flags ] = isRegex
-    return new RegExp(escapeRegexString(pattern, flags))
+  if (!isRegex) {
+    return str
   }
-  return str
+  const [ _match, pattern, flags ] = isRegex
+  return new RegExp(escapeRegexString(pattern), flags)
 }
 
 function convertToArray(str = '') {
-  const { fixedArray } = optionsParse(`fixedArray=${str}`)
+  const { fixedArray } = parse(`fixedArray=${str}`)
   return (fixedArray || [])
 }
 
@@ -74,12 +85,12 @@ node ./cli.js test/fixtures/md/**.md debug --transform test/fixtures/md/transfor
 */
 function getGlobGroupsFromArgs(args, opts = {}) {
   const globKeys = opts.globKeys || []
-  let proceding = ['', '']
+  let preceding = ['', '']
   let collection = []
   let globGroups = []
   let reserved = []
   let otherOpts = []
-  let cacheKey = ''
+  let /** @type {string|undefined} */ cacheKey = ''
   for (let i = 0; i < args.length; i++) {
     const isLastArg = (args.length - 1) === i
     const arg = args[i]
@@ -95,7 +106,7 @@ function getGlobGroupsFromArgs(args, opts = {}) {
     } else if (arg.match(/^-+/)) {
       cacheKey = arg
       if (collection.length) {
-        const val = getValue(proceding)
+        const val = getValue(preceding)
         reserved.push(val)
         globGroups.push({
           key: trimLeadingDashes(val),
@@ -104,7 +115,7 @@ function getGlobGroupsFromArgs(args, opts = {}) {
         })
         collection = []
       }
-      proceding = [ prevArg, arg ]
+      preceding = [ prevArg, arg ]
     } else if (cacheKey && arg.match(/=/)) {
       // console.log('FOOO', arg)
       cacheKey = undefined
@@ -131,7 +142,7 @@ function getGlobGroupsFromArgs(args, opts = {}) {
     }
 
     if (isLastArg && collection.length) {
-      const val = getValue(proceding)
+      const val = getValue(preceding)
       reserved.push(val)
       globGroups.push({
         key: trimLeadingDashes(val),
@@ -148,9 +159,6 @@ function getGlobGroupsFromArgs(args, opts = {}) {
   }
 }
 
-// const unique = Array.from(new Set(dismiss.concat(nodeSlug)))
-
-
 async function runCli(options = {}) {
   let configFile
   let opts = {}
@@ -165,10 +173,11 @@ async function runCli(options = {}) {
     //   options.glob = argv[0]
     // }
     const globParse = getGlobGroupsFromArgs(argv, {
-      // CLI args that should be glob keys
+      /* CLI args that should be glob keys */
       globKeys: ['files', 'file']
     })
     const { globGroups, otherOpts } = globParse
+    console.log('globGroups', globGroups)
     // deepLog(globParse)
     // console.log('globParse', globParse)
     if (globGroups.length) {
@@ -194,11 +203,13 @@ async function runCli(options = {}) {
     }
 
     /* Parse for weird CLI inputs */
-    const extraParse = optionsParse(otherOpts.join(' '))
+    const extraParse = parse(otherOpts.join(' '))
 
     /*
-    console.log('otherOpts', otherOpts)
-    console.log('extraParse', extraParse)
+    // console.log('otherOpts', otherOpts)
+    console.log('nicely handed CLI args')
+    console.log(extraParse)
+    process.exit(1)
     /** */
 
     delete options._

package/lib/cli.test.js

@@ -19,83 +19,83 @@ test('Exports API', () => {
   assert.equal(typeof getGlobGroupsFromArgs, 'function', 'undefined val')
 })
 
-test('Returns globs', () => {
+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 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)
+  const globData = getGlobGroupsFromArgs(longArgs)
   //*
-  logInput(rawArgv)
+  logInput(longArgs)
   deepLogger(globData)
   /** */
   assert.equal(globData.globGroups, [

package/lib/globals.d.ts

@@ -0,0 +1,66 @@
+export {}
+
+declare global {
+  const BUILD_VERSION: string;
+  interface TestGlob {
+    greeting: string;
+    duration?: number;
+    color?: string;
+  }
+}
+
+
+
+export type TinyProps = {
+  message: string;
+  count: number;
+  disabled: boolean;
+};
+
+declare var Age: number;
+
+declare function greetTwo(greeting: string): void;
+
+interface GreetingSettings {
+  greeting: string;
+  duration?: number;
+  color?: string;
+}
+declare function greet(setting: GreetingSettings): void;
+
+export namespace testFnTypes {
+  type input = boolean | Function;
+}
+
+// Use namespaces to organize types.
+// Ref like GreetingLib.LogOptions
+export declare namespace GreetingLib {
+  interface LogOptions {
+    verbose?: boolean;
+  }
+  interface AlertOptions {
+    modal: boolean;
+    title?: string;
+    color?: string;
+  }
+}
+
+export declare namespace Xyz.Options {
+  // Refer to via Xyz.Options.Log
+  interface Log {
+    verbose?: boolean;
+  }
+  interface Alert {
+    modal: boolean;
+    title?: string;
+    color?: string;
+  }
+}
+
+export namespace Dotted {
+  type Name = number;
+}
+
+export declare class A {
+  static foo(): void;
+}

package/lib/index.js

@@ -3,31 +3,63 @@ const { glob, globWithGit } = require('smart-glob')
 const codeTransform = require('./transforms/code')
 const fileTransform = require('./transforms/file')
 const tocTransform = require('./transforms/toc')
+const sectionTocTransform = require('./transforms/sectionToc')
 const wordCountTransform = require('./transforms/wordCount')
 const remoteTransform = require('./transforms/remote')
-const { deepLog, success, error, info } = require('./utils/logs')
 const { getSyntaxInfo } = require('./utils/syntax')
 const { onlyUnique, getCodeLocation, pluralize } = require('./utils')
 const { writeFile, resolveOutputPath, resolveFlatPath } = require('./utils/fs')
 const { processFile } = require('./process-file')
 const { processContents } = require('./process-contents')
-const { getBlockRegex } = require('./block-parser')
-const { OPEN_WORD, CLOSE_WORD, DEFAULT_GLOB_PATTERN } = require('./defaults')
 const { parseMarkdown } = require('./utils/md/parse')
-
-const LINE = '────────────────────────────────────────'
+const { deepLog, success, error, info } = require('./utils/logs')
+const { OPEN_WORD, CLOSE_WORD, DEFAULT_GLOB_PATTERN } = require('./defaults')
+// const { getBlockRegex } = require('./block-parser')
 // const diff = require('../misc/old-test/utils/diff')
 
+const LINE = '────────────────────────────────'
+
 const defaultTransforms = {
   CODE: codeTransform,
   FILE: fileTransform,
   TOC: tocTransform,
+  sectionToc: sectionTocTransform,
   wordCount: wordCountTransform,
   remote: remoteTransform
 }
 
+/**
+ * Allowed file syntaxes
+ * @typedef {'md' | 'js' | 'yml' | 'yaml'} SyntaxType
+ */
+
+/**
+ * Configuration for markdown magic
+ * 
+ * Below is the main config for markdown magic
+ * 
+ * @typedef {object} MarkdownMagicOptions
+ * @property {Array} [transforms = defaultTransforms] - Custom commands to transform block contents, see transforms & custom transforms sections below.
+ * @property {string} [outputDir] - Change output path of new content. Default behavior is replacing the original file
+ * @property {SyntaxType} [syntax = 'md'] - Syntax to parse
+ * @property {boolean} [outputFlatten] - Flatten files that are output
+ * @property {function} [handleOutputPath] - Custom function for altering output paths
+ * @property {boolean} [useGitGlob] - Use git glob for LARGE file directories
+ * @property {boolean} [dryRun = false] - See planned execution of matched blocks
+ * @property {boolean} [debug = false] - See debug details
+ * @property {boolean} [failOnMissingTransforms = false] - Fail if transform functions are missing. Default skip blocks.
+ */
+
+/**
+ * Markdown Magic
+ * @param {string|MarkdownMagicOptions} globOrOpts - Files to process or config. Uses [globby patterns](https://github.com/sindresorhus/multimatch/blob/master/test.js)
+ * @param {MarkdownMagicOptions} options - Markdown magic config
+ * @returns 
+ * @example
+  markdownMagic(filePath, config)
+ */
 async function markdownMagic(globOrOpts, options = {}) {
-  let opts = {}
+  let opts = options || {}
   let globPat
   if (typeof globOrOpts === 'string' || Array.isArray(globOrOpts)) {
     opts = options
@@ -35,8 +67,9 @@ async function markdownMagic(globOrOpts, options = {}) {
   } else if (typeof globOrOpts === 'object') {
     opts = globOrOpts
   }
-  const { 
+  const {
     transforms,
+    // open,
     outputDir,
     outputFlatten = false,
     handleOutputPath,
@@ -44,6 +77,7 @@ async function markdownMagic(globOrOpts, options = {}) {
     failOnMissingTransforms = false,
     dryRun = false,
     debug = true,
+    syntax = 'md',
   } = opts
 
   let open = OPEN_WORD
@@ -84,7 +118,7 @@ async function markdownMagic(globOrOpts, options = {}) {
 
   info(`Running Markdown Magic:`)
   logCommentBlockSyntax({
-    syntax: opts.syntax || 'md',
+    syntax: syntax,
     open,
     close
   })
@@ -265,7 +299,7 @@ async function markdownMagic(globOrOpts, options = {}) {
     console.log(`Invalid transforms:    ${missingTotal} / ${total}`)
     console.log('Syntax:')
     logCommentBlockSyntax({
-      syntax: opts.syntax || 'md',
+      syntax: syntax,
       open,
       close
     })