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 / Rust / C++ linters and formatters like flake8, pylint, mypy, black, ruff(with auto-fix support), rustfmt, clippy, clang-format 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.12.1.tar.gz (28.7 kB view details)

Uploaded Source

Built Distribution

lintrunner_adapters-0.12.1-py3-none-any.whl (61.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lintrunner_adapters-0.12.1.tar.gz
Algorithm Hash digest
SHA256 2121632a1822780d1ba8d86a49207d22499d08b22ad4de187a20461cdc80aff5
MD5 f7128c158a3f5736a6ef1380b5c20d6c
BLAKE2b-256 fe922fccb066d890f2875b7005f02ef24a419d71071354390b69775416223e84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lintrunner_adapters-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 df5c43b520242473230bcccb8c64cf20bdff75dc41cfa236d1010e896134b054
MD5 ea15133776b65b688cc33d4fd993ae12
BLAKE2b-256 7ad59da8d73cd543a2eb03b8cbdb3c19639613cd428c78b24f48a756e71c0f76

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