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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

Details for the file silence_fixit_error-0.3.2.tar.gz.

File metadata

  • Download URL: silence_fixit_error-0.3.2.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for silence_fixit_error-0.3.2.tar.gz
Algorithm Hash digest
SHA256 a438f7cf0016105218f0748544eedbb41dcd3fb10573af7beb2fb4f421e00787
MD5 5ac39efa37a322db07f89284d7f4fd8a
BLAKE2b-256 86097d8d1bceb386f2646fb04685e088cd39161aa1e690d0bcd92d8400d90d97

See more details on using hashes here.

File details

Details for the file silence_fixit_error-0.3.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for silence_fixit_error-0.3.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5fff71bad87dd0212d64dff359f0b6744611ce781cc0a1c67df6ec7505db2394
MD5 06ebe69ff6333c84ebf03d6c6cdf99a6
BLAKE2b-256 6fd1676c58c856681bdf3486d0b57018bbbb81d5fc51bcf3cb631530d0b2e874

See more details on using hashes here.

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