Skip to content

Opinionated Pylint Checker for enforcing boolean variable naming

License

Notifications You must be signed in to change notification settings

rhyn0/pylint-boolean-naming

Repository files navigation

Pylint Boolean Naming Checker

This is a pylint Checker to enforce variables with boolean results include common phrases implying True/False states.

Inspiration taken from here
Came across this [issue](https://github.com/pylint-dev/pylint/issues/9409) and thought it would be cool to try and do it myself.

How to Use

Install the package and then add it to the pylint runtime plugins.

# assuming git cloning until PyPI publish
git clone ...
cd pylint-boolean-naming
pip install .

# inside your code base
pylint --load-plugins pylint-boolean-naming \
    ... # other commands

Code Quality

Use pre-commit for general code quality and as a CI checker. This has hooks for: - MyPy - Ruff - Poetry

Contributing

We welcome all forms of contributions such as updates for documentation, new code, checking issues for duplicates or telling us that we can close them, confirming that issues still exist, creating issues because you found a bug or want a feature, etc. Everything is much appreciated!

About

Opinionated Pylint Checker for enforcing boolean variable naming

Resources

License

Stars

Watchers

Forks

Languages