Skip to content

Commit

Permalink
Improve docs for ALE plugin for vim (astral-sh#14335)
Browse files Browse the repository at this point in the history
2 different fixers are available in ALE :
- ruff which runs `ruff check --fix` command (useful for example when
isort is enabled in lint config),
 - ruff_format which runs `run format` command.

The documentation was missing `ruff` as a possible fixer in ALE.

---------

Co-authored-by: Dhruv Manilawala <dhruvmanila@gmail.com>
  • Loading branch information
pgiraud and dhruvmanila authored Nov 14, 2024
1 parent 924741c commit ec2c7ca
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/editors/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,12 +150,15 @@ extension for [coc.nvim](https://github.com/neoclide/coc.nvim).
<summary>With the <a href="https://github.com/dense-analysis/ale">ALE</a> plugin for Vim or Neovim.</summary>

```vim
" Linter
" Linters
let g:ale_linters = { "python": ["ruff"] }
" Formatter
let g:ale_fixers = { "python": ["ruff_format"] }
" Fixers
let g:ale_fixers = { "python": ["ruff", "ruff_format"] }
```

For the fixers, `ruff` will run `ruff check --fix` (to fix all auto-fixable problems) whereas
`ruff_format` will run `ruff format`.

</details>

<details>
Expand Down

0 comments on commit ec2c7ca

Please sign in to comment.