Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vscode-shellcheck/vscode-shellcheck
Integrates ShellCheck into VS Code, a linter for Shell scripts.
https://github.com/vscode-shellcheck/vscode-shellcheck
bash hacktoberfest linter shell visual-studio-code vscode vscode-extension
Last synced: 28 days ago
JSON representation
Integrates ShellCheck into VS Code, a linter for Shell scripts.
- Host: GitHub
- URL: https://github.com/vscode-shellcheck/vscode-shellcheck
- Owner: vscode-shellcheck
- License: mit
- Created: 2016-10-08T09:29:11.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-22T18:55:33.000Z (4 months ago)
- Last Synced: 2024-09-29T08:03:36.342Z (about 1 month ago)
- Topics: bash, hacktoberfest, linter, shell, visual-studio-code, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck
- Size: 5.72 MB
- Stars: 792
- Watchers: 11
- Forks: 45
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - vscode-shellcheck/vscode-shellcheck - Integrates ShellCheck into VS Code, a linter for Shell scripts. (visual-studio-code)
README
# ShellCheck for Visual Studio Code
Integrates [ShellCheck](https://github.com/koalaman/shellcheck) into VS Code, a linter for Shell scripts.
[](https://github.com/vscode-shellcheck/vscode-shellcheck/releases/latest)
[](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck)
[](https://marketplace.visualstudio.com/items?itemName=timonwong.shellcheck)
[](https://open-vsx.org/extension/timonwong/shellcheck)
## Quick start
## Disclaimer
This VS Code extension requires [shellcheck] (the awesome static analysis tool for shell scripts) to work, but precompiled [shellcheck] binaries are bundled in this extension for these platforms:
- Linux (x86_64, arm, arm64)
- macOS (x86_64, arm64)
- Windows (x86_64, arm)
## Requirements
1. Run [`Install Extension`](https://code.visualstudio.com/docs/editor/extension-gallery#_install-an-extension) command from [Command Palette](https://code.visualstudio.com/Docs/editor/codebasics#_command-palette).
2. Search and choose `shellcheck`.
## Troubleshooting
If shellcheck seems not working, a helper command `ShellCheck: ShellCheck: Collect Diagnostics For Current Document` from the [Command Palette](https://code.visualstudio.com/Docs/editor/codebasics#_command-palette) is provided to help troubleshooting.
## Options
There are various options that can be configured by making changes to your user or workspace preferences.
Default options are:
```jsonc
{
"shellcheck.enable": true,
"shellcheck.enableQuickFix": true,
"shellcheck.run": "onType",
"shellcheck.executablePath": "", // Priority: user defined > bundled shellcheck binary > "shellcheck"
"shellcheck.exclude": [],
"shellcheck.customArgs": [],
"shellcheck.ignorePatterns": {
"**/*.csh": true,
"**/*.cshrc": true,
"**/*.fish": true,
"**/*.login": true,
"**/*.logout": true,
"**/*.tcsh": true,
"**/*.tcshrc": true,
"**/*.xonshrc": true,
"**/*.xsh": true,
"**/*.zsh": true,
"**/*.zshrc": true,
"**/zshrc": true,
"**/*.zprofile": true,
"**/zprofile": true,
"**/*.zlogin": true,
"**/zlogin": true,
"**/*.zlogout": true,
"**/zlogout": true,
"**/*.zshenv": true,
"**/zshenv": true,
"**/*.zsh-theme": true
},
"shellcheck.ignoreFileSchemes": ["git", "gitfs", "output"]
}
```
### `shellcheck.ignorePatterns`
The `shellcheck.ignorePatterns` works exactly the same as `search.exclude`, read more about glob patterns [here](https://code.visualstudio.com/docs/editor/codebasics#_advanced-search-options)
For example:
```jsonc
{
"shellcheck.ignorePatterns": {
"**/*.zsh": true,
"**/*.zsh*": true,
"**/.git/*.sh": true,
"**/folder/**/*.sh": true
}
}
```
To add additional ignore patterns atop the default patterns, you have to copy the default ignore patterns and then add yours to the end of the list ([#1196](https://github.com/vscode-shellcheck/vscode-shellcheck/issues/1196)).
### Fix all errors on save
The auto-fixable errors can be fixed automatically on save by using the following configuration:
```jsonc
{
"editor.codeActionsOnSave": {
"source.fixAll.shellcheck": "explicit"
}
}
```
Alternatively, you can fix all errors on demand by running the command _Fix All_ in the VS Code Command Palette.
### Lint `onType` or `onSave`
By default the linter will lint as you type. Alternatively, set `shellcheck.run` to `onSave` if you want to lint only when the file is saved (works best if auto-save is on).
```jsonc
{
"shellcheck.run": "onType" // also: "onSave"
}
```
### Excluding Checks
By default all shellcheck checks are performed and reported on as necessary. To globally ignore certain checks in all files, you can use a `.shellcheckrc` at the workspace root. For example, to exclude [SC1017](https://github.com/koalaman/shellcheck/wiki/SC1017):
```ini
# .shellcheckrc
disable=SC1017
```
As last resort, you can also add the "SC identifiers" to `shellcheck.exclude` extension setting. For example, to exclude [SC1017](https://github.com/koalaman/shellcheck/wiki/SC1017):
```jsonc
{
"shellcheck.exclude": ["1017"]
}
```
### Using Docker version of shellcheck
In order to get it to work, you need a "shim" script. Just remember not to try to construct command line arguments for shellcheck yourself.
Here is a simple "shim" script to get started with (see discussion: [#24](https://github.com/vscode-shellcheck/vscode-shellcheck/issues/24)):
```shell
#!/bin/bash
exec docker run --rm --interactive --volume "${PWD}:/mnt:ro" koalaman/shellcheck:latest "$@"
```
For example, you can place it at `shellcheck.sh` in the root of your workspace with execution permission (`chmod +x shellcheck.sh`).
You can can then configure the extension to use it with:
```jsonc
// .vscode/settings.json
{
// use the shim as shellcheck executable
"shellcheck.executablePath": "${workspaceFolder}/shellcheck.sh",
// you may also need to turn this option on, so shellcheck in the container
// can access all the files in the workspace and not only the directory
// where the file being linted is.
"shellcheck.useWorkspaceRootAsCwd": true
}
```
Just have in mind that this should come with a performance hit, as booting up a docker container is slower than just invoking the binary.
## Advanced usage
### Integrating other VS Code extensions
This extension provides a small API, which allows other VS Code extensions to interact with the ShellCheck extension. For details, see [API.md](./doc/API.md).
## Acknowledgements
This extension was originally based on @hoovercj's [Haskell Linter](https://github.com/hoovercj/vscode-haskell-linter).
## LICENSE
This extension is licensed under the [MIT license](./LICENSE).
Bundled [shellcheck] binaries are licensed under [GPLv3](https://github.com/koalaman/shellcheck/blob/master/LICENSE).
[shellcheck]: https://github.com/koalaman/shellcheck