Resolves #62, deprecates markdown options.<option> in favor of options.engineOptions.<option>

Author: webketje

lib/index.d.ts

@@ -2,7 +2,7 @@ import { marked } from 'marked';
 import Metalsmith from 'metalsmith';
 
 export default markdown;
-export interface Options extends marked.MarkedOptions {
+export interface Options {
     /**
      * - Key names of file metadata to render to HTML - can be nested
      */
@@ -11,6 +11,10 @@ export interface Options extends marked.MarkedOptions {
      * - Expand `*` wildcards in keypaths
      */
     wildcard?: boolean;
+    /**
+     * Marked markdown [options](https://marked.js.org/using_advanced#options)
+     */
+    engineOptions?: marked.MarkedOptions
 };
 /**
  * A Metalsmith plugin to render markdown files to HTML

src/index.js

@@ -15,11 +15,13 @@ function render(data, key, options) {
  * @typedef Options
  * @property {string[]} [keys] - Key names of file metadata to render to HTML - can be nested
  * @property {boolean} [wildcard=false] - Expand `*` wildcards in keypaths
+ * @property {Object} [engineOptions] Options to pass to the markdown engine (default [marked](https://github.com/markedjs/marked))
  **/
 
 const defaultOptions = {
   keys: [],
-  wildcard: false
+  wildcard: false,
+  engineOptions: {}
 }
 
 /**
@@ -40,6 +42,15 @@ function markdown(options = defaultOptions) {
     const debug = metalsmith.debug('@metalsmith/markdown')
     const matches = metalsmith.match('**/*.{md,markdown}', Object.keys(files))
 
+    const legacyEngineOptions = Object.keys(options).filter((opt) => !Object.keys(defaultOptions).includes(opt))
+    if (legacyEngineOptions.length) {
+      debug.warn('Starting from version 2.0 marked engine options will need to be specified as options.engineOptions')
+      legacyEngineOptions.forEach((opt) => {
+        options.engineOptions[opt] = options[opt]
+      })
+      debug.warn('Moved engine options %s to options.engineOptions', legacyEngineOptions.join(', '))
+    }
+
     debug('Running with options: %O', options)
     if (matches.length === 0) {
       debug.warn('No markdown files found.')
@@ -54,7 +65,7 @@ function markdown(options = defaultOptions) {
       if ('.' != dir) html = join(dir, html)
 
       debug.info('Rendering file "%s" as "%s"', file, html)
-      const str = marked(data.contents.toString(), options)
+      const str = marked(data.contents.toString(), options.engineOptions)
       data.contents = Buffer.from(str)
 
       let keys = options.keys
@@ -63,7 +74,7 @@ function markdown(options = defaultOptions) {
       }
       keys.forEach((k) => {
         debug.info('Rendering key "%s" of file "%s"', k.join ? k.join('.') : k, file)
-        render(data, k, options)
+        render(data, k, options.engineOptions)
       })
 
       delete files[file]

test/index.cjs

@@ -131,6 +131,40 @@ describe('@metalsmith/markdown', function () {
       })
   })
 
+  it('< v2.0.0 should move legacy engine options in object root to options.engineOptions', done => {
+    const ms = msCommon('test/fixtures/basic')
+    const output = []
+    const Debugger = (...args) => { output.push(['log', ...args])}
+    Object.assign(Debugger, {
+      info: (...args) => { output.push(['info', ...args]) },
+      warn: (...args) => { output.push(['warn', ...args]) },
+      error: (...args) => { output.push(['error', ...args]) }
+    })
+
+    ms
+      .use(() => {
+        ms.debug = () => Debugger
+      })
+      .use(markdown({
+        gfm: true,
+        smartypants: false,
+        engineOptions: {}
+      }))
+      .process((err) => {
+        if (err) done(err)
+        try  {
+          assert.deepStrictEqual(output.slice(0,2), [
+            ['warn', 'Starting from version 2.0 marked engine options will need to be specified as options.engineOptions'],
+            ['warn', 'Moved engine options %s to options.engineOptions', 'gfm, smartypants']
+          ])
+          done()
+        } catch (err) {
+          done(err)
+        }
+      })
+
+  })
+
   it('expandWildCardKeyPath should throw if root is not an object', function () {
     try {
       expandWildcardKeypath(null, [], '*')