mdat 0.7.5 → 0.8.0

package/dist/readme/rules/index.d.ts

@@ -17,6 +17,12 @@ declare const _default: {
         content(options: import("type-fest").JsonValue, tree: import("mdast").Root): Promise<string>;
         order: number;
     };
+    'size-table': {
+        content(options: import("type-fest").JsonValue): Promise<string>;
+    };
+    size: {
+        content(options: import("type-fest").JsonValue): Promise<string>;
+    };
     'short-description': {
         content(): Promise<string>;
         order: number;

package/dist/readme/rules/size-table.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    'size-table': {
+        content(options: import("type-fest").JsonValue): Promise<string>;
+    };
+};
+export default _default;

package/dist/readme/rules/size.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    size: {
+        content(options: import("type-fest").JsonValue): Promise<string>;
+    };
+};
+export default _default;

package/dist/readme/rules/utilities/size/size-report.d.ts

@@ -0,0 +1,19 @@
+type SizeInfo = {
+    bytes: number;
+    bytesPretty: string;
+    percent: number;
+    percentPretty: string;
+};
+export type SizeReport = {
+    brotli: SizeInfo;
+    gzip: SizeInfo;
+    original: SizeInfo;
+};
+/**
+ * Analyzes a file's size and its compressed sizes using Brotli and Gzip
+ * @param filePath - Path to the file to analyze
+ * @returns Promise containing detailed size report
+ * @throws Error if file cannot be read or compressed
+ */
+export declare function createSizeReport(filePath: string): Promise<SizeReport>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mdat",
-  "version": "0.7.5",
+  "version": "0.8.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,43 +39,44 @@
   ],
   "dependencies": {
     "@clack/prompts": "^0.7.0",
-    "@kitschpatrol/tldraw-cli": "^4.6.16",
+    "@kitschpatrol/tldraw-cli": "^4.6.22",
     "@types/mdast": "^4.0.4",
     "@types/node": "18.19.0",
     "@types/unist": "^3.0.3",
-    "@types/which": "^3.0.4",
     "@types/yargs": "^17.0.33",
     "cosmiconfig": "^9.0.0",
-    "cosmiconfig-typescript-loader": "^5.0.0",
-    "execa": "^9.3.1",
+    "cosmiconfig-typescript-loader": "^5.1.0",
+    "execa": "^9.5.1",
     "globby": "^14.0.2",
     "read-pkg": "^9.0.1",
-    "which": "^4.0.0"
+    "which": "^5.0.0"
   },
   "devDependencies": {
-    "@kitschpatrol/shared-config": "^4.7.9",
-    "bumpp": "^9.5.2",
+    "@kitschpatrol/shared-config": "^4.7.11",
+    "@types/which": "^3.0.4",
+    "bumpp": "^9.8.1",
     "chalk": "^5.3.0",
     "chevrotain": "^11.0.3",
     "find-up": "^7.0.0",
     "is-executable": "^2.0.1",
     "mdast-util-toc": "^7.1.0",
-    "nanoid": "^5.0.7",
+    "nanoid": "^5.0.8",
     "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",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.0",
-    "remark-mdat": "^0.7.2",
+    "remark-mdat": "^0.7.3",
     "to-vfile": "^8.0.0",
-    "tsup": "^8.2.4",
+    "tsup": "^8.3.5",
     "type-fest": "^4.26.1",
-    "typescript": "^5.6.2",
+    "typescript": "^5.6.3",
     "untildify": "^5.0.0",
     "vfile": "^6.0.3",
-    "vitest": "^2.1.1",
+    "vitest": "^2.1.4",
     "yargs": "^17.7.2",
     "zod": "^3.23.8"
   },

package/readme.md

@@ -190,7 +190,7 @@ As [noted below](#similar-projects), there are several similar projects out ther
    }
    ```
 
-   This scales all the way up to some of the [more](src/lib/readme/rules/table-of-contents.ts) [elaborate](src/lib/readme/rules/cli-help) rules found in the `mdat readme` subcommand.
+   This scales all the way up to some of the [more](src/lib/readme/rules/table-of-contents.ts) [elaborate](src/lib/readme/rules/cli-help.ts) rules found in the `mdat readme` subcommand.
 
    You can also treat any JSON file as a rule set. MDAT will flatten it to allow any dot-notated key path to become a placeholder comment keyword.
 
@@ -453,7 +453,7 @@ mdat readme init [options]
 
 <!-- /cli-help -->
 
-_Meta note: The entire section above was generated automatically by the [`<!-- cli-help -->`](src/lib/readme/rules/cli-help/index.ts) mdat expansion rule provided in `mdat readme` subcommand. It dynamically parses the output from `mdat --help` into a Markdown table, recursively calling `--help` on subcommands to build a tidy representation of the help output._
+_Meta note: The entire section above was generated automatically by the [`<!-- cli-help -->`](src/lib/readme/rules/cli-help.ts) mdat expansion rule provided in `mdat readme` subcommand. It dynamically parses the output from `mdat --help` into a Markdown table, recursively calling `--help` on subcommands to build a tidy representation of the help output._
 
 #### Examples
 
@@ -702,13 +702,30 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
   A quick way to embed a code block from elsewhere in your repository. Useful for examples.
 
+- ###### `<!-- size { file: "./package.json" } -->`
+
+  Embeds the size of a file or, optionally, its Brotli or Gzip compressed size.
+
+- ###### `<!-- size-table { files: ["package.json", "readme.md"] } -->`
+
+  Show a table of several file sizes, along with compressed sizes, for example:
+
+  <!-- size-table { files: ["package.json", "readme.md"] } -->
+
+  | File         | Original | Gzip    | Brotli |
+  | ------------ | -------- | ------- | ------ |
+  | package.json | 2.5 kB   | 1.1 kB  | 986 B  |
+  | readme.md    | 56.1 kB  | 10.9 kB | 8.7 kB |
+
+  <!-- /size-table -->
+
 - ###### `<!-- cli-help -->`
 
   Automatically transform a CLI command's `--help` output into nicely formatted Markdown tables. The rule also recursively calls `--help` on any subcommands found for inclusion in the output.
 
   Currently, the rule can only parse help output in the format provided by [Yargs](https://yargs.js.org)- and [Meow](https://github.com/sindresorhus/meow)-based tools. If parsing fails, the rule will fall back to show the raw help output in a regular code block.
 
-  ([Parsing help output](src/lib/readme/rules/cli-help/utilities/parsers) is a bit tricky. The [jc](https://github.com/kellyjonbrazil/jc) project is a heroic collection of output parsers, but does not currently implement help output parsing. It might be interesting to try to contribute mdat's help parsing implementations to jc.)
+  ([Parsing help output](src/lib/readme/rules/utilities/cli-help/parsers) is a bit tricky. The [jc](https://github.com/kellyjonbrazil/jc) project is a heroic collection of output parsers, but does not currently implement help output parsing. It might be interesting to try to contribute mdat's help parsing implementations to jc.)
 
   This rule is also aliased under the `<!-- cli -->` keyword.