remark-mdat 3.0.3 → 3.1.1

package/dist/index.js

@@ -30,12 +30,12 @@ function setLogger(logger) {
 }
 //#endregion
 //#region src/lib/mdat/mdat-log.ts
-function saveLog(file, level, source, message, lineOrNode, maybeColumn) {
+function saveLog(file, level, source, message, lineOrNode, maybeColumn = 0) {
 	let line;
 	let column;
 	if (lineOrNode === void 0 || typeof lineOrNode === "number") {
 		line = lineOrNode ?? 0;
-		column = maybeColumn ?? 0;
+		column = maybeColumn;
 	} else {
 		line = lineOrNode?.position?.start.line ?? 0;
 		column = lineOrNode?.position?.start.column ?? 0;
@@ -138,9 +138,11 @@ function parseCommentNode(node, parent) {
 const HTML_COMMENT_OPEN_REGEX = /^\s*<!-{2,}\s*/v;
 const HTML_COMMENT_CLOSE_REGEX = /\s*-{2,}>\s*$/v;
 const WHITESPACE_REGEX = /\s/v;
+const KEYWORD_REGEX = /^[\p{L}\p{N}_$][\p{L}\p{N}_$.\-]*$/v;
 /**
 * Parse any comment string into structured data. Comments using code-style
-* notation (`//`, `#`, `/*`) are ignored and return `undefined`.
+* notation (`//`, `#`, `/*`) and comments whose first word is not a valid
+* keyword (e.g. commented-out Markdown) are ignored and return `undefined`.
 *
 * @returns A CommentMarker or undefined if the node is not a recognized
 *   comment.
@@ -155,6 +157,7 @@ function parseComment(text) {
 	const type = rawKeyword.startsWith("/") ? "close" : "open";
 	let keyword = rawKeyword;
 	if (type === "close") keyword = keyword.slice(1);
+	if (!KEYWORD_REGEX.test(keyword)) return;
 	let options = {};
 	if (parenIndex !== -1) {
 		const lastParen = commentBody.lastIndexOf(")");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "remark-mdat",
-  "version": "3.0.3",
-  "description": "A remark plugin implementing the Markdown Autophagic Template (MDAT) system.",
+  "version": "3.1.1",
+  "description": "Remark plugin implementing the Markdown Autophagic Template (MDAT) system.",
   "keywords": [
     "mdat",
     "markdown",
@@ -12,7 +12,8 @@
     "mdast-util",
     "syntax-tree",
     "remark",
-    "remark-plugin"
+    "remark-plugin",
+    "npm-package"
   ],
   "homepage": "https://github.com/kitschpatrol/remark-mdat",
   "bugs": "https://github.com/kitschpatrol/remark-mdat/issues",
@@ -59,18 +60,19 @@
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.5",
-    "@kitschpatrol/shared-config": "^8.10.0",
+    "@kitschpatrol/shared-config": "^8.12.1",
     "@types/node": "~24.13.4",
-    "@vitest/coverage-v8": "^5.0.1",
+    "@vitest/coverage-v8": "^5.0.3",
     "bumpp": "^12.3.0",
-    "publint": "^0.3.24",
+    "publint": "^0.3.25",
     "shx": "^0.4.0",
+    "skills": "^1.7.0",
     "tsdown": "^0.23.0",
     "typescript": "~6.0.3",
-    "vitest": "^5.0.1"
+    "vitest": "^5.0.3"
   },
   "engines": {
-    "node": ">=24.16.0"
+    "node": "^24.16.0 || >=26.3.0"
   },
   "scripts": {
     "bench": "vitest bench --run",

package/readme.md

@@ -4,25 +4,18 @@
 
 <!-- /title -->
 
-<!-- badges({
-  custom: {
-    "Bundle Size": {
-      image: "https://img.shields.io/bundlephobia/minzip/remark-mdat?label=Size",
-      link: "https://bundlephobia.com/package/remark-mdat",
-    },
-  }
-}) -->
+<!-- badges({ bundleSize: true }) -->
 
 [![NPM Package remark-mdat](https://img.shields.io/npm/v/remark-mdat.svg)](https://www.npmjs.com/package/remark-mdat)
 [![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)
-[![Bundle Size](https://img.shields.io/bundlephobia/minzip/remark-mdat?label=Size)](https://bundlephobia.com/package/remark-mdat)
+[![Bundle Size remark-mdat](https://img.shields.io/bundlephobia/minzip/remark-mdat?label=Size)](https://bundlephobia.com/package/remark-mdat)
 
 <!-- /badges -->
 
 <!-- description -->
 
-**A remark plugin implementing the Markdown Autophagic Template (MDAT) system.**
+**Remark plugin implementing the Markdown Autophagic Template (MDAT) system.**
 
 <!-- /description -->
 
@@ -87,16 +80,28 @@ This plugin powers the higher-level [`mdat` package](https://github.com/kitschpa
 
 ## Getting started
 
+<!-- dependencies -->
+
 ### Dependencies
 
-This library is ESM only and requires Node 24.16.0+. It's designed to work with Remark 15. `remark-mdat` is implemented in TypeScript and bundles a complete set of type definitions.
+- [Node.js](https://nodejs.org/) 24.16.0 or newer (specifically `^24.16.0 || >=26.3.0`)
+
+<!-- /dependencies -->
+
+This library is ESM only. It's designed to work with Remark 15. `remark-mdat` is implemented in TypeScript and bundles a complete set of type definitions.
+
+<!-- install -->
 
 ### Installation
 
+Add it to your project:
+
 ```sh
-pnpm add remark-mdat
+npm install remark-mdat
 ```
 
+<!-- /install -->
+
 ## Usage
 
 ### API
@@ -118,7 +123,11 @@ remark().use(remarkMdat)
 
 The plugin accepts an optional `Options` object with a `rules` field. `Rules` is a `Record<string, Rule>` where each key is a keyword matching an HTML comment in the Markdown file (e.g. `title` matches `<!-- title -->`).
 
-HTML comments using code-style notation (`<!-- // ... -->`, `<!-- # ... -->`, `<!-- /* ... */ -->`) are ignored and will not be treated as mdat keywords. Rule keywords cannot start with `/`, `*`, or `#`.
+HTML comments using code-style notation (`<!-- // ... -->`, `<!-- # ... -->`, `<!-- /* ... */ -->`) are ignored and will not be treated as mdat keywords.
+
+Comments whose first word is not a valid mdat rule in the context of the loaded configuration are also ignored.
+
+A keyword consists of letters, numbers, `_`, `$`, `-`, and `.`, and cannot start with `/`, `*`, `#`, `-`, or `.`.
 
 A `Rule` value can take several forms: