MDAT configuration for @kitschpatrol/shared-config.
npm install @kitschpatrol/mdat-config
MDAT configuration for @kitschpatrol/shared-config.
It's a shared MDAT (Markdown Autophagic Template) system config, plus a command-line tool ksc-mdat to perform mdat-related project initialization, linting, and fixing.
> [!IMPORTANT]
>
> You can use this package on its own, but it's recommended to use @kitschpatrol/shared-config instead for a single-dependency and single-package approach to linting and fixing your project.
>
> This package is included as a dependency in @kitschpatrol/shared-config, which also automatically invokes the command line functionality in this package via its ksc command
To use just mdat-config in isolation:
1. Install the basic repository configuration files in your project root. This is required for correct PNPM behavior:
``sh`
pnpm --package=@kitschpatrol/repo-config dlx ksc-repo init
2. Add the package:
`sh`
pnpm add -D @kitschpatrol/mdat-config
3. Add the starter .mdatrc.ts file to your project root, and add any customizations you'd like:
`sh`
pnpm exec ksc-mdat init
The mdat binary is specified as a peer dependency, and should be installed up automatically by PNPM.
You can call it directly, or use the script bundled with the config.
Integrate with your package.json scripts as you see fit, for example:
`json`
{
"scripts": {
"lint": "ksc-mdat lint",
"fix": "ksc-mdat fix"
}
}
"Fix" in this case is a slight misnomer for consistency with the other shared-config tools.
It runs mdat readme expand to expand placeholder comments in your readme.md using the bundled mdat readme expansion rules, plus custom rules provided by mdat-config's mdat.config.ts file, plus any additional rules specified in the repository-specific .mdatrc.ts file.
To create a mdat.config.ts in your project root:
`sh`
pnpm exec ksc-mdat init
(Note that this will delete the mdat property in your package.json!)
_Or_
To create a mdat property in package.json:
`sh`
pnpm exec ksc-mdat init --location package
(Note that this will delete the mdat.config.ts file in your project root!)
#### Command: ksc-mdat
Kitschpatrol's Mdat shared configuration tools.
This section lists top-level commands for ksc-mdat.
Usage:
`txt`
ksc-mdat
| Command | Description |
| -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| init | Initialize by copying starter config files to your project root or to your package.json file. |lint
| | Validate that all Mdat content placeholders in your readme.md file(s) have been expanded. Package-scoped. In a monorepo, it will also run in all packages below the current working directory. |fix
| | Expand all Mdat content placeholders in your readme.md file(s). Package-scoped. In a monorepo, it will also run in all packages below the current working directory. |print-config
| | Print the effective Mdat configuration. Package-scoped.. Searches up to the root of a monorepo if necessary.. Includes configuration provided by the mdat readme command. |
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| --help | Show help | boolean |--version
| | Show version number | boolean |
_See the sections below for more information on each subcommand._
#### Subcommand: ksc-mdat init
Initialize by copying starter config files to your project root or to your package.json file.
Usage:
`txt`
ksc-mdat init
| Option | Description | Type | Default |
| ------------------- | ------------------- | -------------------- | -------- |
| --location | TK | "file" "package" | "file" |--help
| | Show help | boolean | |--version
| | Show version number | boolean | |
#### Subcommand: ksc-mdat lint
Validate that all Mdat content placeholders in your readme.md file(s) have been expanded. Package-scoped. In a monorepo, it will also run in all packages below the current working directory.
Usage:
`txt`
ksc-mdat lint
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| --help | Show help | boolean |--version
| | Show version number | boolean |
#### Subcommand: ksc-mdat fix
Expand all Mdat content placeholders in your readme.md file(s). Package-scoped. In a monorepo, it will also run in all packages below the current working directory.
Usage:
`txt`
ksc-mdat fix
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| --help | Show help | boolean |--version
| | Show version number | boolean |
#### Subcommand: ksc-mdat print-config
Print the effective Mdat configuration. Package-scoped.. Searches up to the root of a monorepo if necessary.. Includes configuration provided by the mdat readme command.
Usage:
`txt`
ksc-mdat print-config
| Option | Description | Type |
| ------------------- | ------------------- | --------- |
| --help | Show help | boolean |--version
| | Show version number | boolean` |
MIT © Eric Mika