markdown-magic 3.0.0 → 3.0.2

package/README.md

@@ -21,7 +21,7 @@ This `README.md` is generated with `markdown-magic` [view the raw file](https://
 ## Table of Contents
 <!-- ⛔️ MD-MAGIC-EXAMPLE:START (TOC:collapse=true&collapseText=Click to expand) -->
 <details>
-<summary>Click to expaxnd</summary>
+<summary>Click to expand</summary>
 
 - [About](#about)
 - [Install](#install)
@@ -43,6 +43,7 @@ This `README.md` is generated with `markdown-magic` [view the raw file](https://
 - [Prior Art](#prior-art)
 - [License](#license)
 - [Usage examples](#usage-examples)
+- [Misc Markdown helpers](#misc-markdown-helpers)
 
 </details>
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END -->
@@ -55,7 +56,7 @@ npm install markdown-magic --save-dev
 
 ## Usage
 <!-- ⛔️ MD-MAGIC-EXAMPLE:START (CODE:src=./examples/1-_basic-usage.js) -->
-<!-- The below code snippet is automatically added from ./examples/basic-usage.js -->
+<!-- The below code snippet is automatically added from ./examples/1-_basic-usage.js -->
 ```js
 import path from 'path'
 import markdownMagic from 'markdown-magic'
@@ -65,19 +66,14 @@ markdownMagic(markdownPath)
 ```
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END *-->
 
+### API
 
 <!-- ⛔️ MD-MAGIC-EXAMPLE:START (RENDERDOCS:path=./lib/index.js)
 - Do not remove or modify this section -->
-### API
-```js
-markdownMagic(filePath, config, callback)
-```
-- `filePaths` - *String or Array* - Path or glob pattern. Uses [globby patterns](https://github.com/sindresorhus/multimatch/blob/master/test.js)
-- `config` - See configuration options below
-- `callback` - callback to run after markdown updates
+Markdown Magic
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END - Do not remove or modify this section -->
 
-<!-- ⛔️ MD-MAGIC-EXAMPLE:START (RENDERDOCS:path=./lib/processFile.js)
+<!-- ⛔️ MD-MAGIC-EXAMPLE:START (RENDERDOCS:path=./lib/process-file.js)
 - Do not remove or modify this section -->
 ### Configuration Options
 
@@ -118,20 +114,27 @@ In NPM scripts, `npm run docs` would run the markdown magic and parse all the `.
 
 If you have a `markdown.config.js` file where `markdown-magic` is invoked, it will automatically use that as the configuration unless otherwise specified by `--config` flag.
 
-<!-- ⛔️ MD-MAGIC-EXAMPLE:START (CODE:src=./markdown.config.js) -->
-<!-- The below code snippet is automatically added from ./markdown.config.js -->
+<!-- ⛔️ MD-MAGIC-EXAMPLE:START (CODE:src=./md.config.js) -->
+<!-- The below code snippet is automatically added from ./md.config.js -->
 ```js
 /* CLI markdown.config.js file example */
 module.exports = {
-  matchWord: 'MD-MAGIC-EXAMPLE',
+  // handleOutputPath: (currentPath) => {
+  //   const newPath =  'x' + currentPath
+  //   return newPath
+  // },
+  // handleOutputPath: (currentPath) => {
+  //   const newPath = currentPath.replace(/fixtures/, 'fixtures-out')
+  //   return newPath
+  // },
   transforms: {
-    /* Match <!-- AUTO-GENERATED-CONTENT:START (LOLZ) --> */
-    LOLZ(content, options) {
-      return `This section was generated by the cli config markdown.config.js file`
+    /* Match <!-- AUTO-GENERATED-CONTENT:START (transformOne) --> */
+    transformOne() {
+      return `This section was generated by the cli config md.config.js file`
+    },
+    functionName() {
+      return `xyz`
     }
-  },
-  callback: function () {
-    console.log('markdown processing done')
   }
 }
 ```
@@ -144,7 +147,7 @@ Markdown Magic comes with a couple of built-in transforms for you to use or you
 <!-- ⛔️ MD-MAGIC-EXAMPLE:START (RENDERDOCS:path=./lib/transforms/index.js) - Do not remove or modify this section -->
 ### > TOC
 
-Generate table of contents from markdown file
+Generate taxxxxble of contents from markdown file
 
 **Options:**
 - `firsth1` - *boolean* - (optional): Show first h1 of doc in table of contents. Default `false`
@@ -274,23 +277,32 @@ The below code is used to generate **this markdown file** via the plugin system.
 ```js
 const fs = require('fs')
 const path = require('path')
-const markdownMagic = require('../index')
-// const markdownMagic = require('markdown-magic')
+const doxxx = require('doxxx')
+const { markdownMagic } = require('../lib')
+// const { markdownMagic } = require('markdown-magic')
 
 const config = {
   matchWord: 'MD-MAGIC-EXAMPLE', // default matchWord is AUTO-GENERATED-CONTENT
   transforms: {
     /* Match <!-- AUTO-GENERATED-CONTENT:START (customTransform:optionOne=hi&optionOne=DUDE) --> */
-    customTransform(content, options) {
+    customTransform({ content, options }) {
       console.log('original content in comment block', content)
       console.log('options defined on transform', options)
       // options = { optionOne: hi, optionOne: DUDE}
       return `This will replace all the contents of inside the comment ${options.optionOne}`
     },
     /* Match <!-- AUTO-GENERATED-CONTENT:START (RENDERDOCS:path=../file.js) --> */
-    RENDERDOCS(content, options) {
+    RENDERDOCS(api) {
+      console.log('api', api)
+      const { options } = api
+      console.log('options.path', path.resolve(options.path))
       const fileContents = fs.readFileSync(options.path, 'utf8')
-      const docBlocs = require('doxxx').parseComments(fileContents, { raw: true, skipSingleStar: true })
+      const docBlocs = doxxx.parseComments(fileContents, { raw: true, skipSingleStar: true })
+        .filter((item) => {
+          return item.tags.length
+        })
+      console.log('docBlocs', docBlocs)
+      // process.exit(1)
       let updatedContent = ''
       docBlocs.forEach((data) => {
         updatedContent += `${data.description.full}\n\n`
@@ -300,6 +312,10 @@ const config = {
     INLINE_EXAMPLE: () => {
       return '**⊂◉‿◉つ**'
     },
+    lolz() {
+      console.log('run lol')
+      return `This section was generated by the cli config markdown.config.js file`
+    },
     /* Match <!-- AUTO-GENERATED-CONTENT:START (pluginExample) --> */
     pluginExample: require('./plugin-example')({ addNewLine: true }),
     /* Include plugins from NPM */
@@ -327,16 +343,15 @@ return function myCustomTransform (content, options)
 <!-- The below code snippet is automatically added from ./examples/plugin-example.js -->
 ```js
 /* Custom Transform Plugin example */
-const merge = require('deepmerge')
 module.exports = function customPlugin(pluginOptions) {
   // set plugin defaults
   const defaultOptions = {
     addNewLine: false
   }
   const userOptions = pluginOptions || {}
-  const pluginConfig = merge(defaultOptions, userOptions)
+  const pluginConfig = Object.assign(defaultOptions, userOptions)
   // return the transform function
-  return function myCustomTransform (content, options) {
+  return function myCustomTransform ({ content, options }) {
     const newLine = (pluginConfig.addNewLine) ? '\n' : ''
     const updatedContent = content + newLine
     return updatedContent
@@ -348,7 +363,6 @@ module.exports = function customPlugin(pluginOptions) {
 [View the raw file](https://raw.githubusercontent.com/DavidWells/markdown-magic/master/README.md) file and run `npm run docs` to see this plugin run
 <!-- ⛔️ MD-MAGIC-EXAMPLE:START (pluginExample) ⛔️ -->
 This content is altered by the `pluginExample` plugin registered in `examples/generate-readme.js`
-
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END -->
 
 ## Other usage examples

package/lib/block-parser-js.test.js

@@ -12,168 +12,160 @@ test('JS file parse', async () => {
     open: 'GENERATED',
     close: 'END-GENERATED',
   })
-  // deepLog(blocks)
-  assert.equal(blocks, {
-    pattern: /([ \t]*)(?:\/\*+(?:.*|\r?|\n?|\s*)GENERATED\s*([(\[\{]*[A-Za-z0-9_$-]*[)\]\}]*)\s*)((?:.*?|.*?\r?\n?)*?)\/\*+(?:.*|\r?|\n?|\s*)END-GENERATED(?:.|\r?\n)*?\*+\//gim,
-    COMMENT_OPEN_REGEX: /([ \t]*)(\/\*+(?:.|\r?|\n?|\s*)\bGENERATED\b)((?:.|\r?\n)*?\*+\/\n?)/gi,
-    COMMENT_CLOSE_REGEX: /\*+\/(?:.|\r?\n)*?([ 	]*)((?:\/\*+(?:.*|\r?\n)(?:.*|\r?\n))*?\bEND-GENERATED\b)((?:.|\r?\n)*?\*+\/)/gi,
-    blocks: [
-      {
-        index: 2,
-        type: 'a',
-        options: {},
-        context: { isMultiline: true },
-        open: { value: '/* GENERATED a */\n', start: 96, end: 113 },
-        content: {
-          value: '// comment inside',
-          start: 113,
-          end: 132,
-          indentation: 0
-        },
-        close: { value: '\n/* END-GENERATED */', start: 132, end: 151 },
-        block: {
-          indentation: '',
-          lines: [ 7, 9 ],
-          start: 96,
-          end: 151,
-          rawType: 'a',
-          rawArgs: '',
-          rawContent: '\n// comment inside\n',
-          value: '/* GENERATED a */\n// comment inside\n/* END-GENERATED */'
-        }
+  /*
+  deepLog(blocks.blocks)
+  /** */
+  assert.equal(blocks.blocks, [
+    {
+      index: 1,
+      type: 'a',
+      options: {},
+      context: { isMultiline: true },
+      open: { value: '/* ⛔️ GENERATED a */\n', start: 96, end: 117 },
+      content: {
+        value: '// comment inside',
+        start: 117,
+        end: 134,
+        indentation: 0
       },
-      {
-        index: 3,
-        type: 'b',
-        options: {},
-        context: { isMultiline: true },
-        open: { value: '/* GENERATED b */\n', start: 153, end: 170 },
-        content: { value: '', start: 170, end: 171, indentation: 0 },
-        close: {
-          value: '/* comment inside */\n/* END-GENERATED */',
-          start: 171,
-          end: 211
-        },
-        block: {
-          indentation: '',
-          lines: [ 11, 13 ],
-          start: 153,
-          end: 211,
-          rawType: 'b',
-          rawArgs: '',
-          rawContent: '\n',
-          value: '/* GENERATED b */\n/* comment inside */\n/* END-GENERATED */'
-        }
+      close: { value: '\n/* END-GENERATED */', start: 134, end: 154 },
+      block: {
+        indentation: '',
+        lines: [ 7, 9 ],
+        start: 96,
+        end: 154,
+        rawArgs: '',
+        rawContent: '// comment inside',
+        value: '/* ⛔️ GENERATED a */\n// comment inside\n/* END-GENERATED */'
+      }
+    },
+    {
+      index: 2,
+      type: 'b',
+      options: {},
+      context: { isMultiline: true },
+      open: { value: '/* GENERATED b */\n', start: 156, end: 174 },
+      content: {
+        value: '/* comment inside */',
+        start: 174,
+        end: 194,
+        indentation: 0
+      },
+      close: { value: '\n/* END-GENERATED */', start: 194, end: 214 },
+      block: {
+        indentation: '',
+        lines: [ 11, 13 ],
+        start: 156,
+        end: 214,
+        rawArgs: '',
+        rawContent: '/* comment inside */',
+        value: '/* GENERATED b */\n/* comment inside */\n/* END-GENERATED */'
+      }
+    },
+    {
+      index: 3,
+      type: 'c',
+      options: {},
+      context: { isMultiline: true },
+      open: { value: '/* GENERATED c */\n', start: 216, end: 234 },
+      content: {
+        value: '/* \n  comment inside \n*/',
+        start: 234,
+        end: 258,
+        indentation: 0
+      },
+      close: { value: '\n/* END-GENERATED */', start: 258, end: 278 },
+      block: {
+        indentation: '',
+        lines: [ 15, 19 ],
+        start: 216,
+        end: 278,
+        rawArgs: '',
+        rawContent: '/* \n  comment inside \n*/',
+        value: '/* GENERATED c */\n/* \n  comment inside \n*/\n/* END-GENERATED */'
+      }
+    },
+    {
+      index: 4,
+      type: 'd',
+      options: {},
+      context: { isMultiline: true },
+      open: { value: '/* GENERATED d */\n', start: 280, end: 298 },
+      content: {
+        value: '/**\n * comment inside \n */',
+        start: 298,
+        end: 324,
+        indentation: 0
       },
-      {
-        index: 4,
-        type: 'c',
-        options: {},
-        context: { isMultiline: true },
-        open: { value: '/* GENERATED c */\n', start: 213, end: 230 },
-        content: {
-          value: '/* \n  comment inside \n*/',
-          start: 230,
-          end: 256,
-          indentation: 0
-        },
-        close: { value: '\n/* END-GENERATED */', start: 256, end: 275 },
-        block: {
-          indentation: '',
-          lines: [ 15, 19 ],
-          start: 213,
-          end: 275,
-          rawType: 'c',
-          rawArgs: '',
-          rawContent: '\n/* \n  comment inside \n*/\n',
-          value: '/* GENERATED c */\n/* \n  comment inside \n*/\n/* END-GENERATED */'
-        }
+      close: { value: '\n/* END-GENERATED */', start: 324, end: 344 },
+      block: {
+        indentation: '',
+        lines: [ 21, 25 ],
+        start: 280,
+        end: 344,
+        rawArgs: '',
+        rawContent: '/**\n * comment inside \n */',
+        value: '/* GENERATED d */\n/**\n * comment inside \n */\n/* END-GENERATED */'
+      }
+    },
+    {
+      index: 5,
+      type: 'e',
+      options: {},
+      context: { isMultiline: true },
+      open: { value: '/* GENERATED e */\n', start: 346, end: 364 },
+      content: {
+        value: '/****************\n comment inside \n******************/',
+        start: 364,
+        end: 418,
+        indentation: 0
       },
-      {
-        index: 5,
-        type: 'd',
-        options: {},
-        context: { isMultiline: true },
-        open: { value: '/* GENERATED d */\n', start: 277, end: 294 },
-        content: {
-          value: '/**\n * comment inside \n */',
-          start: 294,
-          end: 322,
-          indentation: 0
-        },
-        close: { value: '\n/* END-GENERATED */', start: 322, end: 341 },
-        block: {
-          indentation: '',
-          lines: [ 21, 25 ],
-          start: 277,
-          end: 341,
-          rawType: 'd',
-          rawArgs: '',
-          rawContent: '\n/**\n * comment inside \n */\n',
-          value: '/* GENERATED d */\n/**\n * comment inside \n */\n/* END-GENERATED */'
-        }
+      close: { value: '\n/* END-GENERATED */', start: 418, end: 438 },
+      block: {
+        indentation: '',
+        lines: [ 27, 31 ],
+        start: 346,
+        end: 438,
+        rawArgs: '',
+        rawContent: '/****************\n comment inside \n******************/',
+        value: '/* GENERATED e */\n' +
+          '/****************\n' +
+          ' comment inside \n' +
+          '******************/\n' +
+          '/* END-GENERATED */'
+      }
+    },
+    {
+      index: 6,
+      type: 'MyCodeGen',
+      options: { yay: 'nice' },
+      context: { isMultiline: true },
+      open: {
+        value: "/* GENERATED MyCodeGen yay='nice' */\n",
+        start: 455,
+        end: 492
       },
-      {
-        index: 6,
-        type: 'e',
-        options: {},
-        context: { isMultiline: true },
-        open: { value: '/* GENERATED e */\n', start: 343, end: 360 },
-        content: {
-          value: '/****************\n comment inside \n******************/',
-          start: 360,
-          end: 416,
-          indentation: 0
-        },
-        close: { value: '\n/* END-GENERATED */', start: 416, end: 435 },
-        block: {
-          indentation: '',
-          lines: [ 27, 31 ],
-          start: 343,
-          end: 435,
-          rawType: 'e',
-          rawArgs: '',
-          rawContent: '\n/****************\n comment inside \n******************/\n',
-          value: '/* GENERATED e */\n' +
-            '/****************\n' +
-            ' comment inside \n' +
-            '******************/\n' +
-            '/* END-GENERATED */'
-        }
+      content: {
+        value: "/* Awesome */\nconsole.log('noooo')",
+        start: 492,
+        end: 526,
+        indentation: 0
       },
-      {
-        index: 7,
-        type: 'MyCodeGen',
-        options: { yay: 'nice' },
-        context: { isMultiline: true },
-        open: {
-          value: "/* GENERATED MyCodeGen yay='nice' */\n",
-          start: 452,
-          end: 488
-        },
-        content: {
-          value: "/* Awesome */\nconsole.log('noooo')",
-          start: 488,
-          end: 524,
-          indentation: 0
-        },
-        close: { value: '\n/* END-GENERATED */', start: 524, end: 543 },
-        block: {
-          indentation: '',
-          lines: [ 35, 38 ],
-          start: 452,
-          end: 543,
-          rawType: 'MyCodeGen',
-          rawArgs: "yay='nice'",
-          rawContent: "\n/* Awesome */\nconsole.log('noooo')\n",
-          value: "/* GENERATED MyCodeGen yay='nice' */\n" +
-            '/* Awesome */\n' +
-            "console.log('noooo')\n" +
-            '/* END-GENERATED */'
-        }
+      close: { value: '\n/* END-GENERATED */', start: 526, end: 546 },
+      block: {
+        indentation: '',
+        lines: [ 35, 38 ],
+        start: 455,
+        end: 546,
+        rawArgs: "yay='nice'",
+        rawContent: "/* Awesome */\nconsole.log('noooo')",
+        value: "/* GENERATED MyCodeGen yay='nice' */\n" +
+          '/* Awesome */\n' +
+          "console.log('noooo')\n" +
+          '/* END-GENERATED */'
       }
-    ]
-  })
+    }
+  ])
 })
 
 test.run()