mdat 0.8.1 → 0.9.0

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "0.8.1",
+  "version": "0.9.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,46 @@
   ],
   "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",
+    "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": "^9.10.1",
+    "chalk": "^5.4.1",
     "chevrotain": "^11.0.3",
     "find-up": "^7.0.0",
     "is-executable": "^2.0.1",
     "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",
+    "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

@@ -601,6 +601,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 +645,7 @@ 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.
 
 #### Rule file format
 
@@ -712,10 +738,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  | 978 B  |
-  | readme.md    | 56.1 kB  | 10.9 kB | 8.7 kB |
+  | 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 |
 
   <!-- /size-table -->