mdat 0.9.0 → 0.10.0

package/dist/processors.d.ts

@@ -1,11 +1,12 @@
 import { type Root } from 'mdast';
 import { VFile } from 'vfile';
 import { type ConfigLoaded, type ConfigToLoad, type loadConfig, type RulesToLoad } from './config';
+import { type AmbientRemarkConfig } from './utilities';
 type Loader = typeof loadConfig;
 type ProcessorGetter = typeof getCleanProcessor | typeof getExpandProcessor;
 export declare function processFiles(files: string | string[], loader: Loader, processorGetter: ProcessorGetter, name?: string, output?: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile[]>;
 export declare function processString(markdown: string, loader: Loader, processorGetter: ProcessorGetter, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>;
-export declare function getExpandProcessor(options: ConfigLoaded): import("unified").Processor<Root, undefined, undefined, Root, string>;
-export declare function getCleanProcessor(options: ConfigLoaded): import("unified").Processor<Root, undefined, undefined, Root, string>;
-export declare function getCheckProcessor(options: ConfigLoaded): import("unified").Processor<Root, undefined, undefined, Root, string>;
+export declare function getExpandProcessor(options: ConfigLoaded, ambientRemarkConfig: AmbientRemarkConfig): import("unified").Processor<Root, undefined, undefined, Root, string>;
+export declare function getCleanProcessor(options: ConfigLoaded, ambientRemarkConfig: AmbientRemarkConfig): import("unified").Processor<Root, undefined, undefined, Root, string>;
+export declare function getCheckProcessor(options: ConfigLoaded, ambientRemarkConfig: AmbientRemarkConfig): import("unified").Processor<Root, undefined, undefined, Root, string>;
 export {};

package/dist/utilities.d.ts

@@ -1,3 +1,5 @@
+import { type ConfigResult as AmbientRemarkConfig } from 'unified-engine';
+export { type ConfigResult as AmbientRemarkConfig } from 'unified-engine';
 export declare function getInputOutputPaths(inputs: string[], output: string | undefined, name: string | undefined, extension: string | undefined): Array<{
     input: string;
     name: string;
@@ -11,3 +13,4 @@ export declare function getInputOutputPath(input: string, output: string | undef
 export declare function expandPath(file: string): string;
 export declare function findPackage(): Promise<string | undefined>;
 export declare function ensureArray<T>(value: T | T[] | undefined): T[];
+export declare function loadAmbientRemarkConfig(): Promise<AmbientRemarkConfig>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "type": "module",
   "description": "CLI tool and 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.",
   "repository": "github:kitschpatrol/mdat",
@@ -51,17 +51,19 @@
     "read-pkg": "^9.0.1",
     "remark-mdat": "^0.7.5",
     "type-fest": "^4.33.0",
+    "unified-engine": "^11.2.2",
     "vfile": "^6.0.3",
     "which": "^5.0.0"
   },
   "devDependencies": {
     "@kitschpatrol/shared-config": "^4.7.12",
     "@types/which": "^3.0.4",
-    "bumpp": "^9.10.1",
+    "bumpp": "^10.0.1",
     "chalk": "^5.4.1",
     "chevrotain": "^11.0.3",
     "find-up": "^7.0.0",
     "is-executable": "^2.0.1",
+    "mdast-util-to-markdown": "^2.1.2",
     "mdast-util-toc": "^7.1.0",
     "nanoid": "^5.0.9",
     "package-up": "^5.0.0",
@@ -73,7 +75,7 @@
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.0",
     "to-vfile": "^8.0.0",
-    "tsup": "^8.3.5",
+    "tsup": "^8.3.6",
     "typescript": "^5.7.3",
     "untildify": "^5.0.0",
     "vitest": "^2.1.8",

package/readme.md

@@ -216,7 +216,8 @@ As [noted below](#similar-projects), there are several similar projects out ther
 
 ## Usage
 
-> \[!WARNING]\
+> [!WARNING]
+>
 > **The MDAT CLI tool directly manipulates the contents of readme files, in close (and perhaps dangerous) proximity to your painstakingly crafted words.**
 >
 > Please make sure any text you care about is committed before running `mdat`, and never directly modify content inside of the comment expansion blocks.
@@ -647,6 +648,10 @@ A valid configuration file default-exports an object conforming to the above typ
 
 The configuration file may be located in any location supported by [cosmicconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#searchplaces). I use an `mdat.config.ts` file in the root of my projects.
 
+> [!NOTE]
+>
+> The `mdat` commands _also_ search for and merge any ambient Remark `.remarkrc` configuration files you might have in your project. This is unrelated to the `mdat` rule configuration files, but it _can_ have an affect how Markdown is validated and rendered by `mdat`.
+
 #### Rule file format
 
 Rules may also be defined in separate files that default-export a record of rules. The record keys become the keywords used to reference a rule from your comments in Markdown.
@@ -738,10 +743,10 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
   <!-- size-table { files: ["package.json", "readme.md"] } -->
 
-  | File         | Original | Gzip   | Brotli |
-  | ------------ | -------- | ------ | ------ |
-  | package.json | 2.5 kB   | 1.1 kB | 996 B  |
-  | readme.md    | 22.8 kB  | 8.2 kB | 6.8 kB |
+  | File         | Original | Gzip    | Brotli |
+  | ------------ | -------- | ------- | ------ |
+  | package.json | 2.6 kB   | 1.2 kB  | 1 kB   |
+  | readme.md    | 57.4 kB  | 11.4 kB | 9.1 kB |
 
   <!-- /size-table -->
 
@@ -856,6 +861,10 @@ Recommended workflow integration approach:
 
 - Invoke via hooks / GitHub actions?
 
+Architectural improvements:
+
+- Use [unified-engine](https://github.com/unifiedjs/unified-engine) to handle file loading and transformation.
+
 ## Maintainers
 
 [@kitschpatrol](https://github.com/kitschpatrol)