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.7.0.tar.gz (26.5 kB view details)

Uploaded Source

Built Distribution

lintrunner_adapters-0.7.0-py3-none-any.whl (55.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lintrunner_adapters-0.7.0.tar.gz
  • Upload date:
  • Size: 26.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for lintrunner_adapters-0.7.0.tar.gz
Algorithm Hash digest
SHA256 46f1f86723c13aa7c58416b9120171bd15b927eb52757648c831243e8a855a05
MD5 23731c62d1b8ee2a2af6ee8aabbc8969
BLAKE2b-256 aec5eda24002b51375f8c578d9643deb7a3b79167b7351251b4156960b127063

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lintrunner_adapters-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 09f8702a86503e13700ef3f7db383f312e0c4bbe60be23cfe55845e3e3b5a6b1
MD5 42e8d6e372b1d8222cdca3cfd0c1378a
BLAKE2b-256 43603f6af68780633a1e05fd6e3d5af1f6917a869ab52950e075f028310b3678

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