markdown-magic 2.6.1 → 3.0.0

package/lib/utils/text.test.js

@@ -0,0 +1,311 @@
+const { test } = require('uvu')
+const assert = require('uvu/assert')
+const { stripComments, dedentString, convertCommentSyntax } = require('./text')
+const { deepLog } = require('./logs')
+
+const md = `<h1 id="jdjdj">Netlify + FaunaDB &nbsp;&nbsp;&nbsp; 
+ <a href="https://app.netlify.com/start/deploy?repository=https://github.com/netlify/netlify-faunadb-example&stack=fauna">
+   <img src="https://www.netlify.com/img/deploy/button.svg">
+ </a>
+</h1>
+
+foo o     <!-- XYZ:START functionName foo={{ rad: 'yellow' }} -->
+
+nice
+<!-- XYZ:END -->
+
+<!-- XYZ:START functionName foo={{ rad: 'yellow' }} -->
+wooooooo
+<!-- XYZ:END -->
+
+<!-- XYZ:START {functionName} foo={{ rad: 'blue' }} -->
+cool
+<!-- XYZ:END -->
+
+<!-- XYZ:START {functionName} foo={{ rad: 'red' }} -->
+rad
+<!-- XYZ:END -->
+
+
+<!-- XYZ:START [wootName] foo=['one', 'two'] -->
+nice
+<!-- XYZ:END -->
+
+
+<!-- XYZ:START -->
+lol
+<!-- XYZ:END -->
+
+
+<!-- xyz:start (lowerCase) foo=['one', 'two'] heading=false -->
+nice
+<!-- XYZ:END -->
+
+
+<!-- XYZ:START(cool) 
+ width={999} 
+ height={{111}}
+ numberAsString="12345"   
+ great={["scoot", "sco ot", 'scooo ttt']} 
+ nice={{ value: nice, cool: "true" }}
+ soclose=[jdjdjd, hdhfhfhffh]
+ rad="boss"
+ cool=true notCool=false
+ nooooo={[one, two, 3, 4]}
+ numberZero=0,
+ xyz=999,
+ nope=false,
+ // comment
+ yes={true} -->
+
+actual content
+
+<!-- XYZ:END -->
+
+
+<img src="https://www.netlify.com/img/deploy/button.svg"/>
+
+
+<img src="https://www.hehhehehehe.com/img/deploy/button.svg" />
+
+
+<!-- XYZ:START(cool) xxx
+hhddh=cool -->
+wowow
+whatever we want 
+<!-- XYZ:END -->
+
+
+<!-- XYZ:START(hhh) -->
+xyz
+<!-- XYZ:END -->
+
+
+<!-- XYZ:START(cool) isCool -->
+nice
+<!-- XYZ:END -->
+
+`
+
+test('Remove Markdown comments', () => {
+  const parsedValue = stripComments(md, {
+    syntax: 'md'
+  })
+  /*
+  console.log('parsedValue')
+  logOutput(parsedValue)
+  /** */
+  assert.equal(typeof parsedValue, 'string')
+  assert.equal(parsedValue.match(/-->/), null)
+  assert.equal(parsedValue.match(/<!--/), null)
+  assert.equal(parsedValue.split('\n'), [
+    '<h1 id="jdjdj">Netlify + FaunaDB &nbsp;&nbsp;&nbsp; ',
+    ' <a href="https://app.netlify.com/start/deploy?repository=https://github.com/netlify/netlify-faunadb-example&stack=fauna">',
+    '   <img src="https://www.netlify.com/img/deploy/button.svg">',
+    ' </a>',
+    '</h1>',
+    '',
+    'foo o',
+    '',
+    'nice',
+    '',
+    'wooooooo',
+    '',
+    'cool',
+    '',
+    'rad',
+    '',
+    '',
+    'nice',
+    '',
+    '',
+    'lol',
+    '',
+    '',
+    'nice',
+    '',
+    '',
+    '',
+    'actual content',
+    '',
+    '',
+    '',
+    '<img src="https://www.netlify.com/img/deploy/button.svg"/>',
+    '',
+    '',
+    '<img src="https://www.hehhehehehe.com/img/deploy/button.svg" />',
+    '',
+    '',
+    'wowow',
+    'whatever we want ',
+    '',
+    '',
+    'xyz',
+    '',
+    '',
+    'nice',
+    '',
+    ''
+  ])
+})
+
+test('Remove Javascript comments', () => {
+  const parsedValue = stripComments(`
+/*
+Fooo bar
+*/
+console.log('cool')
+console.log('multiline')/*
+weird one
+*/
+console.log('inline') /* inline klsjlkajdsalkjd *****/
+
+/* inline */
+console.log('nice')
+`, {
+  syntax: 'js'
+})
+  /*
+  console.log('parsedValue')
+  logOutput(parsedValue)
+  /** */
+  assert.equal(typeof parsedValue, 'string')
+  assert.equal(parsedValue.match(/\/\*/), null)
+  assert.equal(parsedValue.match(/\*\//), null)
+  assert.equal(parsedValue.split('\n'), [
+    '',
+    "console.log('cool')",
+    "console.log('multiline')",
+    "console.log('inline')",
+    '',
+    "console.log('nice')",
+    ''
+  ])
+})
+
+test('Remove YAML comments', () => {
+  const parsedValue = stripComments(`
+  bob: cool
+  # Remove this
+  # And this Remove this
+  joe: cool
+  bill: "cool"
+  ## Remove this
+  ## And this
+  steve: 'cool' # inline comment
+  foo:
+    bar: lol
+`, {
+  syntax: 'yml'
+})
+
+  /*
+  console.log('yml', dedentString(parsedValue))
+  console.log('parsedValue')
+  // deepLog(parsedValue)
+  logOutput(parsedValue)
+  /** */
+  assert.equal(typeof parsedValue, 'string')
+  assert.equal(parsedValue.match(/#/), null)
+  assert.equal(parsedValue.split('\n'), [
+    '',
+    '  bob: cool',
+    '  joe: cool',
+    '  bill: "cool"',
+    "  steve: 'cool'",
+    '  foo:',
+    '    bar: lol',
+    ''
+  ])
+})
+
+test('Convert comment syntax', () => {
+  const yml = `
+  bob: cool
+  # Remove this
+  # And this Remove this
+  joe: cool
+  bill: "cool"
+  ## Remove this
+  ## And this
+  steve: 'cool' # inline comment
+  foo:
+    bar: lol
+`
+  const jsx = convertCommentSyntax(yml, {
+    from: 'yml',
+    to: 'jsx'
+  })
+  // logOutput(jsx)
+
+  assert.equal(jsx.split('\n'), [
+    '',
+    '  bob: cool',
+    '  {/* Remove this */}',
+    '  {/* And this Remove this */}',
+    '  joe: cool',
+    '  bill: "cool"',
+    '  {/* Remove this */}',
+    '  {/* And this */}',
+    "  steve: 'cool' {/* inline comment */}",
+    '  foo:',
+    '    bar: lol',
+    ''
+  ])
+
+  const js = convertCommentSyntax(yml, {
+    from: 'yml',
+    to: 'js'
+  })
+  // logOutput(js)
+
+  assert.equal(js.split('\n'), [
+    '',
+    '  bob: cool',
+    '  /* Remove this */',
+    '  /* And this Remove this */',
+    '  joe: cool',
+    '  bill: "cool"',
+    '  /* Remove this */',
+    '  /* And this */',
+    "  steve: 'cool' /* inline comment */",
+    '  foo:',
+    '    bar: lol',
+    ''
+  ])
+
+  const html = convertCommentSyntax(yml, {
+    from: 'yml',
+    to: 'html'
+  })
+  // logOutput(html)
+
+  assert.equal(html.split('\n'), [
+    '',
+    '  bob: cool',
+    '  <!-- Remove this -->',
+    '  <!-- And this Remove this -->',
+    '  joe: cool',
+    '  bill: "cool"',
+    '  <!-- Remove this -->',
+    '  <!-- And this -->',
+    "  steve: 'cool' <!-- inline comment -->",
+    '  foo:',
+    '    bar: lol',
+    ''
+  ])
+
+  // //*
+  // console.log('parsedValue')
+  // // deepLog(parsedValue)
+  // logOutput(parsedValue)
+  // /** */
+  // assert.equal(typeof parsedValue, 'string')
+})
+
+
+function logOutput(value) {
+  console.log(value.split('\n'))
+}
+
+test.run()

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "markdown-magic",
-  "version": "2.6.1",
+  "version": "3.0.0",
   "description": "Automatically update markdown files with content from external sources",
-  "main": "index.js",
+  "main": "lib/index.js",
   "bin": {
     "markdown": "./cli.js",
     "md-magic": "./cli.js"
@@ -10,18 +10,25 @@
   "files": [
     "README.md",
     "package.json",
-    "index.js",
+    "package-lock.json",
     "cli.js",
-    "cli-utils.js",
     "/lib"
   ],
   "scripts": {
     "docs": "node examples/generate-readme.js",
-    "uvu": "uvu lib '.test.([mc]js|[jt]sx?)$'",
-    "test": "ava --verbose",
-    "test:watch": "ava --verbose --watch",
+    "test": "npm run test:lib && npm run test:test && echo 'tests done'",
+    "test:lib": "uvu lib '.test.([mc]js|[jt]sx?)$'",
+    "test:test": "uvu test '.test.([mc]js|[jt]sx?)$'",
+    "test:options": "uvu lib 'options-parser.test.([mc]js|[jt]sx?)$'",
+    "test:block": "uvu lib 'block-parser.test.([mc]js|[jt]sx?)$'",
+    "test:cli": "uvu lib 'cli.test.([mc]js|[jt]sx?)$'",
+    "test:md": "uvu lib 'md.test.([mc]js|[jt]sx?)$'",
+    "test:fs": "uvu lib 'fs.test.([mc]js|[jt]sx?)$'",
+    "test:js": "uvu lib 'block-parser-js.test.([mc]js|[jt]sx?)$'",
+    "test:errors": "uvu test 'errors.test.([mc]js|[jt]sx?)$'",
+    "test:transforms": "uvu test 'transforms.test.([mc]js|[jt]sx?)$'",
+    "test:text": "uvu lib 'text.test.([mc]js|[jt]sx?)$'",
     "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
-    "lint": "eslint .",
     "publish": "git push origin && git push origin --tags",
     "release:patch": "npm version patch && npm publish",
     "release:minor": "npm version minor && npm publish",
@@ -36,29 +43,22 @@
   },
   "dependencies": {
     "@technote-space/doctoc": "2.4.7",
-    "commander": "^7.2.0",
-    "deepmerge": "^4.2.2",
-    "find-up": "^5.0.0",
-    "globby": "^10.0.2",
+    "globrex": "^0.1.2",
+    "gray-matter": "^4.0.3",
+    "is-glob": "^4.0.3",
     "is-local-path": "^0.1.6",
+    "is-valid-path": "^0.1.1",
     "json-alexander": "^0.1.8",
-    "mkdirp": "^1.0.4",
+    "mri": "^1.2.0",
+    "smart-glob": "^1.0.2",
     "sync-request": "^6.1.0"
   },
   "devDependencies": {
-    "ava": "^3.15.0",
-    "doxxx": "^1.0.0",
-    "rimraf": "^3.0.2",
-    "sinon": "^11.1.1",
-    "uvu": "^0.5.1",
     "ansi-styles": "^4.2.1",
     "concordance": "^5.0.1",
-    "safe-chalk": "^1.0.0"
-  },
-  "ava": {
-    "files": [
-      "test/**/*.test.js"
-    ],
-    "verbose": true
+    "doxxx": "^1.0.0",
+    "rimraf": "^3.0.2",
+    "safe-chalk": "^1.0.0",
+    "uvu": "^0.5.1"
   }
 }

package/index.js

@@ -1,46 +0,0 @@
-const globby = require('globby')
-const processFile = require('./lib/processFile')
-/**
- * ### 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
- *
- * @param  {string} filePath - Path to markdown file
- * @param  {object} [config] - configuration object
- * @param  {Function} [callback] - callback function with updated contents
- */
-module.exports = async function markdownMagic(filePaths, config, callback) {
-  const files = globby.sync(filePaths)
-  const configuration = config || {}
-  if (!callback && typeof configuration === 'function') {
-    callback = configuration // eslint-disable-line
-  } else if (typeof config === 'object' && config.callback) {
-    // set callback in config for CLI usage
-    callback = config.callback // eslint-disable-line
-  }
-  if (!files.length) {
-    callback && callback('No files matched')
-    console.log('No files matched pattern', filePaths)
-    return false
-  }
-  configuration.originalFilePaths = files
-
-  const data = files.map(async (file) => {
-    const x = await processFile(file, configuration)
-    return x
-  })
-
-  const values = await Promise.all(data)
-
-  if (callback) {
-    callback(null, values)
-  }
-  return values
-}
-
-// expose globby for use in plugins
-module.exports.globby = globby

package/lib/processFile.js

@@ -1,154 +0,0 @@
-const fs = require('fs')
-const mkdirp = require('mkdirp')
-const path = require('path')
-const merge = require('deepmerge')
-const transforms = require('./transforms')
-const regexUtils = require('./utils/regex')
-const pluginSortOrder = require('./utils/sortOrder')
-const updateContents = require('./updateContents')
-const cwd = process.cwd()
-
-module.exports = async function processFile(filePath, config) {
-  let content
-  try {
-    content = fs.readFileSync(filePath, 'utf8')
-  } catch (e) {
-    console.log(`FILE NOT FOUND ${filePath}`)
-    throw e
-  }
-  /**
-   * ### Configuration Options
-   */
-  const defaultConfig = {
-    /**
-     * - `transforms` - *object* - (optional) Custom commands to transform block contents, see transforms & custom transforms sections below.
-     * @type {Object}
-     */
-    transforms: transforms,
-    /**
-     * - `outputDir` - *string* - (optional) Change output path of new content. Default behavior is replacing the original file
-     * @type {string}
-     */
-    outputDir: path.dirname(filePath),
-    /**
-     * - `matchWord` - *string* - (optional) Comment pattern to look for & replace inner contents. Default `AUTO-GENERATED-CONTENT`
-     * @type {string}
-     * @default [AUTO-GENERATED-CONTENT]
-     */
-    matchWord: 'AUTO-GENERATED-CONTENT',
-    /**
-     * - `DEBUG` - *Boolean* - (optional) set debug flag to `true` to inspect the process
-     * @type {boolean}
-     */
-    DEBUG: false,
-  }
-
-  const userConfig = (config && typeof config === 'object') ? config : {}
-  const mergedConfig = merge(defaultConfig, userConfig)
-
-  const registeredTransforms = Object.keys(mergedConfig.transforms)
-  // Set originalPath constant
-  mergedConfig.originalPath = filePath
-  // contents of original MD file
-  mergedConfig.originalContent = content
-  // set default outputContents for first pass for single commands
-  mergedConfig.outputContent = content
-
-  const regex = regexUtils.matchCommentBlock(mergedConfig.matchWord)
-  // console.log(regex)
-  const match = content.match(regex)
-  const transformsFound = []
-
-  if (match) {
-    let commentMatches
-    let matchIndex = 0
-    while ((commentMatches = regex.exec(content)) !== null) {
-      if (commentMatches.index === regex.lastIndex) {
-        regex.lastIndex++ // This is necessary to avoid infinite loops
-      }
-
-      // console.log('commentMatches', commentMatches)
-      // const command = `Transform ${commentMatches[2]}`
-      // console.log(command)
-      transformsFound.push({
-        spaces: commentMatches[1], // Preserve indentation
-        transform: commentMatches[2],
-        match: match[matchIndex]
-      })
-      // wait
-      matchIndex++
-    }
-
-    // console.log('registeredTransforms', registeredTransforms)
-
-    const transformsToRun = pluginSortOrder(registeredTransforms, transformsFound)
-    if (mergedConfig.DEBUG) {
-      console.log('↓ transformsToRun')
-      console.log(transformsToRun)
-    }
-
-    const fileName = path.basename(filePath)
-    const outputFilePath = path.join(mergedConfig.outputDir, fileName)
-
-    // create folder path if doesnt exist
-    mkdirp.sync(mergedConfig.outputDir)
-
-    // run sort
-    let transformMsg = ''
-    for (const element of transformsToRun) {
-      // console.log('element', element)
-      transformMsg += `  ⁕ ${element.transform} \n`
-      // console.log('order', element.transform)
-      const newContent = await updateContents(element.match, mergedConfig)
-      const firstLineIndentation = element.spaces
-      const contentWithIndentation = newContent.split('\n').join(`\n` + element.spaces)
-      const preserveTabs = `${firstLineIndentation}${contentWithIndentation}`
-
-      content = content.replace(element.match, preserveTabs)
-      mergedConfig.outputContent = content
-    }
-
-    let notFoundNotice
-    if (!transformMsg) {
-      // console.log('config', config)
-      const notFound = transformsFound.map((x) => {
-        return `"${x.transform}"`
-      })
-      notFoundNotice = notFound
-    }
-
-    // console.log('transformMsg', transformMsg)
-
-    const msg = outputFilePath.replace(cwd, '')
-
-    if (transformMsg) {
-      console.log(`✔ ${msg} Updated`)
-      // update file contents
-      fs.writeFileSync(outputFilePath, content)
-      console.log(` Transforms run`)
-      console.log(transformMsg)
-    }
-
-    if (notFoundNotice) {
-      const word = notFoundNotice.length > 1 ? 'transforms' : 'transform'
-      console.log(`ℹ Notice:`)
-      console.log(`  Missing ${word} ${notFoundNotice.join(',')} in ${msg}`)
-      console.log()
-    }
-
-
-    // set return values
-    mergedConfig.outputFilePath = outputFilePath
-    mergedConfig.outputContent = content
-
-    return mergedConfig
-  }
-
-  if (mergedConfig.DEBUG) {
-    console.log(`↓ ${filePath}`)
-    console.log(`[No match] <!-- ${mergedConfig.matchWord} --> comment found`)
-  }
-
-  // no match return original contents
-  return mergedConfig
-}

package/lib/transforms/index.js

@@ -1,114 +0,0 @@
-const code = require('./code')
-const file = require('./file')
-const remoteContent = require('./remote')
-const toc = require('./toc')
-
-const transforms = {
-  /**
-   * ### > TOC
-   *
-   * Generate table of contents from markdown file
-   *
-   * **Options:**
-   * - `firsth1` - *boolean* - (optional): Show first h1 of doc in table of contents. Default `false`
-   * - `collapse` - *boolean* - (optional): Collapse the table of contents in a detail accordian. Default `false`
-   * - `collapseText` - *string* - (optional): Text the toc accordian summary
-   * - `excludeText` - *string* - (optional): Text to exclude in the table of contents. Default `Table of Contents`
-   * - `maxDepth` - *number* - (optional): Max depth of headings. Default 4
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (TOC) -->
-   * toc will be generated here
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated content to place in the content block
-   */
-  TOC: toc,
-  /**
-   * ### > CODE
-   *
-   * Get code from file or URL and put in markdown
-   *
-   * **Options:**
-   * - `src`: The relative path to the code to pull in, or the `URL` where the raw code lives
-   * - `syntax` (optional): Syntax will be inferred by fileType if not specified
-   * - `header` (optional): Will add header comment to code snippet. Useful for pointing to relative source directory or adding live doc links
-   * - `lines` (optional): a range with lines of code which will then be replaced with code from the file. The line range should be defined as: "lines=*startLine*-*EndLine*" (for example: "lines=22-44"). Please see the example below
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (CODE:src=./relative/path/to/code.js) -->
-   * This content will be dynamically replaced with code from the file
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * ```md
-   *  <!-- AUTO-GENERATED-CONTENT: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
-   *  <!-- AUTO-GENERATED-CONTENT:END -->
-   *  ```
-   * 
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated inner contents of the comment block
-   */
-  CODE: code,
-  /**
-   * ### > FILE
-   *
-   * Get local file contents.
-   *
-   * **Options:**
-   * - `src`: The relative path to the file to pull in
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (FILE:src=./path/to/file) -->
-   * This content will be dynamically replaced from the local file
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated content to place in the content block
-   */
-  FILE: file,
-  /**
-   * ### > REMOTE
-   *
-   * Get any remote Data and put in markdown
-   *
-   * **Options:**
-   * - `url`: The URL of the remote content to pull in
-   *
-   * **Example:**
-   * ```md
-   * <!-- AUTO-GENERATED-CONTENT:START (REMOTE:url=http://url-to-raw-md-file.md) -->
-   * This content will be dynamically replaced from the remote url
-   * <!-- AUTO-GENERATED-CONTENT:END -->
-   * ```
-   *
-   * Default `MATCHWORD` is `AUTO-GENERATED-CONTENT`
-   *
-   * ---
-   * @param {string} content The current content of the comment block
-   * @param {object} options The options passed in from the comment declaration
-   * @return {string} Updated content to place in the content block
-   */
-  REMOTE: remoteContent,
-}
-
-module.exports = transforms