Skip to content

ruff format の対象から Markdown を外す - #15

Merged
ryuuji merged 1 commit into
masterfrom
chore/ruff-format-exclude-md
Aug 14, 2026
Merged

ruff format の対象から Markdown を外す#15
ryuuji merged 1 commit into
masterfrom
chore/ruff-format-exclude-md

Conversation

@ryuuji

@ryuuji ryuuji commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

ruff format の対象から Markdown を外します。#28 に入れ損ねた小さな追い足しです。

なぜ

ruff format は Markdown 内の Python コードブロックも既定で整形対象にします。 これは今回まで気づいていませんでした。

一方で ruff check は Markdown を見ません.md を直接渡すと No Python files found under the given path(s) を返します。lint はしないのに format はする、という非対称になっています。

このリポジトリの README.mdCLAUDE.md のコードブロックは bash だけなので今は差分が出ませんが、Python のコード例を1つ足しただけで ruff format --check . が落ちる状態でした。ドキュメントを直したら CI が赤くなる、という壊れ方をします。

実際に別のリポジトリ(unitrad-moon-age)では、CLAUDE.md に書かれた設計メモの擬似コードが ruff format . で書き換えられました(48行削除・18行追加)。関数シグネチャの折り返しが1行に畳まれ、クォートが single に変わる、という変更です。設計メモの擬似コードを整形する意味はありません。

変更

[tool.ruff.format]
quote-style = "single"
exclude = ["*.md"]

これで ruff format の対象が5ファイル(.py 3 + .md 2)から**3ファイル(.py のみ)**になります。

CLAUDE.md の Lint の節にも一行書き足しました。

確認

uv sync --locked --group lint  → Checked 20 packages
uv run ruff check .            → All checks passed!
uv run ruff format --check .   → 3 files already formatted

関連

同じ変更を ndc-dev/api と unitrad-moon-age にも入れています。

Todoist: Python の lint を ruff に統一する(5リポジトリ)

🤖 Generated with Claude Code

https://claude.ai/code/session_01BsERiWbzZwB6EdGoyyqcpT

ruff format は Markdown 内の Python コードブロックも既定で整形対象にする。
このリポジトリの README には Python のコード例が無いので今は差分が出ないが、
1つ足しただけで CI が落ちる状態だった。

ruff check のほうは Markdown を見ない("No Python files found" を返す)ので、
lint と format のスコープを揃える意味もある。

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BsERiWbzZwB6EdGoyyqcpT
@ryuuji
ryuuji merged commit 9b40b8a into master Aug 14, 2026
4 checks passed
@ryuuji
ryuuji deleted the chore/ruff-format-exclude-md branch August 14, 2026 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant