remark-mdat 2.2.0 → 2.2.2

package/dist/index.d.ts

@@ -193,11 +193,13 @@ declare function mdatStrip(tree: Root, _file: VFile): void;
 //#endregion
 //#region src/lib/mdat/log.d.ts
 /**
- * Set the logger instance for the module.
- * Export this for library consumers to inject their own logger.
- * @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
+ * Set the logger instance for the module. Export this for library consumers to
+ * inject their own logger.
+ *
+ * @param logger - Accepts either a LogLayer instance or a Console- or
+ *   Stream-like log target
  */
-declare function setLogger(logger?: ILogBasic | ILogLayer): void;
+declare function setLogger(logger?: ILogBasic | ILogLayer<unknown>): void;
 //#endregion
 //#region src/lib/mdat/mdat-log.d.ts
 /** A simplified representation of a {@link VFileMessage}. */
@@ -224,7 +226,11 @@ declare function reporterMdat(files: VFile[]): void;
 //#region src/lib/remark-mdat.d.ts
 /** Configuration for the remarkMdat plugin. */
 type Options = {
-  /** Rules mapping comment keywords to expansion content. Merged with built-in defaults. */rules?: Rules;
+  /**
+   * Rules mapping comment keywords to expansion content. Merged with built-in
+   * defaults.
+   */
+  rules?: Rules;
 };
 /** Zod schema for validating {@link Options}. */
 declare const optionsSchema: z.ZodObject<{

package/dist/index.js

@@ -19,9 +19,11 @@ let log = createLogger({
 	name: "remark-mdat"
 });
 /**
-* Set the logger instance for the module.
-* Export this for library consumers to inject their own logger.
-* @param logger - Accepts either a LogLayer instance or a Console- or Stream-like log target
+* Set the logger instance for the module. Export this for library consumers to
+* inject their own logger.
+*
+* @param logger - Accepts either a LogLayer instance or a Console- or
+*   Stream-like log target
 */
 function setLogger(logger) {
 	log = injectionHelper(logger);
@@ -456,7 +458,7 @@ function splitHtmlIntoMdastNodes(mdastNode) {
 	return mdastNodes;
 }
 function addStartPoint(position, start) {
-	if (position === void 0 || start === void 0) return void 0;
+	if (position === void 0 || start === void 0) return;
 	const startLine = position.start.line - 1 + start.line;
 	const endLine = position.end.line - 1 + start.line;
 	return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-mdat",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "A remark plugin implementing the Markdown Autophagic Template (MDAT) system.",
   "keywords": [
     "mdat",
@@ -46,27 +46,28 @@
     "gray-matter-es": "^0.2.1",
     "hast-util-from-html": "^2.0.3",
     "json5": "^2.2.3",
-    "lognow": "^0.6.0",
+    "lognow": "^0.6.1",
     "picocolors": "^1.1.1",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "type-fest": "^5.5.0",
+    "type-fest": "^5.6.0",
     "unified": "^11.0.5",
     "unist-util-visit": "^5.1.0",
     "vfile": "^6.0.3",
     "vfile-message": "^4.0.3",
-    "zod": "^4.3.6"
+    "zod": "^4.4.1"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.2",
-    "@kitschpatrol/shared-config": "^7.0.1",
-    "@types/node": "~20.19.37",
-    "@vitest/coverage-v8": "^4.1.2",
+    "@kitschpatrol/shared-config": "^7.5.2",
+    "@types/node": "~20.19.39",
+    "@vitest/coverage-v8": "^4.1.5",
     "bumpp": "^11.0.1",
     "publint": "^0.3.18",
-    "tsdown": "^0.21.7",
+    "shx": "^0.4.0",
+    "tsdown": "^0.21.10",
     "typescript": "~5.9.3",
-    "vitest": "^4.1.2"
+    "vitest": "^4.1.5"
   },
   "engines": {
     "node": ">=20.19.6"
@@ -81,13 +82,13 @@
     "bench": "vitest bench --run --no-file-parallelism --compare test/benchmarks/baseline.json",
     "bench:baseline": "vitest bench --run --no-file-parallelism --outputJson test/benchmarks/baseline.json",
     "build": "tsdown",
-    "clean": "git rm -f pnpm-lock.yaml ; git clean -fdX",
+    "clean": "shx rm -f pnpm-lock.yaml && git clean -fdX -e !.claude/",
     "coverage": "vitest --coverage --run",
-    "dev": "pnpm run test",
+    "dev": "pnpm test",
     "fix": "ksc fix",
     "lint": "ksc lint",
-    "release": "bumpp --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",
-    "release-preview": "bumpp --preid preview --commit 'Release: %s' && pnpm run build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish --tag preview",
+    "release": "bumpp --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish",
+    "release-preview": "bumpp --preid preview --commit 'Release: %s' && pnpm build && NPM_AUTH_TOKEN=$(op read 'op://Personal/npm/token') && pnpm publish --tag preview",
     "test": "vitest run"
   }
 }

package/readme.md

@@ -4,17 +4,10 @@
 
 <!-- /title -->
 
-<!-- badges { custom: {
-    "CI": {
-      image: "https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml/badge.svg",
-      link: "https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml",
-    },
-  }
-}
--->
+<!-- badges -->
 
 [![NPM Package remark-mdat](https://img.shields.io/npm/v/remark-mdat.svg)](https://npmjs.com/package/remark-mdat)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/mit/)
 [![CI](https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml/badge.svg)](https://github.com/kitschpatrol/remark-mdat/actions/workflows/ci.yml)
 
 <!-- /badges -->
@@ -361,6 +354,8 @@ The former `mdast-util-mdat-clean` / `mdatClean` is now `mdast-util-mdat-collaps
 
 The `mdast-util-mdat-check` utility and its export `mdatCheck` have been removed. Validation logic (missing rules, empty content, rule errors) is now handled inline during expansion by `mdatExpand`, which reports issues as VFile messages. Use `reporterMdat` to format and display these messages.
 
+For use cases where you need to check whether a file's expansions are up to date without modifying it (similar to `validate` in 1.x), use the new `mdatDiff` utility. It compares an original document against a freshly expanded version per-tag, identifying stale, unexpanded, or missing comments and reporting structured results.
+
 ### Rule function signature change
 
 In 1.x, rule content functions received the mdast tree directly as the second argument:
@@ -387,7 +382,7 @@ In 1.x, the argument parser was very permissive — parentheses were optional, b
 
 ```md
 <!-- greeting name: "Alice" -->
-<!-- greeting {name: "Alice"} -->
+<!-- greeting ({name: "Alice"}) -->
 <!-- greeting({name: "Alice"}) -->
 ```
 
@@ -427,7 +422,7 @@ Remark is not a peer dependency on account of this discussion: [strip-markdown/i
 
 ## Maintainers
 
-[@kitschpatrol](https://github.com/kitschpatrol)
+[kitschpatrol](https://github.com/kitschpatrol)
 
 ## Acknowledgments
 
@@ -437,10 +432,14 @@ Thanks to the [unified team](https://github.com/orgs/unifiedjs/people) for their
 
 ## Contributing
 
-[Issues](https://github.com/kitschpatrol/remark-mdat/issues) and pull requests are welcome.
+[Issues](https://github.com/kitschpatrol/remark-mdat/issues) are welcome and appreciated.
+
+Please open an issue to discuss changes before submitting a pull request. Unsolicited PRs (especially AI-generated ones) are unlikely to be merged.
+
+This repository uses [@kitschpatrol/shared-config](https://github.com/kitschpatrol/shared-config) (via its `ksc` CLI) for linting and formatting, plus [MDAT](https://github.com/kitschpatrol/mdat) for readme placeholder expansion.
 
 ## License
 
-[MIT](license.txt) © Eric Mika
+[MIT](license.txt) © [Eric Mika](https://ericmika.com)
 
 <!-- /footer -->