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.

GitHub action

https://github.com/justinchuby/lintrunner-action

How to

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.

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.

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

Option 1

Use a GitHub Action: lintrunner-action

Option 2

Run it directly in the workflow. 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.11.0.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

lintrunner_adapters-0.11.0-py3-none-any.whl (60.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lintrunner_adapters-0.11.0.tar.gz
Algorithm Hash digest
SHA256 18bef20e795133995314db26bbc5e9290ad18adf5d7150d935fe8cb879200c08
MD5 9f2508482146113062dab65593015e9d
BLAKE2b-256 dd447ccc6afee4f7c1d76dbaa5b81fb359898c3e4972965f2145fa077562eb08

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lintrunner_adapters-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a13cd6c6553d499492d296a2cd1df01d5893ee56dffe388a0bdc41094b06a7d
MD5 100ba7159f53e101904e93b772946df6
BLAKE2b-256 c8a395901aff7188c897af9ca4dc3c29f4751bbea7811fea9e127cdaa853d2e3

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