metalsmith-markdown-partials 2.0.0 → 2.0.1

package/lib/index.js

@@ -1,6 +1,3 @@
-/* eslint-disable */
-const fs = require('fs');
-
 /**
  * @typedef Options
  * @property {String} key
@@ -8,7 +5,7 @@ const fs = require('fs');
 
 /** @type {Options} */
 const defaults = {
-  libraryPath: './src/md-library/',
+  libraryPath: './src/content/md-library/',
   fileSuffix: '.md'
 };
 
@@ -17,96 +14,100 @@ const defaults = {
  * @param {Options} [options]
  * @returns {Object}
  */
-function normalizeOptions(options) {
+ function normalizeOptions(options) {
   return Object.assign({}, defaults, options || {});
 }
 
 /**
- * getIncludes
- * Extract include markers from file contents
+ * getMarkdownIncludes
+ * Get include markdown markers and replacements
  *
- * @param  {[string]} str - the file contents in string form
- * @return {[array]}  markers - the start and end indexes for all include markers
+ * @param  {[Object]} files - the metalsmith file object
+ * @param {Options}  options
+ * 
+ * @return {[Array]}  Array with all markdown include objects
  */
+function getMarkdownIncludes(files, options) {
+    const markdownIncludes = [];
 
-function getIncludes(fileData) {
-  const str = fileData.contents.toString();
-  const markers = [];
-  let previousMarker, i;
-  let temp = [];
-
-  // find first include marker
-  let newMarker = str.indexOf('{#md');
-
-  if (newMarker > -1) {
-    // get the number of partials in this file
-    const 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 = [];
-      // find the next marker
-      previousMarker = newMarker;
-      newMarker = str.indexOf('{#md', previousMarker);
-    }
-  }
-  return markers;
+    // 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}`
+            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
 }
 
 /**
- * resolveIncludes
- * Replace include markers with their respective files content
+ * resolveMarkdownIncludes
+ * Replace markers with their markdown replacement strings
  *
- * @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
+ * @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) {
 
-function resolveIncludes(fileData, markers, options) {
-  let markerString, filePath, replaceThis;
-  const str = fileData.contents.toString();
-  let data;
-
-  for (i = 0; markers.length > i; i++) {
-    // get the whole marker string
-    markerString = str.substring(markers[i][0], markers[i][1]);
-
-    // extract the markdown particle file path from the marker string
-    // replace single quotes with double quotes... just in case
-    filePath = markerString.replace(/'/g, '"');
-    // get the path inside the marker between the quotes
-    filePath = filePath.match(/"([^"]+)"/)[1];
-
-    // get the file content
-    const libPath = options.libraryPath;
-    
-    try {
-      data = fs.readFileSync(libPath + filePath, 'utf8');
-    } catch (e) {
-      console.log('Error:', e.stack);
-    }
+    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(markerString, data));
+      fileData.contents = Buffer.from(contents.replace(markdownInclude.marker, markdownInclude.markerReplacement));
     } catch (e) {
       console.error(e);
     }
-  }
+
+  });
 }
 
 /**
@@ -119,31 +120,21 @@ function resolveIncludes(fileData, markers, options) {
  * @returns {import('metalsmith').Plugin}
  */
 
-function markdownPartials(options) {
+function initMarkdownPartials(options) {
   options = normalizeOptions(options);
 
-  return function (files, metalsmith, done) {
+  return function markdownPartials(files, metalsmith, done) {
     setImmediate(done);
 
-    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
-      if (file.endsWith(options.fileSuffix)) {
-        // get the file data
-        const fileData = files[file];
-
-        // get include markers for this file
-        const markers = getIncludes(fileData);
-
-        // replace include markers with their respective replacement
-        if (markers.length) {
-          resolveIncludes(fileData, markers, options);
-        }
-      }
-    });
+    // get all markdown includes
+    const markdownIncludes = getMarkdownIncludes(files, options);
+
+    // replace include markers with their respective replacement
+    if (markdownIncludes.length) {
+      resolveMarkdownIncludes(files, markdownIncludes);
+    }
+
   };
 }
 
-module.exports = markdownPartials;
+module.exports = initMarkdownPartials;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metalsmith-markdown-partials",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "A Metalsmith plugin that allows the use of partial markdowm files",
   "keywords": [
     "metalsmith-plugin",

package/tests/index.js

@@ -21,7 +21,7 @@ describe('metalsmith-markdown-partials', () => {
 
     metalsmith(fixture())
       .use(mdPartials({
-          libraryPath: path.join(fixture(), `/md-partials/`),
+          libraryPath: path.join(fixture(), `/src/md-partials/`),
           fileSuffix: '.md',
         }))
       .build( err => {