markdown-magic 2.6.1 → 3.0.1

package/README.md

@@ -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 -->
@@ -54,8 +55,8 @@ npm install markdown-magic --save-dev
 ```
 
 ## Usage
-<!-- ⛔️ MD-MAGIC-EXAMPLE:START (CODE:src=./examples/basic-usage.js) -->
-<!-- The below code snippet is automatically added from ./examples/basic-usage.js -->
+<!-- ⛔️ MD-MAGIC-EXAMPLE:START (CODE:src=./examples/1-_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=./index.js)
+<!-- ⛔️ 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')
   }
 }
 ```
@@ -139,12 +142,12 @@ module.exports = {
 
 ## Transforms
 
-Markdown Magic comes with a couple of built in transforms for you to use or you can extend it with your own transforms. See 'Custom Transforms' below.
+Markdown Magic comes with a couple of built-in transforms for you to use or you can extend it with your own transforms. See 'Custom Transforms' below.
 
 <!-- ⛔️ 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`
@@ -255,9 +258,9 @@ The face symbol 👉 <!-- MD-MAGIC-EXAMPLE:START (INLINE_EXAMPLE) -->**⊂◉‿
 * [jsdoc](https://github.com/bradtaylorsf/markdown-magic-jsdoc) - Adds jsdoc comment support
 * [build-badge](https://github.com/rishichawda/markdown-magic-build-badge) - Update branch badges to auto-magically point to current branches.
 * [package-json](https://github.com/forresst/markdown-magic-package-json) - Add the package.json properties to markdown files
-* [local-image](https://github.com/stevenbenisek/markdown-magic-local-image)
 * [figlet](https://github.com/lafourchette/markdown-magic-figlet) - Add FIGfont text to markdown files
 * [local-image](https://github.com/stevenbenisek/markdown-magic-local-image) - plugin to add local images to markdown
+* [markdown-magic-build-badge](https://github.com/rishichawda/markdown-magic-build-badge) - A plugin to update your branch badges to point to correct branch status
 
 ## Adding Custom Transforms
 
@@ -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
@@ -346,9 +361,8 @@ module.exports = function customPlugin(pluginOptions) {
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END -->
 
 [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) DO not edit ⛔️ -->
+<!-- ⛔️ 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
@@ -376,10 +390,6 @@ This will replace all the contents of inside the comment DUDE
 
 This was inspired by [Kent C Dodds](https://twitter.com/kentcdodds) and [jfmengels](https://github.com/jfmengels)'s [all contributors cli](https://github.com/jfmengels/all-contributors-cli) project.
 
-<!-- MD-MAGIC-EXAMPLE:START (LOLZ)-->
-This section was generated by the cli config markdown.config.js file
-<!-- MD-MAGIC-EXAMPLE:END (LOLZ)-->
-
 ## License
 
 [MIT][mit] © [DavidWells][author]

package/cli.js

@@ -1,84 +1,7 @@
-#!/usr/bin/env node
+const mri = require('mri')
+const { runCli } = require('./lib/cli')
+const argv = process.argv.slice(2)
+const cliArgs = mri(argv)
 
-const program = require('commander')
-const pkg = require('./package.json')
-const markdownMagic = require('./index')
-const findUp = require('find-up')
-const defaultFileName = 'README.md'
-const defaultConfigPath = './markdown.config.js'
-const loadConfig = require('./cli-utils').loadConfig
+runCli(cliArgs)
 
-var filePaths = defaultFileName
-var callbackFunction = defaultCallback // eslint-disable-line
-var ignorePath // eslint-disable-line
-
-// start commander.js
-program
-  .version(pkg.version)
-  .option('-p, --path [path]', `Define path to markdown (single path or glob). Default ${defaultFileName}`, parsePaths, defaultFileName)
-  .option('-i, --ignore [path]', '(Optional) Define path to ignore', parseIgnorePaths, defaultConfigPath)
-  .option('-c, --config [path]', '(Optional) Define config file path. If you have custom transforms or a callback you will want to specify this option', null, defaultConfigPath)
-  // .option('-cb, --callback [path]', 'Define path', parsePaths, defaultFileName)
-  .parse(process.argv)
-
-const configFile = getConfigFilepath()
-const foundConfig = (configFile) ? loadConfig(configFile) : false
-
-if (foundConfig && foundConfig.callback) {
-  callbackFunction = foundConfig.callback
-}
-if (!foundConfig) {
-  // console.log('No markdown magic config set using {empty object}')
-}
-const configuration = foundConfig || {}
-
-function parsePaths(path, defaultValue) {
-  if (path) {
-    filePaths = path
-  }
-}
-
-function parseIgnorePaths(path, defaultValue) {
-  if (path) {
-    ignorePath = path.split(',').map((p) => {
-      const fp = p.trim()
-      if (fp.match(/\bnode_modules\b/)) {
-        // exact node_module match. Ignore entire DIR
-        return '!node_modules/**'
-      }
-      if (!fp.match(/^!/)) {
-        return `!${fp}`
-      }
-      return fp
-    })
-  }
-}
-
-// process default
-if (program.path) {
-  filePaths = program.path
-}
-
-if (ignorePath) {
-  // console.log('ignore path', ignorePath)
-  filePaths = [filePaths].concat(ignorePath)
-}
-
-// console.log('filePaths', filePaths)
-// console.log('configuration', configuration)
-// console.log('callbackFunction', callbackFunction)
-console.log('Starting markdown-magic', filePaths)
-markdownMagic(filePaths, configuration, callbackFunction)
-
-function defaultCallback(err, msg) {
-  if (err) {
-    console.log('Error:', err)
-  }
-  if (msg) {
-    console.log('Files processed. markdown-magic Finished! ⊂◉‿◉つ')
-  }
-}
-
-function getConfigFilepath() {
-  return program.config || findUp.sync(defaultConfigPath) || findUp.sync('md-magic.config.js')
-}

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

@@ -0,0 +1,171 @@
+const path = require('path')
+const fs = require('fs').promises
+const { test } = require('uvu') 
+const assert = require('uvu/assert')
+const { parseBlocks } = require('./block-parser')
+const { deepLog } = require('./utils/logs')
+
+test('JS file parse', async () => {
+  const contents = await fs.readFile(path.join(__dirname, '../test/fixtures/js/simple.js'), 'utf-8')
+  const blocks = parseBlocks(contents, {
+    syntax: 'js',
+    open: 'GENERATED',
+    close: '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
+      },
+      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
+      },
+      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
+      },
+      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
+      },
+      content: {
+        value: "/* Awesome */\nconsole.log('noooo')",
+        start: 492,
+        end: 526,
+        indentation: 0
+      },
+      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()