Merge branch 'main' into feature/snippets-for-argument-parsing

Author: EmilyGraceSeville7cf

.github/workflows/codeql-analysis.yml

@@ -17,12 +17,12 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         with:
           languages: javascript
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/deploy.yml

@@ -9,13 +9,16 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
+
+      - name: Install shellcheck and shfmt (used for testing)
+        run: sudo apt-get install -y shellcheck shfmt
 
       - uses: pnpm/action-setup@v2
         with:
           version: 8
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org/

.github/workflows/upgrade-tree-sitter.yml

@@ -9,13 +9,13 @@ jobs:
   upgrade_tree_sitter:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: pnpm/action-setup@v2
         with:
           version: 8
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: "pnpm"
@@ -27,7 +27,7 @@ jobs:
         run: bash scripts/upgrade-tree-sitter.sh
 
       - name: Verify file changes
-        uses: tj-actions/verify-changed-files@v16
+        uses: tj-actions/verify-changed-files@v17
         id: verify-changed-files
         with:
           files: |
@@ -36,7 +36,7 @@ jobs:
 
       - name: Create pull request
         if: steps.verify-changed-files.outputs.files_changed == 'true'
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
         with:
           add-paths: server
           title: Auto upgrade tree-sitter-bash parser

.github/workflows/verify.yml

@@ -12,17 +12,17 @@ jobs:
         node-version: [16.x, 18.x, 20.x]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - name: Install shellcheck (used for testing)
-        run: sudo apt-get install -y shellcheck
+      - name: Install shellcheck and shfmt (used for testing)
+        run: sudo apt-get install -y shellcheck shfmt
 
       - uses: pnpm/action-setup@v2
         with:
           version: 8
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           cache: "pnpm"
           cache-dependency-path: '**/pnpm-lock.yaml'
@@ -34,7 +34,7 @@ jobs:
         run: pnpm verify:bail
 
       - name: Publish coverage to codecov.io
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         if: success() && matrix.node-version == '20.x'
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.tool-versions

@@ -1 +1 @@
-nodejs 18.17.1
+nodejs 18.20.1

.vscode/settings.json

@@ -8,6 +8,6 @@
 	"typescript.tsdk": "./node_modules/typescript/lib",
 	"typescript.tsc.autoDetect": "off",
 	"editor.codeActionsOnSave": {
-		"source.fixAll.eslint": true
+		"source.fixAll.eslint": "explicit"
 	}
 }

README.md

@@ -1,8 +1,6 @@
 # Bash Language Server
 
-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].
-
-We strongly recommend that you install [shellcheck][shellcheck] to enable linting: https://github.com/koalaman/shellcheck#installing
+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], [shellcheck][shellcheck] and [shfmt][shfmt].
 
 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.
 
@@ -16,28 +14,48 @@ Documentation around configuration variables can be found in the [config.ts](htt
 - Simple diagnostics reporting
 - Documentation for symbols on hover
 - Workspace symbols
+- Rename symbol
+- Format document
 
 To be implemented:
 
-- Rename symbol
 - Better jump to declaration and find references based on scope
 
 ## Installation
 
+### Dependencies
+
+As a dependency, we recommend that you first install [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 of 500ms).
+
+If you want your shell scripts to be formatted consistently, you can install [shfmt][shfmt]. If
+`shfmt` is installed then your documents will be formatted whenever you take the 'format document'
+action. In most editors this can be configured to happen automatically when files are saved.
+
+### Bash language server
+
 Usually you want to install a client for your editor (see the section below).
 
-But if you want to install the server binary:
+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:
 
 ```bash
 npm i -g bash-language-server
 ```
 
-On Fedora based distros:
+Alternatively, bash-language-server may also be distributed directly by your Linux distro, for example on Fedora based distros:
 
 ```bash
 dnf install -y nodejs-bash-language-server
 ```
 
+Or on Ubuntu with snap:
+
+```bash
+sudo snap install bash-language-server --classic
+```
+
 To verify that everything is working:
 
 ```bash
@@ -69,7 +87,7 @@ For Vim 8 or later install the plugin [prabirshrestha/vim-lsp][vim-lsp] and add
 if executable('bash-language-server')
   au User lsp_setup call lsp#register_server({
         \ 'name': 'bash-language-server',
-        \ 'cmd': {server_info->[&shell, &shellcmdflag, 'bash-language-server start']},
+        \ 'cmd': {server_info->['bash-language-server', 'start']},
         \ 'allowlist': ['sh', 'bash'],
         \ })
 endif
@@ -158,6 +176,34 @@ Add the configuration to your `.emacs.d/init.el`
   (sh-mode . lsp))
 ```
 
+Using the built-in `eglot` lsp mode:
+
+```emacs-lisp
+(use-package eglot
+  :config
+  (add-to-list 'eglot-server-programs '((sh-mode bash-ts-mode) . ("bash-language-server" "start")))
+
+  :hook
+  (sh-mode . eglot-ensure)
+  (bash-ts-mode . eglot-ensure))
+```
+
+## `shfmt` integration
+
+The indentation used by `shfmt` is whatever has been configured for the current editor session, so
+there is no `shfmt`-specific configuration variable for this. If your editor is configured for
+two-space indents then that's what it will use. If you're using tabs for indentation then `shfmt`
+will use that.
+
+The `shfmt` integration also supports configuration via `.editorconfig`. If any `shfmt`-specific
+configuration properties are found in `.editorconfig` then the config in `.editorconfig` will be
+used and the language server config will be ignored. This follows `shfmt`'s approach of using either
+`.editorconfig` or command line flags, but not both. Note that only `shfmt`-specific configuration
+properties are read from `.editorconfig` - indentation preferences are still provided by the editor,
+so to format using the indentation specified in `.editorconfig` make sure your editor is also
+configured to read `.editorconfig`. It is possible to disable `.editorconfig` support and always use
+the language server config by setting the "Ignore Editorconfig" configuration variable.
+
 ## Logging
 
 The minimum logging level for the server can be adjusted using the `BASH_IDE_LOG_LEVEL` environment variable
@@ -175,6 +221,7 @@ Please see [docs/development-guide][dev-guide] for more information.
 [sublime-text-lsp]: https://packagecontrol.io/packages/LSP-bash
 [explainshell]: https://explainshell.com/
 [shellcheck]: https://www.shellcheck.net/
+[shfmt]: https://github.com/mvdan/sh#shfmt
 [languageclient-neovim]: https://github.com/autozimu/LanguageClient-neovim
 [nvim-lspconfig]: https://github.com/neovim/nvim-lspconfig
 [vim-lsp]: https://github.com/prabirshrestha/vim-lsp

package.json

@@ -17,29 +17,29 @@
     "postinstall": "pnpm --dir=vscode-client install --ignore-workspace"
   },
   "devDependencies": {
-    "@types/jest": "29.5.4",
-    "@types/node": "18.17.11",
-    "@typescript-eslint/eslint-plugin": "5.62.0",
-    "@typescript-eslint/parser": "5.62.0",
-    "eslint": "8.48.0",
-    "eslint-config-prettier": "8.10.0",
-    "eslint-plugin-jest": "27.2.3",
+    "@types/jest": "29.5.12",
+    "@types/node": "18.19.30",
+    "@typescript-eslint/eslint-plugin": "7.5.0",
+    "@typescript-eslint/parser": "7.5.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-jest": "27.9.0",
     "eslint-plugin-prettier": "4.2.1",
-    "eslint-plugin-simple-import-sort": "10.0.0",
-    "eslint-plugin-sort-class-members": "1.18.0",
-    "jest": "29.6.4",
+    "eslint-plugin-simple-import-sort": "12.0.0",
+    "eslint-plugin-sort-class-members": "1.20.0",
+    "jest": "29.7.0",
     "prettier": "2.8.8",
-    "ts-jest": "29.1.1",
-    "typescript": "5.2.2",
+    "ts-jest": "29.1.2",
+    "typescript": "5.4.4",
     "vscode-languageserver": "8.0.2",
-    "vscode-languageserver-textdocument": "1.0.8"
+    "vscode-languageserver-textdocument": "1.0.11"
   },
   "resolutions": {
-    "@types/vscode": "1.81.0"
+    "@types/vscode": "1.88.0"
   },
   "engines": {
     "node": ">=16",
-    "pnpm": "8.x"
+    "pnpm": ">=8.x"
   },
   "jest": {
     "preset": "ts-jest",