https://github.com/tommilligan/flake8-fixme
Check for FIXME, TODO and other temporary developer notes.
https://github.com/tommilligan/flake8-fixme
Last synced: 22 days ago
JSON representation
Check for FIXME, TODO and other temporary developer notes.
- Host: GitHub
- URL: https://github.com/tommilligan/flake8-fixme
- Owner: tommilligan
- License: apache-2.0
- Created: 2019-03-14T11:30:06.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-02-08T01:50:36.000Z (about 2 years ago)
- Last Synced: 2025-04-09T12:48:30.021Z (27 days ago)
- Language: Python
- Homepage: https://pypi.org/project/flake8-fixme/
- Size: 336 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-flake8-extensions - flake8-fixme - Check for FIXME, TODO and other temporary developer notes. (Comments)
README
# flake8-fixme
[](https://pypi.python.org/pypi/flake8-fixme)
[](https://pypi.python.org/pypi/flake8-fixme)
[](https://codecov.io/gh/tommilligan/flake8-fixme/branch/master)
[](https://circleci.com/gh/tommilligan/flake8-fixme)
Check for FIXME, TODO and other temporary developer notes.
This module provides a plugin for `flake8`, the Python code checker.
> This module was inspired by [flake8-todo](https://github.com/schlamar/flake8-todo)
## Installation
Install with pip:
```bash
pip install flake8-fixme
```
The plugin officially supports Python `>= 3.6` and `flake8 >= 3.7`.
You may find other Python 3 versions work as well.
## Usage
The plugin finds temporary comments you may not want to commit:
```python
def my_function():
# FIXME actual implementation here!
pass
```
```log
./my_file.py:2:7: T100 Fixme found (FIXME)
```
Each word has a seperate warning so you can adjust your workflow. We like to allow committing `TODO`s, but deny committing `FIXME`s.
## Changelog
### 1.1.1
#### Enhancements
- update `setup.py` metadata to match other parts of the repo
### 1.1.0
#### Features
- lint the word `HACK`
### 1.0.2
#### Enhancements
- development pipeline now runs integration tests with flake8, for
- locally built package (all builds)
- package downloaded from pypi (after version release)
### 1.0.1
#### Bugfixes
- fixed pypi packaging not picking up source files
- fixed setup.py not loading markdown readme correctly
### 1.0.0
#### Breaking changes
Upgrading to `flake8-fixme` from `flake8-todo` has the following breaking changes:
- error codes have been changed as follows:
- `T100`: line contains `FIXME`
- `T101`: line contains `TODO`
- `T102`: line contains `XXX`
- a line containing multiple words will raise an error for each word
- drop support for Python `2.7`