Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add task-tags & ignore-overlong-task-comments settings #1654

Merged
merged 4 commits into from Jan 5, 2023

Conversation

charliermarsh
Copy link
Owner

This is a revert and re-application of #1550, to preserve the individual commit messages.

charliermarsh and others added 4 commits January 4, 2023 23:26
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>
@charliermarsh
Copy link
Owner Author

\cc @not-my-profile

@charliermarsh charliermarsh merged commit 53e3dd8 into main Jan 5, 2023
6 checks passed
@charliermarsh charliermarsh deleted the charlie/revert branch January 5, 2023 04:54
renovate bot added a commit to ixm-one/pytest-cmake-presets that referenced this pull request Jan 6, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](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` |
[![age](https://badges.renovateapi.com/packages/pypi/ruff/0.0.212/age-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://badges.renovateapi.com/packages/pypi/ruff/0.0.212/adoption-slim)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://badges.renovateapi.com/packages/pypi/ruff/0.0.212/compatibility-slim/0.0.211)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://badges.renovateapi.com/packages/pypi/ruff/0.0.212/confidence-slim/0.0.211)](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
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[charliermarsh/ruff#1654
- Stop highlighting --help output in README as shell by
[@&#8203;not-my-profile](https://togithub.com/not-my-profile) in
[charliermarsh/ruff#1655
- Add proc-macro to derive `CheckCodePrefix` by
[@&#8203;messense](https://togithub.com/messense) in
[charliermarsh/ruff#1656
- \[`flake8-bandit`] Add Rule for `S324` (Insecure hash functions in
`hashlib`) by [@&#8203;saadmk11](https://togithub.com/saadmk11) in
[charliermarsh/ruff#1661
- Avoid false-positives for yields with non-identical references by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[charliermarsh/ruff#1665
- \[`flake8-bandit`] Add Rule for `S506` (unsafe use of yaml load) by
[@&#8203;saadmk11](https://togithub.com/saadmk11) in
[charliermarsh/ruff#1664
- Fix flake8-import-conventions configuration examples by
[@&#8203;diego-pm](https://togithub.com/diego-pm) in
[charliermarsh/ruff#1660
- Allow overhang in Google-style docstring arguments by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[charliermarsh/ruff#1668
- Fix some `&String`, `&Option`, and `&Vec` usages by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[charliermarsh/ruff#1670
- Improve Pandas call and attribute detection by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[charliermarsh/ruff#1671
- Implement duplicate isinstance detection (SIM101) by
[@&#8203;charliermarsh](https://togithub.com/charliermarsh) in
[charliermarsh/ruff#1673
- Replace \&String with \&str in AnnotatedImport::ImportFrom by
[@&#8203;andersk](https://togithub.com/andersk) in
[charliermarsh/ruff#1674
- Simplify Option<String> → Option<\&str> conversion using as_deref by
[@&#8203;andersk](https://togithub.com/andersk) in
[charliermarsh/ruff#1675
- Remove an unneeded .to_string() in tokenize_files_to_codes_mapping by
[@&#8203;andersk](https://togithub.com/andersk) in
[charliermarsh/ruff#1676

#### New Contributors

- [@&#8203;diego-pm](https://togithub.com/diego-pm) made their first
contribution in
[charliermarsh/ruff#1660

**Full Changelog**:
charliermarsh/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>
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.

None yet

2 participants