TODO Check in CI#682
Conversation
JackCrumpLeys
left a comment
JackCrumpLeys
left a comment
There was a problem hiding this comment.
just had some concerns about what code we are scanning
| paths = list(pathlib.Path(".").rglob("*")) | ||
|
|
||
| clean = True | ||
| for path in paths: |
There was a problem hiding this comment.
I know you are just starting but this will include code in target so be careful. We cannot copntroll TODO usage in code outside valence. I would stick to examples/*, src/*, crates/*, extractor/src/* and any stand alone files in . (like cargo.toml).
There was a problem hiding this comment.
Good point. Do you think it would be better to have a whitelist or blacklist for scanning?
There was a problem hiding this comment.
probably both (whitelist text files and skip checking things like json, while blacklisting certain dirs) idk tho if its worth going outside of just .rs files to cover some on the config files. for detecting comments most languages either have // or # so that should cover alot. the java is a little more complex as with the /* syntax
There was a problem hiding this comment.
In commit 5c8a13d I made it so that the script only searches these directories: .github assets benches crates examples extractor/src scripts src tools website. Is this good enough?
2 participants
Objective
Get people to make issues for every TODO so that they are well defined, accessible, and in a central location.
Solution
Add a CI check for TODOs that do not reference a Github issue.