Bash Language Server

The Bash IDE extension provides the following features for shell scripting in Visual Studio Code:

• Navigation: Jump to declaration, Find references, Workspace symbols, and Rename symbol.
• IntelliSense: Code completion, Code Outline & Show Symbols, Highlight occurrences, and Snippets.
• Information: Documentation for flags on hover (via explainshell).
• Code Quality: Simple diagnostics reporting and Format document (via shfmt).

Since the server is embedded in the VS Code client, you must link server changes to your local client installation. Run the following command once, then follow the standard 'Working on the client' steps (launching the Launch Client task) to see your server changes reflected in the extension.

pnpm link-server

For Vim 8 or Neovim using dense-analysis/ale, add the following to your .vimrc:

let g:ale_linters = {
    \ 'sh': ['language_server'],
    \ }

For Vim 8 or Neovim using neoclide/coc.nvim, add the following to your coc-settings.json:

  "languageserver": {
    "bash": {
      "command": "bash-language-server",
      "args": ["start"],
      "filetypes": ["sh"],
      "ignoredRootPaths": ["~"]
    }
  }

In the Oni configuration file (File -> Preferences -> Edit Oni config), add the following:

"language.bash.languageServer.command": "bash-language-server",
"language.bash.languageServer.arguments": ["start"],

To develop the VS Code extension client:

1. Open Visual Studio Code.
2. Use the Debug View to launch the Launch Client task.
3. This opens a new VS Code window with the extension loaded. The client will automatically recompile whenever you save changes to the client code.

The Bash IDE is a Visual Studio Code extension that utilizes the Bash Language Server and integrates with explainshell, shellcheck, and shfmt to provide advanced shell scripting features.

To enable full functionality, it is highly recommended to install the following external tools:

• shellcheck: Enables linting and diagnostics.
• shfmt: Enables code formatting.

You can find the extension on the VS Marketplace or Open VSX.

For Vim 8 or Neovim using YouCompleteMe, add this to your .vimrc:

let g:ycm_language_server =
        \ [
        \   {
        \       'name': 'bash',
        \       'cmdline': [ 'bash-language-server', 'start' ],
        \       'filetypes': [ 'sh' ],
        \   }
        \ ]

To begin developing on the Bash Language Server project, ensure you have pnpm and node (v20 or newer) installed. Follow these steps to initialize the workspace:

1. Install dependencies in the project root using pnpm install. This triggers the postinstall hook to install dependencies for both the vscode-client and server sub-projects.
2. Verify the configuration by compiling both the client and the server using pnpm compile.

Using lsp-mode via use-package, add this to your .emacs.d/init.el:

(use-package lsp-mode
  :commands lsp
  :hook
  (sh-mode . lsp))