metalsmith-markdown-partials 2.4.0 → 2.5.1

package/README.md

@@ -7,9 +7,15 @@ A Metalsmith plugin that enables the use of Markdown partials.
 [![license: MIT][license-badge]][license-url]
 [![coverage][coverage-badge]][coverage-url]
 [![ESM/CommonJS][modules-badge]][npm-url]
+[![Known Vulnerabilities](https://snyk.io/test/npm/metalsmith-markdown-partials/badge.svg)](https://snyk.io/test/npm/metalsmith-markdown-partials)
 
 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.
 
+## Features
+- This plugin supports both ESM and CommonJS environments with no configuration needed:
+  - ESM: `import mdPartials from 'metalsmith-markdown-partials'`
+  - CommonJS: `const mdPartials = require('metalsmith-markdown-partials')`
+
 ## Installation
 
 ```js
@@ -19,9 +25,6 @@ $ npm install --save metalsmith-markdown-partials
 ## Usage
 
 ```js
-var mdPartials = require('metalsmith-markdown-partials');
-
-...
 .use(mdPartials({
     libraryPath: './markdown-partials/',
     fileSuffix: '.md.njk',
@@ -155,22 +158,13 @@ To use this plugin with the Metalsmith CLI, add `metalsmith-markdown-partials` t
 }
 ```
 
-## Author
-
-- [werner@glinka.co](https://github.com/wernerglinka)
-
 ## 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.
 
-Coverage report (from latest test run):
-
-File      | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
-----------|---------|----------|---------|---------|-------------------
-All files | 94.11 | 79.16 | 100 | 94.11 |
- index.js | 94.11 | 79.16 | 100 | 94.11 | 83-85,135-137,175-177,186-187
-
+## Author
 
+[werner@glinka.co](https://github.com/wernerglinka)
 
 ## License
 
@@ -182,6 +176,6 @@ Code released under [the MIT license](https://github.com/wernerglinka/metalsmith
 [metalsmith-url]: https://metalsmith.io
 [license-badge]: https://img.shields.io/github/license/wernerglinka/metalsmith-markdown-partials
 [license-url]: LICENSE
-[coverage-badge]: https://img.shields.io/badge/coverage-94%25-brightgreen
+[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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "metalsmith-markdown-partials",
-  "version": "2.4.0",
-  "description": "A Metalsmith plugin that allows the use of partial markdowm files",
+  "version": "2.5.1",
+  "description": "A Metalsmith plugin that allows the use of partial markdown files",
   "keywords": [
     "metalsmith-plugin",
     "metalsmith",
@@ -13,13 +13,20 @@
   "module": "./lib/index.js",
   "exports": {
     "import": "./lib/index.js",
-    "require": "./lib/index.cjs"
+    "require": "./lib/index.cjs",
+    "default": "./lib/index.js"
   },
   "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wernerglinka/metalsmith-markdown-partials.git"
   },
+  "files": [
+    "src",
+    "lib",
+    "LICENSE",
+    "README.md"
+  ],
   "author": {
     "name": "Werner Glinka",
     "email": "werner@glinka.co"
@@ -32,16 +39,16 @@
   "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",
+    "coverage": "c8 --include=src/**/*.js --reporter=lcov --reporter=text-summary mocha 'test/index.js' 'test/cjs.test.cjs' -t 15000",
     "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",
+    "release:patch": "release-it patch",
+    "release:minor": "release-it minor",
+    "release:major": "release-it major",
+    "release:check": "npm run lint:check && npm run build && 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",
@@ -51,21 +58,24 @@
   "devDependencies": {
     "auto-changelog": "^2.5.0",
     "c8": "^10.1.3",
-    "eslint": "^9.14.0",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint": "^9.32.0",
+    "eslint-config-prettier": "^10.1.8",
     "metalsmith": "^2.6.3",
     "microbundle": "^0.15.1",
-    "mocha": "^10.8.2",
-    "prettier": "^3.3.3",
-    "release-it": "^17.10.0"
+    "mocha": "^11.7.1",
+    "prettier": "^3.6.2",
+    "release-it": "19.0.4"
   },
   "peerDependencies": {
     "metalsmith": "^2.5.1"
   },
   "engines": {
-    "node": ">=8"
+    "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "depcheck": "^1.4.7"
   }
 }

package/.c8rc.json

@@ -1,13 +0,0 @@
-{
-  "all": true,
-  "include": ["src/**/*.js"],
-  "exclude": ["node_modules/**", "test/**", "lib/**"],
-  "reporter": ["text", "lcov"],
-  "report-dir": "./coverage",
-  "watermarks": {
-    "lines": [80, 95],
-    "functions": [80, 95],
-    "branches": [80, 95],
-    "statements": [80, 95]
-  }
-}

package/.env

@@ -1 +0,0 @@
-GITHUB_TOKEN=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

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/.nvmrc

@@ -1 +0,0 @@
-20.12.1

package/.prettierignore

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

package/.release-it.json

@@ -1,22 +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 && ls *.tgz",
-    "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 -t https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs"
-  },
-  "npm": { "publish": false },
-  "github": {
-    "release": true,
-    "releaseName": "metalsmith-markdown-partials ${version}",
-    "tokenRef": "GITHUB_TOKEN",
-    "assets": ["metalsmith-markdown-partials-${version}.tgz"]
-  }
-}

package/CHANGELOG.md

@@ -1,83 +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).
-
-#### [v2.4.0](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.3.1...v2.4.0)
-
-- feat: add dual ESM/CJS module support [`84b61d3`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/84b61d39b4d01f01066ac98719ffa15959254166)
-- updated dependencies [`07a2658`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/07a2658c276ed31c5630e30dd2924b96f2267e44)
-- updated to ms2.6 [`27a9944`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/27a9944d46388f558146eac1dcceb6a198cf1c68)
-- updated packages, ms to 2.5.0 [`c8ab04f`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/c8ab04f15994cbf243fc4e1deaf63515d6b86a34)
-- converted plugin to es6 [`b9a7573`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/b9a75738fa4c381b033016b435058d621289b551)
-- updated dependencies [`dec7b1b`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/dec7b1bdfcebc1dabf4102fc39d75a4ba9e87792)
-- Update coverage badge in README [`c375bdb`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/c375bdbbe899cbac465dddf19f6aaff949bcddb9)
-- Bump package.json to 2.3.1 [`dde7e7a`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/dde7e7a6d65489201412638385774e4c844137bc)
-- Bump package.json to 2.3.0 [`1623204`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/1623204d7b21bda03b774bdce9d480686786d7ac)
-- Bump package.json to 2.2.0 [`297b94d`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/297b94d7055b0168bc08dad2f183ce70e77acf16)
-- Bump package.json to 2.1.1 [`a7bf8a7`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/a7bf8a7fe34a6f2e20ab1bd393b4a1b59b21dd7d)
-- Bump package.json to 2.1.0 [`14d0fc7`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/14d0fc7d31333644c2b2bde7209eb8aa8a592ecf)
-
-#### [v2.3.1](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.3.0...v2.3.1)
-
-> 11 November 2024
-
-- updated dependencies [`7fc7b23`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/7fc7b233da4d6fb3a24584349a144f0a7b88f3db)
-- Bump package.json to 2.3.1 [`eaadf39`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/eaadf391660aa1cc99697c8ecc25d1ea310358ea)
-
-#### [v2.3.0](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.2.0...v2.3.0)
-
-> 31 January 2024
-
-- converted plugin to es6 [`f14e341`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/f14e341185f76bcc1a4954abf2f1d84931623799)
-- Bump package.json to 2.3.0 [`f419a58`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/f419a58a79fbda033756f7127b44597c27b0aa4e)
-
-#### [v2.2.0](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.1.1...v2.2.0)
-
-> 2 June 2023
-
-- updated to ms2.6 [`4f52254`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/4f52254fc276df1def382ae5981e137f260c108a)
-- Bump package.json to 2.2.0 [`2ab528c`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/2ab528cefca34187a6accc11f146ac0ad8ce7686)
-
-#### [v2.1.1](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.1.0...v2.1.1)
-
-> 18 October 2022
-
-- updated dependencies [`a8a94d1`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/a8a94d124e017ace3aebdb0f900d252713f79f12)
-- Bump package.json to 2.1.1 [`e313840`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/e313840d40cf148fe5a63a79f658e85de70c4186)
-
-#### [v2.1.0](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.0.2...v2.1.0)
-
-> 24 September 2022
-
-- updated packages, ms to 2.5.0 [`6bcffce`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/6bcffcee79a9535ad638cac873b1559e102c1d60)
-- Bump package.json to 2.1.0 [`e2e0691`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/e2e0691345181406e50e4041a15f7f192b5ec0d2)
-- Bump package.json to 2.0.4 [`1252474`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/125247419f2dac902c9af2bd0b06c3164bb02c35)
-- Bump package.json to 2.0.3 [`7a9de6a`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/7a9de6a33828819988b14da0f65378fab5aafea9)
-
-#### [v2.0.2](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.0.1...v2.0.2)
-
-> 3 February 2022
-
-- updated readme file [`c3998e9`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/c3998e9d5dc8ccb3cbd0bdd6114c43bdae5f212a)
-
-#### [v2.0.1](https://github.com/wernerglinka/metalsmith-markdown-partials/compare/v2.0.0...v2.0.1)
-
-> 3 February 2022
-
-- refactored plugin code, moved library into content folder [`124154d`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/124154da94875adf561987dd890451d0d5f70183)
-
-#### v2.0.0
-
-> 1 February 2022
-
-- added various config files [`1be389c`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/1be389cb9aedf82405c08c79cdfa866e7d3560d9)
-- updated readme [`d037ed5`](https://github.com/wernerglinka/metalsmith-markdown-partials/commit/d037ed5a42f0743f28e37bc07c0a52393ad53028)
-- 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)