mdat 1.3.4 → 1.3.5

package/readme.md

@@ -98,7 +98,7 @@ In this case, according to a set of rules defined in an external configuration f
 
 ### Dependencies
 
-The `mdat` CLI tool and API requires Node 18+ (specifically `^18.19.0 || >=20.5.0`). The exported APIs for expanding Markdown text and documents are. `mdat` is implemented in TypeScript and bundles a complete set of type definitions.
+The `mdat` CLI tool and API requires Node 20+ (specifically `>=20.19.0`). `mdat` is implemented in TypeScript and bundles a complete set of type definitions.
 
 ### Installation
 
@@ -278,7 +278,7 @@ mdat expand <files..> [options]
 | `--meta`<br>`-m`    | Embed an extra comment at the top of the generated Markdown warning editors that certain sections of the document have been generated dynamically. Can be a `boolean` to enable/disable the default message, or a `string` to provide a custom message. Defaults to `false` for `mdat` commands and `true` for `mdat readme` commands. |           |                                                                               |
 | `--prefix`          | Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-MDAT comments in your Markdown file, or if you're willing to trade some verbosity for safety.                                                                                                                            | `string`  |                                                                               |
 | `--print`           | Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.                                                                                                                                                                                                                            | `boolean` |                                                                               |
-| `--verbose`         | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
+| `--verbose`         | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
 | `--help`<br>`-h`    | Show help                                                                                                                                                                                                                                                                                                                              | `boolean` |                                                                               |
 | `--version`<br>`-v` | Show version number                                                                                                                                                                                                                                                                                                                    | `boolean` |                                                                               |
 
@@ -302,7 +302,7 @@ mdat check <files..> [options]
 | `--rules`<br>`-r`   | Path(s) to files containing MDAT comment expansion rules.                                                                                                                                                                                                                                                                              | `array`   |                                                                               |
 | `--meta`<br>`-m`    | Embed an extra comment at the top of the generated Markdown warning editors that certain sections of the document have been generated dynamically. Can be a `boolean` to enable/disable the default message, or a `string` to provide a custom message. Defaults to `false` for `mdat` commands and `true` for `mdat readme` commands. |           |                                                                               |
 | `--prefix`          | Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-MDAT comments in your Markdown file, or if you're willing to trade some verbosity for safety.                                                                                                                            | `string`  |                                                                               |
-| `--verbose`         | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
+| `--verbose`         | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
 | `--help`<br>`-h`    | Show help                                                                                                                                                                                                                                                                                                                              | `boolean` |                                                                               |
 | `--version`<br>`-v` | Show version number                                                                                                                                                                                                                                                                                                                    | `boolean` |                                                                               |
 
@@ -327,7 +327,7 @@ mdat collapse <files..> [options]
 | `--name`<br>`-n`    | Output file name.                                                                                                                                                                                           | `string`  | Same name as input file. Overwrites the input file.                           |
 | `--prefix`          | Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-MDAT comments in your Markdown file, or if you're willing to trade some verbosity for safety. | `string`  |                                                                               |
 | `--print`           | Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.                                                                                                 | `boolean` |                                                                               |
-| `--verbose`         | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.                                                                               | `boolean` |                                                                               |
+| `--verbose`         | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.                                                                               | `boolean` |                                                                               |
 | `--help`<br>`-h`    | Show help                                                                                                                                                                                                   | `boolean` |                                                                               |
 | `--version`<br>`-v` | Show version number                                                                                                                                                                                         | `boolean` |                                                                               |
 
@@ -379,7 +379,7 @@ mdat readme expand [files..] [options]
 | `--prefix`          | Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-MDAT comments in your Markdown file, or if you're willing to trade some verbosity for safety.                                                                                                                            | `string`  |                                                                               |
 | `--meta`<br>`-m`    | Embed an extra comment at the top of the generated Markdown warning editors that certain sections of the document have been generated dynamically. Can be a `boolean` to enable/disable the default message, or a `string` to provide a custom message. Defaults to `false` for `mdat` commands and `true` for `mdat readme` commands. |           |                                                                               |
 | `--print`           | Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.                                                                                                                                                                                                                            | `boolean` |                                                                               |
-| `--verbose`         | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
+| `--verbose`         | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
 | `--help`<br>`-h`    | Show help                                                                                                                                                                                                                                                                                                                              | `boolean` |                                                                               |
 | `--version`<br>`-v` | Show version number                                                                                                                                                                                                                                                                                                                    | `boolean` |                                                                               |
 
@@ -405,7 +405,7 @@ mdat readme check [files..] [options]
 | `--assets`          | Path to find and save readme-related assets.                                                                                                                                                                                                                                                                                           | `string`  | `./assets`                                                                    |
 | `--prefix`          | Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-MDAT comments in your Markdown file, or if you're willing to trade some verbosity for safety.                                                                                                                            | `string`  |                                                                               |
 | `--meta`<br>`-m`    | Embed an extra comment at the top of the generated Markdown warning editors that certain sections of the document have been generated dynamically. Can be a `boolean` to enable/disable the default message, or a `string` to provide a custom message. Defaults to `false` for `mdat` commands and `true` for `mdat readme` commands. |           |                                                                               |
-| `--verbose`         | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
+| `--verbose`         | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                          | `boolean` |                                                                               |
 | `--help`<br>`-h`    | Show help                                                                                                                                                                                                                                                                                                                              | `boolean` |                                                                               |
 | `--version`<br>`-v` | Show version number                                                                                                                                                                                                                                                                                                                    | `boolean` |                                                                               |
 
@@ -430,7 +430,7 @@ mdat readme collapse [files..] [options]
 | `--print`           | Print the expanded Markdown to stdout instead of saving to a file. Ignores `--output` and `--name` options.                                                                                                 | `boolean` |                                                                               |
 | `--config`          | Path(s) to files containing MDAT configuration.                                                                                                                                                             | `array`   | Configuration is loaded if found from the usual places, or defaults are used. |
 | `--prefix`          | Require a string prefix before all comments to be considered for expansion. Useful if you have a bunch of non-MDAT comments in your Markdown file, or if you're willing to trade some verbosity for safety. | `string`  |                                                                               |
-| `--verbose`         | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.                                                                               | `boolean` |                                                                               |
+| `--verbose`         | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.                                                                               | `boolean` |                                                                               |
 | `--help`<br>`-h`    | Show help                                                                                                                                                                                                   | `boolean` |                                                                               |
 | `--version`<br>`-v` | Show version number                                                                                                                                                                                         | `boolean` |                                                                               |
 
@@ -452,7 +452,7 @@ mdat readme init [options]
 | `--expand`<br>`-e`      | Automatically run `mdat readme` immediately after creating the readme template.                                                                                                                                                                                                                                                         | `boolean`                                                          | `true`                                                   |
 | `--template`<br>`-t`    | Specify a template to use for the new readme.                                                                                                                                                                                                                                                                                           | `"MDAT Readme"` `"Standard Readme Basic"` `"Standard Readme Full"` | `"MDAT Readme"`                                          |
 | `--compound`<br>`-c`    | Use compound comment version of the template to replace several individual comment placeholders where possible. This combines things like `<!-- title -->`, `<!-- badges -->`, etc. in a single `<!-- header -->` comment. It's less clutter when you're editing, but it's also less explicit. The final readme.md output is identical. | `boolean`                                                          | `true`                                                   |
-| `--verbose`             | Enable verbose logging. All verbose logs and prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                           | `boolean`                                                          |                                                          |
+| `--verbose`             | Enable verbose logging. All verbose logs are prefixed with their log level and are printed to stderr for ease of redirection.                                                                                                                                                                                                           | `boolean`                                                          |                                                          |
 | `--help`<br>`-h`        | Show help                                                                                                                                                                                                                                                                                                                               | `boolean`                                                          |                                                          |
 | `--version`<br>`-v`     | Show version number                                                                                                                                                                                                                                                                                                                     | `boolean`                                                          |                                                          |
 
@@ -483,13 +483,13 @@ mdat *.md
 A number of option flags are exposed on the CLI. Any values set here will override both ambient configuration files and any configuration file referenced passed as options:
 
 ```sh
-mdat  --prefix 'mm-
+mdat --prefix 'mm-'
 ```
 
 ##### Custom configuration file
 
 ```sh
-mdat  --config 'custom-config.ts"
+mdat --config 'custom-config.ts'
 ```
 
 ##### Rule sets
@@ -540,7 +540,7 @@ Highlights include:
 function expandString(markdown: string, config?: ConfigToLoad, rules?: RulesToLoad): Promise<VFile>
 ```
 
-Takes a string of Markdown and returns. Note that the returned object is a [VFile](https://github.com/vfile), which includes both the post-conversion Markdown content and additional metadata about the conversion.
+Takes a string of Markdown and returns a [VFile](https://github.com/vfile), which includes both the post-conversion Markdown content and additional metadata about the conversion.
 
 To get the Markdown content, simply call `.toString()` on the returned VFile object.
 
@@ -650,7 +650,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 `mdat.config.ts` file in the root of my projects.
+The configuration file may be located in any location supported by [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig?tab=readme-ov-file#searchplaces). I use an `mdat.config.ts` file in the root of my projects.
 
 > [!NOTE]
 >
@@ -687,7 +687,7 @@ Some notes on the type:
 
 Since it's a record, multiple rules may be combined in single rules file.
 
-If multiple configuration and rule files are loaded, they are merged. CLI options take precedence over ambient configuration discovered by cosmicconfig, and where multiple configuration or rule files are provided, with the "last" rule of a particular key takes precedence.
+If multiple configuration and rule files are loaded, they are merged. CLI options take precedence over ambient configuration discovered by cosmiconfig, and where multiple configuration or rule files are provided, the "last" rule of a particular key takes precedence.
 
 ### Creating custom rules
 
@@ -749,7 +749,7 @@ See the [Examples section](https://github.com/kitschpatrol/remark-mdat#examples)
 
   | File         | Original | Gzip    | Brotli |
   | ------------ | -------- | ------- | ------ |
-  | package.json | 2.4 kB   | 1.1 kB  | 965 B  |
+  | package.json | 2.7 kB   | 1.1 kB  | 1 kB   |
   | readme.md    | 64 kB    | 11.6 kB | 9.3 kB |
 
   <!-- /size-table -->
@@ -916,6 +916,9 @@ This has been done several times before:
 
 - lillallol's [md-in-place](https://www.npmjs.com/package/md-in-place)
 
+- [AutoMD](https://automd.unjs.io/)\
+  Extremely similar functionality to mdat, with the project initiated around the same time I was initially writing mdat. I didn't find the project until a few years later. Ships in the night.
+
 ### Implementation notes
 
 This project was split from a monorepo containing both `mdat` and `remark-mdat` into separate repos in July 2024.