mdat 0.8.1 → 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/readme/rules/utilities/cli-help/parsers/index.d.ts

@@ -33,8 +33,8 @@ export type ProgramInfo = {
     subcommandName?: string;
 };
 declare const _default: {
-    meow: typeof helpStringToObjectMeow;
     yargs: typeof helpStringToObjectYargs;
+    meow: typeof helpStringToObjectMeow;
 };
 export default _default;
 export declare function getCommandParts(wholeCommand: string | undefined): {

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.8.1",
+  "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",
@@ -39,46 +39,48 @@
   ],
   "dependencies": {
     "@clack/prompts": "^0.7.0",
-    "@kitschpatrol/tldraw-cli": "^4.6.22",
+    "@kitschpatrol/tldraw-cli": "^4.6.28",
     "@types/mdast": "^4.0.4",
     "@types/node": "18.19.0",
     "@types/unist": "^3.0.3",
     "@types/yargs": "^17.0.33",
     "cosmiconfig": "^9.0.0",
-    "cosmiconfig-typescript-loader": "^6.0.0",
-    "execa": "^9.5.1",
+    "cosmiconfig-typescript-loader": "^6.1.0",
+    "execa": "^9.5.2",
     "globby": "^14.0.2",
     "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.8.1",
-    "chalk": "^5.3.0",
+    "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.8",
+    "nanoid": "^5.0.9",
     "package-up": "^5.0.0",
     "path-type": "^6.0.0",
     "pkg-dir": "^8.0.0",
     "plur": "^5.1.0",
     "pretty-bytes": "^6.1.1",
-    "pretty-ms": "^9.1.0",
+    "pretty-ms": "^9.2.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.0",
-    "remark-mdat": "^0.7.4",
     "to-vfile": "^8.0.0",
-    "tsup": "^8.3.5",
-    "type-fest": "^4.26.1",
-    "typescript": "^5.6.3",
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
     "untildify": "^5.0.0",
-    "vfile": "^6.0.3",
-    "vitest": "^2.1.4",
+    "vitest": "^2.1.8",
     "yargs": "^17.7.2",
-    "zod": "^3.23.8"
+    "zod": "^3.24.1"
   },
   "publishConfig": {
     "access": "public"

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.
@@ -601,6 +602,32 @@ TypeScript or JavaScript with JSDoc annotations are recommended for the most fle
 
 `mdat` also allows arbitrary JSON files to be loaded as rule sets, flattening them so any value may be accessed by using a dot-notation key path as a comment keyword.
 
+#### Configuration in package.json
+
+"Shared" configurations can be specified in `package.json` as a special case by passing a string that can be resolved to a module which default-exports an `mdat` `Config` type object. For example, in your `package.json`:
+
+```json
+{
+  "mdat": "@kitschpatrol/mdat-config"
+}
+```
+
+Though a string is not technically a valid `mdat` `Config` object, it is detected as a special case which loads the `Config` object exported from the `@kitschpatrol/mdat-config` module.
+
+Rules may also be defined directly in `package.json`, but of course only static replacements are supported. For programmatic rules, you will need to create a JavaScript or TypeScript configuration file.
+
+For example, the following configuration in your `package.json` will expand `<!-- what -->` comments:
+
+```json
+{
+  "mdat": {
+    "rules": {
+      "what": "hath god wrought"
+    }
+  }
+}
+```
+
 #### Configuration file format
 
 The `mdat` configuration file is a record object allowing you to customize aspects of the comment expansion process, and also optionally define expansion rules as well under the `rules` key:
@@ -619,7 +646,11 @@ type Config = {
 
 A valid configuration file default-exports an object conforming to the above type.
 
-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 `.mdatrc.ts` file in the root of my projects.
+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
 
@@ -714,8 +745,8 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
   | File         | Original | Gzip    | Brotli |
   | ------------ | -------- | ------- | ------ |
-  | package.json | 2.5 kB   | 1.1 kB  | 978 B  |
-  | readme.md    | 56.1 kB  | 10.9 kB | 8.7 kB |
+  | package.json | 2.6 kB   | 1.2 kB  | 1 kB   |
+  | readme.md    | 57.4 kB  | 11.4 kB | 9.1 kB |
 
   <!-- /size-table -->
 
@@ -830,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)