Flake8 plugin to check that every TODO, FIXME, QQ etc comment has a JIRA ID next to it.
Project description
Flake8 JIRA TODO Checker
Flake8 plugin to check that every TODO
, FIXME
, QQ
etc comment has a JIRA ID next to it.
In other words, this is valid:
def hacky_function():
# TODO ABC-123 Stop reticulating splines
...
But this would raise the new flake8 error JIR001
:
def hacky_function():
# TODO Stop reticulating splines
...
Configuration
jira-project-ids
A list of valid JIRA project IDs can be provided via the flag --jira-project-ids
or via the key jira-project-ids
in a flake8 configuration file, e.g
jira-project-ids = ABC,DEF
If no project IDs are provided then all TODOs will be rejected.
todo-synonyms
A list of words which will be treated like TODO can be provided via the flag --todo-synonyms
or via the key
todo-synonyms
in a flake8 configuration file. Defaults to:
todo-synonyms = TODO,FIX,QQ
Releasing
poetry run bump2version minor
git push && git push --tags
tox -e pypi
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flake8-jira-todo-checker-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dea96baf412f7bd91e9b4ee6378281afe4584eec283caea5fddb1a66c673d796 |
|
MD5 | 2d2e4b8a1f506fd57932bac60ccd29e1 |
|
BLAKE2b-256 | 1ea6eb57905c620398fd6c8b5e7af99cc911946c33b467a268979a7c68d2ad51 |
Hashes for flake8_jira_todo_checker-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f34c11867eff29d124030f647c2141cd26d3ff48bc9177ece0664b63decc7af2 |
|
MD5 | d07bfe0405a6534307651c8b498d380a |
|
BLAKE2b-256 | 1c6bd6062eeebf1aa965ff1228bfde624ec6c25dd1ffe4b60be65280f8b9e579 |