As an LSP it's supported by most editors

This commit is contained in:
Imbolc 2024-09-03 11:31:41 +06:00 committed by GitHub
parent 92cb61cc8d
commit 37b935a7f1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 5 deletions

View File

@ -68,24 +68,29 @@ Run `shellcheck yourscript` in your terminal for instant output, as seen above.
You can see ShellCheck suggestions directly in a variety of editors. You can see ShellCheck suggestions directly in a variety of editors.
* Vim / Neovim, through * Vim / Neovim, through
[Bash Language Server](https://github.com/bash-lsp/bash-language-server), [Bash Language Server][],
[ALE](https://github.com/w0rp/ale), [Neomake](https://github.com/neomake/neomake), [ALE](https://github.com/w0rp/ale), [Neomake](https://github.com/neomake/neomake)
or [Syntastic](https://github.com/scrooloose/syntastic): or [Syntastic](https://github.com/scrooloose/syntastic):
![Screenshot of Vim showing inlined shellcheck feedback](doc/vim-syntastic.png). ![Screenshot of Vim showing inlined shellcheck feedback](doc/vim-syntastic.png).
* Emacs, through [Flycheck](https://github.com/flycheck/flycheck) or [Flymake](https://github.com/federicotdn/flymake-shellcheck): * Emacs, through
[Bash Language Server][],
[Flycheck](https://github.com/flycheck/flycheck)
or [Flymake](https://github.com/federicotdn/flymake-shellcheck):
![Screenshot of emacs showing inlined shellcheck feedback](doc/emacs-flycheck.png). ![Screenshot of emacs showing inlined shellcheck feedback](doc/emacs-flycheck.png).
* Sublime, through [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter-shellcheck). * Sublime, through [Bash Language Server][] or [SublimeLinter](https://github.com/SublimeLinter/SublimeLinter-shellcheck).
* Pulsar Edit (former Atom), through [linter-shellcheck-pulsar](https://github.com/pulsar-cooperative/linter-shellcheck-pulsar). * Pulsar Edit (former Atom), through [linter-shellcheck-pulsar](https://github.com/pulsar-cooperative/linter-shellcheck-pulsar).
* VSCode, through [vscode-shellcheck](https://github.com/timonwong/vscode-shellcheck). * VSCode, through [Bash Language Server][] or [vscode-shellcheck](https://github.com/timonwong/vscode-shellcheck).
* Most other editors, through [GCC error compatibility](shellcheck.1.md#user-content-formats). * Most other editors, through [GCC error compatibility](shellcheck.1.md#user-content-formats).
[Bash Language Server]: https://github.com/bash-lsp/bash-language-server
### In your build or test suites ### In your build or test suites
While ShellCheck is mostly intended for interactive use, it can easily be added to builds or test suites. While ShellCheck is mostly intended for interactive use, it can easily be added to builds or test suites.