metalsmith-markdown-partials 1.0.0 → 2.0.3

package/.eslintcache

@@ -0,0 +1 @@
+[{"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js":"1","/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/tests/index.js":"2"},{"size":4171,"mtime":1644358226139,"results":"3","hashOfConfig":"4"},{"size":862,"mtime":1643928622922,"results":"5","hashOfConfig":"4"},{"filePath":"6","messages":"7","suppressedMessages":"8","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"uajcbk",{"filePath":"9","messages":"10","suppressedMessages":"11","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js",[],[],"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/tests/index.js",[],[]]

package/.eslintrc.yml

@@ -0,0 +1,8 @@
+env:
+  node: true
+  es6: true
+extends:
+  - 'eslint:recommended'
+  - 'prettier'
+parserOptions:
+  ecmaVersion: 2017

package/.gitattributes

@@ -0,0 +1,7 @@
+# Automatically normalize line endings for all text-based files
+# http://git-scm.com/docs/gitattributes#_end_of_line_conversion
+* text=auto eol=lf
+
+# For binary file types, prevent converting CRLF chars
+*.jpg		-text
+*.png   -text

package/.nyc_output/9d928c88-3cb5-4d77-8d43-36a76d50ab03.json

@@ -0,0 +1 @@
+{"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js":{"path":"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js","statementMap":{"0":{"start":{"line":7,"column":17},"end":{"line":10,"column":1}},"1":{"start":{"line":18,"column":2},"end":{"line":18,"column":52}},"2":{"start":{"line":31,"column":29},"end":{"line":31,"column":31}},"3":{"start":{"line":34,"column":24},"end":{"line":34,"column":67}},"4":{"start":{"line":35,"column":24},"end":{"line":35,"column":59}},"5":{"start":{"line":37,"column":4},"end":{"line":76,"column":7}},"6":{"start":{"line":48,"column":6},"end":{"line":75,"column":7}},"7":{"start":{"line":49,"column":28},"end":{"line":49,"column":34}},"8":{"start":{"line":50,"column":26},"end":{"line":50,"column":30}},"9":{"start":{"line":51,"column":20},"end":{"line":51,"column":51}},"10":{"start":{"line":54,"column":22},"end":{"line":54,"column":62}},"11":{"start":{"line":57,"column":8},"end":{"line":74,"column":9}},"12":{"start":{"line":58,"column":10},"end":{"line":73,"column":11}},"13":{"start":{"line":58,"column":23},"end":{"line":58,"column":24}},"14":{"start":{"line":59,"column":27},"end":{"line":59,"column":65}},"15":{"start":{"line":60,"column":35},"end":{"line":60,"column":121}},"16":{"start":{"line":65,"column":38},"end":{"line":65,"column":99}},"17":{"start":{"line":67,"column":12},"end":{"line":71,"column":15}},"18":{"start":{"line":79,"column":4},"end":{"line":83,"column":7}},"19":{"start":{"line":80,"column":6},"end":{"line":82,"column":7}},"20":{"start":{"line":81,"column":8},"end":{"line":81,"column":27}},"21":{"start":{"line":85,"column":4},"end":{"line":85,"column":27}},"22":{"start":{"line":98,"column":2},"end":{"line":110,"column":5}},"23":{"start":{"line":100,"column":21},"end":{"line":100,"column":48}},"24":{"start":{"line":103,"column":4},"end":{"line":108,"column":5}},"25":{"start":{"line":104,"column":23},"end":{"line":104,"column":51}},"26":{"start":{"line":105,"column":6},"end":{"line":105,"column":115}},"27":{"start":{"line":107,"column":6},"end":{"line":107,"column":23}},"28":{"start":{"line":124,"column":2},"end":{"line":124,"column":38}},"29":{"start":{"line":126,"column":2},"end":{"line":137,"column":4}},"30":{"start":{"line":127,"column":4},"end":{"line":127,"column":23}},"31":{"start":{"line":130,"column":29},"end":{"line":130,"column":64}},"32":{"start":{"line":133,"column":4},"end":{"line":135,"column":5}},"33":{"start":{"line":134,"column":6},"end":{"line":134,"column":55}},"34":{"start":{"line":140,"column":0},"end":{"line":140,"column":38}}},"fnMap":{"0":{"name":"normalizeOptions","decl":{"start":{"line":17,"column":10},"end":{"line":17,"column":26}},"loc":{"start":{"line":17,"column":36},"end":{"line":19,"column":1}},"line":17},"1":{"name":"getMarkdownIncludes","decl":{"start":{"line":30,"column":9},"end":{"line":30,"column":28}},"loc":{"start":{"line":30,"column":45},"end":{"line":86,"column":1}},"line":30},"2":{"name":"(anonymous_2)","decl":{"start":{"line":37,"column":31},"end":{"line":37,"column":32}},"loc":{"start":{"line":37,"column":47},"end":{"line":76,"column":5}},"line":37},"3":{"name":"(anonymous_3)","decl":{"start":{"line":79,"column":31},"end":{"line":79,"column":32}},"loc":{"start":{"line":79,"column":47},"end":{"line":83,"column":5}},"line":79},"4":{"name":"resolveMarkdownIncludes","decl":{"start":{"line":96,"column":9},"end":{"line":96,"column":32}},"loc":{"start":{"line":96,"column":58},"end":{"line":111,"column":1}},"line":96},"5":{"name":"(anonymous_5)","decl":{"start":{"line":98,"column":27},"end":{"line":98,"column":28}},"loc":{"start":{"line":98,"column":53},"end":{"line":110,"column":3}},"line":98},"6":{"name":"initMarkdownPartials","decl":{"start":{"line":123,"column":9},"end":{"line":123,"column":29}},"loc":{"start":{"line":123,"column":39},"end":{"line":138,"column":1}},"line":123},"7":{"name":"markdownPartials","decl":{"start":{"line":126,"column":18},"end":{"line":126,"column":34}},"loc":{"start":{"line":126,"column":60},"end":{"line":137,"column":3}},"line":126}},"branchMap":{"0":{"loc":{"start":{"line":18,"column":37},"end":{"line":18,"column":50}},"type":"binary-expr","locations":[{"start":{"line":18,"column":37},"end":{"line":18,"column":44}},{"start":{"line":18,"column":48},"end":{"line":18,"column":50}}],"line":18},"1":{"loc":{"start":{"line":48,"column":6},"end":{"line":75,"column":7}},"type":"if","locations":[{"start":{"line":48,"column":6},"end":{"line":75,"column":7}},{"start":{"line":48,"column":6},"end":{"line":75,"column":7}}],"line":48},"2":{"loc":{"start":{"line":48,"column":10},"end":{"line":48,"column":76}},"type":"binary-expr","locations":[{"start":{"line":48,"column":10},"end":{"line":48,"column":43}},{"start":{"line":48,"column":47},"end":{"line":48,"column":76}}],"line":48},"3":{"loc":{"start":{"line":57,"column":8},"end":{"line":74,"column":9}},"type":"if","locations":[{"start":{"line":57,"column":8},"end":{"line":74,"column":9}},{"start":{"line":57,"column":8},"end":{"line":74,"column":9}}],"line":57},"4":{"loc":{"start":{"line":80,"column":6},"end":{"line":82,"column":7}},"type":"if","locations":[{"start":{"line":80,"column":6},"end":{"line":82,"column":7}},{"start":{"line":80,"column":6},"end":{"line":82,"column":7}}],"line":80},"5":{"loc":{"start":{"line":133,"column":4},"end":{"line":135,"column":5}},"type":"if","locations":[{"start":{"line":133,"column":4},"end":{"line":135,"column":5}},{"start":{"line":133,"column":4},"end":{"line":135,"column":5}}],"line":133}},"s":{"0":1,"1":1,"2":1,"3":1,"4":1,"5":1,"6":2,"7":1,"8":1,"9":1,"10":1,"11":1,"12":1,"13":1,"14":1,"15":1,"16":1,"17":1,"18":1,"19":2,"20":1,"21":1,"22":1,"23":1,"24":1,"25":1,"26":1,"27":0,"28":1,"29":1,"30":1,"31":1,"32":1,"33":1,"34":1},"f":{"0":1,"1":1,"2":2,"3":2,"4":1,"5":1,"6":1,"7":1},"b":{"0":[1,0],"1":[1,1],"2":[2,2],"3":[1,0],"4":[1,1],"5":[1,0]},"_coverageSchema":"1a1c01bbd47fc00a2c39e90264f33305004495a9","hash":"5a1610d35933a6d0de98c2efdfcab0bbaafbd6bd","contentHash":"0267ccac04a4935df40548e98e2dbbb2d1c5b36280a2a47d872df36ae3e24b14"}}

package/.nyc_output/processinfo/9d928c88-3cb5-4d77-8d43-36a76d50ab03.json

@@ -0,0 +1 @@
+{"parent":null,"pid":46842,"argv":["/Users/wernerglinka/.nvm/versions/node/v16.13.0/bin/node","/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/node_modules/.bin/mocha","./tests/index.js"],"execArgv":[],"cwd":"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials","time":1644364249222,"ppid":46841,"coverageFilename":"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/.nyc_output/9d928c88-3cb5-4d77-8d43-36a76d50ab03.json","externalId":"","uuid":"9d928c88-3cb5-4d77-8d43-36a76d50ab03","files":["/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js"]}

package/.nyc_output/processinfo/index.json

@@ -0,0 +1 @@
+{"processes":{"9d928c88-3cb5-4d77-8d43-36a76d50ab03":{"parent":null,"children":[]}},"files":{"/Users/wernerglinka/Documents/Projects/1-SANDBOXES/metalsmith-sandbox/>>>plugins/ms-markdown-partials/lib/index.js":["9d928c88-3cb5-4d77-8d43-36a76d50ab03"]},"externalIds":{}}

package/.prettierignore

@@ -0,0 +1,3 @@
+test/fixtures/**
+.nyc_output/**
+package-lock.json

package/.prettierrc.yml

@@ -0,0 +1,7 @@
+trailingComma: none
+tabWidth: 2
+semi: true
+singleQuote: true
+bracketSpacing: true
+arrowParens: always
+printWidth: 120

package/.release-it.json

@@ -0,0 +1,24 @@
+{
+  "hooks": {
+    "before:init": ["npm run lint", "npm test"],
+    "after:bump": "auto-changelog -p --commit-limit false --ignore-commit-pattern '^((dev|chore|ci):|Release)'",
+    "after:npm:bump": "npm pack",
+    "after:release": "echo Successfully released ${name} v${version} to ${repo.repository}."
+  },
+  "git": {
+    "commitMessage": "Release ${version}",
+    "commitArgs": ["-S"],
+    "tagAnnotation": "Release ${version}",
+    "tagArgs": ["-s"],
+    "changelog": "auto-changelog -u --commit-limit false --ignore-commit-pattern '^((dev|chore|ci):|Release)' --stdout"
+  },
+  "npm": {
+    "publish": false
+  },
+  "github": {
+    "release": true,
+    "releaseName": "@metalsmith/~core-plugin~ ${version}",
+    "tokenRef": "GITHUB_TOKEN",
+    "assets": ["metalsmith-~core-plugin~-${version}.tgz"]
+  }
+}

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+### Changelog
+
+All notable changes to this project will be documented in this file. Dates are displayed in UTC.
+
+Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
+
+#### Unreleased
+
+- added various config files [`1be389c`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/1be389cb9aedf82405c08c79cdfa866e7d3560d9)
+- updated to ES6 style JS, added license [`37b000f`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/37b000fa3669d928f693ec23a7ccfa629c0e7163)
+- added test [`d998103`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/d998103cb57b4a35ac9224afb11f4264b56f4abe)
+- initial commit [`9a91277`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/9a91277da228d9a718b2c86b012901559c95470d)
+- streamlined code and added to readme.md [`67c32be`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/67c32be34771325f407b9652dc3e7760971e3574)
+- added package.json [`86bfc7d`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/86bfc7d8de66be9127d612c5c5a9a79258a413f8)
+- removed initial debug directory [`46643bd`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/46643bd1aa19f45a9bf1b2513b6c7683da3eff78)
+- added install snippet [`321fb60`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/321fb6042240e1147b90468938911f6d8ed88f28)

package/LICENSE

@@ -0,0 +1,7 @@
+ISC License (ISC)
+
+Copyright (c) 2022 Werner Glinka
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -2,80 +2,132 @@
 
 This Metalsmith plugin enables the use of Markdown partials, e.g. Markdown fragments can be inserted into the contents section of a page markdown file via an include marker.
 
-````
-{{md "<file name>.md" }}
-````
+[![metalsmith: plugin][metalsmith-badge]][metalsmith-url]
+[![npm: version][npm-badge]][npm-url]
+[![license: MIT][license-badge]][license-url]
+
+```
+{#md "<file name>.md" #}
+```
 
 This allows for modular markdown and promotes reuse of markdown partials.
 
 ## Page Markdown File
+
 A markdown file that will be transformed into an html file via a template
 
-## Markdown Partials
+## Markdown Partial
+
 A markdown file to be inserted into a Page Markdown file
 
-Markdown partials are located in a separate directory, for example /library/. This directory should be located in _/dev/content/_ and ignored by the Metalsmith process. This can be done using [metalsmith-ignore](https://github.com/segmentio/metalsmith-ignore).
+Markdown partials are located in a separate directory, for example `/markdown-library/`. This directory should be located inside `/src/` .
 
-Partial markdown files have the extention **.md**. A markdown partial file does NOT have frontmatter metadata, only the markdown to be inserted into a page markdown file.
+Partial markdown files have the extention `.md`. A markdown partial file does NOT have frontmatter metadata, only the markdown to be inserted into a page markdown file.
 
-The markdown partials directory's default location is './dev/content/library/'. The partials directory can be set via the libraryPath option.
+The markdown partials directory's default location is `./src/markdown-library/`. The partials directory can be set via the libraryPath option.
 
-### Example to ignore partial markdown files:
-````
-var ignore = require('metalsmith-ignore');
-...
-// ignore partial markdown files in library
-.use(ignore([
-  'library/*'
-  ]))
-...
-````
+## Installation
+
+```js
+$ npm install --save metalsmith-markdown-partials
+```
 
 ## Usage
-````
+
+```js
 var mdPartials = require('metalsmith-markdown-partials');
 
 ...
-.use(mdPartials({"libraryPath": './dev/content/library/'}))
+.use(mdPartials({
+    libraryPath: './markdown-partials/',
+    fileSuffix: '.md.njk',
+  }))
 ...
 
-````
+```
+
+## Options
+
+**libraryPath**
+
+The default libraryPath is `./markdown-partials/`. This default assumes that all pages are located in `./src/` so the markdown partials are located inside the metalsmith source directory.
+
+```js
+const mdPartials = require('metalsmith-markdown-partials');
+
+metalsmith(__dirname)
+  .use(mdPartials({
+    libraryPath: './markdown-partials/'
+  })
+```
+
+**fileSuffix**
+
+The default fileSuffix is `.md`, but depending on which templating language is used, the suffix will have two parts. For example for Nunjucks it will be `md.njk`.
+
+```js
+const mdPartials = require('metalsmith-markdown-partials').use(
+  mdPartials({
+    fileSuffix: '.md.njk'
+  })
+);
+```
+
+## How it works
 
 ### index.md
 
-````
+```markdown
 # This is an Example Page
 
 Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec id elit non mi porta gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.
 
-{{md "example_partial.md" }}
+{#md "example_partial.md" #}
 
 Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
-````
+```
 
 ### example_partial.md
 
-````
+```markdown
 ## Inserted Content
+
 Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nulla vitae elit libero, a pharetra augue.
-````
+```
 
 ### index.html
-````
+
+```html
 <h1>This is an Example Page</h1>
 
-<p>Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec id elit non mi porta gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit.</p>
+<p>
+  Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec id elit non mi porta
+  gravida at eget metus. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec
+  elit.
+</p>
 
 <h2>Inserted Content</h2>
 <p>Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nulla vitae elit libero, a pharetra augue.</p>
 
-<p>Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.</p>
-````
-
-
+<p>
+  Cras mattis consectetur purus sit amet fermentum. Cras justo odio, dapibus ac facilisis in, egestas eget quam.
+  Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Cum sociis natoque penatibus et magnis dis
+  parturient montes, nascetur ridiculus mus.
+</p>
+```
 
+## Credits
 
+- [werner@glinka.co](https://github.com/wernerglinka)
 
+## License
 
+Code released under [the ISC license](https://github.com/wernerglinka/metalsmith-markdown-partials/blob/main/LICENSE).
 
 
+[npm-badge]: https://img.shields.io/npm/v/metalsmith-markdown-partials.svg
+[npm-url]: https://www.npmjs.com/package/metalsmith-markdown-partials
+[metalsmith-badge]: https://img.shields.io/badge/metalsmith-plugin-green.svg?longCache=true
+[metalsmith-url]: https://metalsmith.io
+[license-badge]: https://img.shields.io/github/license/wernerglinka/metalsmith-markdown-partials
+[license-url]: LICENSE

package/lib/index.js

@@ -0,0 +1,140 @@
+/**
+ * @typedef Options
+ * @property {String} key
+ */
+
+/** @type {Options} */
+const defaults = {
+  libraryPath: './src/content/md-library/',
+  fileSuffix: '.md'
+};
+
+/**
+ * Normalize plugin options
+ * @param {Options} [options]
+ * @returns {Object}
+ */
+ function normalizeOptions(options) {
+  return Object.assign({}, defaults, options || {});
+}
+
+/**
+ * getMarkdownIncludes
+ * Get include markdown markers and replacements
+ *
+ * @param  {[Object]} files - the metalsmith file object
+ * @param {Options}  options
+ * 
+ * @return {[Array]}  Array with all markdown include objects
+ */
+function getMarkdownIncludes(files, options) {
+    const markdownIncludes = [];
+
+    // get the library name 
+    const libraryPath = options.libraryPath.slice(0, -1).split("/");
+    const libraryName = libraryPath[libraryPath.length - 1];
+
+    Object.keys(files).forEach(function (file) {
+      /*
+       * checks if string 'file' ends with options.fileSuffix
+       * when metalsmith-in-place or metalsmith-layouts are used
+       * the suffix depends on what templating language is used
+       * for example with Nunjucks it would be .md.njk
+       *
+       * Also check that file does NOT start with libraryName as 
+       * the markdown partials library is also located in the content
+       * folder
+       */  
+      if (file.endsWith(options.fileSuffix) && !file.startsWith(libraryName)) {
+        const markerStart = "{#md";
+        const markerEnd = "#}";
+        const str = files[file].contents.toString();
+
+        // check for markers present
+        const count = str.match(/\{#md\s*".+?"\s*#\}/g).length;
+
+        // get all markdown includes
+        if (count) {
+          for (let i = 0; count > i; i++) {
+            const marker = str.match(/\{#md\s*"(.+?)"\s*#\}/g)[i];
+            const markerFileName = marker.replaceAll(" ", "").replace(`${markerStart}"`, "").replace(`"${markerEnd}`, "");
+
+            // get the replacement markdown string
+            // by reconstructing the object key for the replacement markdown file
+            // `${libraryName}/${markerFileName}`
+            const replacementString = files[`${libraryName}/${markerFileName}`].contents.toString();
+
+            markdownIncludes.push({
+              marker,
+              markerReplacement: replacementString,
+              file
+            });
+ 
+          }
+        }
+      }
+    });
+
+    // Remove markdown-partials from metalsmith build process
+    Object.keys(files).forEach(function (file) {
+      if (file.startsWith(libraryName)) {
+        delete files[file];
+      }
+    });
+
+    return markdownIncludes
+}
+
+/**
+ * resolveMarkdownIncludes
+ * Replace markers with their markdown replacement strings
+ *
+ * @param  {[Object]} files - the metalsmith file object
+ * @param  {[Array]}  markdownIncludes with all markdown include objects
+ * @return {[void]}
+ */
+function resolveMarkdownIncludes(files, markdownIncludes) {
+  // replace all markers with their markdown replacements
+  markdownIncludes.forEach(function(markdownInclude) {
+
+    const fileData = files[markdownInclude.file];
+
+    // replace the include marker with the actual include file content
+    try {
+      const contents = fileData.contents.toString();
+      fileData.contents = Buffer.from(contents.replace(markdownInclude.marker, markdownInclude.markerReplacement));
+    } catch (e) {
+      console.error(e);
+    }
+
+  });
+}
+
+/**
+ * A Metalsmith plugin to merge markdown partials into main markdown file
+ *
+ * A marker of the form {#md "<file name>.md" #} indicates where the partial
+ * must be inserted and also provides the file name of the replacement markdown.
+ *
+ * @param {Options} options
+ * @returns {import('metalsmith').Plugin}
+ */
+
+function initMarkdownPartials(options) {
+  options = normalizeOptions(options);
+
+  return function markdownPartials(files, metalsmith, done) {
+    setImmediate(done);
+
+    // get all markdown includes
+    const markdownIncludes = getMarkdownIncludes(files, options);
+
+    // replace include markers with their respective replacement
+    if (markdownIncludes.length) {
+      resolveMarkdownIncludes(files, markdownIncludes);
+    }
+
+  };
+}
+
+module.exports = initMarkdownPartials;

package/package.json

@@ -1,28 +1,57 @@
 {
   "name": "metalsmith-markdown-partials",
-  "version": "1.0.0",
+  "version": "2.0.3",
   "description": "A Metalsmith plugin that allows the use of partial markdowm files",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "keywords": [
+    "metalsmith-plugin",
+    "metalsmith",
+    "markdown",
+    "markdown-partials",
+    "static-site"
+  ],
+  "main": "lib/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wernerglinka/metalsmith-markdown-partials.git"
   },
-  "keywords": [
-    "Metalsmith",
-    "Markdown",
-    "Partials"
-  ],
-  "author": [
-    { "name": "Werner Glinka",
-      "email": "werner@glinka.co"
-    }
-  ],
+  "author": {
+    "name": "Werner Glinka",
+    "email": "werner@glinka.co"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/wernerglinka/metalsmith-markdown-partials/issues"
   },
-  "homepage": "https://github.com/wernerglinka/metalsmith-markdown-partials#readme"
+  "homepage": "https://github.com/wernerglinka/metalsmith-markdown-partials#readme",
+  "dependencies": {
+    "debug": "^4.3.3"
+  },
+  "devDependencies": {
+    "auto-changelog": "^2.4.0",
+    "chai": "^4.3.6",
+    "coveralls": "^3.1.1",
+    "eslint": "^8.4.1",
+    "eslint-config-prettier": "^8.3.0",
+    "metalsmith": "^2.4.1",
+    "mocha": "^9.2.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.5.1",
+    "release-it": "^14.12.4"
+  },
+  "peerDependencies": {
+    "metalsmith": "^2.4.1"
+  },
+  "scripts": {
+    "changelog": "auto-changelog -u date --commit-limit false --ignore-commit-pattern '^((dev|chore|ci):|Release)'",
+    "format": "prettier --write \"**/*.{yml,md,js,json}\"",
+    "lint": "eslint --cache --fix-dry-run .",
+    "release": "release-it .",
+    "test": "nyc mocha ./tests/index.js"
+  },
+  "engines": {
+    "node": ">=8"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/tests/fixtures/build/markdown.md

@@ -0,0 +1,11 @@
+# Markdown page... testing markdown partials plugin
+
+Nullam quis risus eget urna mollis ornare vel eu leo. Curabitur blandit tempus porttitor. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Donec sed odio dui.
+
+## Test partial title
+
+Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis. Maecenas faucibus mollis interdum. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
+Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla vitae elit libero, a pharetra augue. Maecenas faucibus mollis interdum. Maecenas faucibus mollis interdum. Sed posuere consectetur est at lobortis.
+
+Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Aenean lacinia bibendum nulla sed consectetur.

package/tests/fixtures/expected/final-markdown.md

@@ -0,0 +1,11 @@
+# Markdown page... testing markdown partials plugin
+
+Nullam quis risus eget urna mollis ornare vel eu leo. Curabitur blandit tempus porttitor. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Donec sed odio dui.
+
+## Test partial title
+
+Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis. Maecenas faucibus mollis interdum. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.
+
+Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla vitae elit libero, a pharetra augue. Maecenas faucibus mollis interdum. Maecenas faucibus mollis interdum. Sed posuere consectetur est at lobortis.
+
+Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Aenean lacinia bibendum nulla sed consectetur.

package/tests/fixtures/src/markdown.md

@@ -0,0 +1,9 @@
+# Markdown page... testing markdown partials plugin
+
+Nullam quis risus eget urna mollis ornare vel eu leo. Curabitur blandit tempus porttitor. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Donec sed odio dui.
+
+{#md "test-partial.md" #}
+
+Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Nulla vitae elit libero, a pharetra augue. Maecenas faucibus mollis interdum. Maecenas faucibus mollis interdum. Sed posuere consectetur est at lobortis.
+
+Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Aenean lacinia bibendum nulla sed consectetur.

package/tests/fixtures/src/md-partials/test-partial.md

@@ -0,0 +1,3 @@
+## Test partial title
+
+Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Sed posuere consectetur est at lobortis. Maecenas faucibus mollis interdum. Morbi leo risus, porta ac consectetur ac, vestibulum at eros.

package/tests/index.js

@@ -0,0 +1,36 @@
+/* global describe, it */
+
+'use strict';
+
+const chai = require('chai');
+const metalsmith = require('metalsmith');
+const mdPartials = require('../lib');
+const fs = require('fs');
+const path = require('path');
+const expect = chai.expect;
+
+const fixture = path.resolve.bind(path, __dirname, 'fixtures');
+
+function file(_path) {
+  return fs.readFileSync(fixture(_path), 'utf8');
+}
+
+describe('metalsmith-markdown-partials', () => {
+
+  it('should replace marker with markdown partial', done => {
+
+    metalsmith(fixture())
+      .use(mdPartials({
+          libraryPath: path.join(fixture(), `/src/md-partials/`),
+          fileSuffix: '.md',
+        }))
+      .build( err => {
+        if (err) {
+          return done(err);
+        }
+        expect(file('build/markdown.md')).to.be.eql(file('expected/final-markdown.md'));
+        
+        done();
+      });
+  });
+});

package/.npmignore

@@ -1,2 +0,0 @@
-.DS_Store
-.idea

package/index.js

@@ -1,112 +0,0 @@
-/* eslint-disable */
-var fs = require('fs');
-
-module.exports = plugin;
-
-/**
- * Metalsmith plugin to merge markdown partials into main markdown file
- */
-
-function plugin(options){
-  options = options || {};
-
-  return function(files, metalsmith, done){
-    setImmediate(done);
-
-    Object.keys(files).forEach(function(file){
-
-      // exit if this file is not a markdown file
-      var fileExtension = file.split('.').pop();
-      if ( fileExtension !== 'md') return;
-
-      // get the file data and convert to string
-      var fileData = files[file];
-
-      // get all include markers for this file
-      var markers = getIncludes(fileData);
-
-      // replace all include markers with their respective file content
-      if (markers.length) {
-        resolveIncludes(fileData, markers, options);
-      }
-    });
-  };
-}
-
-/**
- * getIncludes
- * function to extract all include markers from the file contents
- * @param  {[string]} str - the file contents in string form
- * @return {[array]}  markers - the start and end indexes for all include markers
- */
-function getIncludes(fileData) {
-  var str = fileData.contents.toString();
-  var markers = [];
-  var previousMarker, i;
-  var temp = [];
-  // get any include marker
-  var newMarker = str.indexOf('{{md');
-
-  if ( newMarker > -1 ) {
-    // get the number of partials in this file
-    var count = (str.match(/{{md/g) || []).length;
-
-    // get the marker boundaries for this file
-    // a marker looks like this: {{md "<partial name>.md"}}
-    for(i = 0; count > i; i++) {
-      // get the marker pair
-      temp.push(newMarker);
-      previousMarker = newMarker;
-      // find the closing brackets '}}'
-      newMarker = str.indexOf('}}', previousMarker) + 2;
-      temp.push(newMarker);
-      // push marker pair into markers array
-      markers.push(temp);
-      temp = [];
-      previousMarker = newMarker;
-      newMarker = str.indexOf('{{md', previousMarker);
-    }
-  }
-  return markers;
-}
-
-
-/**
- * resolveIncludes
- * function to replace all include markers with their respective files content
- * @param  {[object]} fileData - the file being processed as an object
- * @param  {[array]} markers - the start and end indexes for all include markers
- * @param  {[object]} options  - plugin options. in this case the path to the directory that holds all the markdown includes
- * @return {[void]}
- */
-function resolveIncludes(fileData, markers, options) {
-  var filePath, replaceThis;
-  var str = fileData.contents.toString();
-
-  for (i = 0; markers.length > i; i++) {
-    // get the whole marker string
-    filePath = str.substring(markers[i][0], markers[i][1]);
-    // keep the include market string for later replace
-    replaceThis = filePath;
-    // replace single quotes with double quotes... just in case
-    filePath = filePath.replace(/'/g, '"');
-    // get the path inside the marker between the quotes
-    filePath = filePath.match(/"([^"]+)"/)[1];
-
-    // get the file content synchronously
-    var libPath = options.libraryPath || './dev/content/library/'
-    try {
-        var data = fs.readFileSync(libPath + filePath, 'utf8');
-    } catch(e) {
-        console.log('Error:', e.stack);
-    }
-
-    // replace the include marker with the actual include file content
-    try {
-      var contents = fileData.contents.toString();
-      fileData.contents = new Buffer(contents.replace(replaceThis, data));
-    } catch (e) {
-      console.error(e);
-    }
-  }
-}