Skip to content

Commit

Permalink
chore(docs): update readme for more examples
Browse files Browse the repository at this point in the history
  • Loading branch information
justinchuby committed Feb 6, 2023
1 parent 51bb912 commit 595d78d
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
[![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)
Adapters and tools for [lintrunner](https://github.com/suo/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

Expand All @@ -30,8 +34,16 @@ Use `lintrunner_adapters run` to see a list of adapters available.

### Write lint config in `.lintrunner.toml`

https://docs.rs/lintrunner/latest/lintrunner/lint_config/struct.LintConfig.html
See 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.

### Use `lintrunner_adapters` with `lintrunner` in your project

Refer to the [`.lintrunner.toml`](https://github.com/justinchuby/lintrunner-adapters/blob/main/.lintrunner.toml) config file in this repo and example configs for each adapter under [`examples/adapters`](https://github.com/justinchuby/lintrunner-adapters/tree/main/examples/adapters).

### Run lintrunner in CI and get Github code scanning messages in your PRs

See [`.github/workflows/ci.yml`](https://github.com/justinchuby/lintrunner-adapters/blob/main/.github/workflows/ci.yml).

0 comments on commit 595d78d

Please sign in to comment.