Skip to main content

add `lint-fixme` comments to every occurrence of a `fixit` error

Project description

This tool is no longer maintained. Its functionality is included in the silence-lint-error package.


silence-fixit-error

Add lint-fixme comments to every occurrence of a fixit error.

Usage

Install with pip:

python -m pip install silence-fixit-error

Call the tool with a rule you want to add fixme comments for and the paths to the files:

silence-fixit-error fixit.rules:CollapseIsinstanceChecks path/to/files/ path/to/more/files/

Once an auto-fix is available for this rule, we can remove the fixme comments and run that auto-fix:

fix-silenced-fixit-error fixit.rules:CollapseIsinstanceChecks path/to/files/ path/to/more/files/

Rationale

When adding a new rule (or enabling more rules) in fixit on a large code-base, fixing the existing violations can be too large a task to do quickly. However, starting to check the rule sooner will prevent new violations from being introduced.

Ignoring existing violations is a quick way to allow new rules to be enabled. You can then burn down the existing violations over time.

This tool makes it easy to find and ignore all current violations of a rule so that it can be enabled.

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

silence_fixit_error-0.3.2.tar.gz (4.6 kB view hashes)

Uploaded Source

Built Distribution

silence_fixit_error-0.3.2-py2.py3-none-any.whl (5.4 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page