update for next version of reshape/spike (#18)

* update for next version of reshape/spike

* remove extra options

* 0.6.0-0

* add parserOptions, redo tests to be more thorough and reasonable

* 0.6.0-1

* update reshape-exp

* 0.6.0-2

* add append and prepend plugins options, more docs

* internal docs and naming

* 0.6.0-3

* update deps

Author: jescalan

README.md

@@ -81,8 +81,6 @@ Any of these plugins can be customized by passing options described below.
 | ---- | ----------- | ------- |
 | **root** | Root path used to resolve layouts and includes | |
 | **filename** | Name of the file being compiled, used for error traces and as the include/layout root if not otherwise provided | |
-| **addDependencyTo** | Object with `addDependency` method that will get file paths for tracked deps from includes/layouts | |
-| **webpack** | Shortcut for webpack users to set the `root` and `addDependencyTo` options more easily. Pass webpack loader context. | |
 | **delimiters** | Delimiters used for html-escaped expressions | `['{{', '}}']` |
 | **unescapeDelimiters** | Delimiters used for unescaped expressions | `['{{{', '}}}']` |
 | **markdown** | Options passed in to [markdown-it](https://github.com/markdown-it/markdown-it) constructor | `{ typographer: true, linkify: true }` |
@@ -91,7 +89,10 @@ Any of these plugins can be customized by passing options described below.
 | **retext** | Plugins to be passed to the [reshape-retext](https://github.com/reshape/retext) plugin | `[smartypants]` ([ref](https://github.com/wooorm/retext-smartypants)) |
 | **locals** | Added directly to the output object, used when compiling a reshape template to html | `{}` |
 | **alias** | Alias option to be passed to the [include plugin](https://github.com/reshape/include#options) | |
+| **parserRules** | Parser rules to be passed to the [include plugin](https://github.com/reshape/include#options) | |
 | **minify** | Minifies the html output by removing excess spaces and line breaks | `false` |
+| **appendPlugins** | Adds a single plugin or array of plugins after all the defaults | |
+| **prependPlugins** | Adds a single plugin or array of plugins before all the defaults | |
 
 ### Markdown Rendering Functions
 

lib/index.js

@@ -8,18 +8,34 @@ let layouts = require('reshape-layouts')
 let retext = require('reshape-retext')
 let beautify = require('reshape-beautify')
 let minify = require('reshape-minify')
+let reshapeParser = require('reshape-parser')
 
+/**
+ * Primary export, formats options and returns an object with intelligent
+ * defaults.
+ * @param  {Object} [options={}] - options object
+ * @param {Array} options.delimiters - passed to expressions plugin
+ * @param {Array} options.unescapeDelimiters - passed to expressions plugin
+ * @param {String} options.root - passed to layouts & include plugins
+ * @param {Object} options.alias - passed to include plugin
+ * @param {Object} options.parserRules - passed to include plugin
+ * @param {Object|Function} [options.retext=smartypants] - passed to retext
+ * plugin
+ * @param {Object} [options.content={}] - passed to content plugin
+ * @param {Object} options.markdown - passed to markdown-it constructor
+ * @param {Object} options.locals - if passed, renders as html string
+ * @param {Boolean} options.minify - add minify plugin if true
+ * @param {String} options.filename - copied directly to output
+ * @param {Function} [options.parser=sugarml] - undefined if false
+ * @param {Array|String} options.appendPlugins - appended to plugins array
+ * @param {Array|String} options.prependPlugins - prepended to plugins array
+ * @return {Object} valid reshape options object
+ */
 module.exports = function reshapeStandard (options = {}) {
-  // set options using webpack shortcut if present
-  if (options.webpack) {
-    options.filename = options.webpack.resourcePath
-    options.addDependencyTo = options.webpack
-  }
-
   // add options for expressions, layouts, and includes if present
-  const expressionsOpt = selectiveMerge(options, ['delimiters', 'unescapeDelimiters'])
-  const layoutsOpt = selectiveMerge(options, ['root', 'addDependencyTo'])
-  const includeOpt = selectiveMerge(options, ['root', 'addDependencyTo', 'alias'])
+  const expressionsOpt = selectKeys(options, ['delimiters', 'unescapeDelimiters'])
+  const layoutsOpt = selectKeys(options, ['root'])
+  const includeOpt = selectKeys(options, ['root', 'alias', 'parserRules'])
 
   // if the user has not provided a custom parser or `false`, use sugarml
   let parserOpt = options.parser || sugarml
@@ -38,6 +54,12 @@ module.exports = function reshapeStandard (options = {}) {
     contentOpt.mdi = md.renderInline.bind(md)
   }
 
+  // default parserRules if using sugarml correctly import html and svg files
+  if (!includeOpt.parserRules && parserOpt === sugarml) {
+    includeOpt.parserRules = [{ test: /\.html|svg$/, parser: reshapeParser }]
+  }
+
+  // add all the default plugins with their options
   const plugins = [
     layouts(layoutsOpt),
     include(includeOpt),
@@ -46,6 +68,16 @@ module.exports = function reshapeStandard (options = {}) {
     retext(options.retext || smartypants)
   ]
 
+  // append and prepend plugins if needed
+  if (options.appendPlugins) {
+    plugins.push(...Array.prototype.concat(options.appendPlugins))
+  }
+
+  if (options.prependPlugins) {
+    plugins.unshift(...Array.prototype.concat(options.prependPlugins))
+  }
+
+  // append the minify or beautify formatting plugin (always last)
   if (options.minify) {
     plugins.push(minify())
   } else {
@@ -60,7 +92,15 @@ module.exports = function reshapeStandard (options = {}) {
   }
 }
 
-function selectiveMerge (opts, optNames) {
+/**
+ * Given an options object and an array of key names, return an object filtered
+ * to contain only the keys in the optNames array, if they exist on the options
+ * object.
+ * @param  {Object} opts - full options object
+ * @param  {Array} optNames - keys to filter
+ * @return {Object} object filtered for the specific keys
+ */
+function selectKeys (opts, optNames) {
   return optNames.reduce((m, opt) => {
     if (typeof opts[opt] !== 'undefined') { m[opt] = opts[opt] }; return m
   }, {})

package.json

@@ -1,7 +1,7 @@
 {
   "name": "reshape-standard",
   "description": "a standard plugin pack for reshape",
-  "version": "0.5.0",
+  "version": "0.6.0-3",
   "author": "Jeff Escalante",
   "ava": {
     "verbose": "true"
@@ -11,16 +11,17 @@
     "markdown-it": "^8.2.2",
     "reshape-beautify": "^0.1.2",
     "reshape-content": "^0.2.0",
-    "reshape-expressions": "^0.1.3",
-    "reshape-include": "^0.3.0",
-    "reshape-layouts": "^0.2.1",
+    "reshape-expressions": "^0.1.5",
+    "reshape-include": "^1.0.0",
+    "reshape-layouts": "^1.0.0",
     "reshape-minify": "^0.1.1",
+    "reshape-parser": "^0.2.1",
     "reshape-retext": "^0.3.0",
     "retext-smartypants": "^2.0.0",
     "sugarml": "^0.5.0"
   },
   "devDependencies": {
-    "ava": "^0.18.1",
+    "ava": "^0.19.0",
     "coveralls": "2.x",
     "nyc": "^10.0.0",
     "reshape": "^0.4.0",

test/index.js

@@ -3,53 +3,117 @@ const rewire = require('rewire')
 const standardRewired = rewire('..')
 const standard = require('..')
 
-test('options passed correctly', (t) => {
-  standardRewired.__set__('content', (opts) => {
+test('content options passed correctly', (t) => {
+  const undo = standardRewired.__set__('content', (opts) => {
     t.truthy(opts.md === 'test')
   })
-  standardRewired.__set__('include', (opts) => {
+  standardRewired({ content: { md: 'test' } })
+  undo()
+})
+
+test('include options passed correctly', (t) => {
+  const undo = standardRewired.__set__('include', (opts) => {
     t.truthy(opts.root === 'test')
-    t.truthy(opts.addDependencyTo.addDependency === 'test')
+    t.truthy(opts.alias === 'test')
+    t.truthy(opts.parserRules === 'test')
   })
-  standardRewired.__set__('layouts', (opts) => {
+  standardRewired({ root: 'test', alias: 'test', parserRules: 'test' })
+  undo()
+})
+
+test('layouts options passed correctly', (t) => {
+  const undo = standardRewired.__set__('layouts', (opts) => {
     t.truthy(opts.root === 'test')
-    t.truthy(opts.addDependencyTo.addDependency === 'test')
   })
-  standardRewired.__set__('expressions', (opts) => {
+  standardRewired({ root: 'test' })
+  undo()
+})
+
+test('expressions options passed correctly', (t) => {
+  const undo = standardRewired.__set__('expressions', (opts) => {
     t.truthy(opts.delimiters === 'test')
     t.truthy(opts.unescapeDelimiters === 'test')
   })
-  standardRewired.__set__('retext', (opts) => {
+  standardRewired({ delimiters: 'test', unescapeDelimiters: 'test' })
+  undo()
+})
+
+test('retext options passed correctly', (t) => {
+  const undo = standardRewired.__set__('retext', (opts) => {
     t.truthy(opts.length === 3)
   })
-  standardRewired.__set__('MarkdownIt', class Mock {
-    constructor (opts) {
-      t.truthy(opts === 'test')
-    }
+  standardRewired({ retext: [1, 2, 3] })
+  undo()
+})
+
+test('filename passed correctly', (t) => {
+  const out = standard({ filename: 'test' })
+  t.truthy(out.filename === 'test')
+})
+
+test('defaults come out right', (t) => {
+  const out = standard()
+  t.truthy(out.parser.name === 'SugarMLParser')
+  t.truthy(Object.keys(out.locals).length === 0)
+  t.truthy(out.filename === undefined)
+  t.truthy(out.plugins.length === 6)
+})
+
+test('content defaults', (t) => {
+  const undo = standardRewired.__set__('content', (opts) => {
+    t.truthy(typeof opts.md === 'function')
+    t.truthy(typeof opts.mdi === 'function')
   })
+  standardRewired()
+  undo()
+})
 
-  const out1 = standardRewired({
-    root: 'test',
-    webpack: { resourcePath: 'test', addDependency: 'test' },
-    delimiters: 'test',
-    locals: 'true',
-    unescapeDelimiters: 'test',
-    content: { md: 'test' },
-    retext: [1, 2, 3],
-    markdown: 'test'
+test('parserRules defaults', (t) => {
+  const undo = standardRewired.__set__('include', (opts) => {
+    t.truthy(opts.parserRules[0].test.exec)
   })
+  standardRewired()
+  undo()
+})
 
-  const out2 = standard({
-    parser: false,
-    addDependencyTo: { addDependency: (x) => x },
-    locals: 'true',
-    minify: true
+test('retext default', (t) => {
+  const undo = standardRewired.__set__('retext', (opts) => {
+    t.truthy(typeof opts === 'function')
   })
+  standardRewired()
+  undo()
+})
+
+test('parser false', (t) => {
+  const out = standard({ parser: false })
+  t.truthy(out.parser === undefined)
+})
+
+test('alternate parser', (t) => {
+  const out = standard({ parser: 'test' })
+  t.truthy(out.parser === 'test')
+})
+
+test('passed locals', (t) => {
+  const out = standard({ locals: 'test' })
+  t.truthy(out.locals === 'test')
+})
+
+test('minify option', (t) => {
+  const out = standard({ minify: true })
+  t.truthy(out.plugins[out.plugins.length - 1].name === 'minifyPlugin')
+})
+
+test('appendPlugins option', (t) => {
+  const out = standard({ appendPlugins: ['test'] })
+  const out2 = standard({ appendPlugins: 'test' })
+  t.truthy(out.plugins[out.plugins.length - 2] === 'test')
+  t.truthy(out2.plugins[out.plugins.length - 2] === 'test')
+})
 
-  t.truthy(out1.parser)
-  t.truthy(out1.locals)
-  t.truthy(out1.filename === 'test')
-  t.truthy(out1.plugins.length === 6)
-  t.falsy(out2.parser)
-  t.truthy(out2.plugins[out2.plugins.length - 1].name === 'minifyPlugin')
+test('prependPlugins option', (t) => {
+  const out = standard({ prependPlugins: ['test'] })
+  const out2 = standard({ prependPlugins: 'test' })
+  t.truthy(out.plugins[0] === 'test')
+  t.truthy(out2.plugins[0] === 'test')
 })