mdat 2.0.1 → 2.1.0

package/dist/bin/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import picocolors from "picocolors";
 import prettyMilliseconds from "pretty-ms";
-import { getMdatReports, getSoleRule, mdatClean, mdatExpand, mdatSplit, reporterMdat, rulesSchema, setLogger } from "remark-mdat";
+import { getMdatReports, getSoleRule, mdatCollapse, mdatExpand, mdatSplit, mdatStrip, reporterMdat, rulesSchema, setLogger } from "remark-mdat";
 import { cosmiconfig, defaultLoaders } from "cosmiconfig";
 import { TypeScriptLoader } from "cosmiconfig-typescript-loader";
 import fs from "node:fs/promises";
@@ -42,7 +42,7 @@ function deepMergeDefined(...objects) {
 //#endregion
 //#region package.json
 var name = "mdat";
-var version = "2.0.1";
+var version = "2.1.0";
 
 //#endregion
 //#region src/lib/log.ts
@@ -740,17 +740,26 @@ function getExpandProcessor(config, ambientRemarkConfig) {
 		emphasis: "_"
 	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => async function(tree, file) {
 		mdatSplit(tree, file);
-		mdatClean(tree, file);
+		mdatCollapse(tree, file);
 		await mdatExpand(tree, file, config);
 	});
 }
-function getCleanProcessor(_config, ambientRemarkConfig) {
+function getCollapseProcessor(_config, ambientRemarkConfig) {
 	return remark().use({ settings: {
 		bullet: "-",
 		emphasis: "_"
 	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => function(tree, file) {
 		mdatSplit(tree, file);
-		mdatClean(tree, file);
+		mdatCollapse(tree, file);
+	});
+}
+function getStripProcessor(_config, ambientRemarkConfig) {
+	return remark().use({ settings: {
+		bullet: "-",
+		emphasis: "_"
+	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => function(tree, file) {
+		mdatSplit(tree, file);
+		mdatStrip(tree, file);
 	});
 }
 
@@ -889,10 +898,11 @@ function getTemplateOptions() {
 //#endregion
 //#region src/lib/api.ts
 /**
-* Expand MDAT comments in one or more Markdown files.
-* If no files are provided, auto-finds the closest readme.md.
-* Writing is the responsibility of the caller (e.g. via `await write(result)`)
-* @returns an array of VFiles
+* Expand MDAT comments in one or more Markdown files. If no files are provided,
+* auto-finds the closest readme.md. Writing is the responsibility of the caller
+* (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
 */
 async function expand(files, name, output, config, options) {
 	files ??= await findReadmeThrows();
@@ -901,21 +911,37 @@ async function expand(files, name, output, config, options) {
 	return results;
 }
 /**
-* Collapse MDAT comments in one or more Markdown files.
-* If no files are provided, auto-finds the closest readme.md.
-* Writing is the responsibility of the caller (e.g. via `await write(result)`)
-* @returns an array of VFiles
+* Collapse MDAT comments in one or more Markdown files. If no files are
+* provided, auto-finds the closest readme.md. Writing is the responsibility of
+* the caller (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
 */
 async function collapse(files, name, output, config, options) {
 	files ??= await findReadmeThrows();
-	const results = await processFiles(files, loadConfig, getCleanProcessor, name, output, config);
+	const results = await processFiles(files, loadConfig, getCollapseProcessor, name, output, config);
+	if (options?.format) await formatResults(results);
+	return results;
+}
+/**
+* Strips MDAT comments in one or more Markdown files without touching other
+* content. Does _not_ automatically expand Mdat content before stripping the
+* tags. If no files are provided, auto-finds the closest readme.md. Writing is
+* the responsibility of the caller (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
+*/
+async function strip(files, name, output, config, options) {
+	files ??= await findReadmeThrows();
+	const results = await processFiles(files, loadConfig, getStripProcessor, name, output, config);
 	if (options?.format) await formatResults(results);
 	return results;
 }
 /**
-* Dry-run expand and compare with file on disk.
-* If no files are provided, auto-finds the closest readme.md.
-* @returns per-file sync status and expanded VFiles
+* Dry-run expand and compare with file on disk. If no files are provided,
+* auto-finds the closest readme.md.
+*
+* @returns Per-file sync status and expanded VFiles
 */
 async function check(files, config, options) {
 	files ??= await findReadmeThrows();
@@ -1041,6 +1067,18 @@ try {
 		reporterMdat(results);
 		log.debug(`Collapsed comments in ${prettyMilliseconds(performance.now() - startTime)}.`);
 		process.exitCode = getExitCode(results);
+	}).command("strip [files..] [options]", "Strip MDAT comments while preserving expanded content. If no files are provided, the closest readme.md is stripped.", (yargs) => yargs.positional(...filesPositional).option(outputOption).option(nameOption).option(printOption).option(formatOption), async ({ files, format, name, output, print }) => {
+		logConflicts({
+			name,
+			output,
+			print
+		});
+		const results = await strip(files, name, output, void 0, { format });
+		for (const file of results) if (print) process.stdout.write(file.toString());
+		else await write(file);
+		reporterMdat(results);
+		log.debug(`Stripped comments in ${prettyMilliseconds(performance.now() - startTime)}.`);
+		process.exitCode = getExitCode(results);
 	}).command("check [files..] [options]", "Check if MDAT placeholder comments are up to date. Exits with code 1 if any files have stale or unexpanded content.", (yargs) => yargs.positional(...filesPositional).option(configOption).option(formatOption), async ({ config, files, format }) => {
 		const results = await check(files, collectConfig(config), { format });
 		let allInSync = true;

package/dist/lib/index.d.ts

@@ -67,10 +67,11 @@ declare function createReadme(options?: Partial<MdatReadmeCreateOptions>): Promi
 //#endregion
 //#region src/lib/api.d.ts
 /**
- * Expand MDAT comments in one or more Markdown files.
- * If no files are provided, auto-finds the closest readme.md.
- * Writing is the responsibility of the caller (e.g. via `await write(result)`)
- * @returns an array of VFiles
+ * Expand MDAT comments in one or more Markdown files. If no files are provided,
+ * auto-finds the closest readme.md. Writing is the responsibility of the caller
+ * (e.g. via `await write(result)`)
+ *
+ * @returns An array of VFiles
  */
 declare function expand(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
   format?: boolean;
@@ -82,10 +83,11 @@ declare function expandString(markdown: string, config?: ConfigToLoad, options?:
   format?: boolean;
 }): Promise<VFile>;
 /**
- * Collapse MDAT comments in one or more Markdown files.
- * If no files are provided, auto-finds the closest readme.md.
- * Writing is the responsibility of the caller (e.g. via `await write(result)`)
- * @returns an array of VFiles
+ * Collapse MDAT comments in one or more Markdown files. If no files are
+ * provided, auto-finds the closest readme.md. Writing is the responsibility of
+ * the caller (e.g. via `await write(result)`)
+ *
+ * @returns An array of VFiles
  */
 declare function collapse(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
   format?: boolean;
@@ -97,9 +99,27 @@ declare function collapseString(markdown: string, config?: ConfigToLoad, options
   format?: boolean;
 }): Promise<VFile>;
 /**
- * Dry-run expand and compare with file on disk.
- * If no files are provided, auto-finds the closest readme.md.
- * @returns per-file sync status and expanded VFiles
+ * Strips MDAT comments in one or more Markdown files without touching other
+ * content. Does _not_ automatically expand Mdat content before stripping the
+ * tags. If no files are provided, auto-finds the closest readme.md. Writing is
+ * the responsibility of the caller (e.g. via `await write(result)`)
+ *
+ * @returns An array of VFiles
+ */
+declare function strip(files?: string | string[], name?: string, output?: string, config?: ConfigToLoad, options?: {
+  format?: boolean;
+}): Promise<VFile[]>;
+/**
+ * Strip MDAT comments from a Markdown string.
+ */
+declare function stripString(markdown: string, config?: ConfigToLoad, options?: {
+  format?: boolean;
+}): Promise<VFile>;
+/**
+ * Dry-run expand and compare with file on disk. If no files are provided,
+ * auto-finds the closest readme.md.
+ *
+ * @returns Per-file sync status and expanded VFiles
  */
 declare function check(files?: string | string[], config?: ConfigToLoad, options?: {
   format?: boolean;
@@ -160,4 +180,4 @@ declare function resetMetadataCaches(): void;
  */
 declare function setLogger(logger?: ILogBasic | ILogLayer): void;
 //#endregion
-export { type Config, type ReadmeMetadata, type Rule, check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger };
+export { type Config, type ReadmeMetadata, type Rule, check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger, strip, stripString };

package/dist/lib/index.js

@@ -4,7 +4,7 @@ import fs from "node:fs/promises";
 import path from "node:path";
 import picocolors from "picocolors";
 import plur from "plur";
-import { getSoleRule, mdatClean, mdatExpand, mdatSplit, rulesSchema, setLogger as setLogger$1 } from "remark-mdat";
+import { getSoleRule, mdatCollapse, mdatExpand, mdatSplit, mdatStrip, rulesSchema, setLogger as setLogger$1 } from "remark-mdat";
 import { deepmerge } from "deepmerge-ts";
 import { createLogger, getChildLogger, injectionHelper } from "lognow";
 import { defineTemplate, getMetadata, helpers, setLogger as setLogger$2, templates } from "metascope";
@@ -748,17 +748,26 @@ function getExpandProcessor(config, ambientRemarkConfig) {
 		emphasis: "_"
 	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => async function(tree, file) {
 		mdatSplit(tree, file);
-		mdatClean(tree, file);
+		mdatCollapse(tree, file);
 		await mdatExpand(tree, file, config);
 	});
 }
-function getCleanProcessor(_config, ambientRemarkConfig) {
+function getCollapseProcessor(_config, ambientRemarkConfig) {
 	return remark().use({ settings: {
 		bullet: "-",
 		emphasis: "_"
 	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => function(tree, file) {
 		mdatSplit(tree, file);
-		mdatClean(tree, file);
+		mdatCollapse(tree, file);
+	});
+}
+function getStripProcessor(_config, ambientRemarkConfig) {
+	return remark().use({ settings: {
+		bullet: "-",
+		emphasis: "_"
+	} }).use(remarkGfm).use(ambientRemarkConfig).use(() => function(tree, file) {
+		mdatSplit(tree, file);
+		mdatStrip(tree, file);
 	});
 }
 //#endregion
@@ -888,10 +897,11 @@ function getTemplateOptions() {
 //#endregion
 //#region src/lib/api.ts
 /**
-* Expand MDAT comments in one or more Markdown files.
-* If no files are provided, auto-finds the closest readme.md.
-* Writing is the responsibility of the caller (e.g. via `await write(result)`)
-* @returns an array of VFiles
+* Expand MDAT comments in one or more Markdown files. If no files are provided,
+* auto-finds the closest readme.md. Writing is the responsibility of the caller
+* (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
 */
 async function expand(files, name, output, config, options) {
 	files ??= await findReadmeThrows();
@@ -908,14 +918,15 @@ async function expandString(markdown, config, options) {
 	return result;
 }
 /**
-* Collapse MDAT comments in one or more Markdown files.
-* If no files are provided, auto-finds the closest readme.md.
-* Writing is the responsibility of the caller (e.g. via `await write(result)`)
-* @returns an array of VFiles
+* Collapse MDAT comments in one or more Markdown files. If no files are
+* provided, auto-finds the closest readme.md. Writing is the responsibility of
+* the caller (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
 */
 async function collapse(files, name, output, config, options) {
 	files ??= await findReadmeThrows();
-	const results = await processFiles(files, loadConfig, getCleanProcessor, name, output, config);
+	const results = await processFiles(files, loadConfig, getCollapseProcessor, name, output, config);
 	if (options?.format) await formatResults(results);
 	return results;
 }
@@ -923,14 +934,37 @@ async function collapse(files, name, output, config, options) {
 * Collapse MDAT comments in a Markdown string.
 */
 async function collapseString(markdown, config, options) {
-	const result = await processString(markdown, loadConfig, getCleanProcessor, config);
+	const result = await processString(markdown, loadConfig, getCollapseProcessor, config);
+	if (options?.format) await formatResults([result]);
+	return result;
+}
+/**
+* Strips MDAT comments in one or more Markdown files without touching other
+* content. Does _not_ automatically expand Mdat content before stripping the
+* tags. If no files are provided, auto-finds the closest readme.md. Writing is
+* the responsibility of the caller (e.g. via `await write(result)`)
+*
+* @returns An array of VFiles
+*/
+async function strip(files, name, output, config, options) {
+	files ??= await findReadmeThrows();
+	const results = await processFiles(files, loadConfig, getStripProcessor, name, output, config);
+	if (options?.format) await formatResults(results);
+	return results;
+}
+/**
+* Strip MDAT comments from a Markdown string.
+*/
+async function stripString(markdown, config, options) {
+	const result = await processString(markdown, loadConfig, getStripProcessor, config);
 	if (options?.format) await formatResults([result]);
 	return result;
 }
 /**
-* Dry-run expand and compare with file on disk.
-* If no files are provided, auto-finds the closest readme.md.
-* @returns per-file sync status and expanded VFiles
+* Dry-run expand and compare with file on disk. If no files are provided,
+* auto-finds the closest readme.md.
+*
+* @returns Per-file sync status and expanded VFiles
 */
 async function check(files, config, options) {
 	files ??= await findReadmeThrows();
@@ -947,4 +981,4 @@ async function formatResults(results) {
 	for (const file of results) file.value = await formatWithPrettier(file.toString(), file.path || void 0);
 }
 //#endregion
-export { check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger };
+export { check, collapse, collapseString, createReadme as create, createReadmeInteractive as createInteractive, defineConfig, expand, expandString, getContextMetadata, getReadmeMetadata, loadConfig, mergeConfig, resetMetadataCaches, setLogger, strip, stripString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "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",
@@ -50,7 +50,7 @@
     "globby": "^16.2.0",
     "lognow": "^0.6.0",
     "mdast-util-toc": "^7.1.0",
-    "metascope": "^0.5.0",
+    "metascope": "^0.6.0",
     "path-type": "^6.0.0",
     "picocolors": "^1.1.1",
     "plur": "^6.0.0",
@@ -58,7 +58,7 @@
     "pretty-ms": "^9.3.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.1",
-    "remark-mdat": "^2.0.2",
+    "remark-mdat": "^2.1.0",
     "to-vfile": "^8.0.0",
     "type-fest": "^5.5.0",
     "unified-engine": "^11.2.2",
@@ -69,7 +69,7 @@
   },
   "devDependencies": {
     "@arethetypeswrong/core": "^0.18.2",
-    "@kitschpatrol/shared-config": "^7.0.0",
+    "@kitschpatrol/shared-config": "^7.0.1",
     "@types/mdast": "^4.0.4",
     "@types/node": "~22.17.2",
     "@types/unist": "^3.0.3",

package/readme.md

@@ -228,6 +228,7 @@ mdat [command] [files..] [options]
 | ---------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------- |
 | `expand`   | `[files..]` `[options]` | Expand MDAT placeholder comments. If no files are provided, the closest readme.md is expanded. _(Default command.)_ |
 | `collapse` | `[files..]` `[options]` | Collapse MDAT placeholder comments. If no files are provided, the closest readme.md is collapsed.                   |
+| `strip`    | `[files..]` `[options]` | Strip MDAT comments while preserving expanded content. If no files are provided, the closest readme.md is stripped. |
 | `check`    | `[files..]` `[options]` | Check if MDAT placeholder comments are up to date. Exits with code 1 if any files have stale or unexpanded content. |
 | `create`   | `[options]`             | Create a new Markdown file from a template.                                                                         |
 
@@ -282,6 +283,30 @@ mdat collapse [files..] [options]
 | `--help`<br>`-h`    | Show help                                                                                                                     | `boolean` |                                                     |
 | `--version`<br>`-v` | Show version number                                                                                                           | `boolean` |                                                     |
 
+#### Subcommand: `mdat strip`
+
+Strip MDAT comments while preserving expanded content. If no files are provided, the closest readme.md is stripped.
+
+Usage:
+
+```txt
+mdat strip [files..] [options]
+```
+
+| Positional Argument | Description                                                                                           | Type     |
+| ------------------- | ----------------------------------------------------------------------------------------------------- | -------- |
+| `files`             | Markdown file(s) with MDAT placeholder comments. If not provided, the closest readme.md file is used. | `string` |
+
+| Option              | Description                                                                                                                   | Type      | Default                                             |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------- | --------------------------------------------------- |
+| `--verbose`         | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection. | `boolean` |                                                     |
+| `--output`<br>`-o`  | Output file directory.                                                                                                        | `string`  | Same directory as input file.                       |
+| `--name`<br>`-n`    | Output file name.                                                                                                             | `string`  | Same name as input file. Overwrites the input file. |
+| `--print`           | Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.                   | `boolean` |                                                     |
+| `--format`<br>`-f`  | Format the output with Prettier. Discovers Prettier config from the file path. Requires `prettier` as a peer dependency.      | `boolean` |                                                     |
+| `--help`<br>`-h`    | Show help                                                                                                                     | `boolean` |                                                     |
+| `--version`<br>`-v` | Show version number                                                                                                           | `boolean` |                                                     |
+
 #### Subcommand: `mdat check`
 
 Check if MDAT placeholder comments are up to date. Exits with code 1 if any files have stale or unexpanded content.
@@ -366,6 +391,12 @@ mdat check
 mdat collapse
 ```
 
+##### Strip MDAT comments from expanded content
+
+```sh
+mdat strip
+```
+
 ##### Expand and format with Prettier
 
 ```sh
@@ -420,6 +451,12 @@ Expands MDAT comments in a Markdown string. Call `.toString()` on the returned [
 
 Removes expanded content, leaving only the opening comment placeholders. Same signatures as `expand` / `expandString`.
 
+#### `strip` / `stripString`
+
+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.
+
 #### `check`
 
 ```ts
@@ -577,16 +614,16 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
   Embeds a file's size, with optional Brotli or Gzip compressed size.
 
-- ##### `<!-- size-table({ files: [".gitignore", "readme.md"] }) -->`
+- ##### `<!-- size-table({ files: [".gitignore", "license.txt"] }) -->`
 
   A table of files and their compressed sizes:
 
-  <!-- size-table({ files: [".gitignore", "readme.md"] }) -->
+  <!-- size-table({ files: [".gitignore", "license.txt"] }) -->
 
-  | File       | Original | Gzip   | Brotli |
-  | ---------- | -------- | ------ | ------ |
-  | .gitignore | 305 B    | 245 B  | 216 B  |
-  | readme.md  | 34.4 kB  | 8.3 kB | 6.9 kB |
+  | File        | Original | Gzip  | Brotli |
+  | ----------- | -------- | ----- | ------ |
+  | .gitignore  | 305 B    | 245 B | 216 B  |
+  | license.txt | 1 kB     | 659 B | 468 B  |
 
   <!-- /size-table -->