はじめる

madr-lint は MADR（Markdown Architectural Decision Records）向けのリンターです。ADR の構造、ステータス値、 日付、ファイル名、そしてファイル間の整合性を検証します。

インストール

開発依存としてインストールします。

# npm
npm install --save-dev madr-lint

# pnpm
pnpm add -D madr-lint

# yarn
yarn add -D madr-lint

Node.js 22 以降が必要です。

インストールせずに実行することもできます。

npx madr-lint --help

設定ファイルをスキャフォールドする

最も手早く始める方法は init です。ADR ディレクトリ（docs/adr、 docs/decisions、doc/adr、adr、docs/architecture/decisions）、既存 ADR の主要な MADR バージョン、プロジェクトが TypeScript を使っているかどうかを 検出し、madr-lint:recommended を継承する設定ファイルを書き出します。

npx madr-lint init

init は非対話型です。すべての判断はファイルシステムのヒューリスティック またはフラグで決まるため、CI やパイプの中でも安全に実行できます。既存の設定 ファイルは上書きしません（置き換えるには --force を渡します）。また、検出 したディレクトリの初回 lint で違反が見つかった場合は、レガシーな負債が導入の 妨げにならないよう --update-baseline を案内します。--dir と --json に ついては CLI ガイド を参照してください。

最初の lint を実行する

デフォルトでは、madr-lint は adrDir として設定されたディレクトリ （デフォルト: docs/adr）を lint します。

npx madr-lint

または、明示的にファイルやディレクトリを指定することもできます。ディレクトリは .md ファイルを再帰的に検索します。

npx madr-lint docs/adr docs/decisions/0007-use-x.md

出力例:

docs/adr/0003-use-postgres.md
  error  madr/status-enum        Status "decided" is not one of: proposed,rejected,accepted,deprecated,superseded by ...
  error  madr/required-sections  Missing required section: "Consequences"

2 errors

推奨ルールを有効にする

初期状態では、ルールが設定されていない場合、CLI は madr-lint:recommended プリセットにフォールバックします。上記の npx madr-lint init はこれを明示的な 設定として書き出します。手で設定ファイルを作成する（そしてカスタマイズを始める） 場合は次のようにします。

madr-lint.config.ts

import { defineConfig } from 'madr-lint';

export default defineConfig({
  extends: ['madr-lint:recommended'],
  adrDir: 'docs/adr',
});

すべてのオプションについては 設定 を、ルールの完全な リファレンスについては ルール を参照してください。

終了コード

madr-lint は CI に適しています。

終了コード	意味
0	エラーなし。--max-warnings を設定している場合は警告数が上限以内
1	1 件以上の error 重大度の診断、または警告数が --max-warnings を超過
2	使用法または設定エラー（--max-warnings の値が不正、--config ファイルが存在しない、無効なルールオプション、未知の --format）

次のステップ

• 設定 — 設定ファイル、プリセット、ルールごとのオプション
• CLI — すべてのコマンドラインフラグ
• GitHub Action — CI での実行
• ルール — 各ルールがチェックする内容とそのオプション
• ルールの抑制 — インラインの madr-lint-disable コメント
• 既存リポジトリへの導入 — 既存の違反をベースライン化する