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, 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.6.0.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

lintrunner_adapters-0.6.0-py3-none-any.whl (54.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lintrunner_adapters-0.6.0.tar.gz
  • Upload date:
  • Size: 25.6 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.6.0.tar.gz
Algorithm Hash digest
SHA256 880cf7b58c21c420b6bb5c13208be5072c5f1f567955b0eb39e744ba85eed33d
MD5 0475d2395fd6b196b501b09f685a9e40
BLAKE2b-256 62a8ad41b935e1a39b6529f08eb7e9b79ae4de7473d9c393b69d1529f44103f4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lintrunner_adapters-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a39baaa27cd0b4f4c36bf1ffbd611d4f01bc9f985d5a7efddad322ab2910120
MD5 8ec4a35eb6c4c96d84cab830770a80d5
BLAKE2b-256 cccfac3efba375d7fb369dd55d9f60accd7ee3aee2f0ff6fa688920a1ee983c8

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