Skip to content

Commit aab3728

Browse files
committed
Correctly define the shellcheckPath config option
1 parent 7e68f14 commit aab3728

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

vscode-client/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Bash IDE
22

3-
Visual Studio Code extension utilizing the [bash language server](bash-lsp), that is based on [Tree Sitter][tree-sitter] and its [grammar for Bash][tree-sitter-bash] and supports [explainshell][explainshell] integration.
3+
Visual Studio Code extension utilizing the [bash language server](bash-lsp), that is based on [Tree Sitter][tree-sitter] and its [grammar for Bash][tree-sitter-bash] and and supports [explainshell][explainshell] and [shellcheck][shellcheck].
4+
5+
We strongly recommend that you install [shellcheck][shellcheck] to enable linting: https://github.com/koalaman/shellcheck#installing
46

57
## Features
68

@@ -28,3 +30,4 @@ For security reasons, it defaults to `""`, which disables explainshell integrati
2830
[tree-sitter]: https://github.com/tree-sitter/tree-sitter
2931
[tree-sitter-bash]: https://github.com/tree-sitter/tree-sitter-bash
3032
[explainshell]: https://explainshell.com/
33+
[shellcheck]: https://www.shellcheck.net/

vscode-client/package.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@
4545
"type": "string",
4646
"default": "",
4747
"description": "Configure explainshell server in order to get hover documentation on flags and options."
48+
},
49+
"bashIde.shellcheckPath": {
50+
"type": "string",
51+
"default": "",
52+
"description": "Configure a custom path for the Shellcheck executable in order to get linting information."
4853
}
4954
}
5055
}

0 commit comments

Comments
 (0)