Add task-tags & ignore-overlong-task-comments settings #1654
+0
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit ca48492.
Programmers often leave comments to themselves and others such as:
# TODO: Use a faster algorithm?
The keywords used to prefix such comments are just a convention and vary
from project to project. Other common keywords include FIXME and HACK.
The keywords in use for the codebase are of interest to ruff because
ruff does also lint comments. For example the ERA lint detects
commented-out code but ignores comments starting with such a keyword.
Previously the ERA lint simply hardcoded the regular expression
TODO|FIXME|XXX to achieve that. This commit introduces a new `task-tags`
setting to make this configurable (and to allow other comment lints to
recognize the same set of keywords).
The term "task tags" has probably been popularized by the Eclipse
IDE.[1] For Python there has been the proposal PEP 350[2], which
referred to such keywords as "codetags". That proposal however has been
rejected. We are choosing the term "task tags" over "code tags" because
the former is more descriptive: a task tag describes a task.
While according to the PEP 350 such keywords are also sometimes used for
non-tasks e.g. NOBUG to describe a well-known problem that will never be
addressed due to design problems or domain limitations, such keywords
are so rare that we are neglecting them here in favor of more
descriptive terminology. The vast majority of such keywords does
describe tasks, so naming the setting "task-tags" is apt.
[1]: https://www.eclipse.org/pdt/help/html/task_tags.htm
[2]: https://peps.python.org/pep-0350/
Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
This step is split up into a separate commit so that the following commit has a cleaner diff.
Imagine a .py file containing the following comment:
# TODO: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
# do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Since `git grep` only matches individual lines `git grep TODO` would
only output the first line of the comment, cutting off potentially
important information. (git grep currently doesn't support multiline
grepping). Projects using such a workflow therefore probably format
the comment in a single line instead:
# TODO: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
This commit introduces a setting to accomdate this workflow by making
the line-length checks (`E501`) optionally ignore overlong lines
if they start with a recognized task tag.
Co-authored-by: Charlie Marsh <charlie.r.marsh@gmail.com>
|
\cc @not-my-profile |
renovate bot
referenced
this pull request
in ixm-one/pytest-cmake-presets
Jan 6, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://togithub.com/charliermarsh/ruff) | `^0.0.211` -> `^0.0.212` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.212`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.212) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.211...v0.0.212) #### What's Changed - Add task-tags & ignore-overlong-task-comments settings by [@​charliermarsh](https://togithub.com/charliermarsh) in [https://github.com/charliermarsh/ruff/pull/1654](https://togithub.com/charliermarsh/ruff/pull/1654) - Stop highlighting --help output in README as shell by [@​not-my-profile](https://togithub.com/not-my-profile) in [https://github.com/charliermarsh/ruff/pull/1655](https://togithub.com/charliermarsh/ruff/pull/1655) - Add proc-macro to derive `CheckCodePrefix` by [@​messense](https://togithub.com/messense) in [https://github.com/charliermarsh/ruff/pull/1656](https://togithub.com/charliermarsh/ruff/pull/1656) - \[`flake8-bandit`] Add Rule for `S324` (Insecure hash functions in `hashlib`) by [@​saadmk11](https://togithub.com/saadmk11) in [https://github.com/charliermarsh/ruff/pull/1661](https://togithub.com/charliermarsh/ruff/pull/1661) - Avoid false-positives for yields with non-identical references by [@​charliermarsh](https://togithub.com/charliermarsh) in [https://github.com/charliermarsh/ruff/pull/1665](https://togithub.com/charliermarsh/ruff/pull/1665) - \[`flake8-bandit`] Add Rule for `S506` (unsafe use of yaml load) by [@​saadmk11](https://togithub.com/saadmk11) in [https://github.com/charliermarsh/ruff/pull/1664](https://togithub.com/charliermarsh/ruff/pull/1664) - Fix flake8-import-conventions configuration examples by [@​diego-pm](https://togithub.com/diego-pm) in [https://github.com/charliermarsh/ruff/pull/1660](https://togithub.com/charliermarsh/ruff/pull/1660) - Allow overhang in Google-style docstring arguments by [@​charliermarsh](https://togithub.com/charliermarsh) in [https://github.com/charliermarsh/ruff/pull/1668](https://togithub.com/charliermarsh/ruff/pull/1668) - Fix some `&String`, `&Option`, and `&Vec` usages by [@​charliermarsh](https://togithub.com/charliermarsh) in [https://github.com/charliermarsh/ruff/pull/1670](https://togithub.com/charliermarsh/ruff/pull/1670) - Improve Pandas call and attribute detection by [@​charliermarsh](https://togithub.com/charliermarsh) in [https://github.com/charliermarsh/ruff/pull/1671](https://togithub.com/charliermarsh/ruff/pull/1671) - Implement duplicate isinstance detection (SIM101) by [@​charliermarsh](https://togithub.com/charliermarsh) in [https://github.com/charliermarsh/ruff/pull/1673](https://togithub.com/charliermarsh/ruff/pull/1673) - Replace \&String with \&str in AnnotatedImport::ImportFrom by [@​andersk](https://togithub.com/andersk) in [https://github.com/charliermarsh/ruff/pull/1674](https://togithub.com/charliermarsh/ruff/pull/1674) - Simplify Option<String> → Option<\&str> conversion using as_deref by [@​andersk](https://togithub.com/andersk) in [https://github.com/charliermarsh/ruff/pull/1675](https://togithub.com/charliermarsh/ruff/pull/1675) - Remove an unneeded .to_string() in tokenize_files_to_codes_mapping by [@​andersk](https://togithub.com/andersk) in [https://github.com/charliermarsh/ruff/pull/1676](https://togithub.com/charliermarsh/ruff/pull/1676) #### New Contributors - [@​diego-pm](https://togithub.com/diego-pm) made their first contribution in [https://github.com/charliermarsh/ruff/pull/1660](https://togithub.com/charliermarsh/ruff/pull/1660) **Full Changelog**: astral-sh/ruff@v0.0.211...v0.0.212 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/ixm-one/pytest-cmake-presets). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC44MS4wIiwidXBkYXRlZEluVmVyIjoiMzQuODEuMCJ9--> Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a revert and re-application of #1550, to preserve the individual commit messages.