Skip to content

Commit

Permalink
Change: Make ruff more prominent in the README
Browse files Browse the repository at this point in the history
ruff is the rising star of linters.
  • Loading branch information
bjoernricks committed Jan 26, 2024
1 parent d2f2c7d commit 4fe01c5
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Library for managing and writing [git hooks](https://git-scm.com/docs/githooks)
in Python using `pyproject.toml` for its settings.

Looking for automatic formatting and linting, e.g., with [black] and [pylint],
Looking for automatic formatting and linting, e.g., with [black] and [ruff],
while creating a git commit using a pure Python implementation? Do you just want
to have your git hook settings in the `pyproject.toml` file too?

Expand Down Expand Up @@ -57,12 +57,12 @@ Python 3.8+ is required for autohooks.

* Python code formatting via [autopep8](https://github.com/LeoIV/autohooks-plugin-autopep8)

* Python code linting via [ruff](https://github.com/greenbone/autohooks-plugin-ruff)

* Python code linting via [pylint](https://github.com/greenbone/autohooks-plugin-pylint)

* Python code linting via [flake8](https://github.com/greenbone/autohooks-plugin-flake8)

* Python code linting via [ruff](https://github.com/greenbone/autohooks-plugin-ruff)

* Python code linting via [mypy](https://github.com/greenbone/autohooks-plugin-mypy)

* Python import sorting via [isort](https://github.com/greenbone/autohooks-plugin-isort)
Expand All @@ -71,12 +71,12 @@ Python 3.8+ is required for autohooks.

## Installing autohooks

Quick installation of [pylint] and [black] plugins using [poetry]:
Quick installation of [ruff] and [black] plugins using [poetry]:

```shell
poetry add --dev autohooks autohooks-plugin-black autohooks-plugin-pylint
poetry add --dev autohooks autohooks-plugin-black autohooks-plugin-ruff
poetry run autohooks activate --mode poetry
poetry run autohooks plugins add autohooks.plugins.black autohooks.plugins.pylint
poetry run autohooks plugins add autohooks.plugins.black autohooks.plugins.ruff
```

The output of `autohooks activate` should be similar to
Expand Down

0 comments on commit 4fe01c5

Please sign in to comment.