Skip to content

Commit 565d911

Browse files
authored
Merge branch 'main' into rename-symbol
2 parents 612f4ab + aec18c7 commit 565d911

File tree

5 files changed

+193
-170
lines changed

5 files changed

+193
-170
lines changed

.tool-versions

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
nodejs 18.18.0
1+
nodejs 18.19.0

README.md

Lines changed: 14 additions & 4 deletions
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

package.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,25 @@
1717
"postinstall": "pnpm --dir=vscode-client install --ignore-workspace"
1818
},
1919
"devDependencies": {
20-
"@types/jest": "29.5.5",
21-
"@types/node": "18.18.0",
20+
"@types/jest": "29.5.11",
21+
"@types/node": "18.19.3",
2222
"@typescript-eslint/eslint-plugin": "5.62.0",
2323
"@typescript-eslint/parser": "5.62.0",
24-
"eslint": "8.50.0",
24+
"eslint": "8.56.0",
2525
"eslint-config-prettier": "8.10.0",
26-
"eslint-plugin-jest": "27.4.0",
26+
"eslint-plugin-jest": "27.6.0",
2727
"eslint-plugin-prettier": "4.2.1",
2828
"eslint-plugin-simple-import-sort": "10.0.0",
29-
"eslint-plugin-sort-class-members": "1.18.0",
29+
"eslint-plugin-sort-class-members": "1.19.0",
3030
"jest": "29.7.0",
3131
"prettier": "2.8.8",
3232
"ts-jest": "29.1.1",
33-
"typescript": "5.2.2",
33+
"typescript": "5.3.3",
3434
"vscode-languageserver": "8.0.2",
35-
"vscode-languageserver-textdocument": "1.0.8"
35+
"vscode-languageserver-textdocument": "1.0.11"
3636
},
3737
"resolutions": {
38-
"@types/vscode": "1.82.0"
38+
"@types/vscode": "1.85.0"
3939
},
4040
"engines": {
4141
"node": ">=16",

0 commit comments

Comments
 (0)