review-md スキル
Markdown 記事の誤字脱字チェックと textlint による校正を行うスキルです。
使い方
/review-md <ファイル名>
例: /review-md a.md または /review-md a
引数
<ファイル名>: チェック対象のファイル名(必須)。articles/配下を自動で検索する
ファイル解決
対象ファイルは常に articles/ ディレクトリ配下から検索する。以下の順序で解決を試みる。
articles/配下で指定されたファイル名に完全一致するファイルを Glob で検索する(例:articles/**/a.md)- 見つからない場合、拡張子
.mdを付与して再検索する(例:articles/**/a.md) - それでも見つからない場合、部分一致で検索する(例:
articles/**/*a*.md) - 候補が複数ある場合はユーザーに選択を求める
- 候補が0件の場合はエラーを報告して終了する
重要: 検索は指定されたファイル名に対してのみ行う。articles/ 配下の全ファイル一覧を列挙してはならない
実行手順
- 上記のファイル解決手順で対象ファイルを特定する
- 対象ファイルを読み込む
- 以下の観点で誤字脱字をチェックする
- 日本語の誤字・脱字(漢字の誤変換、送り仮名の誤りなど)
- 英単語のスペルミス(技術用語を含む)
- 固有名詞の表記ミス
mise x -- pnpm textlint <ファイルパス>を実行して校正ルール違反を検出する- 検出した問題を一覧で報告する
- 誤字・スペルミスの一覧(行番号、修正前、修正後)
- textlint の指摘事項一覧
- ユーザーに修正を適用するか確認する
- 承認された場合、以下の順序で修正を適用する
mise x -- pnpm textlint --fix <ファイルパス>で自動修正可能な項目を修正- textlint の自動修正で意図しない変換が発生していないか確認し、あれば修正する(例: パッケージ名内の単語が誤って大文字化されるケース)
- 手動修正が必要な項目(誤字、長文分割、弱い表現など)を個別に修正
- 最後に
mise x -- pnpm textlint <ファイルパス>を再実行してエラーが0件であることを確認する
注意事項
- 対象ファイルは必ず引数で明示的に指定すること
- 修正の適用前に必ずユーザーに確認を取ること