Implement flake8_todos

[evanrittenhouse]

Completes #3870

Will be able to easily clear #3859 when this lands as well.

[github-actions]

PR Check Results

Ecosystem

✅ ecosystem check detected no changes.

Benchmark

Linux

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.01     16.7±0.39ms     2.4 MB/sec    1.00     16.5±0.27ms     2.5 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.01      4.0±0.03ms     4.1 MB/sec    1.00      4.0±0.04ms     4.2 MB/sec
linter/all-rules/numpy/globals.py          1.00    489.6±5.34µs     6.0 MB/sec    1.00    489.5±3.05µs     6.0 MB/sec
linter/all-rules/pydantic/types.py         1.00      6.9±0.06ms     3.7 MB/sec    1.00      6.8±0.08ms     3.7 MB/sec
linter/default-rules/large/dataset.py      1.00      8.0±0.05ms     5.1 MB/sec    1.00      8.0±0.09ms     5.1 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.02  1730.9±42.19µs     9.6 MB/sec    1.00  1704.6±15.47µs     9.8 MB/sec
linter/default-rules/numpy/globals.py      1.02   201.4±16.07µs    14.7 MB/sec    1.00    198.3±6.31µs    14.9 MB/sec
linter/default-rules/pydantic/types.py     1.01      3.6±0.02ms     7.0 MB/sec    1.00      3.6±0.04ms     7.1 MB/sec
parser/large/dataset.py                    1.00      6.4±0.03ms     6.3 MB/sec    1.00      6.4±0.05ms     6.3 MB/sec
parser/numpy/ctypeslib.py                  1.00  1247.8±11.91µs    13.3 MB/sec    1.01   1256.3±4.22µs    13.3 MB/sec
parser/numpy/globals.py                    1.05    132.1±3.26µs    22.3 MB/sec    1.00    125.5±1.78µs    23.5 MB/sec
parser/pydantic/types.py                   1.00      2.7±0.02ms     9.3 MB/sec    1.00      2.7±0.02ms     9.3 MB/sec

Windows

group                                      main                                   pr
-----                                      ----                                   --
linter/all-rules/large/dataset.py          1.00     17.0±0.23ms     2.4 MB/sec    1.00     17.0±0.23ms     2.4 MB/sec
linter/all-rules/numpy/ctypeslib.py        1.00      4.3±0.07ms     3.9 MB/sec    1.00      4.3±0.04ms     3.9 MB/sec
linter/all-rules/numpy/globals.py          1.00    499.7±8.84µs     5.9 MB/sec    1.00   502.2±17.98µs     5.9 MB/sec
linter/all-rules/pydantic/types.py         1.00      7.1±0.10ms     3.6 MB/sec    1.02      7.2±0.13ms     3.5 MB/sec
linter/default-rules/large/dataset.py      1.00      8.3±0.08ms     4.9 MB/sec    1.01      8.4±0.10ms     4.9 MB/sec
linter/default-rules/numpy/ctypeslib.py    1.00  1782.8±30.13µs     9.3 MB/sec    1.00  1779.4±39.27µs     9.4 MB/sec
linter/default-rules/numpy/globals.py      1.00    195.3±3.56µs    15.1 MB/sec    1.04    203.2±9.25µs    14.5 MB/sec
linter/default-rules/pydantic/types.py     1.00      3.8±0.04ms     6.8 MB/sec    1.01      3.8±0.05ms     6.7 MB/sec
parser/large/dataset.py                    1.01      6.7±0.05ms     6.0 MB/sec    1.00      6.7±0.06ms     6.1 MB/sec
parser/numpy/ctypeslib.py                  1.00  1291.7±25.15µs    12.9 MB/sec    1.00  1285.8±27.40µs    13.0 MB/sec
parser/numpy/globals.py                    1.00    130.9±2.78µs    22.5 MB/sec    1.00    130.5±2.24µs    22.6 MB/sec
parser/pydantic/types.py                   1.00      2.9±0.04ms     8.8 MB/sec    1.00      2.9±0.06ms     8.9 MB/sec

[evanrittenhouse]

@charliermarsh Would you prefer I implement TDO003 in this PR as well, or do we allow partial implementation of plugins?

[charliermarsh]

Partial is cool, I just haven't had time to sit down and dig in on this one yet.

[evanrittenhouse]

Sorry, didn't mean to rush you at all! Just the first time I've tried implementing a plugin, so wasn't sure how we handle that. Please take your time

[evanrittenhouse]

No idea why these errors are happening - will take a closer look in a bit

E: had to bump the ruleset

[evanrittenhouse]

Re-marking as draft to fix an edge case and clean up the code a little bit

[evanrittenhouse]

Sorry for the false starts. I believe this is good to go now

[evanrittenhouse]

I'm not super sure why those tests are failing - it seems like they're referencing the old snapshots which no longer exist, but I already removed them so I'm not even really sure why they're being referenced

[JonathanPlasse]

These snapshots must be deleted.

/home/runner/work/ruff/ruff/crates/ruff/src/rules/flake8_todo/snapshots/ruff__rules__flake8_todo__tests__invalid-capitalization-in-todo_TDO006.py.snap
  /home/runner/work/ruff/ruff/crates/ruff/src/rules/flake8_todo/snapshots/ruff__rules__flake8_todo__tests__missing-colon-in-todo_TDO004.py.snap
  /home/runner/work/ruff/ruff/crates/ruff/src/rules/flake8_todo/snapshots/ruff__rules__flake8_todo__tests__missing-author-in-todo_TDO002.py.snap
  /home/runner/work/ruff/ruff/crates/ruff/src/rules/flake8_todo/snapshots/ruff__rules__flake8_todo__tests__missing-text-in-todo_TDO005.py.snap
  /home/runner/work/ruff/ruff/crates/ruff/src/rules/flake8_todo/snapshots/ruff__rules__flake8_todo__tests__invalid-todo-tag_TDO001.py.snap
  /home/runner/work/ruff/ruff/crates/ruff/src/rules/flake8_todo/snapshots/ruff__rules__flake8_todo__tests__missing-space-after-colon-in-todo_TDO007.py.snap
  /home/runner/work/ruff/ruff/crates/ruff/src/rules/flake8_todo/snapshots/ruff__rules__flake8_todo__tests__missing-link-in-todo_TDO003.py.snap

[JonathanPlasse]

You can do this automatically by running

cargo insta test --all --all-features --delete-unreferenced-snapshots

[charliermarsh]

Gonna do one pass over the docs then merge.

[charliermarsh]

There is one bug here, whereby links aren't detected in multiline comments, i.e., this is a false positive:

# TODO: here's a TODO on the last line with no link
# Here's more content.
# TDO-3870