Merge branch 'main' into master

Author: skovhus

.github/workflows/deploy.yml

@@ -3,7 +3,7 @@ name: Deploy server and extension
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   deploy:

.gitignore

@@ -1,8 +1,18 @@
-**/node_modules
-
+# Build output
 vscode-client/out
 server/out
+
+# Linter cache
+coverage/
+.eslintcache/
+
+# OS related
 .DS_Store
 *.log
-coverage
-.eslintcache
+
+# NPM cache
+node_modules/
+package-lock.json
+
+# YARN cache
+.yarn/

.npmrc

@@ -0,0 +1 @@
+save-exact = true

README.md

@@ -22,6 +22,12 @@ We strongly recommend that you install [shellcheck][shellcheck] to enable lintin
 npm i -g bash-language-server
 ```
 
+On Fedora based distros:
+
+```bash
+dnf install -y nodejs-bash-language-server
+```
+
 If you encounter installation errors, ensure you have node version 12 or newer (`node --version`).
 
 ### Clients

docs/releasing.md

@@ -6,12 +6,12 @@ To release a new version of the vscode extension
 
 - Bump the version in `vscode-client/package.json`
 - Update `vscode-client/CHANGELOG.md`
-- Merge to master
+- Merge to main branch
 
 ## Server
 
 To release a new version of the server
 
 - Bump the version in `server/package.json`
 - Update `server/CHANGELOG.md`
-- Merge to master
+- Merge to main branch

package.json

@@ -16,19 +16,19 @@
     "link-server": "npm uninstall -g bash-language-server && yarn compile && yarn unlink bash-language-server && cd server && yarn link && cd ../vscode-client && yarn link bash-language-server"
   },
   "devDependencies": {
-    "@types/jest": "27.5.1",
-    "@types/node": "12.20.52",
-    "@typescript-eslint/eslint-plugin": "5.26.0",
-    "@typescript-eslint/parser": "5.26.0",
-    "eslint": "8.16.0",
+    "@types/jest": "28.1.7",
+    "@types/node": "12.20.55",
+    "@typescript-eslint/eslint-plugin": "5.33.1",
+    "@typescript-eslint/parser": "5.33.1",
+    "eslint": "8.22.0",
     "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-jest": "26.2.2",
-    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-jest": "26.8.3",
+    "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-simple-import-sort": "7.0.0",
-    "jest": "28.1.0",
-    "prettier": "2.6.2",
-    "ts-jest": "28.0.2",
-    "typescript": "4.6.4",
+    "jest": "28.1.3",
+    "prettier": "2.7.1",
+    "ts-jest": "28.0.8",
+    "typescript": "4.7.4",
     "vscode-languageserver": "6.1.1"
   },
   "dependencies": {},

renovate.json

@@ -1,5 +1,11 @@
 {
   "extends": [
     "config:base"
+  ],
+  "packageRules": [
+    {
+      "matchUpdateTypes": ["minor", "patch", "pin", "digest"],
+      "automerge": true
+    }
   ]
 }

server/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Bash Language Server
 
+## 3.0.5
+
+- Fix Shellcheck issue when using vim-lsp https://github.com/bash-lsp/bash-language-server/pull/443
+
+## 3.0.4
+
+- Fix Windows support for analyzer https://github.com/bash-lsp/bash-language-server/pull/433
+
 ## 3.0.3
 
 - Workaround for emscripten node 18 support https://github.com/bash-lsp/bash-language-server/pull/404

server/package.json

@@ -3,7 +3,7 @@
   "description": "A language server for Bash",
   "author": "Mads Hartmann",
   "license": "MIT",
-  "version": "3.0.3",
+  "version": "3.0.5",
   "publisher": "mads-hartmann",
   "main": "./out/server.js",
   "typings": "./out/server.d.ts",

server/src/__tests__/analyzer.test.ts

@@ -223,19 +223,23 @@ describe('findSymbolCompletions', () => {
 describe('commentsAbove', () => {
   it('returns a string of a comment block above a line', () => {
     analyzer.analyze(CURRENT_URI, FIXTURES.COMMENT_DOC)
-    expect(analyzer.commentsAbove(CURRENT_URI, 22)).toEqual('doc for func_one')
+    expect(analyzer.commentsAbove(CURRENT_URI, 22)).toEqual(
+      '```txt\ndoc for func_one\n```',
+    )
   })
 
   it('handles line breaks in comments', () => {
     analyzer.analyze(CURRENT_URI, FIXTURES.COMMENT_DOC)
     expect(analyzer.commentsAbove(CURRENT_URI, 28)).toEqual(
-      'doc for func_two\nhas two lines',
+      '```txt\ndoc for func_two\nhas two lines\n```',
     )
   })
 
   it('only returns connected comments', () => {
     analyzer.analyze(CURRENT_URI, FIXTURES.COMMENT_DOC)
-    expect(analyzer.commentsAbove(CURRENT_URI, 36)).toEqual('doc for func_three')
+    expect(analyzer.commentsAbove(CURRENT_URI, 36)).toEqual(
+      '```txt\ndoc for func_three\n```',
+    )
   })
 
   it('returns null if no comment found', () => {
@@ -245,13 +249,15 @@ describe('commentsAbove', () => {
 
   it('works for variables', () => {
     analyzer.analyze(CURRENT_URI, FIXTURES.COMMENT_DOC)
-    expect(analyzer.commentsAbove(CURRENT_URI, 42)).toEqual('works for variables')
+    expect(analyzer.commentsAbove(CURRENT_URI, 42)).toEqual(
+      '```txt\nworks for variables\n```',
+    )
   })
 
   it('returns connected comments with empty comment line', () => {
     analyzer.analyze(CURRENT_URI, FIXTURES.COMMENT_DOC)
     expect(analyzer.commentsAbove(CURRENT_URI, 51)).toEqual(
-      'this is also included\n\ndoc for func_four',
+      '```txt\nthis is also included\n\ndoc for func_four\n```',
     )
   })
 })

server/src/__tests__/linter.test.ts

@@ -14,7 +14,7 @@ describe('linter', () => {
   })
 
   it('should set canLint to true if executable not empty', () => {
-    expect(new Linter({ executablePath: null }).canLint).toBe(false)
+    expect(new Linter({ executablePath: 'foo' }).canLint).toBe(true)
   })
 
   it('should set canLint to false when linting fails', async () => {

server/src/__tests__/server.test.ts

@@ -101,7 +101,7 @@ describe('server', () => {
     expect(result).toBeDefined()
     expect(result).toEqual({
       contents:
-        'Function defined on line 8\n\nthis is a comment\ndescribing the function\nhello_world\nthis function takes two arguments',
+        '### Function: **hello_world** - *defined on line 8*\n\n```txt\nthis is a comment\ndescribing the function\nhello_world\nthis function takes two arguments\n```',
     })
   })
 
@@ -416,7 +416,7 @@ describe('server', () => {
             "name": "BLUE",
             "type": 3,
           },
-          "documentation": "Variable defined in ../extension.inc",
+          "documentation": "### Variable: **BLUE** - *defined in ../extension.inc*",
           "kind": 6,
           "label": "BLUE",
         },
@@ -439,20 +439,22 @@ describe('server', () => {
     )
 
     expect(resultFunction).toMatchInlineSnapshot(`
-Array [
-  Object {
-    "data": Object {
-      "name": "add_a_user",
-      "type": 3,
-    },
-    "documentation": "Function defined in ../issue101.sh
-
-Helper function to add a user",
-    "kind": 3,
-    "label": "add_a_user",
-  },
-]
-`)
+      Array [
+        Object {
+          "data": Object {
+            "name": "add_a_user",
+            "type": 3,
+          },
+          "documentation": "### Function: **add_a_user** - *defined in ../issue101.sh*
+
+      \`\`\`txt
+      Helper function to add a user
+      \`\`\`",
+          "kind": 3,
+          "label": "add_a_user",
+        },
+      ]
+    `)
   })
 
   it('responds to onCompletion with local symbol when word is found in multiple files', async () => {

server/src/analyser.ts

@@ -2,6 +2,7 @@ import * as fs from 'fs'
 import * as FuzzySearch from 'fuzzy-search'
 import * as request from 'request-promise-native'
 import * as URI from 'urijs'
+import * as url from 'url'
 import { promisify } from 'util'
 import * as LSP from 'vscode-languageserver'
 import * as Parser from 'web-tree-sitter'
@@ -72,7 +73,7 @@ export default class Analyzer {
       )
 
       for (const filePath of filePaths) {
-        const uri = `file://${filePath}`
+        const uri = url.pathToFileURL(filePath).href
         connection.console.log(`Analyzing ${uri}`)
 
         try {
@@ -436,9 +437,9 @@ export default class Analyzer {
     // is not a comment line
     const getComment = (l: string): null | string => {
       // this regexp has to be defined within the function
-      const commentRegExp = /^\s*#\s*(.*)/g
+      const commentRegExp = /^\s*#\s?(.*)/g
       const matches = commentRegExp.exec(l)
-      return matches ? matches[1].trim() : null
+      return matches ? matches[1].trimRight() : null
     }
 
     let currentLine = doc.getText({
@@ -459,9 +460,12 @@ export default class Analyzer {
     }
 
     if (commentBlock.length) {
+      commentBlock.push('```txt')
       // since we searched from bottom up, we then reverse
       // the lines so that it reads top down.
-      return commentBlock.reverse().join('\n')
+      commentBlock.reverse()
+      commentBlock.push('```')
+      return commentBlock.join('\n')
     }
 
     // no comments found above line:

server/src/server.ts

@@ -28,7 +28,7 @@ export default class BashServer {
    */
   public static async initialize(
     connection: LSP.Connection,
-    { rootPath }: LSP.InitializeParams,
+    { rootPath, capabilities }: LSP.InitializeParams,
   ): Promise<BashServer> {
     const parser = await initializeParser()
 
@@ -43,7 +43,7 @@ export default class BashServer {
       Analyzer.fromRoot({ connection, rootPath, parser }),
       new Linter({ executablePath: config.getShellcheckPath() }),
     ]).then(([executables, analyzer, linter]) => {
-      return new BashServer(connection, executables, analyzer, linter)
+      return new BashServer(connection, executables, analyzer, linter, capabilities)
     })
   }
 
@@ -53,17 +53,20 @@ export default class BashServer {
 
   private documents: LSP.TextDocuments<TextDocument> = new LSP.TextDocuments(TextDocument)
   private connection: LSP.Connection
+  private clientCapabilities: LSP.ClientCapabilities
 
   private constructor(
     connection: LSP.Connection,
     executables: Executables,
     analyzer: Analyzer,
     linter: Linter,
+    capabilities: LSP.ClientCapabilities,
   ) {
     this.connection = connection
     this.executables = executables
     this.analyzer = analyzer
     this.linter = linter
+    this.clientCapabilities = capabilities
   }
 
   /**
@@ -83,7 +86,9 @@ export default class BashServer {
       // Run shellcheck diagnostics:
       let diagnostics: LSP.Diagnostic[] = []
 
-      const folders = await connection.workspace.getWorkspaceFolders()
+      const folders = this.clientCapabilities.workspace?.workspaceFolders
+        ? await connection.workspace.getWorkspaceFolders()
+        : []
       const lintDiagnostics = await this.linter.lint(change.document, folders || [])
       diagnostics = diagnostics.concat(lintDiagnostics)
 
@@ -177,15 +182,13 @@ export default class BashServer {
 
     const commentAboveSymbol = this.analyzer.commentsAbove(symbolUri, symbolStarLine)
     const symbolDocumentation = commentAboveSymbol ? `\n\n${commentAboveSymbol}` : ''
+    const hoverHeader = `### ${symbolKindToDescription(symbol.kind)}: **${symbol.name}**`
+    const symbolLocation =
+      symbolUri !== currentUri
+        ? `in ${Path.relative(currentUri, symbolUri)}`
+        : `on line ${symbolStarLine + 1}`
 
-    return symbolUri !== currentUri
-      ? `${symbolKindToDescription(symbol.kind)} defined in ${Path.relative(
-          currentUri,
-          symbolUri,
-        )}${symbolDocumentation}`
-      : `${symbolKindToDescription(symbol.kind)} defined on line ${
-          symbolStarLine + 1
-        }${symbolDocumentation}`
+    return `${hoverHeader} - *defined ${symbolLocation}*${symbolDocumentation}`
   }
 
   private getCompletionItemsForSymbols({
@@ -400,7 +403,7 @@ export default class BashServer {
 
     const reservedWordsCompletions = ReservedWords.LIST.map((reservedWord) => ({
       label: reservedWord,
-      kind: LSP.SymbolKind.Interface, // ??
+      kind: LSP.CompletionItemKind.Keyword,
       data: {
         name: reservedWord,
         type: CompletionItemDataType.ReservedWord,
@@ -413,7 +416,7 @@ export default class BashServer {
       .map((executable) => {
         return {
           label: executable,
-          kind: LSP.SymbolKind.Function,
+          kind: LSP.CompletionItemKind.Function,
           data: {
             name: executable,
             type: CompletionItemDataType.Executable,
@@ -423,7 +426,7 @@ export default class BashServer {
 
     const builtinsCompletions = Builtins.LIST.map((builtin) => ({
       label: builtin,
-      kind: LSP.SymbolKind.Interface, // ??
+      kind: LSP.CompletionItemKind.Function,
       data: {
         name: builtin,
         type: CompletionItemDataType.Builtin,
@@ -432,7 +435,7 @@ export default class BashServer {
 
     const optionsCompletions = options.map((option) => ({
       label: option,
-      kind: LSP.SymbolKind.Interface,
+      kind: LSP.CompletionItemKind.Constant,
       data: {
         name: option,
         type: CompletionItemDataType.Symbol,

vscode-client/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Bash IDE
 
+## 1.14.0
+
+- Upgrade language server to 3.0.3 that includes support for Shellcheck linting (please follow https://github.com/koalaman/shellcheck#installing to install Shellcheck)
+
 ## 1.13.0
 
 - Upgrade language server to 2.1.0