metalsmith-markdown-partials 2.2.0 → 2.3.1

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

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

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

@@ -0,0 +1 @@
+{"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 +1 @@
-{"processes":{"d6df1464-1710-492c-bd87-9bf64bde6d5d":{"parent":null,"children":[]}},"files":{"/Users/wernerglinka/Documents/Projects/Metalsmith/>>>plugins/ms-markdown-partials/lib/index.js":["d6df1464-1710-492c-bd87-9bf64bde6d5d"]},"externalIds":{}}
+{"processes":{"181518ec-15ce-4116-8650-58fc4a5be71d":{"parent":null,"children":[]}},"files":{},"externalIds":{}}

package/lib/index.js

@@ -14,8 +14,8 @@ const defaults = {
  * @param {Options} [options]
  * @returns {Object}
  */
- function normalizeOptions(options) {
-  return Object.assign({}, defaults, options || {});
+function normalizeOptions( options ) {
+  return Object.assign( {}, defaults, options || {} );
 }
 
 /**
@@ -27,62 +27,62 @@ const defaults = {
  * 
  * @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
-            });
- 
-          }
+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];
-      }
-    });
+  // Remove markdown-partials from metalsmith build process
+  Object.keys( files ).forEach( function ( file ) {
+    if ( file.startsWith( libraryName ) ) {
+      delete files[ file ];
+    }
+  } );
 
-    return markdownIncludes
+  return markdownIncludes;
 }
 
 /**
@@ -93,21 +93,21 @@ function getMarkdownIncludes(files, options) {
  * @param  {[Array]}  markdownIncludes with all markdown include objects
  * @return {[void]}
  */
-function resolveMarkdownIncludes(files, markdownIncludes) {
+function resolveMarkdownIncludes( files, markdownIncludes ) {
   // replace all markers with their markdown replacements
-  markdownIncludes.forEach(function(markdownInclude) {
+  markdownIncludes.forEach( function ( markdownInclude ) {
 
-    const fileData = files[markdownInclude.file];
+    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 ) );
+    } catch ( e ) {
+      console.error( e );
     }
 
-  });
+  } );
 }
 
 /**
@@ -120,21 +120,21 @@ function resolveMarkdownIncludes(files, markdownIncludes) {
  * @returns {import('metalsmith').Plugin}
  */
 
-function initMarkdownPartials(options) {
-  options = normalizeOptions(options);
+function initMarkdownPartials( options ) {
+  options = normalizeOptions( options );
 
-  return function markdownPartials(files, metalsmith, done) {
-    setImmediate(done);
+  return function markdownPartials( files, metalsmith, done ) {
+    setImmediate( done );
 
     // get all markdown includes
-    const markdownIncludes = getMarkdownIncludes(files, options);
+    const markdownIncludes = getMarkdownIncludes( files, options );
 
     // replace include markers with their respective replacement
-    if (markdownIncludes.length) {
-      resolveMarkdownIncludes(files, markdownIncludes);
+    if ( markdownIncludes.length ) {
+      resolveMarkdownIncludes( files, markdownIncludes );
     }
 
   };
 }
 
-module.exports = initMarkdownPartials;
+export default initMarkdownPartials;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "metalsmith-markdown-partials",
-  "version": "2.2.0",
+  "version": "2.3.1",
   "description": "A Metalsmith plugin that allows the use of partial markdowm files",
   "keywords": [
     "metalsmith-plugin",
@@ -10,6 +10,7 @@
     "static-site"
   ],
   "main": "lib/index.js",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wernerglinka/metalsmith-markdown-partials.git"
@@ -24,19 +25,19 @@
   },
   "homepage": "https://github.com/wernerglinka/metalsmith-markdown-partials#readme",
   "dependencies": {
-    "debug": "^4.3.4"
+    "debug": "^4.3.7"
   },
   "devDependencies": {
-    "auto-changelog": "^2.4.0",
-    "chai": "^4.3.7",
+    "auto-changelog": "^2.5.0",
+    "chai": "^5.1.2",
     "coveralls": "^3.1.1",
-    "eslint": "^8.41.0",
-    "eslint-config-prettier": "^8.8.0",
-    "metalsmith": "^2.6.0",
-    "mocha": "^10.2.0",
-    "nyc": "^15.1.0",
-    "prettier": "^2.8.8",
-    "release-it": "^15.10.5"
+    "eslint": "^9.14.0",
+    "eslint-config-prettier": "^9.1.0",
+    "metalsmith": "^2.6.3",
+    "mocha": "^10.8.2",
+    "nyc": "^17.1.0",
+    "prettier": "^3.3.3",
+    "release-it": "^17.10.0"
   },
   "peerDependencies": {
     "metalsmith": "^2.5.1"

package/tests/index.js

@@ -2,35 +2,41 @@
 
 '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;
+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';
 
-const fixture = path.resolve.bind(path, __dirname, 'fixtures');
+/* eslint-disable no-underscore-dangle */
+const __dirname = dirname( fileURLToPath( import.meta.url ) );
 
-function file(_path) {
-  return fs.readFileSync(fixture(_path), 'utf8');
+const { expect } = chai;
+
+const fixture = path.resolve.bind( path, __dirname, 'fixtures' );
+
+function file( _path ) {
+  return fs.readFileSync( fixture( _path ), 'utf8' );
 }
 
-describe('metalsmith-markdown-partials', () => {
+describe( 'metalsmith-markdown-partials', () => {
 
-  it('should replace marker with markdown partial', done => {
+  it( 'should replace marker with markdown partial', done => {
 
-    metalsmith(fixture())
-      .use(mdPartials({
-          libraryPath: path.join(fixture(), `/src/md-partials/`),
-          fileSuffix: '.md',
-        }))
+    metalsmith( fixture() )
+      .use( mdPartials( {
+        libraryPath: path.join( fixture(), `/src/md-partials/` ),
+        fileSuffix: '.md',
+      } ) )
       .build( err => {
-        if (err) {
-          return done(err);
+        if ( err ) {
+          return done( err );
         }
-        expect(file('build/markdown.md')).to.be.eql(file('expected/final-markdown.md'));
-        
+        expect( file( 'build/markdown.md' ) ).to.be.eql( file( 'expected/final-markdown.md' ) );
+
         done();
-      });
-  });
-});
+      } );
+  } );
+} );

package/.nyc_output/d6df1464-1710-492c-bd87-9bf64bde6d5d.json

@@ -1 +0,0 @@
-{"/Users/wernerglinka/Documents/Projects/Metalsmith/>>>plugins/ms-markdown-partials/lib/index.js":{"path":"/Users/wernerglinka/Documents/Projects/Metalsmith/>>>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":"d30875f7d9fd9a483e52f4e94bf0a91003da47ff","contentHash":"87380a6c441133d03a472090227144e67609864995ff212e4601aab62ea569dd"}}

package/.nyc_output/processinfo/d6df1464-1710-492c-bd87-9bf64bde6d5d.json

@@ -1 +0,0 @@
-{"parent":null,"pid":22552,"argv":["/Users/wernerglinka/.nvm/versions/node/v16.17.1/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":1685729137316,"ppid":22550,"coverageFilename":"/Users/wernerglinka/Documents/Projects/Metalsmith/>>>plugins/ms-markdown-partials/.nyc_output/d6df1464-1710-492c-bd87-9bf64bde6d5d.json","externalId":"","uuid":"d6df1464-1710-492c-bd87-9bf64bde6d5d","files":["/Users/wernerglinka/Documents/Projects/Metalsmith/>>>plugins/ms-markdown-partials/lib/index.js"]}