remark-mdat 1.1.3 → 1.2.0

package/dist/index.js

@@ -4170,8 +4170,9 @@ function checkCommentOrder(file, comments) {
 function checkMetaCommentPresence(file, comments, options) {
 	const { addMetaComment } = options;
 	const metaCommentCount = comments.filter((comment) => comment.type === "meta").length;
-	if (addMetaComment && metaCommentCount !== 1) saveLog(file, "error", "check", `Missing meta comment`);
-	if (!addMetaComment && metaCommentCount !== 0) saveLog(file, "error", "check", `Unexpected meta comment`);
+	const shouldHaveMetaComment = typeof addMetaComment === "string" ? true : addMetaComment;
+	if (shouldHaveMetaComment && metaCommentCount !== 1) saveLog(file, "error", "check", `Missing meta comment`);
+	if (!shouldHaveMetaComment && metaCommentCount !== 0) saveLog(file, "error", "check", `Unexpected meta comment`);
 	if (metaCommentCount > 1) saveLog(file, "error", "check", `Multiple meta comments`);
 }
 function commentOrderList(comments) {
@@ -20792,7 +20793,7 @@ async function mdatExpand(tree, file, options) {
 	if (addMetaComment) {
 		const metaComment = {
 			type: "html",
-			value: `<!--${metaCommentIdentifier} Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. ${metaCommentIdentifier}-->`
+			value: `<!--${metaCommentIdentifier} ${typeof addMetaComment === "string" ? addMetaComment : "Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten."} ${metaCommentIdentifier}-->`
 		};
 		tree.children.unshift(metaComment);
 	}
@@ -30564,7 +30565,7 @@ const defaultOptions = {
 	rules: { mdat: `Powered by the Markdown Autophagic Template system: [mdat](https://github.com/kitschpatrol/mdat).` }
 };
 const optionsSchema = z.object({
-	addMetaComment: z.boolean().optional(),
+	addMetaComment: z.union([z.boolean(), z.string()]).optional(),
 	closingPrefix: z.string().optional(),
 	keywordPrefix: z.string().optional(),
 	metaCommentIdentifier: z.string().optional(),

package/dist/lib/mdast-utils/mdast-util-mdat-check.d.ts

@@ -2,7 +2,7 @@ import type { Root } from 'mdast';
 import type { VFile } from 'vfile';
 import type { Rules } from '../mdat/rules';
 export type Options = {
-    addMetaComment: boolean;
+    addMetaComment: boolean | string;
     closingPrefix: string;
     keywordPrefix: string;
     metaCommentIdentifier: string;

package/dist/lib/mdast-utils/mdast-util-mdat-expand.d.ts

@@ -2,7 +2,7 @@ import type { Root } from 'mdast';
 import type { VFile } from 'vfile';
 import type { Rules } from '../mdat/rules';
 export type Options = {
-    addMetaComment: boolean;
+    addMetaComment: boolean | string;
     closingPrefix: string;
     keywordPrefix: string;
     metaCommentIdentifier: string;

package/dist/lib/mdast-utils/mdast-util-mdat.d.ts

@@ -2,7 +2,7 @@ import type { Root } from 'mdast';
 import type { VFile } from 'vfile';
 import type { Rules } from '../mdat/rules';
 export type Options = {
-    addMetaComment: boolean;
+    addMetaComment: boolean | string;
     closingPrefix: string;
     keywordPrefix: string;
     metaCommentIdentifier: string;

package/dist/lib/remark-mdat.d.ts

@@ -4,7 +4,7 @@ import { z } from 'zod';
 import type { Options as MdatOptions } from './mdast-utils/mdast-util-mdat';
 export type Options = Partial<MdatOptions>;
 export declare const optionsSchema: z.ZodObject<{
-    addMetaComment: z.ZodOptional<z.ZodBoolean>;
+    addMetaComment: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodString]>>;
     closingPrefix: z.ZodOptional<z.ZodString>;
     keywordPrefix: z.ZodOptional<z.ZodString>;
     metaCommentIdentifier: z.ZodOptional<z.ZodString>;
@@ -14,13 +14,13 @@ export declare const optionsSchema: z.ZodObject<{
     keywordPrefix?: string | undefined;
     metaCommentIdentifier?: string | undefined;
     rules?: Record<string, any> | undefined;
-    addMetaComment?: boolean | undefined;
+    addMetaComment?: string | boolean | undefined;
 }, {
     closingPrefix?: string | undefined;
     keywordPrefix?: string | undefined;
     metaCommentIdentifier?: string | undefined;
     rules?: Record<string, any> | undefined;
-    addMetaComment?: boolean | undefined;
+    addMetaComment?: string | boolean | undefined;
 }>;
 /**
  * A remark plugin that expands HTML comments in Markdown files.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remark-mdat",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "A remark plugin implementing the Markdown Autophagic Template (MDAT) system.",
   "keywords": [
     "mdat",
@@ -35,7 +35,7 @@
   ],
   "dependencies": {
     "@types/mdast": "^4.0.4",
-    "@types/node": "^20.19.24",
+    "@types/node": "^20.19.25",
     "@types/unist": "^3.0.3",
     "picocolors": "^1.1.1",
     "type-fest": "^5.2.0",
@@ -44,7 +44,7 @@
     "zod": "^3.25.76"
   },
   "devDependencies": {
-    "@kitschpatrol/shared-config": "^5.8.1",
+    "@kitschpatrol/shared-config": "^5.8.3",
     "bumpp": "^10.3.1",
     "cli-table3": "^0.6.5",
     "deepmerge-ts": "^7.1.5",
@@ -52,11 +52,11 @@
     "json5": "^2.2.3",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "tsdown": "^0.16.0",
+    "tsdown": "^0.16.3",
     "typescript": "~5.9.3",
     "unist-util-visit": "^5.0.0",
     "vfile-message": "^4.0.3",
-    "vitest": "^4.0.7"
+    "vitest": "^4.0.8"
   },
   "engines": {
     "node": ">=20.19.0"

package/readme.md

@@ -101,7 +101,7 @@ The plugin accepts an optional options object which exposes some configuration o
 
 ```ts
 export type Options = {
-  addMetaComment?: boolean // Default: false
+  addMetaComment?: boolean | string // Default: false
   closingPrefix?: string // Default: '/',
   keywordPrefix?: string // Default: '',
   metaCommentIdentifier?: string // Default: '+',