Merge pull request #230 from bash-lsp/documentation-improvements

onHover and documentation improvements

Author: skovhus

.github/workflows/verify.yml

@@ -1,6 +1,6 @@
 name: Verify changes
 
-on: [push, pull_request]
+on: [pull_request]
 
 jobs:
   verify:

server/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Bash Language Server
 
+## 1.14.0
+
+* onHover and onCompletion documentation improvements (https://github.com/bash-lsp/bash-language-server/pull/230)
+* support 0/1 as values for `HIGHLIGHT_PARSING_ERRORS` (https://github.com/bash-lsp/bash-language-server/pull/231)
+
 ## 1.13.1
 
 * Gracefully handle glob failures (https://github.com/bash-lsp/bash-language-server/pull/224, https://github.com/bash-lsp/bash-language-server/pull/226)

server/package.json

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

server/src/__tests__/analyzer.test.ts

@@ -107,8 +107,9 @@ describe('findSymbolCompletions', () => {
     analyzer.analyze('install.sh', FIXTURES.INSTALL)
     analyzer.analyze('sourcing-sh', FIXTURES.SOURCING)
 
-    expect(analyzer.findSymbolsMatchingWord({ word: 'npm_config_logl' }))
-      .toMatchInlineSnapshot(`
+    expect(
+      analyzer.findSymbolsMatchingWord({ word: 'npm_config_logl', exactMatch: false }),
+    ).toMatchInlineSnapshot(`
       Array [
         Object {
           "kind": 13,
@@ -181,13 +182,13 @@ describe('findSymbolCompletions', () => {
       ]
     `)
 
-    expect(analyzer.findSymbolsMatchingWord({ word: 'xxxxxxxx' })).toMatchInlineSnapshot(
-      `Array []`,
-    )
+    expect(
+      analyzer.findSymbolsMatchingWord({ word: 'xxxxxxxx', exactMatch: false }),
+    ).toMatchInlineSnapshot(`Array []`)
 
-    expect(analyzer.findSymbolsMatchingWord({ word: 'BLU' })).toMatchInlineSnapshot(
-      `Array []`,
-    )
+    expect(
+      analyzer.findSymbolsMatchingWord({ word: 'BLU', exactMatch: false }),
+    ).toMatchInlineSnapshot(`Array []`)
   })
 })
 

server/src/__tests__/builtins.test.ts

@@ -27,13 +27,6 @@ describe('list', () => {
   })
 })
 
-describe('documentation', () => {
-  it('uses `man` so it disregards the PATH it has been initialized with', async () => {
-    const result = await executables.documentation('ls')
-    expect(result).toBeTruthy()
-  })
-})
-
 describe('isExecutableOnPATH', () => {
   it('looks at the PATH it has been initialized with', async () => {
     const result = executables.isExecutableOnPATH('ls')

server/src/__tests__/executables.test.ts

@@ -71,7 +71,7 @@ describe('server', () => {
     expect(result).toEqual({
       contents: {
         kind: 'markdown',
-        value: expect.stringContaining('RM(1)'),
+        value: expect.stringContaining('remove directories'),
       },
     })
   })

server/src/__tests__/server.test.ts

@@ -264,13 +264,20 @@ export default class Analyzer {
   /**
    * Find symbol completions for the given word.
    */
-  public findSymbolsMatchingWord({ word }: { word: string }): LSP.SymbolInformation[] {
+  public findSymbolsMatchingWord({
+    exactMatch,
+    word,
+  }: {
+    exactMatch: boolean
+    word: string
+  }): LSP.SymbolInformation[] {
     const symbols: LSP.SymbolInformation[] = []
 
     Object.keys(this.uriToDeclarations).forEach(uri => {
       const declarationsInFile = this.uriToDeclarations[uri] || {}
       Object.keys(declarationsInFile).map(name => {
-        if (name.startsWith(word)) {
+        const match = exactMatch ? name === word : name.startsWith(word)
+        if (match) {
           declarationsInFile[name].forEach(symbol => symbols.push(symbol))
         }
       })

server/src/analyser.ts

@@ -1,5 +1,3 @@
-import * as ShUtil from './util/sh'
-
 // You can generate this list by running `compgen -b` in a bash session
 export const LIST = [
   '.',
@@ -68,13 +66,3 @@ const SET = new Set(LIST)
 export function isBuiltin(word: string): boolean {
   return SET.has(word)
 }
-
-export async function documentation(builtin: string): Promise<string> {
-  const errorMessage = `No help page for ${builtin}`
-  try {
-    const doc = await ShUtil.execShellScript(`help ${builtin}`)
-    return doc || errorMessage
-  } catch (error) {
-    return errorMessage
-  }
-}

server/src/builtins.ts

@@ -4,7 +4,6 @@ import { promisify } from 'util'
 
 import * as ArrayUtil from './util/array'
 import * as FsUtil from './util/fs'
-import * as ShUtil from './util/sh'
 
 const lstatAsync = promisify(fs.lstat)
 const readdirAsync = promisify(fs.readdir)
@@ -44,19 +43,6 @@ export default class Executables {
   public isExecutableOnPATH(executable: string): boolean {
     return this.executables.has(executable)
   }
-
-  /**
-   * Look up documentation for the given executable.
-   *
-   * For now it simply tries to look up the MAN documentation.
-   */
-  public documentation(executable: string): Promise<string> {
-    return ShUtil.execShellScript(`man ${executable} | col -b`).then(doc => {
-      return !doc
-        ? Promise.resolve(`No MAN page for ${executable}`)
-        : Promise.resolve(doc)
-    })
-  }
 }
 
 /**

server/src/executables.ts

@@ -1,5 +1,3 @@
-import * as ShUtil from './util/sh'
-
 // https://www.gnu.org/software/bash/manual/html_node/Reserved-Word-Index.html
 
 export const LIST = [
@@ -31,12 +29,3 @@ const SET = new Set(LIST)
 export function isReservedWord(word: string): boolean {
   return SET.has(word)
 }
-
-export async function documentation(reservedWord: string): Promise<string> {
-  try {
-    const doc = await ShUtil.execShellScript(`help ${reservedWord}`)
-    return doc || ''
-  } catch (error) {
-    return ''
-  }
-}