comment-one-sentence-per-line

コメントを 1 行 1 文にし、単純なブロックコメントを 1 行化し、必要に応じて文末の句読点を要求します。

• ルール ID: tai-kun/comment-one-sentence-per-line
• 自動修正: 一部（行の結合と単純なブロックコメントの 1 行化）

複数行にまたがる文を検出して 1 行に結合します。JSDoc タグのない単純なブロックコメント（1 文だけの /** */）は 1 行にまとめます。requireEndPunctuation を有効にすると、散文コメントの最終行に 。 や . などの句読点がない場合も報告します。: や ： で終わる行は文末として扱います。

設定

このルールを有効にするには、vite.config.ts の lint.rules に追加します。

"tai-kun/comment-one-sentence-per-line": ["error", { requireEndPunctuation: true }],

オプション

例

違反例

// これは文の途中で
// 改行されています

/**
 * これは文です。
 */

修正後

// これは文の途中で改行されています。

/** これは文です。 */

注意

• ディレクティブ、JSDoc タグ、リスト、コード、コードフェンス、@example は対象外です。
• : や ： で終わる行（ラベル行など）は文末として扱い、次の行と結合しません。
• JSDoc タグのない単純なブロックコメントは、1 文だけの場合に /** ... */ の 1 行へまとめます。複数文のコメントや空行を含むコメントは対象外です。
• 行の結合とブロックコメントの 1 行化は自動修正されますが、文末の句読点は自動では追加されません。
• requireEndPunctuation の既定値は false です。

関連ルール

• spaced-comment
• comment-japanese-spacing