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

Uploaded Source

Built Distribution

lintrunner_adapters-0.6.1-py3-none-any.whl (54.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lintrunner_adapters-0.6.1.tar.gz
  • Upload date:
  • Size: 26.4 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.1.tar.gz
Algorithm Hash digest
SHA256 e22d91fcae48e29c323795d16900e35cf434987b61944cb2411ffefd231b1889
MD5 636ab993ea2611e3c249b6968d1a6e3f
BLAKE2b-256 f68e1f163ff90546082f49288e31b4d1e72a58c2b95bed84c6f7c15b645d1ca5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lintrunner_adapters-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e8f4fc587e380c7f4bb0d4eb2c6052bd1fceaddcd2df388503deb917520a5786
MD5 ff184165665b035f4e17fbb3ae6a483f
BLAKE2b-256 bf0bf1c52fa470ba0c01dd481a3061931af8eafdd46c4997e28c4e9b3a46bb55

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