metalsmith-markdown-partials 2.3.1 → 2.5.0

package/README.md

@@ -4,7 +4,9 @@ A Metalsmith plugin that enables the use of Markdown partials.
 
 [![metalsmith: plugin][metalsmith-badge]][metalsmith-url]
 [![npm: version][npm-badge]][npm-url]
-[![license: ISC][license-badge]][license-url]
+[![license: MIT][license-badge]][license-url]
+[![coverage][coverage-badge]][coverage-url]
+[![ESM/CommonJS][modules-badge]][npm-url]
 
 Markdown fragments are inserted into the contents of a page markdown file by replacing an include marker with markdown partials. This allows for modular markdown and promotes reuse of content.
 
@@ -58,11 +60,13 @@ const mdPartials = require('metalsmith-markdown-partials').use(
 ## How it works
 
 ### Include marker
+
 ```
 {#md "<file name>.md" #}
 ```
 
 ### Page Markdown File
+
 A markdown file that will be transformed into an html file via a template
 
 ### Markdown Partial
@@ -117,6 +121,7 @@ Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Nulla vitae
   parturient montes, nascetur ridiculus mus.
 </p>
 ```
+
 ## Debug
 
 To enable debug logs, set the `DEBUG` environment variable to `metalsmith-markdown-partials`:
@@ -132,6 +137,7 @@ Windows:
 ```
 set "DEBUG=metalsmith-markdown-partials"
 ```
+
 ### CLI usage
 
 To use this plugin with the Metalsmith CLI, add `metalsmith-markdown-partials` to the `plugins` key in your `metalsmith.json` file:
@@ -149,18 +155,24 @@ To use this plugin with the Metalsmith CLI, add `metalsmith-markdown-partials` t
 }
 ```
 
+## Test Coverage
+
+This project maintains high statement and line coverage for the source code. Coverage is verified during the release process using the c8 coverage tool.
+
 ## Author
 
-- [werner@glinka.co](https://github.com/wernerglinka)
+[werner@glinka.co](https://github.com/wernerglinka)
 
 ## License
 
-Code released under [the ISC license](https://github.com/wernerglinka/metalsmith-markdown-partials/blob/main/LICENSE).
-
+Code released under [the MIT 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
+[license-url]: LICENSE
+[coverage-badge]: https://img.shields.io/badge/test%20coverage-94%25-brightgreen
+[coverage-url]: #test-coverage
+[modules-badge]: https://img.shields.io/badge/modules-ESM%2FCJS-blue

package/lib/index.cjs

@@ -0,0 +1,184 @@
+'use strict';
+
+/**
+ * A Metalsmith plugin to merge markdown partials into main markdown files.
+ *
+ * @module metalsmith-markdown-partials
+ */
+
+/**
+ * @typedef {Object} Options
+ * @property {String} libraryPath - Path to the markdown partials library (defaults to './src/content/md-library/')
+ * @property {String} fileSuffix - File suffix for markdown files (defaults to '.md')
+ */
+
+// Define debug namespace at the top of the file
+const debugNs = 'metalsmith-markdown-partials';
+
+/** @type {Options} */
+const defaults = {
+  libraryPath: './src/content/md-library/',
+  fileSuffix: '.md'
+};
+
+/**
+ * Normalize plugin options by merging with defaults
+ * @param {Options} [options] - User provided options
+ * @returns {Options} Normalized options
+ */
+function normalizeOptions(options) {
+  return Object.assign({}, defaults, options || {});
+}
+
+/**
+ * Extract markdown partials from files and prepare them for insertion
+ *
+ * @param {Object} files - The metalsmith file object
+ * @param {Options} options - Plugin options
+ * @param {Function} debug - Debug function
+ * @returns {Array} Array with all markdown include objects
+ */
+function getMarkdownIncludes(files, options, debug) {
+  const markdownIncludes = [];
+
+  // Extract the library name from the path
+  const libraryPath = options.libraryPath.slice(0, -1).split('/');
+  const libraryName = libraryPath[libraryPath.length - 1];
+  debug('Processing markdown files with libraryName: %s', libraryName);
+
+  // Regex for matching include markers
+  const markerRegex = /\{#md\s*".+?"\s*#\}/g;
+  const markerStart = '{#md';
+  const markerEnd = '#}';
+
+  // Set to track already processed partials to prevent duplicates
+  const processedPartials = new Set();
+  Object.keys(files).forEach(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 str = files[file].contents.toString();
+
+      // Check if markers are present
+      const matches = str.match(markerRegex);
+      if (!matches) {
+        return;
+      }
+      debug('Found %d markdown partials in %s', matches.length, file);
+
+      // Process each marker in the file
+      matches.forEach(marker => {
+        // Extract the filename from the marker
+        const markerFileName = marker.replaceAll(' ', '').replace(`${markerStart}"`, '').replace(`"${markerEnd}`, '');
+        const partialKey = `${libraryName}/${markerFileName}`;
+
+        // Check if partial file exists
+        if (!files[partialKey]) {
+          debug('Warning: Partial file not found: %s', partialKey);
+          return;
+        }
+
+        // Skip if we've already processed this exact marker+file combination
+        const combinedKey = `${file}:${marker}`;
+        if (processedPartials.has(combinedKey)) {
+          return;
+        }
+        processedPartials.add(combinedKey);
+
+        // Get the replacement content
+        const replacementString = files[partialKey].contents.toString();
+        markdownIncludes.push({
+          marker,
+          markerReplacement: replacementString,
+          file
+        });
+      });
+    }
+  });
+
+  // Remove markdown-partials from metalsmith build process
+  Object.keys(files).forEach(file => {
+    if (file.startsWith(libraryName)) {
+      delete files[file];
+    }
+  });
+  debug('Processed %d markdown includes', markdownIncludes.length);
+  return markdownIncludes;
+}
+
+/**
+ * Replace markers with their markdown replacement strings
+ *
+ * @param {Object} files - The metalsmith file object
+ * @param {Array} markdownIncludes - Array with all markdown include objects
+ * @param {Function} debug - Debug function
+ * @return {void}
+ */
+function resolveMarkdownIncludes(files, markdownIncludes, debug) {
+  // replace all markers with their markdown replacements
+  markdownIncludes.forEach(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));
+      debug('Replaced marker in %s', markdownInclude.file);
+    } catch (e) {
+      debug('Error replacing marker in %s: %s', markdownInclude.file, e.message);
+      console.error(`Error replacing marker in ${markdownInclude.file}:`, 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] - Plugin options
+ * @returns {import('metalsmith').Plugin} Metalsmith plugin function
+ * @example
+ * // In your metalsmith build:
+ * .use(markdownPartials({
+ *   libraryPath: './src/content/md-partials/',
+ *   fileSuffix: '.md.njk'
+ * }))
+ */
+function initMarkdownPartials(options) {
+  options = normalizeOptions(options);
+  return function markdownPartials(files, metalsmith, done) {
+    // Use metalsmith's debug method if available
+    const debug = metalsmith.debug ? metalsmith.debug(debugNs) : () => {};
+    debug('Running with options: %o', options);
+    try {
+      // Get all markdown includes
+      const markdownIncludes = getMarkdownIncludes(files, options, debug);
+
+      // Replace include markers with their respective replacement
+      if (markdownIncludes.length) {
+        resolveMarkdownIncludes(files, markdownIncludes, debug);
+      }
+      setImmediate(done);
+    } catch (err) {
+      debug('Error processing markdown partials: %s', err.message);
+      setImmediate(() => done(err));
+    }
+  };
+}
+
+// CommonJS export compatibility
+if (typeof module !== 'undefined') {
+  module.exports = initMarkdownPartials;
+}
+
+module.exports = initMarkdownPartials;
+//# sourceMappingURL=index.cjs.map

package/lib/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","sources":["../src/index.js"],"sourcesContent":["/**\n * A Metalsmith plugin to merge markdown partials into main markdown files.\n *\n * @module metalsmith-markdown-partials\n */\n\n/**\n * @typedef {Object} Options\n * @property {String} libraryPath - Path to the markdown partials library (defaults to './src/content/md-library/')\n * @property {String} fileSuffix - File suffix for markdown files (defaults to '.md')\n */\n\n// Define debug namespace at the top of the file\nconst debugNs = 'metalsmith-markdown-partials';\n\n/** @type {Options} */\nconst defaults = {\n  libraryPath: './src/content/md-library/',\n  fileSuffix: '.md'\n};\n\n/**\n * Normalize plugin options by merging with defaults\n * @param {Options} [options] - User provided options\n * @returns {Options} Normalized options\n */\nfunction normalizeOptions(options) {\n  return Object.assign({}, defaults, options || {});\n}\n\n/**\n * Extract markdown partials from files and prepare them for insertion\n *\n * @param {Object} files - The metalsmith file object\n * @param {Options} options - Plugin options\n * @param {Function} debug - Debug function\n * @returns {Array} Array with all markdown include objects\n */\nfunction getMarkdownIncludes(files, options, debug) {\n  const markdownIncludes = [];\n\n  // Extract the library name from the path\n  const libraryPath = options.libraryPath.slice(0, -1).split('/');\n  const libraryName = libraryPath[libraryPath.length - 1];\n\n  debug('Processing markdown files with libraryName: %s', libraryName);\n\n  // Regex for matching include markers\n  const markerRegex = /\\{#md\\s*\".+?\"\\s*#\\}/g;\n  const markerStart = '{#md';\n  const markerEnd = '#}';\n\n  // Set to track already processed partials to prevent duplicates\n  const processedPartials = new Set();\n\n  Object.keys(files).forEach((file) => {\n    /*\n     * checks if string 'file' ends with options.fileSuffix\n     * when metalsmith-in-place or metalsmith-layouts are used\n     * the suffix depends on what templating language is used\n     * for example with Nunjucks it would be .md.njk\n     *\n     * Also check that file does NOT start with libraryName as\n     * the markdown partials library is also located in the content folder\n     */\n    if (file.endsWith(options.fileSuffix) && !file.startsWith(libraryName)) {\n      const str = files[file].contents.toString();\n\n      // Check if markers are present\n      const matches = str.match(markerRegex);\n      if (!matches) {return;}\n\n      debug('Found %d markdown partials in %s', matches.length, file);\n\n      // Process each marker in the file\n      matches.forEach((marker) => {\n        // Extract the filename from the marker\n        const markerFileName = marker.replaceAll(' ', '').replace(`${markerStart}\"`, '').replace(`\"${markerEnd}`, '');\n        const partialKey = `${libraryName}/${markerFileName}`;\n\n        // Check if partial file exists\n        if (!files[partialKey]) {\n          debug('Warning: Partial file not found: %s', partialKey);\n          return;\n        }\n\n        // Skip if we've already processed this exact marker+file combination\n        const combinedKey = `${file}:${marker}`;\n        if (processedPartials.has(combinedKey)) {return;}\n\n        processedPartials.add(combinedKey);\n\n        // Get the replacement content\n        const replacementString = files[partialKey].contents.toString();\n\n        markdownIncludes.push({\n          marker,\n          markerReplacement: replacementString,\n          file\n        });\n      });\n    }\n  });\n\n  // Remove markdown-partials from metalsmith build process\n  Object.keys(files).forEach((file) => {\n    if (file.startsWith(libraryName)) {\n      delete files[file];\n    }\n  });\n\n  debug('Processed %d markdown includes', markdownIncludes.length);\n  return markdownIncludes;\n}\n\n/**\n * Replace markers with their markdown replacement strings\n *\n * @param {Object} files - The metalsmith file object\n * @param {Array} markdownIncludes - Array with all markdown include objects\n * @param {Function} debug - Debug function\n * @return {void}\n */\nfunction resolveMarkdownIncludes(files, markdownIncludes, debug) {\n  // replace all markers with their markdown replacements\n  markdownIncludes.forEach((markdownInclude) => {\n    const fileData = files[markdownInclude.file];\n\n    // replace the include marker with the actual include file content\n    try {\n      const contents = fileData.contents.toString();\n      fileData.contents = Buffer.from(contents.replace(markdownInclude.marker, markdownInclude.markerReplacement));\n      debug('Replaced marker in %s', markdownInclude.file);\n    } catch (e) {\n      debug('Error replacing marker in %s: %s', markdownInclude.file, e.message);\n      console.error(`Error replacing marker in ${markdownInclude.file}:`, e);\n    }\n  });\n}\n\n/**\n * A Metalsmith plugin to merge markdown partials into main markdown file\n *\n * A marker of the form {#md \"<file name>.md\" #} indicates where the partial\n * must be inserted and also provides the file name of the replacement markdown.\n *\n * @param {Options} [options] - Plugin options\n * @returns {import('metalsmith').Plugin} Metalsmith plugin function\n * @example\n * // In your metalsmith build:\n * .use(markdownPartials({\n *   libraryPath: './src/content/md-partials/',\n *   fileSuffix: '.md.njk'\n * }))\n */\nfunction initMarkdownPartials(options) {\n  options = normalizeOptions(options);\n\n  return function markdownPartials(files, metalsmith, done) {\n    // Use metalsmith's debug method if available\n    const debug = metalsmith.debug ? metalsmith.debug(debugNs) : () => {};\n    debug('Running with options: %o', options);\n\n    try {\n      // Get all markdown includes\n      const markdownIncludes = getMarkdownIncludes(files, options, debug);\n\n      // Replace include markers with their respective replacement\n      if (markdownIncludes.length) {\n        resolveMarkdownIncludes(files, markdownIncludes, debug);\n      }\n\n      setImmediate(done);\n    } catch (err) {\n      debug('Error processing markdown partials: %s', err.message);\n      setImmediate(() => done(err));\n    }\n  };\n}\n\n// ESM export\nexport default initMarkdownPartials;\n\n// CommonJS export compatibility\nif (typeof module !== 'undefined') {\n  module.exports = initMarkdownPartials;\n}\n"],"names":["debugNs","defaults","libraryPath","fileSuffix","normalizeOptions","options","Object","assign","getMarkdownIncludes","files","debug","markdownIncludes","slice","split","libraryName","length","markerRegex","markerStart","markerEnd","processedPartials","Set","keys","forEach","file","endsWith","startsWith","str","contents","toString","matches","match","marker","markerFileName","replaceAll","replace","partialKey","combinedKey","has","add","replacementString","push","markerReplacement","resolveMarkdownIncludes","markdownInclude","fileData","Buffer","from","e","message","console","error","initMarkdownPartials","markdownPartials","metalsmith","done","setImmediate","err","module","exports"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA,MAAMA,OAAO,GAAG,8BAA8B,CAAA;;AAE9C;AACA,MAAMC,QAAQ,GAAG;AACfC,EAAAA,WAAW,EAAE,2BAA2B;AACxCC,EAAAA,UAAU,EAAE,KAAA;AACd,CAAC,CAAA;;AAED;AACA;AACA;AACA;AACA;AACA,SAASC,gBAAgBA,CAACC,OAAO,EAAE;AACjC,EAAA,OAAOC,MAAM,CAACC,MAAM,CAAC,EAAE,EAAEN,QAAQ,EAAEI,OAAO,IAAI,EAAE,CAAC,CAAA;AACnD,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASG,mBAAmBA,CAACC,KAAK,EAAEJ,OAAO,EAAEK,KAAK,EAAE;EAClD,MAAMC,gBAAgB,GAAG,EAAE,CAAA;;AAE3B;AACA,EAAA,MAAMT,WAAW,GAAGG,OAAO,CAACH,WAAW,CAACU,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAACC,KAAK,CAAC,GAAG,CAAC,CAAA;EAC/D,MAAMC,WAAW,GAAGZ,WAAW,CAACA,WAAW,CAACa,MAAM,GAAG,CAAC,CAAC,CAAA;AAEvDL,EAAAA,KAAK,CAAC,gDAAgD,EAAEI,WAAW,CAAC,CAAA;;AAEpE;EACA,MAAME,WAAW,GAAG,sBAAsB,CAAA;EAC1C,MAAMC,WAAW,GAAG,MAAM,CAAA;EAC1B,MAAMC,SAAS,GAAG,IAAI,CAAA;;AAEtB;AACA,EAAA,MAAMC,iBAAiB,GAAG,IAAIC,GAAG,EAAE,CAAA;EAEnCd,MAAM,CAACe,IAAI,CAACZ,KAAK,CAAC,CAACa,OAAO,CAAEC,IAAI,IAAK;AACnC;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACI,IAAA,IAAIA,IAAI,CAACC,QAAQ,CAACnB,OAAO,CAACF,UAAU,CAAC,IAAI,CAACoB,IAAI,CAACE,UAAU,CAACX,WAAW,CAAC,EAAE;MACtE,MAAMY,GAAG,GAAGjB,KAAK,CAACc,IAAI,CAAC,CAACI,QAAQ,CAACC,QAAQ,EAAE,CAAA;;AAE3C;AACA,MAAA,MAAMC,OAAO,GAAGH,GAAG,CAACI,KAAK,CAACd,WAAW,CAAC,CAAA;MACtC,IAAI,CAACa,OAAO,EAAE;AAAC,QAAA,OAAA;AAAO,OAAA;MAEtBnB,KAAK,CAAC,kCAAkC,EAAEmB,OAAO,CAACd,MAAM,EAAEQ,IAAI,CAAC,CAAA;;AAE/D;AACAM,MAAAA,OAAO,CAACP,OAAO,CAAES,MAAM,IAAK;AAC1B;QACA,MAAMC,cAAc,GAAGD,MAAM,CAACE,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAACC,OAAO,CAAC,CAAGjB,EAAAA,WAAW,CAAG,CAAA,CAAA,EAAE,EAAE,CAAC,CAACiB,OAAO,CAAC,CAAA,CAAA,EAAIhB,SAAS,CAAA,CAAE,EAAE,EAAE,CAAC,CAAA;AAC7G,QAAA,MAAMiB,UAAU,GAAG,CAAA,EAAGrB,WAAW,CAAA,CAAA,EAAIkB,cAAc,CAAE,CAAA,CAAA;;AAErD;AACA,QAAA,IAAI,CAACvB,KAAK,CAAC0B,UAAU,CAAC,EAAE;AACtBzB,UAAAA,KAAK,CAAC,qCAAqC,EAAEyB,UAAU,CAAC,CAAA;AACxD,UAAA,OAAA;AACF,SAAA;;AAEA;AACA,QAAA,MAAMC,WAAW,GAAG,CAAA,EAAGb,IAAI,CAAA,CAAA,EAAIQ,MAAM,CAAE,CAAA,CAAA;AACvC,QAAA,IAAIZ,iBAAiB,CAACkB,GAAG,CAACD,WAAW,CAAC,EAAE;AAAC,UAAA,OAAA;AAAO,SAAA;AAEhDjB,QAAAA,iBAAiB,CAACmB,GAAG,CAACF,WAAW,CAAC,CAAA;;AAElC;QACA,MAAMG,iBAAiB,GAAG9B,KAAK,CAAC0B,UAAU,CAAC,CAACR,QAAQ,CAACC,QAAQ,EAAE,CAAA;QAE/DjB,gBAAgB,CAAC6B,IAAI,CAAC;UACpBT,MAAM;AACNU,UAAAA,iBAAiB,EAAEF,iBAAiB;AACpChB,UAAAA,IAAAA;AACF,SAAC,CAAC,CAAA;AACJ,OAAC,CAAC,CAAA;AACJ,KAAA;AACF,GAAC,CAAC,CAAA;;AAEF;EACAjB,MAAM,CAACe,IAAI,CAACZ,KAAK,CAAC,CAACa,OAAO,CAAEC,IAAI,IAAK;AACnC,IAAA,IAAIA,IAAI,CAACE,UAAU,CAACX,WAAW,CAAC,EAAE;MAChC,OAAOL,KAAK,CAACc,IAAI,CAAC,CAAA;AACpB,KAAA;AACF,GAAC,CAAC,CAAA;AAEFb,EAAAA,KAAK,CAAC,gCAAgC,EAAEC,gBAAgB,CAACI,MAAM,CAAC,CAAA;AAChE,EAAA,OAAOJ,gBAAgB,CAAA;AACzB,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS+B,uBAAuBA,CAACjC,KAAK,EAAEE,gBAAgB,EAAED,KAAK,EAAE;AAC/D;AACAC,EAAAA,gBAAgB,CAACW,OAAO,CAAEqB,eAAe,IAAK;AAC5C,IAAA,MAAMC,QAAQ,GAAGnC,KAAK,CAACkC,eAAe,CAACpB,IAAI,CAAC,CAAA;;AAE5C;IACA,IAAI;MACF,MAAMI,QAAQ,GAAGiB,QAAQ,CAACjB,QAAQ,CAACC,QAAQ,EAAE,CAAA;AAC7CgB,MAAAA,QAAQ,CAACjB,QAAQ,GAAGkB,MAAM,CAACC,IAAI,CAACnB,QAAQ,CAACO,OAAO,CAACS,eAAe,CAACZ,MAAM,EAAEY,eAAe,CAACF,iBAAiB,CAAC,CAAC,CAAA;AAC5G/B,MAAAA,KAAK,CAAC,uBAAuB,EAAEiC,eAAe,CAACpB,IAAI,CAAC,CAAA;KACrD,CAAC,OAAOwB,CAAC,EAAE;MACVrC,KAAK,CAAC,kCAAkC,EAAEiC,eAAe,CAACpB,IAAI,EAAEwB,CAAC,CAACC,OAAO,CAAC,CAAA;MAC1EC,OAAO,CAACC,KAAK,CAAC,CAA6BP,0BAAAA,EAAAA,eAAe,CAACpB,IAAI,CAAA,CAAA,CAAG,EAAEwB,CAAC,CAAC,CAAA;AACxE,KAAA;AACF,GAAC,CAAC,CAAA;AACJ,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASI,oBAAoBA,CAAC9C,OAAO,EAAE;AACrCA,EAAAA,OAAO,GAAGD,gBAAgB,CAACC,OAAO,CAAC,CAAA;EAEnC,OAAO,SAAS+C,gBAAgBA,CAAC3C,KAAK,EAAE4C,UAAU,EAAEC,IAAI,EAAE;AACxD;AACA,IAAA,MAAM5C,KAAK,GAAG2C,UAAU,CAAC3C,KAAK,GAAG2C,UAAU,CAAC3C,KAAK,CAACV,OAAO,CAAC,GAAG,MAAM,EAAE,CAAA;AACrEU,IAAAA,KAAK,CAAC,0BAA0B,EAAEL,OAAO,CAAC,CAAA;IAE1C,IAAI;AACF;MACA,MAAMM,gBAAgB,GAAGH,mBAAmB,CAACC,KAAK,EAAEJ,OAAO,EAAEK,KAAK,CAAC,CAAA;;AAEnE;MACA,IAAIC,gBAAgB,CAACI,MAAM,EAAE;AAC3B2B,QAAAA,uBAAuB,CAACjC,KAAK,EAAEE,gBAAgB,EAAED,KAAK,CAAC,CAAA;AACzD,OAAA;MAEA6C,YAAY,CAACD,IAAI,CAAC,CAAA;KACnB,CAAC,OAAOE,GAAG,EAAE;AACZ9C,MAAAA,KAAK,CAAC,wCAAwC,EAAE8C,GAAG,CAACR,OAAO,CAAC,CAAA;AAC5DO,MAAAA,YAAY,CAAC,MAAMD,IAAI,CAACE,GAAG,CAAC,CAAC,CAAA;AAC/B,KAAA;GACD,CAAA;AACH,CAAA;;AAKA;AACA,IAAI,OAAOC,MAAM,KAAK,WAAW,EAAE;EACjCA,MAAM,CAACC,OAAO,GAAGP,oBAAoB,CAAA;AACvC;;;;"}

package/lib/index.js

@@ -1,8 +1,18 @@
 /**
- * @typedef Options
- * @property {String} key
+ * A Metalsmith plugin to merge markdown partials into main markdown files.
+ *
+ * @module metalsmith-markdown-partials
+ */
+
+/**
+ * @typedef {Object} Options
+ * @property {String} libraryPath - Path to the markdown partials library (defaults to './src/content/md-library/')
+ * @property {String} fileSuffix - File suffix for markdown files (defaults to '.md')
  */
 
+// Define debug namespace at the top of the file
+const debugNs = 'metalsmith-markdown-partials';
+
 /** @type {Options} */
 const defaults = {
   libraryPath: './src/content/md-library/',
@@ -10,104 +20,120 @@ const defaults = {
 };
 
 /**
- * Normalize plugin options
- * @param {Options} [options]
- * @returns {Object}
+ * Normalize plugin options by merging with defaults
+ * @param {Options} [options] - User provided options
+ * @returns {Options} Normalized options
  */
-function normalizeOptions( options ) {
-  return Object.assign( {}, defaults, options || {} );
+function normalizeOptions(options) {
+  return Object.assign({}, defaults, options || {});
 }
 
 /**
- * getMarkdownIncludes
- * Get include markdown markers and replacements
+ * Extract markdown partials from files and prepare them for insertion
  *
- * @param  {[Object]} files - the metalsmith file object
- * @param {Options}  options
- * 
- * @return {[Array]}  Array with all markdown include objects
+ * @param {Object} files - The metalsmith file object
+ * @param {Options} options - Plugin options
+ * @param {Function} debug - Debug function
+ * @returns {Array} Array with all markdown include objects
  */
-function getMarkdownIncludes( files, options ) {
+function getMarkdownIncludes(files, options, debug) {
   const markdownIncludes = [];
 
-  // get the library name 
-  const libraryPath = options.libraryPath.slice( 0, -1 ).split( "/" );
-  const libraryName = libraryPath[ libraryPath.length - 1 ];
+  // Extract the library name from the path
+  const libraryPath = options.libraryPath.slice(0, -1).split('/');
+  const libraryName = libraryPath[libraryPath.length - 1];
+  debug('Processing markdown files with libraryName: %s', libraryName);
+
+  // Regex for matching include markers
+  const markerRegex = /\{#md\s*".+?"\s*#\}/g;
+  const markerStart = '{#md';
+  const markerEnd = '#}';
 
-  Object.keys( files ).forEach( function ( file ) {
+  // Set to track already processed partials to prevent duplicates
+  const processedPartials = new Set();
+  Object.keys(files).forEach(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
+     * 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
-          } );
+    if (file.endsWith(options.fileSuffix) && !file.startsWith(libraryName)) {
+      const str = files[file].contents.toString();
 
-        }
+      // Check if markers are present
+      const matches = str.match(markerRegex);
+      if (!matches) {
+        return;
       }
+      debug('Found %d markdown partials in %s', matches.length, file);
+
+      // Process each marker in the file
+      matches.forEach(marker => {
+        // Extract the filename from the marker
+        const markerFileName = marker.replaceAll(' ', '').replace(`${markerStart}"`, '').replace(`"${markerEnd}`, '');
+        const partialKey = `${libraryName}/${markerFileName}`;
+
+        // Check if partial file exists
+        if (!files[partialKey]) {
+          debug('Warning: Partial file not found: %s', partialKey);
+          return;
+        }
+
+        // Skip if we've already processed this exact marker+file combination
+        const combinedKey = `${file}:${marker}`;
+        if (processedPartials.has(combinedKey)) {
+          return;
+        }
+        processedPartials.add(combinedKey);
+
+        // Get the replacement content
+        const replacementString = files[partialKey].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 ];
+  Object.keys(files).forEach(file => {
+    if (file.startsWith(libraryName)) {
+      delete files[file];
     }
-  } );
-
+  });
+  debug('Processed %d markdown includes', markdownIncludes.length);
   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]}
+ * @param {Object} files - The metalsmith file object
+ * @param {Array} markdownIncludes - Array with all markdown include objects
+ * @param {Function} debug - Debug function
+ * @return {void}
  */
-function resolveMarkdownIncludes( files, markdownIncludes ) {
+function resolveMarkdownIncludes(files, markdownIncludes, debug) {
   // replace all markers with their markdown replacements
-  markdownIncludes.forEach( function ( markdownInclude ) {
-
-    const fileData = files[ markdownInclude.file ];
+  markdownIncludes.forEach(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 );
+      fileData.contents = Buffer.from(contents.replace(markdownInclude.marker, markdownInclude.markerReplacement));
+      debug('Replaced marker in %s', markdownInclude.file);
+    } catch (e) {
+      debug('Error replacing marker in %s: %s', markdownInclude.file, e.message);
+      console.error(`Error replacing marker in ${markdownInclude.file}:`, e);
     }
-
-  } );
+  });
 }
 
 /**
@@ -116,25 +142,41 @@ function resolveMarkdownIncludes( files, markdownIncludes ) {
  * 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}
+ * @param {Options} [options] - Plugin options
+ * @returns {import('metalsmith').Plugin} Metalsmith plugin function
+ * @example
+ * // In your metalsmith build:
+ * .use(markdownPartials({
+ *   libraryPath: './src/content/md-partials/',
+ *   fileSuffix: '.md.njk'
+ * }))
  */
+function initMarkdownPartials(options) {
+  options = normalizeOptions(options);
+  return function markdownPartials(files, metalsmith, done) {
+    // Use metalsmith's debug method if available
+    const debug = metalsmith.debug ? metalsmith.debug(debugNs) : () => {};
+    debug('Running with options: %o', options);
+    try {
+      // Get all markdown includes
+      const markdownIncludes = getMarkdownIncludes(files, options, debug);
 
-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 );
+      // Replace include markers with their respective replacement
+      if (markdownIncludes.length) {
+        resolveMarkdownIncludes(files, markdownIncludes, debug);
+      }
+      setImmediate(done);
+    } catch (err) {
+      debug('Error processing markdown partials: %s', err.message);
+      setImmediate(() => done(err));
     }
-
   };
 }
 
-export default initMarkdownPartials;
+// CommonJS export compatibility
+if (typeof module !== 'undefined') {
+  module.exports = initMarkdownPartials;
+}
+
+export { initMarkdownPartials as default };
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/index.js"],"sourcesContent":["/**\n * A Metalsmith plugin to merge markdown partials into main markdown files.\n *\n * @module metalsmith-markdown-partials\n */\n\n/**\n * @typedef {Object} Options\n * @property {String} libraryPath - Path to the markdown partials library (defaults to './src/content/md-library/')\n * @property {String} fileSuffix - File suffix for markdown files (defaults to '.md')\n */\n\n// Define debug namespace at the top of the file\nconst debugNs = 'metalsmith-markdown-partials';\n\n/** @type {Options} */\nconst defaults = {\n  libraryPath: './src/content/md-library/',\n  fileSuffix: '.md'\n};\n\n/**\n * Normalize plugin options by merging with defaults\n * @param {Options} [options] - User provided options\n * @returns {Options} Normalized options\n */\nfunction normalizeOptions(options) {\n  return Object.assign({}, defaults, options || {});\n}\n\n/**\n * Extract markdown partials from files and prepare them for insertion\n *\n * @param {Object} files - The metalsmith file object\n * @param {Options} options - Plugin options\n * @param {Function} debug - Debug function\n * @returns {Array} Array with all markdown include objects\n */\nfunction getMarkdownIncludes(files, options, debug) {\n  const markdownIncludes = [];\n\n  // Extract the library name from the path\n  const libraryPath = options.libraryPath.slice(0, -1).split('/');\n  const libraryName = libraryPath[libraryPath.length - 1];\n\n  debug('Processing markdown files with libraryName: %s', libraryName);\n\n  // Regex for matching include markers\n  const markerRegex = /\\{#md\\s*\".+?\"\\s*#\\}/g;\n  const markerStart = '{#md';\n  const markerEnd = '#}';\n\n  // Set to track already processed partials to prevent duplicates\n  const processedPartials = new Set();\n\n  Object.keys(files).forEach((file) => {\n    /*\n     * checks if string 'file' ends with options.fileSuffix\n     * when metalsmith-in-place or metalsmith-layouts are used\n     * the suffix depends on what templating language is used\n     * for example with Nunjucks it would be .md.njk\n     *\n     * Also check that file does NOT start with libraryName as\n     * the markdown partials library is also located in the content folder\n     */\n    if (file.endsWith(options.fileSuffix) && !file.startsWith(libraryName)) {\n      const str = files[file].contents.toString();\n\n      // Check if markers are present\n      const matches = str.match(markerRegex);\n      if (!matches) {return;}\n\n      debug('Found %d markdown partials in %s', matches.length, file);\n\n      // Process each marker in the file\n      matches.forEach((marker) => {\n        // Extract the filename from the marker\n        const markerFileName = marker.replaceAll(' ', '').replace(`${markerStart}\"`, '').replace(`\"${markerEnd}`, '');\n        const partialKey = `${libraryName}/${markerFileName}`;\n\n        // Check if partial file exists\n        if (!files[partialKey]) {\n          debug('Warning: Partial file not found: %s', partialKey);\n          return;\n        }\n\n        // Skip if we've already processed this exact marker+file combination\n        const combinedKey = `${file}:${marker}`;\n        if (processedPartials.has(combinedKey)) {return;}\n\n        processedPartials.add(combinedKey);\n\n        // Get the replacement content\n        const replacementString = files[partialKey].contents.toString();\n\n        markdownIncludes.push({\n          marker,\n          markerReplacement: replacementString,\n          file\n        });\n      });\n    }\n  });\n\n  // Remove markdown-partials from metalsmith build process\n  Object.keys(files).forEach((file) => {\n    if (file.startsWith(libraryName)) {\n      delete files[file];\n    }\n  });\n\n  debug('Processed %d markdown includes', markdownIncludes.length);\n  return markdownIncludes;\n}\n\n/**\n * Replace markers with their markdown replacement strings\n *\n * @param {Object} files - The metalsmith file object\n * @param {Array} markdownIncludes - Array with all markdown include objects\n * @param {Function} debug - Debug function\n * @return {void}\n */\nfunction resolveMarkdownIncludes(files, markdownIncludes, debug) {\n  // replace all markers with their markdown replacements\n  markdownIncludes.forEach((markdownInclude) => {\n    const fileData = files[markdownInclude.file];\n\n    // replace the include marker with the actual include file content\n    try {\n      const contents = fileData.contents.toString();\n      fileData.contents = Buffer.from(contents.replace(markdownInclude.marker, markdownInclude.markerReplacement));\n      debug('Replaced marker in %s', markdownInclude.file);\n    } catch (e) {\n      debug('Error replacing marker in %s: %s', markdownInclude.file, e.message);\n      console.error(`Error replacing marker in ${markdownInclude.file}:`, e);\n    }\n  });\n}\n\n/**\n * A Metalsmith plugin to merge markdown partials into main markdown file\n *\n * A marker of the form {#md \"<file name>.md\" #} indicates where the partial\n * must be inserted and also provides the file name of the replacement markdown.\n *\n * @param {Options} [options] - Plugin options\n * @returns {import('metalsmith').Plugin} Metalsmith plugin function\n * @example\n * // In your metalsmith build:\n * .use(markdownPartials({\n *   libraryPath: './src/content/md-partials/',\n *   fileSuffix: '.md.njk'\n * }))\n */\nfunction initMarkdownPartials(options) {\n  options = normalizeOptions(options);\n\n  return function markdownPartials(files, metalsmith, done) {\n    // Use metalsmith's debug method if available\n    const debug = metalsmith.debug ? metalsmith.debug(debugNs) : () => {};\n    debug('Running with options: %o', options);\n\n    try {\n      // Get all markdown includes\n      const markdownIncludes = getMarkdownIncludes(files, options, debug);\n\n      // Replace include markers with their respective replacement\n      if (markdownIncludes.length) {\n        resolveMarkdownIncludes(files, markdownIncludes, debug);\n      }\n\n      setImmediate(done);\n    } catch (err) {\n      debug('Error processing markdown partials: %s', err.message);\n      setImmediate(() => done(err));\n    }\n  };\n}\n\n// ESM export\nexport default initMarkdownPartials;\n\n// CommonJS export compatibility\nif (typeof module !== 'undefined') {\n  module.exports = initMarkdownPartials;\n}\n"],"names":["debugNs","defaults","libraryPath","fileSuffix","normalizeOptions","options","Object","assign","getMarkdownIncludes","files","debug","markdownIncludes","slice","split","libraryName","length","markerRegex","markerStart","markerEnd","processedPartials","Set","keys","forEach","file","endsWith","startsWith","str","contents","toString","matches","match","marker","markerFileName","replaceAll","replace","partialKey","combinedKey","has","add","replacementString","push","markerReplacement","resolveMarkdownIncludes","markdownInclude","fileData","Buffer","from","e","message","console","error","initMarkdownPartials","markdownPartials","metalsmith","done","setImmediate","err","module","exports"],"mappings":"AAAA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAEA;AACA,MAAMA,OAAO,GAAG,8BAA8B,CAAA;;AAE9C;AACA,MAAMC,QAAQ,GAAG;AACfC,EAAAA,WAAW,EAAE,2BAA2B;AACxCC,EAAAA,UAAU,EAAE,KAAA;AACd,CAAC,CAAA;;AAED;AACA;AACA;AACA;AACA;AACA,SAASC,gBAAgBA,CAACC,OAAO,EAAE;AACjC,EAAA,OAAOC,MAAM,CAACC,MAAM,CAAC,EAAE,EAAEN,QAAQ,EAAEI,OAAO,IAAI,EAAE,CAAC,CAAA;AACnD,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASG,mBAAmBA,CAACC,KAAK,EAAEJ,OAAO,EAAEK,KAAK,EAAE;EAClD,MAAMC,gBAAgB,GAAG,EAAE,CAAA;;AAE3B;AACA,EAAA,MAAMT,WAAW,GAAGG,OAAO,CAACH,WAAW,CAACU,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAACC,KAAK,CAAC,GAAG,CAAC,CAAA;EAC/D,MAAMC,WAAW,GAAGZ,WAAW,CAACA,WAAW,CAACa,MAAM,GAAG,CAAC,CAAC,CAAA;AAEvDL,EAAAA,KAAK,CAAC,gDAAgD,EAAEI,WAAW,CAAC,CAAA;;AAEpE;EACA,MAAME,WAAW,GAAG,sBAAsB,CAAA;EAC1C,MAAMC,WAAW,GAAG,MAAM,CAAA;EAC1B,MAAMC,SAAS,GAAG,IAAI,CAAA;;AAEtB;AACA,EAAA,MAAMC,iBAAiB,GAAG,IAAIC,GAAG,EAAE,CAAA;EAEnCd,MAAM,CAACe,IAAI,CAACZ,KAAK,CAAC,CAACa,OAAO,CAAEC,IAAI,IAAK;AACnC;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACI,IAAA,IAAIA,IAAI,CAACC,QAAQ,CAACnB,OAAO,CAACF,UAAU,CAAC,IAAI,CAACoB,IAAI,CAACE,UAAU,CAACX,WAAW,CAAC,EAAE;MACtE,MAAMY,GAAG,GAAGjB,KAAK,CAACc,IAAI,CAAC,CAACI,QAAQ,CAACC,QAAQ,EAAE,CAAA;;AAE3C;AACA,MAAA,MAAMC,OAAO,GAAGH,GAAG,CAACI,KAAK,CAACd,WAAW,CAAC,CAAA;MACtC,IAAI,CAACa,OAAO,EAAE;AAAC,QAAA,OAAA;AAAO,OAAA;MAEtBnB,KAAK,CAAC,kCAAkC,EAAEmB,OAAO,CAACd,MAAM,EAAEQ,IAAI,CAAC,CAAA;;AAE/D;AACAM,MAAAA,OAAO,CAACP,OAAO,CAAES,MAAM,IAAK;AAC1B;QACA,MAAMC,cAAc,GAAGD,MAAM,CAACE,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAACC,OAAO,CAAC,CAAGjB,EAAAA,WAAW,CAAG,CAAA,CAAA,EAAE,EAAE,CAAC,CAACiB,OAAO,CAAC,CAAA,CAAA,EAAIhB,SAAS,CAAA,CAAE,EAAE,EAAE,CAAC,CAAA;AAC7G,QAAA,MAAMiB,UAAU,GAAG,CAAA,EAAGrB,WAAW,CAAA,CAAA,EAAIkB,cAAc,CAAE,CAAA,CAAA;;AAErD;AACA,QAAA,IAAI,CAACvB,KAAK,CAAC0B,UAAU,CAAC,EAAE;AACtBzB,UAAAA,KAAK,CAAC,qCAAqC,EAAEyB,UAAU,CAAC,CAAA;AACxD,UAAA,OAAA;AACF,SAAA;;AAEA;AACA,QAAA,MAAMC,WAAW,GAAG,CAAA,EAAGb,IAAI,CAAA,CAAA,EAAIQ,MAAM,CAAE,CAAA,CAAA;AACvC,QAAA,IAAIZ,iBAAiB,CAACkB,GAAG,CAACD,WAAW,CAAC,EAAE;AAAC,UAAA,OAAA;AAAO,SAAA;AAEhDjB,QAAAA,iBAAiB,CAACmB,GAAG,CAACF,WAAW,CAAC,CAAA;;AAElC;QACA,MAAMG,iBAAiB,GAAG9B,KAAK,CAAC0B,UAAU,CAAC,CAACR,QAAQ,CAACC,QAAQ,EAAE,CAAA;QAE/DjB,gBAAgB,CAAC6B,IAAI,CAAC;UACpBT,MAAM;AACNU,UAAAA,iBAAiB,EAAEF,iBAAiB;AACpChB,UAAAA,IAAAA;AACF,SAAC,CAAC,CAAA;AACJ,OAAC,CAAC,CAAA;AACJ,KAAA;AACF,GAAC,CAAC,CAAA;;AAEF;EACAjB,MAAM,CAACe,IAAI,CAACZ,KAAK,CAAC,CAACa,OAAO,CAAEC,IAAI,IAAK;AACnC,IAAA,IAAIA,IAAI,CAACE,UAAU,CAACX,WAAW,CAAC,EAAE;MAChC,OAAOL,KAAK,CAACc,IAAI,CAAC,CAAA;AACpB,KAAA;AACF,GAAC,CAAC,CAAA;AAEFb,EAAAA,KAAK,CAAC,gCAAgC,EAAEC,gBAAgB,CAACI,MAAM,CAAC,CAAA;AAChE,EAAA,OAAOJ,gBAAgB,CAAA;AACzB,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS+B,uBAAuBA,CAACjC,KAAK,EAAEE,gBAAgB,EAAED,KAAK,EAAE;AAC/D;AACAC,EAAAA,gBAAgB,CAACW,OAAO,CAAEqB,eAAe,IAAK;AAC5C,IAAA,MAAMC,QAAQ,GAAGnC,KAAK,CAACkC,eAAe,CAACpB,IAAI,CAAC,CAAA;;AAE5C;IACA,IAAI;MACF,MAAMI,QAAQ,GAAGiB,QAAQ,CAACjB,QAAQ,CAACC,QAAQ,EAAE,CAAA;AAC7CgB,MAAAA,QAAQ,CAACjB,QAAQ,GAAGkB,MAAM,CAACC,IAAI,CAACnB,QAAQ,CAACO,OAAO,CAACS,eAAe,CAACZ,MAAM,EAAEY,eAAe,CAACF,iBAAiB,CAAC,CAAC,CAAA;AAC5G/B,MAAAA,KAAK,CAAC,uBAAuB,EAAEiC,eAAe,CAACpB,IAAI,CAAC,CAAA;KACrD,CAAC,OAAOwB,CAAC,EAAE;MACVrC,KAAK,CAAC,kCAAkC,EAAEiC,eAAe,CAACpB,IAAI,EAAEwB,CAAC,CAACC,OAAO,CAAC,CAAA;MAC1EC,OAAO,CAACC,KAAK,CAAC,CAA6BP,0BAAAA,EAAAA,eAAe,CAACpB,IAAI,CAAA,CAAA,CAAG,EAAEwB,CAAC,CAAC,CAAA;AACxE,KAAA;AACF,GAAC,CAAC,CAAA;AACJ,CAAA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASI,oBAAoBA,CAAC9C,OAAO,EAAE;AACrCA,EAAAA,OAAO,GAAGD,gBAAgB,CAACC,OAAO,CAAC,CAAA;EAEnC,OAAO,SAAS+C,gBAAgBA,CAAC3C,KAAK,EAAE4C,UAAU,EAAEC,IAAI,EAAE;AACxD;AACA,IAAA,MAAM5C,KAAK,GAAG2C,UAAU,CAAC3C,KAAK,GAAG2C,UAAU,CAAC3C,KAAK,CAACV,OAAO,CAAC,GAAG,MAAM,EAAE,CAAA;AACrEU,IAAAA,KAAK,CAAC,0BAA0B,EAAEL,OAAO,CAAC,CAAA;IAE1C,IAAI;AACF;MACA,MAAMM,gBAAgB,GAAGH,mBAAmB,CAACC,KAAK,EAAEJ,OAAO,EAAEK,KAAK,CAAC,CAAA;;AAEnE;MACA,IAAIC,gBAAgB,CAACI,MAAM,EAAE;AAC3B2B,QAAAA,uBAAuB,CAACjC,KAAK,EAAEE,gBAAgB,EAAED,KAAK,CAAC,CAAA;AACzD,OAAA;MAEA6C,YAAY,CAACD,IAAI,CAAC,CAAA;KACnB,CAAC,OAAOE,GAAG,EAAE;AACZ9C,MAAAA,KAAK,CAAC,wCAAwC,EAAE8C,GAAG,CAACR,OAAO,CAAC,CAAA;AAC5DO,MAAAA,YAAY,CAAC,MAAMD,IAAI,CAACE,GAAG,CAAC,CAAC,CAAA;AAC/B,KAAA;GACD,CAAA;AACH,CAAA;;AAKA;AACA,IAAI,OAAOC,MAAM,KAAK,WAAW,EAAE;EACjCA,MAAM,CAACC,OAAO,GAAGP,oBAAoB,CAAA;AACvC;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "metalsmith-markdown-partials",
-  "version": "2.3.1",
-  "description": "A Metalsmith plugin that allows the use of partial markdowm files",
+  "version": "2.5.0",
+  "description": "A Metalsmith plugin that allows the use of partial markdown files",
   "keywords": [
     "metalsmith-plugin",
     "metalsmith",
@@ -9,12 +9,23 @@
     "markdown-partials",
     "static-site"
   ],
-  "main": "lib/index.js",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
+  "exports": {
+    "import": "./lib/index.js",
+    "require": "./lib/index.cjs",
+    "default": "./lib/index.js"
+  },
   "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wernerglinka/metalsmith-markdown-partials.git"
   },
+  "files": [
+    "lib",
+    "LICENSE.md",
+    "README.md"
+  ],
   "author": {
     "name": "Werner Glinka",
     "email": "werner@glinka.co"
@@ -24,35 +35,46 @@
     "url": "https://github.com/wernerglinka/metalsmith-markdown-partials/issues"
   },
   "homepage": "https://github.com/wernerglinka/metalsmith-markdown-partials#readme",
-  "dependencies": {
-    "debug": "^4.3.7"
+  "scripts": {
+    "build": "microbundle --entry src/index.js --output lib/index.js --target node -f esm,cjs --strict --generateTypes=false",
+    "changelog": "auto-changelog -u --commit-limit false --ignore-commit-pattern '^((dev|chore|ci):|Release)'",
+    "coverage": "npm test && c8 report --reporter=text-lcov > ./coverage.info",
+    "format": "prettier --write \"**/*.{yml,md,js,json}\"",
+    "format:check": "prettier --list-different \"**/*.{yml,md,js,json}\"",
+    "lint": "eslint --fix .",
+    "lint:check": "eslint --fix-dry-run .",
+    "prepublishOnly": "npm run build",
+    "update-coverage": "node scripts/update-coverage-badge.js",
+    "prerelease": "npm run update-coverage && git add README.md && git commit -m \"Update coverage badge in README\" || true",
+    "release": "npm run build && GITHUB_TOKEN=$(grep GITHUB_TOKEN .env | cut -d '=' -f2) ./node_modules/.bin/release-it . ",
+    "release:check": "npm run lint:check && npm run build && GITHUB_TOKEN=$(grep GITHUB_TOKEN .env | cut -d '=' -f2) ./node_modules/.bin/release-it . --dry-run",
+    "test": "c8 --include=src/**/*.js mocha 'test/index.js' 'test/cjs.test.cjs' -t 15000",
+    "test:esm": "c8 --include=src/**/*.js mocha test/index.js -t 15000",
+    "test:cjs": "c8 --include=src/**/*.js mocha test/cjs.test.cjs -t 15000",
+    "test:e2e": "serve -l 3000 test/fixtures",
+    "depcheck": "depcheck"
   },
   "devDependencies": {
     "auto-changelog": "^2.5.0",
-    "chai": "^5.1.2",
-    "coveralls": "^3.1.1",
-    "eslint": "^9.14.0",
-    "eslint-config-prettier": "^9.1.0",
+    "c8": "^10.1.3",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.5",
     "metalsmith": "^2.6.3",
-    "mocha": "^10.8.2",
-    "nyc": "^17.1.0",
-    "prettier": "^3.3.3",
-    "release-it": "^17.10.0"
+    "microbundle": "^0.15.1",
+    "mocha": "^11.2.2",
+    "prettier": "^3.5.3",
+    "release-it": "19.0.2"
   },
   "peerDependencies": {
     "metalsmith": "^2.5.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"
+    "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "depcheck": "^1.4.7"
   }
 }

package/.eslintcache

@@ -1 +0,0 @@
-[{"/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

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

package/.gitattributes

@@ -1,7 +0,0 @@
-# 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/181518ec-15ce-4116-8650-58fc4a5be71d.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/processinfo/181518ec-15ce-4116-8650-58fc4a5be71d.json

@@ -1 +0,0 @@
-{"parent":null,"pid":96565,"argv":["/Users/wernerglinka/.nvm/versions/node/v18.16.0/bin/node","/Users/wernerglinka/Documents/Projects/Metalsmith/>>>plugins/ms-markdown-partials/node_modules/.bin/mocha","./tests/index.js"],"execArgv":[],"cwd":"/Users/wernerglinka/Documents/Projects/Metalsmith/>>>plugins/ms-markdown-partials","time":1731375730889,"ppid":96562,"coverageFilename":"/Users/wernerglinka/Documents/Projects/Metalsmith/>>>plugins/ms-markdown-partials/.nyc_output/181518ec-15ce-4116-8650-58fc4a5be71d.json","externalId":"","uuid":"181518ec-15ce-4116-8650-58fc4a5be71d","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +0,0 @@
-{"processes":{"181518ec-15ce-4116-8650-58fc4a5be71d":{"parent":null,"children":[]}},"files":{},"externalIds":{}}

package/.prettierignore

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

package/.prettierrc.yml

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

package/.release-it.json

@@ -1,24 +0,0 @@
-{
-  "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

@@ -1,16 +0,0 @@
-### 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/tests/fixtures/build/markdown.md

@@ -1,11 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

@@ -1,9 +0,0 @@
-# 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

@@ -1,3 +0,0 @@
-## 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

@@ -1,42 +0,0 @@
-/* global describe, it */
-
-'use strict';
-
-import * as chai from 'chai';
-import metalsmith from 'metalsmith';
-import mdPartials from '../lib/index.js';
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'node:url';
-import { dirname } from 'node:path';
-
-/* eslint-disable no-underscore-dangle */
-const __dirname = dirname( fileURLToPath( import.meta.url ) );
-
-const { expect } = chai;
-
-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();
-      } );
-  } );
-} );