markdownlint

Markdownlint

パッケージマネージャーの検出

操作を始める前に、プロジェクトで使用しているパッケージマネージャーを検出します。

1. ロックファイルを確認します。

   • pnpm-lock.yaml → pnpm を使用します
   • yarn.lock → yarn を使用します
   • package-lock.json → npm を使用します
   • bun.lockb → bun を使用します

2. package.json の packageManager フィールドを確認します。

   "packageManager": "[email protected]"
   

3. 手掛かりが見つからない場合は、希望するパッケージマネージャーをユーザーに尋ねます。

このスキル全体を通して、コマンドでは例として pnpm を使用します。検出したパッケージマネージャーに置き換えてください。

• pnpm add -D → npm install --save-dev / yarn add -D / bun add -d
• pnpm run → npm run / yarn run / bun run
• pnpm install → npm install / yarn install / bun install

操作の選択ガイド

依頼された作業に対応するリファレンスを読みます。

操作	リファレンス
インストール、設定ファイル、スクリプト、検証手順	セットアップ
ルール名、コード、オプション、ルールの有効化または無効化	ルール
無視するファイル、フォルダー、パターン、チェック対象からの除外	無視設定
違反の診断、自動修正、残りの手動修正	修正
スクリプト、フック、CI、エディターとの統合	統合
ファイルの欠落、フックの失敗、インストールエラー、パフォーマンスの問題	トラブルシューティング

複数の操作にまたがる依頼の場合は、まずメインのリファレンスを読み、セットアップを完了して検証するために必要な関連リファレンスを読みます。

クイックリファレンス：よく使うコマンド

# Install
pnpm add -D markdownlint markdownlint-cli

# Run linting
pnpm run lint:markdown

# Auto-fix issues
vpx markdownlint '**/*.md' --fix

# Lint specific file
vpx markdownlint README.md

# Lint specific directory
vpx markdownlint 'docs/**/*.md'

クイックリファレンス：設定ファイルの基本

プロジェクトルートの .markdownlint.yaml：

$schema: ./node_modules/markdownlint/schema/markdownlint-config-schema.json

# Disable a rule
line-length: false

# Enable a rule
no-duplicate-heading: true

# Configure a rule
heading-style:
  style: "atx"

プロジェクトルートの .markdownlintignore（gitignore 構文）：

node_modules
dist/
build/
CHANGELOG.md

デフォルト設定の方針

markdownlint のセットアップでは、次の推奨デフォルト設定を使用します。

$schema: ./node_modules/markdownlint/schema/markdownlint-config-schema.json

line-length: false # Modern editors handle wrapping

標準ルールは有効のままにし、このデフォルト設定では line-length を無効にしてください。理由は次のとおりです。

• 最新のエディターやビューアーはテキストの折り返しを自動で処理します
• 行の長さを固定すると、ほとんどのプロジェクトで不要な制約が生じます
• 表示上の問題より、意味上の問題を検出する方が有益です

ユーザーから依頼された場合、またはプロジェクトで確立された要件に応じて、その他のルールをカスタマイズします。