markdown-magic 2.6.0 → 3.0.0

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 expand</summary>
+<summary>Click to expaxnd</summary>
 
 - [About](#about)
 - [Install](#install)
@@ -54,7 +54,7 @@ npm install markdown-magic --save-dev
 ```
 
 ## Usage
-<!-- ⛔️ MD-MAGIC-EXAMPLE:START (CODE:src=./examples/basic-usage.js) -->
+<!-- ⛔️ MD-MAGIC-EXAMPLE:START (CODE:src=./examples/1-_basic-usage.js) -->
 <!-- The below code snippet is automatically added from ./examples/basic-usage.js -->
 ```js
 import path from 'path'
@@ -66,7 +66,7 @@ markdownMagic(markdownPath)
 <!-- ⛔️ MD-MAGIC-EXAMPLE:END *-->
 
 
-<!-- ⛔️ 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
@@ -139,7 +139,7 @@ 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
@@ -255,9 +255,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
 
@@ -346,7 +346,7 @@ 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 -->
@@ -376,10 +376,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,179 @@
+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)
+  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 */'
+        }
+      },
+      {
+        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 */'
+        }
+      },
+      {
+        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 */'
+        }
+      },
+      {
+        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 */'
+        }
+      },
+      {
+        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 */'
+        }
+      },
+      {
+        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 */'
+        }
+      }
+    ]
+  })
+})
+
+test.run()