Skip to content

Commit 6dce2e2

Browse files
authored
Merge pull request #1027 from jerabaul29/doc/explain_shellcheck
Explain shellcheck dependency; add snap install note
2 parents 92223a8 + 0e84537 commit 6dce2e2

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

Diff for: README.md

+14-4
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
Bash language server that brings an IDE-like experience for bash scripts to most editors. This is based on the [Tree Sitter parser][tree-sitter-bash] and supports [explainshell][explainshell] and [shellcheck][shellcheck].
44

5-
We strongly recommend that you install [shellcheck][shellcheck] to enable linting: https://github.com/koalaman/shellcheck#installing
6-
75
Documentation around configuration variables can be found in the [config.ts](https://github.com/bash-lsp/bash-language-server/blob/main/server/src/config.ts) file.
86

97
## Features
@@ -24,20 +22,32 @@ To be implemented:
2422

2523
## Installation
2624

25+
### Dependencies
26+
27+
As a dependency, we recommend that you first install shellcheck [shellcheck][shellcheck] to enable linting: https://github.com/koalaman/shellcheck#installing . If shellcheck is installed, bash-language-server will automatically call it to provide linting and code analysis each time the file is updated (with debounce time or 500ms).
28+
29+
### Bash language server
30+
2731
Usually you want to install a client for your editor (see the section below).
2832

29-
But if you want to install the server binary:
33+
But if you want to install the server binary (for examples for editors, like helix, where a generic LSP client is built in), you can install from npm registry as:
3034

3135
```bash
3236
npm i -g bash-language-server
3337
```
3438

35-
On Fedora based distros:
39+
Alternatively, bash-language-server may also be distributed directly by your Linux distro, for example on Fedora based distros:
3640

3741
```bash
3842
dnf install -y nodejs-bash-language-server
3943
```
4044

45+
Or on Ubuntu with snap:
46+
47+
```bash
48+
sudo snap install bash-language-server --classic
49+
```
50+
4151
To verify that everything is working:
4252

4353
```bash

0 commit comments

Comments
 (0)