Fixit is a Python Lint Framework based on LibCST. It comes with useful default lint rules for coding convention, performance and security issues. It makes custom lint rule easy to build, test and configure. It empowers lint rule to provide autofix to fix the issues for developers. It also provide tools to run autofix across codebase to fix existing issues and automatically insert lint-fixme comments to silent existing violation. Fixit integrates with Flake8 and it adds the above mentioned enhancements to it.
… image:: docs/_static/logo/logo.svg
:width: 600 px
:alt: Fixit
|readthedocs-badge| |pypi-badge| |changelog-badge| |roadmap-badge| |license-badge|
… |readthedocs-badge| image:: https://readthedocs.org/projects/pip/badge/?version=latest&style=flat
:target: https://fixit.readthedocs.io/en/latest/
:alt: Documentation
… |pypi-badge| image:: https://img.shields.io/pypi/v/fixit.svg
:target: https://pypi.org/project/fixit
:alt: PyPI
… |changelog-badge| image:: https://img.shields.io/badge/change-log-blue.svg
:target: https://fixit.readthedocs.io/en/latest/changelog.html
:alt: Changelog
… |roadmap-badge| image:: https://img.shields.io/badge/road-map-9cf.svg
:target: https://github.com/Instagram/Fixit/milestones
:alt: Project Roadmap
… |license-badge| image:: https://img.shields.io/pypi/l/fixit.svg
:target: https://github.com/instagram/fixit/blob/main/LICENSE
:alt: MIT License
Fixit provides a highly configurable linting framework with support for
auto-fixes, custom “local” lint rules, and hierarchical configuration, built
on LibCST <https://libcst.rtfd.io>_.
Fixit makes it quick and easy to write new lint rules and offer suggested
changes for any errors found, which can then be accepted automatically,
or presented to the user for consideration.
Fixit 2.0 has been rebuilt for better configuration and support for custom
lint rules. If you are using Fixit 0.1.4 or older, take a look at the
legacy documentation <https://fixit.rtfd.io/en/v0.1.4/>_
or the stable branch <https://github.com/Instagram/Fixit/tree/0.x>.
See the upgrade guide <https://fixit.rtfd.io/en/latest/upgrade.html>
for tools and information to migrate existing configuration and lint rules
and ensure compatibility with the latest version of Fixit.
For more details, see the user guide__.
… __: https://fixit.rtfd.io/en/latest/guide.html
… QUICKSTART
Fixit is MIT licensed__, as found in the LICENSE file.
