Skip to main content

Adapters and tools for lintrunner

Project description

lintrunner-adapters

CI PyPI version

Adapters and tools for lintrunner.

lintrunner-adapters currently supports popular Python and Rust linters and formatters like flake8, pylint, mypy, black, ruff(with auto-fix support), rustfmt, clippy and many more - and the list is growing. Contribution is welcome!

To see the list of supported linters and formatters, run lintrunner_adapters run.

Install

pip install lintrunner-adapters

Usage

Usage: python -m lintrunner_adapters [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  run       Run an adapter.
  to-sarif  Convert the output of lintrunner json (INPUT) to SARIF (OUTPUT).

Use lintrunner_adapters run to see a list of adapters available.

How to

Write lint config in .lintrunner.toml

See https://docs.rs/lintrunner/latest/lintrunner/lint_config/struct.LintConfig.html.

Create a new adapter

Use lintrunner_adapters/adapters/pylint_linter.py as an example.

Use lintrunner_adapters with lintrunner in your project

Refer to the .lintrunner.toml config file in this repo and example configs for each adapter under examples/adapters.

Run lintrunner in CI and get Github code scanning messages in your PRs

See .github/workflows/ci.yml.

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

lintrunner_adapters-0.9.0.tar.gz (27.1 kB view details)

Uploaded Source

Built Distribution

lintrunner_adapters-0.9.0-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

Details for the file lintrunner_adapters-0.9.0.tar.gz.

File metadata

  • Download URL: lintrunner_adapters-0.9.0.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.4

File hashes

Hashes for lintrunner_adapters-0.9.0.tar.gz
Algorithm Hash digest
SHA256 4e67bbc55a2110cfd80e79c38aa406ac50f4b306dccac1da70b4b3085f67f424
MD5 d709c3c205daf46081fc2185b9bf474b
BLAKE2b-256 bcf5581c1eacc284f89c233cabb5f1e8e0a8bffa6cde6ba3bb7461523f2e57af

See more details on using hashes here.

File details

Details for the file lintrunner_adapters-0.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lintrunner_adapters-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5346a98726499a6ac54b3bc516c173e6464c8162b607e5f8b79f4cb658087706
MD5 f8c4fac59728de4672e11e183371785d
BLAKE2b-256 a1fe8832e94eaf1554488ff70e3b9d181835bd4d3a86659ee5045a2366b934dc

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