Skip to content

Files

Latest commit

ca1048e · Sep 26, 2024

History

History
This branch is 60 commits behind bash-lsp/bash-language-server:main.

vscode-client

Bash IDE

VS Marketplace installs VS Marketplace downloads Open VSX downloads

Visual Studio Code extension utilizing the Bash Language Server and integrating with explainshell, shellcheck and shfmt.

We recommend that you install shellcheck to enable linting and install shfmt to enable formatting.

Features

  • Jump to declaration
  • Find references
  • Code Outline & Show Symbols
  • Highlight occurrences
  • Code completion
  • Simple diagnostics reporting
  • Documentation for flags on hover
  • Workspace symbols
  • Rename symbol
  • Format document
  • Snippets

Configuration

To get documentation for flags on hover (thanks to explainshell), run a explainshell server and update your VS Code settings:

    "bashIde.explainshellEndpoint": "http://localhost:5000",

For security reasons, it defaults to "", which disables explainshell integration. When set, this extension will send requests to the endpoint and displays documentation for flags. We recommend using a local Docker image (see bash-lsp#180).