@envsa/mdat-config

MDAT configuration for @envsa/shared-config.

Overview

It's a shared MDAT (Markdown Autophagic Template) system config.

See @envsa/shared-config for the recommended single-package approach.

Setup

To use just mdat-config in isolation:

1. Install the .npmrc in your project root. This is required for correct PNPM behavior:

   pnpm dlx @envsa/repo-config --init

2. Add the package:

   pnpm add -D @envsa/mdat-config

3. Add the starter .mdatrc.ts file to your project root, and add any customizations you'd like:

   pnpm exec mdat-config --init

Usage

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:

"scripts": {
  "lint": "mdat-config --check"
  "format": "mdat-config --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.

CLI

Command: mdat-config

MDAT configuration for @envsa/shared-config.

Usage:

mdat-config [<file|glob> ...]

| Option | Argument | Description | | ------------------------ | -------- | ---------------------------------------------------------------- | | --check-c | | Check for and report issues. Same as mdat-config. | | --fix-f | | Fix all auto-fixable issues, and report the un-fixable. | | --init-i | | Initialize by copying starter config files to your project root. | | --print-config-p | <path> | Print the effective configuration at a certain path. | | --help-h | | Print this help info. | | --version-v | | Print the package version. |

Credits

Eric Mika is the author of the original @kitschpatrol/shared-config project on which this is based.

License

MIT © Liam Rella