Metadata-Version: 2.1
Name: lintrunner-adapters
Version: 0.2.0
Summary: Adapters and tools for lintrunner
Home-page: https://github.com/justinchuby/lintrunner-adapters
License: MIT
Keywords: lintrunner,lint,cli,sarif
Author: Justin Chu
Author-email: justinchu@microsoft.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Dist: click (>=8.1.3,<9.0.0)
Project-URL: Repository, https://github.com/justinchuby/lintrunner-adapters
Description-Content-Type: text/markdown

# lintrunner-adapters

[![CI](https://github.com/justinchuby/lintrunner-adapters/actions/workflows/ci.yml/badge.svg)](https://github.com/justinchuby/lintrunner-adapters/actions/workflows/ci.yml)
[![PyPI version](https://badge.fury.io/py/lintrunner-adapters.svg)](https://badge.fury.io/py/lintrunner-adapters)

Adapters for [lintrunner](https://github.com/suo/lintrunner)

## Install

```sh
pip install lintrunner-adapters
```

## Usage

```text
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`

https://docs.rs/lintrunner/latest/lintrunner/lint_config/struct.LintConfig.html

### Create a new adapter

Use [`lintrunner_adapters/adapters/pylint_linter.py`](https://github.com/justinchuby/lintrunner-adapters/blob/main/lintrunner_adapters/adapters/pylint_linter.py) as an example.

