mdat 0.6.16 → 0.7.0

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "mdat",
-  "version": "0.6.16",
+  "version": "0.7.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": {
     "type": "git",
-    "url": "git@github.com:kitschpatrol/mdat.git",
-    "directory": "packages/mdat"
+    "url": "git@github.com:kitschpatrol/mdat.git"
   },
+  "homepage": "https://github.com/kitschpatrol/mdat",
   "bugs": {
     "url": "https://github.com/kitschpatrol/mdat/issues",
     "email": "eric@ericmika.com"
@@ -36,27 +36,31 @@
     "mdat",
     "markdown",
     "template",
+    "readme",
     "comments",
     "docs-generator",
     "docs",
-    "cli"
+    "cli",
+    "npm-package"
   ],
   "dependencies": {
     "@clack/prompts": "^0.7.0",
     "@kitschpatrol/tldraw-cli": "^4.5.4",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^20.14.1",
+    "@types/node": "^20.14.2",
     "@types/unist": "^3.0.2",
     "@types/which": "^3.0.4",
     "@types/yargs": "^17.0.32",
     "cosmiconfig": "^9.0.0",
     "cosmiconfig-typescript-loader": "^5.0.0",
-    "execa": "^9.1.0",
+    "execa": "^9.2.0",
     "globby": "^14.0.1",
     "read-pkg": "^9.0.1",
     "which": "^4.0.0"
   },
   "devDependencies": {
+    "@kitschpatrol/shared-config": "^4.6.7",
+    "bumpp": "^9.4.1",
     "chalk": "^5.3.0",
     "chevrotain": "^11.0.3",
     "find-up": "^7.0.0",
@@ -70,25 +74,27 @@
     "pretty-ms": "^9.0.0",
     "remark": "^15.0.1",
     "remark-gfm": "^4.0.0",
+    "remark-mdat": "^0.7.0",
     "to-vfile": "^8.0.0",
     "tsup": "^8.1.0",
-    "type-fest": "^4.19.0",
+    "type-fest": "^4.20.0",
     "typescript": "^5.4.5",
     "untildify": "^5.0.0",
     "vfile": "^6.0.1",
     "vitest": "^1.6.0",
     "yargs": "^17.7.2",
-    "zod": "^3.23.8",
-    "remark-mdat": "0.6.16"
+    "zod": "^3.23.8"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "build": "tsup && tsc -p tsconfig.build.lib.json",
+    "clean": "git clean -fdX && rm ./pnpm-lock.yaml",
     "dev": "pnpm run test",
-    "mdat": "./bin/cli.js readme --config ../../.mdatrc.ts",
-    "pretest": "pnpm run build",
+    "fix": "pnpm shared-config --fix",
+    "lint": "pnpm shared-config --lint",
+    "release": "pnpm bumpp --commit 'Release: %s' --tag 'v%s' && pnpm build && pnpm publish --otp $(op read 'op://Personal/Npmjs/one-time password?attribute=otp')",
     "test": "vitest --no-file-parallelism"
   }
 }

package/readme.md

@@ -1,15 +1,23 @@
 <!--+ Warning: Content inside HTML comment blocks was generated by mdat and may be overwritten. +-->
 
-<!-- header -->
+<!-- title -->
 
 # mdat
 
+<!-- /title -->
+
+<!-- badges -->
+
 [![NPM Package mdat](https://img.shields.io/npm/v/mdat.svg)](https://npmjs.com/package/mdat)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
+<!-- /badges -->
+
+<!-- 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.**
 
-<!-- /header -->
+<!-- /description -->
 
 <!-- table-of-contents -->
 
@@ -29,6 +37,7 @@
 - [Background](#background)
   - [Motivation](#motivation)
   - [Similar projects](#similar-projects)
+  - [Implementation notes](#implementation-notes)
 - [The future](#the-future)
 - [Maintainers](#maintainers)
 - [Acknowledgments](#acknowledgments)
@@ -85,20 +94,20 @@ In this case, according to a set of rules defined in an external configuration f
 
 ### Dependencies
 
-The `mdat` CLI tool requires Node 16+. The exported APIs for expanding Markdown text and documents are ESM-only and share the Node 16+ requirement. `mdat` is implemented in TypeScript and bundles a complete set of type definitions.
+The `mdat` CLI tool requires Node 18+. The exported APIs for expanding Markdown text and documents are ESM-only and share the Node 18+ requirement. `mdat` is implemented in TypeScript and bundles a complete set of type definitions.
 
 ### Installation
 
 Install locally to access the CLI commands in a single project or to import the provided APIs:
 
 ```sh
-npm install remark-mdat
+npm install mdat
 ```
 
 Or, install globally for access across your system:
 
 ```sh
-npm install --global remark-mdat
+npm install --global mdat
 ```
 
 ## Features
@@ -578,7 +587,7 @@ function loadConfig(options?: {
 }): Promise<ConfigLoaded> // returns a single merged config object
 ```
 
-This is provided for more advanced use cases. It assists in discovering and loading ambient configuration in your project (e.g. fields in your package.json, or dedicated `mdat` config files). It also dynamically loads, validates, and merges additional `mdat` configuration and rule files into a final `ConfigLoaded` object ready to be passed into the [`remark-mdat`](../remark-mdat/readme.md) plugin or one of the API functions like `expandFile()`.
+This is provided for more advanced use cases. It assists in discovering and loading ambient configuration in your project (e.g. fields in your package.json, or dedicated `mdat` config files). It also dynamically loads, validates, and merges additional `mdat` configuration and rule files into a final `ConfigLoaded` object ready to be passed into the [`remark-mdat`](https://github.com/kitschpatorl/remark-mdat) plugin or one of the API functions like `expandFile()`.
 
 #### Examples
 
@@ -649,7 +658,7 @@ If multiple configuration and rule files are loaded, they are merged. CLI option
 
 The underlying rule expansion system is flexible and easy to extend.
 
-See the [Examples section](../remark-mdat/readme.md#examples) of the `remark-mdat` readme, or take a look at the implementation of the [rules provided through the `mdat readme` subcommand](./src/lib/readme/rules/) for more complex examples.
+See the [Examples section](https://github.com/kitschpatrol/remark-mdat/readme.md#examples) of the `remark-mdat` readme, or take a look at the implementation of the [rules provided through the `mdat readme` subcommand](./src/lib/readme/rules/) for more complex examples.
 
 ### The `mdat readme` subcommand
 
@@ -699,7 +708,7 @@ See the [Examples section](../remark-mdat/readme.md#examples) of the `remark-mda
 
   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](https://github.com/kitschpatrol/mdat/tree/main/packages/mdat/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](https://github.com/kitschpatrol/mdat/tree/main/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.)
 
   This rule is also aliased under the `<!-- cli -->` keyword.
 
@@ -745,7 +754,7 @@ The `init` command provides a number of "starter readme" templates incorporating
 
 - ##### MDAT Readme
 
-  The house style. An expansive starting point. Prune to your context and taste. The readme files in this monorepo started from this template.
+  The house style. An expansive starting point. Prune to your context and taste. The readme file in this repo was started from this template.
 
 - ##### Standard Readme basic
 
@@ -782,6 +791,10 @@ This has been done several times before:
 
 - lillallol's [md-in-place](https://www.npmjs.com/package/md-in-place)
 
+### Implementation notes
+
+This project was split from a monorepo containing both `mdat` and `remark-mdat` into separate repos in July 2024.
+
 ## The future
 
 Additional rules: