| name | normalize-style |
| description | 記事本文のですます調をだ・である調に統一し、textlint で確認する。文体エラーを修正するときに使用する。 |
| argument-hint | [ファイルパス] |
| disable-model-invocation | true |
文体の統一
記事本文のですます調をだ・である調に統一する。
使い方
/normalize-style [ファイルパス]
ファイルパスを省略した場合は、pnpm lint の結果から文体エラーのあるファイルを自動検出する。
手順
以下の手順を順番通りにすべて実施すること。
ステップ 1: 対象ファイルの確定
引数 $ARGUMENTS にファイルパスが指定されている場合はそれを対象とする。
指定がない場合は以下のコマンドで文体エラーのあるファイルを取得する。
pnpm textlint docs/ 2>&1 \
| awk '/^\/.*\.md$/{file=$0} /no-mix-dearu-desumasu/{print file}' \
| sort -u
対象ファイルが存在しない場合はその旨を伝えて終了する。
複数ファイルが対象の場合は 1 ファイルずつ処理する。
ステップ 2: 対象ファイルの確認
対象ファイルを Read ツールで読み込む。
以下のコマンドで当該ファイルの文体エラー箇所を確認する。
pnpm textlint "<対象ファイル>" 2>&1 | grep -A3 "no-mix-dearu-desumasu"
ステップ 3: ですます調の修正
対象ファイルの本文中にあるですます調をだ・である調に変換する。
対象: 本文・箇条書き(-, *, 数字リスト)。見出し(#)は体言止めが自然なため変更しない。
箇条書きのですます調はだ・である調に変換する。体言止めに変換できる場合はそちらがより自然。
変換の基本方針:
| ですます調 | だ・である調 |
|---|
| 〜します | 〜する |
| 〜があります | 〜がある |
| 〜できます | 〜できる |
| 〜してください | 〜すること / 〜する |
| 〜ください | 〜こと |
| 〜ません | 〜ない |
| 〜でしょう | 〜だろう |
| 〜ましょう | 〜する |
| 〜ですので | 〜のため / 〜なので |
| 〜ですが | 〜だが / 〜が |
| 〜です。 | 〜である。 / 〜だ。 |
注意事項:
- 固有名詞・引用・コード例の中にあるですます表現はそのまま残す
- UI のラベル名や画面に表示される文字列の引用はそのまま残す(例:
「完了しました」というポップアップ の引用部分)
- 変換後の文章が自然かどうかを確認する
pnpm fix で自動修正されて不自然になった箇所は手動で修正する
ステップ 4: textlint による確認
pnpm fix
pnpm lint
エラーが残っている場合は内容を確認して手動修正する。
pnpm fix で文章が不自然になっていないか確認する(特に「。」置き換えによる不自然化)。
ステップ 5: 結果の報告
修正した箇所を列挙し、ユーザーに確認を求める。
承認を得たあとにコミットする。コミットメッセージは Conventional Commits に従い説明は日本語で記載する。
git add <対象ファイル>
git commit -m "fix(docs): <ファイル名の概要> の文体をだ・である調に統一"