init

Author: mrzmmr

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - '4.0'
+  - '9.0'
+after_script: bash <(curl -s https://codecov.io/bash)

license.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Paul Zimmer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package-lock.json

@@ -0,0 +1,55 @@
+{
+  "name": "remark-code-blocks",
+  "version": "1.0.0",
+  "description": "Extract code blocks from an MDAST tree",
+  "main": "index.js",
+  "scripts": {
+    "clean": "rimraf ./*.js .nyc_output coverage",
+    "pretest": "npm run babel",
+    "tap": "tap -Rspec test.js",
+    "babel": "babel src -d .",
+    "test": "nyc npm run tap"
+  },
+  "babel": {
+    "presets": [
+      [
+        "env",
+        {
+          "targets": {
+            "node": "current"
+          }
+        }
+      ]
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mrzmmr/remark-code-blocks.git"
+  },
+  "keywords": [
+    "remark",
+    "util",
+    "utility",
+    "code",
+    "blocks",
+    "extract"
+  ],
+  "author": "mrzmmr",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mrzmmr/remark-code-blocks/issues"
+  },
+  "homepage": "https://github.com/mrzmmr/remark-code-blocks#readme",
+  "devDependencies": {
+    "babel-cli": "^6.26.0",
+    "babel-preset-env": "^1.6.1",
+    "nyc": "^11.3.0",
+    "remark": "^8.0.0",
+    "rimraf": "^2.6.2",
+    "tap": "^10.7.3",
+    "unist-util-is": "^2.1.1"
+  },
+  "dependencies": {
+    "unist-util-find-all-after": "^1.0.1"
+  }
+}

package.json

@@ -0,0 +1 @@
+# remark-code-blocks

readme.md

@@ -0,0 +1,37 @@
+'use strict'
+
+/**
+ * Remark code blocks
+ *
+ * Extracts code blocks from an mdast tree and stores them in vfiles data object.
+ */
+
+const findAllAfter = require('unist-util-find-all-after')
+
+module.exports = (options = {}) => {
+  return (tree, file) => {
+    const { values, lang } = options
+    let codeblocks
+    let nodes = []
+
+    nodes = findAllAfter(tree, 0, 'code')
+
+    if (tree.children[0].type === 'code') {
+      nodes.unshift(tree.children[0])
+    }
+
+    codeblocks = nodes
+
+    if (lang) {
+      nodes = codeblocks
+      codeblocks = nodes.filter(node => node.lang === lang)
+    }
+
+    if (values) {
+      nodes = codeblocks
+      codeblocks = nodes.map(node => node.value)
+    }
+
+    file.data.codeblocks = codeblocks
+  }
+}

src/index.js

@@ -0,0 +1,86 @@
+'use strict'
+
+const is = require('unist-util-is')
+const remark = require('remark')
+const test = require('tap').test
+const codeblocks = require('./')
+
+const markdown = `
+# Foo
+
+\`\`\`js
+const inc = n => n++;
+\`\`\`
+
+\`\`\`
+inc(42);
+\`\`\`
+`
+
+const code = markdown.split('\n').filter((n, i) => i === 4 || i === 8)
+
+test('remark-code-blocks', t => {
+  let result
+  let file
+
+  t.test('should find all `code` nodes including parent.children[0]', it => {
+    it.doesNotThrow(() => {
+      file = remark()
+        .use(codeblocks)
+        .processSync(
+          markdown
+            .split('\n')
+            .splice(2)
+            .join('\n')
+        )
+      result = file.data.codeblocks
+
+      it.ok(is(`code`, result[0]), '`code` as first child is included')
+      it.ok(result[0].value === code[0], '`code` as first child is included')
+    })
+    it.end()
+  })
+
+  t.test('with no options passed', it => {
+    it.doesNotThrow(() => {
+      file = remark()
+        .use(codeblocks)
+        .processSync(markdown)
+      result = file.data.codeblocks
+
+      it.ok(file, 'should process')
+      it.ok(Array.isArray(result), 'result should be an array')
+      it.ok(is('code', result[0]), 'result[i] should be type `code`')
+      it.ok(is('code', result[1]), 'results[i] should be type `code`')
+    }, 'should not throw')
+    it.end()
+  })
+
+  t.test('with lang option', it => {
+    it.doesNotThrow(() => {
+      file = remark()
+        .use(codeblocks, { lang: 'js' })
+        .processSync(markdown)
+      result = file.data.codeblocks
+
+      it.ok(result.length === 1, 'result should have length of 1')
+      it.ok(result[0].value === code[0], 'result should be first value code[0]')
+    }, 'should not throw')
+    it.end()
+  })
+
+  t.test('with values option', it => {
+    it.doesNotThrow(() => {
+      file = remark()
+        .use(codeblocks, { values: 1 })
+        .processSync(markdown)
+      result = file.data.codeblocks
+
+      it.ok(result[0] === code[0], 'result should be string and match code[i]')
+      it.ok(result[1] === code[1], 'result should be string and match code[i]')
+    }, 'should not throw')
+    it.end()
+  })
+
+  t.end()
+})