astral-sh/ruff

TD003 error in regex or misleading error message

Open

#16,519 创建于 2025年3月5日

在 GitHub 查看
 (7 评论) (3 反应) (0 负责人)Rust (47,527 star) (2,088 fork)batch import
documentationhelp wantedrule

描述

Summary

Rule TD0003 ('Missing issue link for this TODO') allows for 4 different forms off issue link, however only explicit link and #123 works anywhere in the TODO comment, 123 and FOOBAR-1234 have to be put alone in the separate line.

  1. While it may be reasonable for digits alone version I think it would be much more convenient to search for FOOBAR-1234 form in the whole TODO comment.
  2. This difference in behavior is not stated anywhere clearly, nor in the error message neither in ruff docs (it can be only inferred form the examples) which is very confusing for the user.

Version

0.9.3

贡献者指南

技术栈
rustpython
领域
clideveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Ruff's TODO rule documentationBasic regex understanding
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Examine the ruff source code for rule TD0003, likely in crates/ruff linter/src/rules/todo.rs or similar. Review the existing regex patterns and error messages. Check the documentation at https://docs.astral.sh/ruff/rules/#TD0003. Discuss in the issue comments (e.g., maintainer feedback) to clarify the intended behavior. Consider updating both the error message and the documentation to clearly state the accepted formats.
TD003 error in regex or misleading error message · astral-sh/ruff#16519 | Good First Issue