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

Uploaded Source

Built Distribution

lintrunner_adapters-0.7.1-py3-none-any.whl (55.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: lintrunner_adapters-0.7.1.tar.gz
  • Upload date:
  • Size: 26.7 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.1.tar.gz
Algorithm Hash digest
SHA256 1909b5d5e178058ee870299d1623b915d499bc09a3c7ddf78741d6e2508932eb
MD5 3459cb78d47d7a883a44f1e7418b2059
BLAKE2b-256 2ff4c0719c9362a79cd61d2f94985e4626cae07917c80428c9a98f857ef3cc87

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lintrunner_adapters-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b0a7706f5b9c8139abefe663e02b231150b8104753439b6af6e87b3947a99a89
MD5 15a0ffe4f5d6bc9af3dd4023c62cbb6a
BLAKE2b-256 d676cd6974fd632f74cbe2fe08f790f96ec69b4334fb8541f7de2e5796f0288d

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