https://github.com/orsinium-labs/flake8-todos

Lint TODO comments in a Python code
https://github.com/orsinium-labs/flake8-todos

code-quality flake8 flake8-plugin linter python qa todo

Last synced: about 2 months ago
JSON representation

Lint TODO comments in a Python code

• Host: GitHub
• URL: https://github.com/orsinium-labs/flake8-todos
• Owner: orsinium-labs
• License: bsd-3-clause
• Created: 2020-11-11T10:49:21.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-02-09T08:50:39.000Z (5 months ago)
• Last Synced: 2024-05-10T01:02:55.256Z (about 2 months ago)
• Topics: code-quality, flake8, flake8-plugin, linter, python, qa, todo
• Language: Python
• Homepage:
• Size: 26.4 KB
• Stars: 26
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-flake8-extensions - flake8-todos - Lint TODO comments to be consistent and have an issue linked. (Comments)

README

        
# flake8-todos

Plugin for [flake8](http://flake8.pycqa.org/en/latest/) linter to check TODOs in the project.

Good:

```python

# TODO(gram): check performance

# https://github.com/orsinium-labs/flake8-todos/issues/1337

```

Bad:

```python

# FIXME idk how it works lol

```

Checks:

+ **T001**: use TODO instead of FIXME (or BUG) for consistency.

+ **T002**: add author into TODO ([motivation](https://dave.cheney.net/practical-go/presentations/qcon-china.html#_dont_comment_bad_code_rewrite_it)).

+ **T003**: add link on issue into TODO.

+ **T004**: missed colon in TODO.

+ **T005**: missed text in TODO.

+ **T006**: write TODO instead of ToDo (use upper case).

+ **T007**: missed space after colon in TODO.

## Installation

```bash

python3 -m pip install --user flake8-todos

```

## Usage

Check that plugin was added in your flake8:

```bash

$ python3 -m flake8 --version

3.7.7 (flake8-todos: 1.0.0, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1) CPython 3.6.7 on Linux

```

If you don't see `flake8-todos` in the previous command output, check that `flake8` and `flake8-todos` is installed in the same interpreter.

If everything is OK, run `flake8`:

```bash

python -m flake8 example.py

```

## License

+ The content of this repository contains a public fork of flake8-todos developed by [EclecticIQ B.V.](https://github.com/eclecticiq). Release 0.1.2 of the package was licensed under BSD 3-Clause License. File [LICENSE](LICENSE) contains the original license file.

+ The fork is distributed under the same license and conditions.

+ Release 0.1.2, all earlier releases, and corresponding source code are licensed under copyright "2019 EclecticIQ".

+ All the later changes and distributions starting from 0.1.4 inclusively are licensed under copyright "2020 Gram ".

+ Both copyrights are included in releases of the fork since it contains changes from both parties.

The fork was created to provide source code, distributions, and maintenance for the project.