@envsa/mdat-config

MDAT configuration for @envsa/shared-config.

Overview

It's a shared MDAT (Markdown Autophagic Template) system config, plus a command-line tool envsa-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 @envsa/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 @envsa/shared-config, which also automatically invokes the command line functionality in this package via its envsa command

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 mdat.config.ts file to your project root, and add any customizations you'd like:

   pnpm exec envsa-mdat 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": "envsa-mdat lint",
    "fix": "envsa-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 mdat.config.ts file.

Configuration

To create a mdat.config.ts in your project root:

pnpm exec envsa-mdat init

(Note that this will delete the mdat property in your package.json!)

Or

To create a mdat property in package.json:

pnpm exec envsa-mdat init --location package

(Note that this will delete the mdat.config.ts file in your project root!)

CLI

Command: envsa-mdat

Envsa's Mdat shared configuration tools.

This section lists top-level commands for envsa-mdat.

Usage:

envsa-mdat <command>

| 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-h | Show help | boolean | | --version-v | Show version number | boolean |

See the sections below for more information on each subcommand.

Subcommand: envsa-mdat init

Initialize by copying starter config files to your project root or to your package.json file.

Usage:

envsa-mdat init

| Option | Description | Type | Default | | ------------------- | ------------------- | -------------------- | -------- | | --location | TK | "file" "package" | "file" | | --help-h | Show help | boolean | | | --version-v | Show version number | boolean | |

Subcommand: envsa-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:

envsa-mdat lint

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

Subcommand: envsa-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:

envsa-mdat fix

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

Subcommand: envsa-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:

envsa-mdat print-config

| Option | Description | Type | | ------------------- | ------------------- | --------- | | --help-h | Show help | boolean | | --version-v | Show version number | boolean |

Credits

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

License

MIT © Liam Rella