mdat 3.1.0 → 3.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "3.1.0",
+  "version": "3.2.1",
   "description": "CLI tool and TypeScript library implementing the Markdown Autophagic Template (MDAT) system. MDAT lets you use comments as dynamic content templates in Markdown files, making it easy to generate and update readme boilerplate.",
   "keywords": [
     "mdat",
@@ -43,51 +43,51 @@
     "dist/*"
   ],
   "dependencies": {
-    "@clack/prompts": "^1.7.0",
-    "cosmiconfig": "^10.0.0",
+    "@clack/prompts": "^1.8.1",
+    "cosmiconfig": "^10.0.1",
     "cosmiconfig-typescript-loader": "^6.3.0",
-    "deepmerge-ts": "^7.1.5",
-    "globby": "^16.2.2",
-    "lognow": "^0.8.0",
+    "deepmerge-ts": "^8.0.2",
+    "globby": "^16.2.4",
+    "lognow": "^0.8.2",
     "mdast-util-toc": "^7.1.0",
-    "metascope": "^0.10.0",
+    "metascope": "^0.12.0",
     "path-type": "^6.0.0",
     "picocolors": "^1.1.1",
     "plur": "^6.0.0",
-    "pretty-bytes": "^7.1.1",
-    "pretty-ms": "^9.3.0",
+    "pretty-bytes": "^7.1.3",
+    "pretty-ms": "^9.3.1",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "remark-mdat": "^3.0.1",
+    "remark-mdat": "^3.0.2",
     "to-vfile": "^8.0.0",
-    "type-fest": "^5.8.0",
+    "type-fest": "^5.9.0",
     "unified-engine": "^11.2.2",
     "untildify": "^6.0.0",
     "vfile": "^6.0.3",
     "yargs": "^18.1.0",
-    "zod": "^4.4.3"
+    "zod": "^4.6.5"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.5",
-    "@kitschpatrol/shared-config": "^8.6.0",
+    "@kitschpatrol/shared-config": "^8.8.0",
     "@types/mdast": "^4.0.4",
-    "@types/node": "~24.13.3",
+    "@types/node": "~24.13.4",
     "@types/unist": "^3.0.3",
     "@types/yargs": "^17.0.35",
-    "@vitest/coverage-v8": "^4.1.10",
-    "bumpp": "^12.1.1",
+    "@vitest/coverage-v8": "^5.0.1",
+    "bumpp": "^12.3.0",
     "execa": "^10.0.1",
-    "mdat-plugin-cli-help": "^3.1.0",
+    "mdat-plugin-cli-help": "^3.2.0",
     "mdat-plugin-example": "^3.0.0",
     "mdat-plugin-tldraw": "^3.0.0",
     "nanoid": "^6.0.1",
     "prettier": "^3.9.6",
-    "publint": "^0.3.22",
+    "publint": "^0.3.24",
     "shx": "^0.4.0",
-    "tsdown": "^0.22.14",
+    "tsdown": "^0.23.0",
     "typescript": "~6.0.3",
-    "unplugin-raw": "^0.7.0",
-    "vitest": "^4.1.10"
+    "unplugin-raw": "^0.8.0",
+    "vitest": "^5.0.1"
   },
   "peerDependencies": {
     "prettier": "^3.0.0"
@@ -101,14 +101,14 @@
     "node": ">=24.16.0"
   },
   "scripts": {
-    "bench": "vitest bench --run --compare test/benchmarks/baseline.json",
-    "bench:baseline": "vitest bench --run --outputJson test/benchmarks/baseline.json",
+    "bench": "vitest bench --run --reporter=default",
+    "bench:baseline": "vitest bench --run --reporter=default",
     "build": "tsdown",
-    "clean": "shx rm -f pnpm-lock.yaml && git clean -fdX -e !.claude/",
+    "clean-deep": "shx rm -f pnpm-lock.yaml && git clean -fdX -e !.claude/",
     "coverage": "vitest --coverage --run",
     "fix": "ksc fix",
     "lint": "ksc lint",
-    "release": "bumpp --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') pnpm publish",
+    "release": "bumpp --commit 'Release: %s' && pnpm build && pnpm publish --otp $(op item get npm --otp)",
     "test": "vitest run"
   }
 }

package/readme.md

@@ -4,11 +4,19 @@
 
 <!-- /title -->
 
-<!-- badges -->
+<!-- badges({
+  custom: {
+    "Bundle Size": {
+      image: "https://img.shields.io/bundlephobia/minzip/mdat?label=Size",
+      link: "https://bundlephobia.com/package/mdat",
+    },
+  }
+}) -->
 
 [![NPM Package mdat](https://img.shields.io/npm/v/mdat.svg)](https://www.npmjs.com/package/mdat)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit)
 [![CI](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml/badge.svg)](https://github.com/kitschpatrol/mdat/actions/workflows/ci.yml)
+[![Bundle Size](https://img.shields.io/bundlephobia/minzip/mdat?label=Size)](https://bundlephobia.com/package/mdat)
 
 <!-- /badges -->
 
@@ -441,7 +449,7 @@ Removes expanded content, leaving only the opening comment placeholders. Same si
 
 Strips all MDAT comment tags (both opening and closing) while preserving expanded content between them. Same signatures as `expand` / `expandString` (without the `config` parameter, since rules are not needed).
 
-This is useful for producing a "clean" Markdown file that no longer depends on MDAT for future updates.
+This is useful for producing a "clean" Markdown file that doesn't need future content updates via MDAT.
 
 #### `check` / `checkString`
 
@@ -604,13 +612,13 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
 - ##### `<!-- size-table({ files: [".gitignore", "license.txt"] }) -->`
 
-  A table of files and their compressed sizes:
+  A table of files and their compressed sizes. The optional `precision` sets the maximum number of decimal places and defaults to `0`:
 
   <!-- size-table({ files: [".gitignore", "license.txt"] }) -->
 
   | File        | Original | Gzip  | Brotli |
   | ----------- | -------- | ----- | ------ |
-  | .gitignore  | 318 B    | 252 B | 237 B  |
+  | .gitignore  | 327 B    | 257 B | 237 B  |
   | license.txt | 1 kB     | 659 B | 468 B  |
 
   <!-- /size-table -->
@@ -709,7 +717,7 @@ Example: `<!-- tldraw({ src: "./sketch.tldr" }) -->`
 
 #### [mdat-plugin-cli-help](https://github.com/kitschpatrol/mdat-plugin-cli-help)
 
-Transform a CLI command's `--help` output into Markdown tables. Recursively calls `--help` on subcommands. Currently parses [Yargs](https://yargs.js.org) and [Meow](https://github.com/sindresorhus/meow) output formats, falling back to a plain text code block as necessary.
+Transform a CLI command's `--help` output into Markdown tables. Recursively calls `--help` on subcommands. Currently parses [Yargs](https://yargs.js.org), [Meow](https://github.com/sindresorhus/meow), and [Commander](https://github.com/tj/commander.js) help output formats, falling back to a plain text code block as necessary.
 
 Example: `<!-- cli-help -->`
 
@@ -796,7 +804,7 @@ There's quite a bit of prior art and similar explorations of this problem space:
 - lillallol's [md-in-place](https://www.npmjs.com/package/md-in-place)
 
 - [AutoMD](https://automd.unjs.io/)\
-  Extremely similar functionality to mdat. The project was initiated around the same time as MDAT, but I didn't find the project until a few years later. Ships in the night.
+  Extremely similar functionality to mdat. The project was initiated around the same time as MDAT, but I didn't find the project until a few years later. Ships passing in the night.
 
 - Franck Abgrall's [readme-md-generator](https://github.com/kefranabg/readme-md-generator)
 
@@ -806,12 +814,15 @@ There's quite a bit of prior art and similar explorations of this problem space:
 
 - Hiroki Osame's [comment-mark](https://github.com/privatenumber/comment-mark)
 
-- Hiroki Osame's [mdeval](https://github.com/privatenumber/mdeval)
+- Hiroki Osame's [mdeval](https://github.com/privatenumber/mdeval)\
+  The best name!
 
 ### Implementation notes
 
 This project was split from a monorepo containing both `mdat` and `remark-mdat` into separate repos in July 2024.
 
+Run `pnpm bench` to compare performance against `test/benchmarks/baseline.json`. Run `pnpm bench:baseline` to refresh the saved results using Vitest 5's benchmark format. Both commands support filters such as `-t loadConfig`; refreshing a filtered subset preserves the other baselines. Use the same machine and Node.js version for meaningful comparisons.
+
 ## Maintainers
 
 [kitschpatrol](https://github.com/kitschpatrol)