justinchuby/lintrunner-adapters

Adapters and tools for lintrunner

lintrunner-adapters

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.

lintrunner-adapters's Issues

Support ruff format

Ruff has no options as `--format`

Hi,

I'm always getting error like

STDERR
    error: unexpected argument '--format' found

I'm using latest Ruff version 0.1.6. Seems they have removed --format option:

Ruff: An extremely fast Python linter.

Usage: ruff [OPTIONS] <COMMAND>

Commands:
  check    Run Ruff on the given files or directories (default)
  rule     Explain a rule (or all rules)
  config   List or describe the available configuration options
  linter   List all supported upstream linters
  clean    Clear any caches in the current directory and any subdirectories
  format   Run the Ruff formatter on the given files or directories
  version  Display Ruff's version
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Log levels:
  -v, --verbose  Enable verbose logging
  -q, --quiet    Print diagnostics, but nothing else
  -s, --silent   Disable all logging (but still exit with status code "1" upon detecting diagnostics)

For help with a specific command, see: `ruff help <command>`.

Can you please remove --format from
https://github.com/justinchuby/lintrunner-adapters/blob/main/lintrunner_adapters/adapters/ruff_linter.py#L89 ?

Thanks!

Create a github workflow

rust-clippy

Add disable instructions to the message

Filter out mypy messages that are not in the include list

BLACK-ISORT linter fails on Windows when black==24.1.1 and Python==3.9

This linter processes the file with isort before sending the result to black as input to the subprocess.

In

lintrunner-adapters/lintrunner_adapters/adapters/black_isort_linter.py

Lines 42 to 58 in c9727c9

	proc = run_command(
	[
	sys.executable,
	"-mblack",
	*(("--pyi",) if filename.endswith(".pyi") else ()),
	*(("--ipynb",) if filename.endswith(".ipynb") else ()),
	*(("--fast",) if fast else ()),
	"--stdin-filename",
	filename,
	"-",
	],
	stdin=None,
	input=import_sorted,
	retries=retries,
	timeout=timeout,
	check=True,
	)

, the input argument was somehow not taken by black when black==24.1.1 on Windows, Python 3.8/Python 3.9.

Maybe consider pipeline the results instead and send it via stdin?

Add windows support to the grep linter

Potentially using Select-String and replace

Select-String -Pattern 'n' -AllMatches

Add full doc as an option to sarif reports

Ruff adapter

https://github.com/charliermarsh/ruff

Update ruff lint message links

Currently the links are all generic https://beta.ruff.rs/docs/rules/. We should update them to point to the specific rules: e.g. https://docs.astral.sh/ruff/rules/blank-line-with-whitespace/

Improve mypy speed

Mypy with a warm cache should run faster