@kitschpatrol/remark-config

Markdown and MDX linting for @kitschpatrol/shared-config.

Overview

It's a shared Remark config for linting Markdown and MDX files, plus a command-line tool kpi-remark to streamline project initialization. Note that linting and fixing is provided separately through @kitschpatrol/eslint-config.

[!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 kpi command

Setup

To use just this Remark config in isolation:

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

   pnpm dlx @kitschpatrol/repo-config init

2. Add the package:

   pnpm add -D @kitschpatrol/remark-config

3. Add the starter .remarkrc.js and files to your project root, and add any customizations you'd like:

   pnpm exec kpi-remark init

Usage

The Remark binary should be picked up automatically by VS Code plugins.

You can call it directly, but it's recommended to use the kpi script bundled with the @kitschpatrol/shared-config instead to invoke the Remark lint rules through ESLint. The eslint-mdx plugin is used to bridge these rules into ESLint and the VS Code ESLint plugin.

If you really want to call it directly, you can integrate a command to the underlying remark CLI tool with your package.json scripts as you see fit, for example:

{
  "scripts": {
    "lint": "pnpm remark . --quiet --frail"
  }
}

CLI

Command: kpi-remark

Kitschpatrol's Remark and Remark Lint shared configuration tools. (Actual linting and fixing is managed through @kitschpatrol/eslint-config.)

This section lists top-level commands for kpi-remark.

Usage:

kpi-remark <command>

| Command | Description | | -------------- | ------------------------------------------------------------------------------------------------------------- | | init | Initialize by copying starter config files to your project root or to your package.json file. | | print-config | Print the effective Remark configuration. Package-scoped. Searches up to the root of a monorepo if necessary. |

| 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: kpi-remark init

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

Usage:

kpi-remark init

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

Subcommand: kpi-remark print-config

Print the effective Remark configuration. Package-scoped. Searches up to the root of a monorepo if necessary.

Usage:

kpi-remark print-config

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

Configuration

Avoiding errors in non-git projects

The remark-validate-links looks for a git remote to validate relative link paths.

If your project is not a git repository, you will receive warning from remark via eslint:

Command failed: git remote -v
fatal: not a git repository (or any of the parent directories): .git
eslint(undefined-undefined)

To fix this, pass the repository: false option in your .remarkrc.js file:

// .remarkrc.js
import sharedConfig, { overrideRules } from '@kitschpatrol/remark-config'

const localConfig = {
  ...sharedConfig,
  plugins: overrideRules(sharedConfig.plugins, [['remarkValidateLinks', { repository: false }]]),
}

export default localConfig

License

MIT © Eric Mika