markdown-magic 2.5.1 → 2.6.1

package/lib/utils/weird-parse.test.js

@@ -0,0 +1,217 @@
+const { test } = require('uvu') 
+const assert = require('uvu/assert')
+const weirdParse = require('./weird-parse')
+
+
+const bigExample = `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}
+ isWhat,
+ /* comment */
+ foo={{ rad: ["whatever", "man"], cool: { beans: 'here' } }}
+ # other comment
+ what='xnxnx'
+ isLoading  
+ whatever={{ chill: "https://app.netlify.com/start/deploy?repository=https://github.com/netlify/netlify-faunadb-example&stack=fauna", pill: ['yo']}}
+ href="https://fooo.com/start/deploy?repository=https://github.com/netlify/netlify-faunadb-example&stack=fauna"
+ src="https://user-images.github{user}content.com/532272/123136878-46f1a300-d408-11eb-82f2-ad452498457b.jpg"
+ deep={{ rad: 'blue', what: { nice: 'cool', wow: { deep: true } } }}`
+
+
+test('Multi line', () => {
+  const parsedValue = weirdParse(bigExample)
+  // console.log('parsedValue', parsedValue)
+  assert.equal(parsedValue, {
+    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,
+    yes: true,
+    isWhat: true,
+    foo: { rad: [ 'whatever', 'man' ], cool: { beans: 'here' } },
+    what: 'xnxnx',
+    isLoading: true,
+    whatever: {
+      chill: 'https://app.netlify.com/start/deploy?repositoryhttps://github.com/netlify/netlify-faunadb-example&stackfauna',
+      pill: [ 'yo' ]
+    },
+    href: 'https://fooo.com/start/deploy?repositoryhttps://github.com/netlify/netlify-faunadb-example&stackfauna',
+    src: 'https://user-images.github{user}content.com/532272/123136878-46f1a300-d408-11eb-82f2-ad452498457b.jpg',
+    deep: { rad: 'blue', what: { nice: 'cool', wow: { deep: true } } }
+  }, 'matches original')
+})
+
+const testSpacing = `width={999} 
+  height={{111}}
+  numberAsString="12345"   
+  great={["scoot", "sco ot", 'scooo ttt']} 
+  nope=false,
+  // comment
+ yes={true}
+ isWhat,
+ /* comment */
+ foo={{ rad: ["whatever", "man"], cool: { beans: 'here' } }}
+ # other comment
+ what='xnxnx'
+    isLoading  
+    href="https://fooo.com/start/deploy?repository=https://github.com/netlify/netlify-faunadb-example&stack=fauna"
+    src="https://user-images.github{user}content.com/532272/123136878-46f1a300-d408-11eb-82f2-ad452498457b.jpg"
+    deep={{ rad: 'blue', what: { nice: 'cool', wow: { deep: true } } }}
+`
+
+// Verify indentation doesnt matter
+test('Multi line indent', () => {
+  const parsedValue = weirdParse(testSpacing)
+  // console.log('parsedValue', parsedValue)
+  assert.equal(parsedValue, {
+    width: 999,
+    height: 111,
+    numberAsString: '12345',
+    great: [ 'scoot', 'sco ot', 'scooo ttt' ],
+    nope: false,
+    yes: true,
+    isWhat: true,
+    foo: { rad: [ 'whatever', 'man' ], cool: { beans: 'here' } },
+    what: 'xnxnx',
+    isLoading: true,
+    href: 'https://fooo.com/start/deploy?repositoryhttps://github.com/netlify/netlify-faunadb-example&stackfauna',
+    src: 'https://user-images.github{user}content.com/532272/123136878-46f1a300-d408-11eb-82f2-ad452498457b.jpg',
+    deep: { rad: 'blue', what: { nice: 'cool', wow: { deep: true } } }
+  }, 'matches original')
+})
+
+test('Single line', () => {
+  const parsedValue = weirdParse(`width={999} height={{111}} numberAsString="12345" great={["scoot", "sco ot", 'scooo ttt']} nice={{ value: nice, cool: "true" }} soclose=[jdjdjd, hdhfhfhffh] rad="boss" cool=true isCool notCool=false nooooo={[one, two, 3, 4]}`)
+  console.log('parsedValue', parsedValue)
+  assert.equal(parsedValue, {
+    width: 999,
+    height: 111,
+    numberAsString: '12345',
+    great: [ 'scoot', 'sco ot', 'scooo ttt' ],
+    nice: { value: 'nice', cool: 'true' },
+    soclose: [ 'jdjdjd', 'hdhfhfhffh' ],
+    rad: 'boss',
+    cool: true,
+    isCool: true,
+    notCool: false,
+    nooooo: [ 'one', 'two', 3, 4 ]
+  }, 'matches original')
+})
+
+test('Simple string equal (single quotes)', () => {
+  const parsedValue = weirdParse(`bob='cool'`)
+  assert.equal(parsedValue, {
+    bob: 'cool',
+  })
+})
+
+test('Simple string equal (double quotes)', () => {
+  const parsedValue = weirdParse(`bob="cool"`)
+  assert.equal(parsedValue, {
+    bob: 'cool',
+  })
+})
+
+test('Simple string equal (no quotes)', () => {
+  const parsedValue = weirdParse(`bob=cool`)
+  // console.log('parsedValue', parsedValue)
+  assert.equal(parsedValue, {
+    bob: 'cool',
+  })
+})
+
+test('Simple string equal (no quotes with spaces)', () => {
+  const answer = { bob: 'cool' }
+  const one = weirdParse(`bob = cool`)
+  const two = weirdParse(`bob= cool`)
+  const three = weirdParse(`bob =cool`)
+  // console.log('parsedValue', parsedValue)
+  assert.equal(one, answer)
+  assert.equal(two, answer)
+  assert.equal(three, answer)
+})
+
+test('Simple boolean', () => {
+  const answer = { isCool: true }
+  const one = weirdParse(`isCool`)
+  const two = weirdParse(`isCool = true`)
+  const three = weirdParse(`isCool =true`)
+  const four = weirdParse(`isCool=true`)
+  const fourx = weirdParse(`isCool={true}`)
+  const foury = weirdParse(`isCool={{true}}`)
+
+  assert.equal(one, answer)
+  assert.equal(two, answer)
+  assert.equal(three, answer)
+  assert.equal(four, answer)
+  assert.equal(fourx, answer)
+  assert.equal(foury, answer)
+
+  const answerTwo = { isNotCool: false }
+  const five = weirdParse(`isNotCool=false`)
+  const six = weirdParse(`isNotCool = false`)
+  const seven = weirdParse(`isNotCool =false`)
+  const eight = weirdParse(`isNotCool=false`)
+  const nine = weirdParse(`isNotCool= false`)
+  const ten = weirdParse(`isNotCool={false}`)
+  const eleven = weirdParse(`isNotCool={{false}}`)
+  
+  assert.equal(five, answerTwo, 'five')
+  assert.equal(six, answerTwo, 'six')
+  assert.equal(seven, answerTwo, 'seven')
+  assert.equal(eight, answerTwo, 'eight')
+  assert.equal(nine, answerTwo, 'nine')
+  assert.equal(ten, answerTwo, 'ten')
+  assert.equal(eleven, answerTwo, 'eleven')
+})
+
+test('Simple object', () => {
+  const a = { key: { a: 'b' }}
+  assert.equal(a, weirdParse(`key={{ "a": "b" }}`))
+  assert.equal(a, weirdParse(`key={{ "a": b }}`))
+  assert.equal(a, weirdParse(`key={{ a: "b" }}`))
+  assert.equal(a, weirdParse(`key={{ a: b }}`))
+  assert.equal(a, weirdParse(`key={ a : b }`), 'single {')
+
+  const answer = { nice: { value: 'nice', cool: 'true', awesome: false } }
+  const one = weirdParse(`nice={{ value: nice, cool: "true", awesome: false }}`)
+  assert.equal(one, answer)
+})
+
+test('Simple array', () => {
+  const x = { key: [ 1, 2, 3 ] }
+  const y = weirdParse(`key=[ 1, 2, 3 ]`)
+  assert.equal(x, y)
+
+  const z = weirdParse(`key=[ "1", "2", "3" ]`)
+  assert.equal(z, { key: [ "1", "2", "3" ] })
+
+  const a = weirdParse(`key=[ one, two, three ]`)
+  assert.equal(a, { key: [ "one", "two", "three" ] })
+
+  const answer = { great: [ 'scoot', 'sco ot', 'scooo ttt', 'one', 'two', 3, 4, true ] }
+  const one = weirdParse(`great={["scoot", "sco ot", 'scooo ttt', one, two, 3, 4, true]} `)
+  assert.equal(one, answer)
+})
+
+test.run()

package/package.json

@@ -1,14 +1,23 @@
 {
   "name": "markdown-magic",
-  "version": "2.5.1",
+  "version": "2.6.1",
   "description": "Automatically update markdown files with content from external sources",
   "main": "index.js",
   "bin": {
     "markdown": "./cli.js",
     "md-magic": "./cli.js"
   },
+  "files": [
+    "README.md",
+    "package.json",
+    "index.js",
+    "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",
     "cli": "node ./cli.js --path 'README.md' --config ./markdown.config.js",
@@ -26,12 +35,13 @@
     "url": "https://github.com/DavidWells/markdown-magic"
   },
   "dependencies": {
-    "@technote-space/doctoc": "^2.4.7",
+    "@technote-space/doctoc": "2.4.7",
     "commander": "^7.2.0",
     "deepmerge": "^4.2.2",
     "find-up": "^5.0.0",
     "globby": "^10.0.2",
     "is-local-path": "^0.1.6",
+    "json-alexander": "^0.1.8",
     "mkdirp": "^1.0.4",
     "sync-request": "^6.1.0"
   },
@@ -39,7 +49,11 @@
     "ava": "^3.15.0",
     "doxxx": "^1.0.0",
     "rimraf": "^3.0.2",
-    "sinon": "^11.1.1"
+    "sinon": "^11.1.1",
+    "uvu": "^0.5.1",
+    "ansi-styles": "^4.2.1",
+    "concordance": "^5.0.1",
+    "safe-chalk": "^1.0.0"
   },
   "ava": {
     "files": [

package/.github/FUNDING.yml

@@ -1 +0,0 @@
-github: [davidwells]

package/.github/workflows/test.yml

@@ -1,40 +0,0 @@
-name: Test
-on:
-  push:
-  pull_request:
-env:
-  FORCE_COLOR: 2
-jobs:
-  full:
-    name: Node.js 15 Full
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@v2
-      - name: Install Node.js
-        uses: actions/setup-node@v2
-        with:
-          node-version: 15
-      - name: Install dependencies
-        uses: bahmutov/npm-install@v1
-      - name: Run tests
-        run: npm test
-  short:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version:
-          - 14
-          - 12
-    name: Node.js ${{ matrix.node-version }} Quick
-    steps:
-      - name: Checkout the repository
-        uses: actions/checkout@v2
-      - name: Install Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install dependencies
-        uses: bahmutov/npm-install@v1
-      - name: Run unit tests
-        run: npm test

package/.travis.yml

@@ -1,10 +0,0 @@
-language: node_js
-sudo: false
-node_js:
-  - 8
-
-install:
-  - npm install
-
-script:
-  - npm test

package/examples/basic-usage.js

@@ -1,5 +0,0 @@
-import path from 'path'
-import markdownMagic from 'markdown-magic'
-
-const markdownPath = path.join(__dirname, 'README.md')
-markdownMagic(markdownPath)

package/examples/generate-readme.js

@@ -1,37 +0,0 @@
-const fs = require('fs')
-const path = require('path')
-const markdownMagic = require('../index')
-// 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) {
-      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) {
-      const fileContents = fs.readFileSync(options.path, 'utf8')
-      const docBlocs = require('doxxx').parseComments(fileContents, { raw: true, skipSingleStar: true })
-      let updatedContent = ''
-      docBlocs.forEach((data) => {
-        updatedContent += `${data.description.full}\n\n`
-      })
-      return updatedContent.replace(/^\s+|\s+$/g, '')
-    },
-    /* Match <!-- AUTO-GENERATED-CONTENT:START (pluginExample) --> */
-    pluginExample: require('./plugin-example')({ addNewLine: true }),
-    /* Include plugins from NPM */
-    // count: require('markdown-magic-wordcount'),
-    // github: require('markdown-magic-github-contributors')
-  }
-}
-
-const markdownPath = path.join(__dirname, '..', 'README.md')
-markdownMagic(markdownPath, config, () => {
-  console.log('Docs ready')
-})

package/examples/package.json

@@ -1,14 +0,0 @@
-{
-  "name": "markdown-magic-usage-example",
-  "version": "1.0.0",
-  "description": "Usage example",
-  "main": "example.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "David Wells",
-  "license": "MIT",
-  "dependencies": {
-    "dox": "^0.9.0"
-  }
-}

package/examples/plugin-example.js

@@ -1,16 +0,0 @@
-/* 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)
-  // return the transform function
-  return function myCustomTransform (content, options) {
-    const newLine = (pluginConfig.addNewLine) ? '\n' : ''
-    const updatedContent = content + newLine
-    return updatedContent
-  }
-}

package/markdown.config.js

@@ -1,13 +0,0 @@
-/* CLI markdown.config.js file example */
-module.exports = {
-  matchWord: 'MD-MAGIC-EXAMPLE',
-  transforms: {
-    /* Match <!-- AUTO-GENERATED-CONTENT:START (LOLZ) --> */
-    LOLZ(content, options) {
-      return `This section was generated by the cli config markdown.config.js file`
-    }
-  },
-  callback: function () {
-    console.log('markdown processing done')
-  }
-}

package/test/fixtures/CODE-test.md

@@ -1,21 +0,0 @@
-# Test Fixture
-
-This is normal text in markdown. Keep it.
-
-<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./local-code-file.js&syntax=js) -->
-THIS CONTENT GETS AUTO GENERATED. Don't directly edit it
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (CODE:src=./local-code-file-lines.js&syntax=js&lines=4-5) -->
-THIS CONTENT GETS AUTO GENERATED. Don't directly edit it
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (CODE:src=https://raw.githubusercontent.com/DavidWells/markdown-magic/master/examples/generate-readme.js) -->
-Remote code block will go here
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (CODE:src=https://raw.githubusercontent.com/DavidWells/markdown-magic/master/examples/package.json&lines=9-10) -->
-Remote code block will go here
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-This is normal text in markdown. Keep it.

package/test/fixtures/CUSTOM-async.md

@@ -1,9 +0,0 @@
-# Custom Async Transform
-
-This is normal text in markdown. Keep it.
-
-<!-- AUTO-GENERATED-CONTENT:START (customAsync:optionOne=hi)  -->
-will be transformed
-<!-- AUTO-GENERATED-CONTENT:END  -->
-
-This is normal text in markdown. Keep it.

package/test/fixtures/CUSTOM-test.md

@@ -1,9 +0,0 @@
-# Custom Transform
-
-This is normal text in markdown. Keep it.
-
-<!-- AUTO-GENERATED-CONTENT:START (customTransform)  -->
-xyz
-<!-- AUTO-GENERATED-CONTENT:END  -->
-
-This is normal text in markdown. Keep it.

package/test/fixtures/FILE-test.md

@@ -1,11 +0,0 @@
-# FILE Test Fixture
-
-This is normal text in markdown. Keep it.
-
-<!-- AUTO-GENERATED-CONTENT:START (FILE:src=./local-code-file.js) -->
-THIS CONTENT GETS AUTO GENERATED. Don't directly edit it
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (FILE:src=./local-code-file-lines.js) -->
-THIS CONTENT GETS AUTO GENERATED. Don't directly edit it
-<!-- AUTO-GENERATED-CONTENT:END -->

package/test/fixtures/REMOTE-test.md

@@ -1,12 +0,0 @@
-# Remote Transform
-
-This is normal text in markdown. Keep it.
-
-<!-- AUTO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/DavidWells/markdown-magic/master/README.md) - Do not remove or modify this section  -->
-
-All of this content will be replaced with remote content from https://raw.githubusercontent.com/DavidWells/markdown-magic/master/README.md
-
-via the `REMOTE` transform
-<!-- AUTO-GENERATED-CONTENT:END  -->
-
-This is normal text in markdown. Keep it.

package/test/fixtures/TOC-test.md

@@ -1,39 +0,0 @@
-# Test for TOC
-
-<!-- AUTO-GENERATED-CONTENT:START (TOC) - Test #1: without option and the content with empty line  -->
-
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (TOC:collapse=true&collapseText=Click Me) - Test #2: with collapse options and the content with 'aaaaaaaaa'  -->
-aaaaaaaaa
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (TOC:collapse=true&collapseText=Click Me=I have the power) - Test #3: with collapseText contains character '='  -->
-
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (TOC) - Test #4: without option and the content is empty  -->
-<!-- AUTO-GENERATED-CONTENT:END -->
-
-<!-- AUTO-GENERATED-CONTENT:START (TOC) - Test #5: without option and tags with same line  --><!-- AUTO-GENERATED-CONTENT:END -->
-
-
-## Title A
-
-Text A
-
-### Subtitle z
-
-Text Z
-
-### Subtitle x
-
-Text X
-
-## Title B
-
-Text B
-
-## Title C
-
-Text B

package/test/fixtures/custom-match-word-test.md

@@ -1,9 +0,0 @@
-# Test Changing Comment MatchWord
-
-The comments in this markdown file use `YOLO:START` instead of the default match word
-
-<!-- YOLO:START (CODE:src=./local-code-file.js&syntax=js) -->
-THIS CONTENT GETS AUTO GENERATED. Don't directly edit it
-<!-- YOLO:END -->
-
-This is normal text in markdown. Keep it.

package/test/fixtures/local-code-file-lines.js

@@ -1,6 +0,0 @@
-
-
-if (foo = bar) {
-  const baz = 'foobar'
-  console.log(`Hello ${baz}`)
-}

package/test/fixtures/local-code-file.js

@@ -1,6 +0,0 @@
-
-
-module.exports.run = () => {
-  const time = new Date()
-  console.log(`Your cron ran ${time}`)
-}

package/test/fixtures/nested/file.md

@@ -1,9 +0,0 @@
-# Nested File
-
-This is normal text in markdown. Keep it.
-
-<!-- AUTO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/DavidWells/markdown-magic/master/README.md) - Do not remove or modify this section  -->
-test
-<!-- AUTO-GENERATED-CONTENT:END  -->
-
-This is normal text in markdown. Keep it.