Merge pull request #577 from bash-lsp/fix-documentation

Fix shell documentation for newlines

Author: skovhus

Diff for: server/src/__tests__/analyzer.test.ts

@@ -37,15 +37,15 @@ describe('analyze', () => {
 })
 
 describe('findDefinition', () => {
-  it('returns empty list if parameter is not found', () => {
+  it('returns an empty list if word is not found', () => {
     analyzer.analyze(CURRENT_URI, FIXTURES.INSTALL)
-    const result = analyzer.findDefinition('foobar')
+    const result = analyzer.findDefinition({ word: 'foobar' })
     expect(result).toEqual([])
   })
 
   it('returns a list of locations if parameter is found', () => {
     analyzer.analyze(CURRENT_URI, FIXTURES.INSTALL)
-    const result = analyzer.findDefinition('node_version')
+    const result = analyzer.findDefinition({ word: 'node_version' })
     expect(result).not.toEqual([])
     expect(result).toMatchSnapshot()
   })

Diff for: server/src/analyser.ts

@@ -17,7 +17,7 @@ const readFileAsync = promisify(fs.readFile)
 
 type Kinds = { [type: string]: LSP.SymbolKind }
 
-type Declarations = { [name: string]: LSP.SymbolInformation[] }
+type Declarations = { [word: string]: LSP.SymbolInformation[] }
 type FileDeclarations = { [uri: string]: Declarations }
 
 type Trees = { [uri: string]: Parser.Tree }
@@ -126,12 +126,12 @@ export default class Analyzer {
   }
 
   /**
-   * Find all the locations where something named name has been defined.
+   * Find all the locations where something has been defined.
    */
-  public findDefinition(name: string): LSP.Location[] {
+  public findDefinition({ word }: { word: string }): LSP.Location[] {
     const symbols: LSP.SymbolInformation[] = []
     Object.keys(this.uriToDeclarations).forEach((uri) => {
-      const declarationNames = this.uriToDeclarations[uri][name] || []
+      const declarationNames = this.uriToDeclarations[uri][word] || []
       declarationNames.forEach((d) => symbols.push(d))
     })
     return symbols.map((s) => s.location)
@@ -317,8 +317,8 @@ export default class Analyzer {
           return
         }
 
-        const name = contents.slice(named.startIndex, named.endIndex)
-        const namedDeclarations = this.uriToDeclarations[uri][name] || []
+        const word = contents.slice(named.startIndex, named.endIndex)
+        const namedDeclarations = this.uriToDeclarations[uri][word] || []
 
         const parent = TreeSitterUtil.findParent(
           n,
@@ -334,14 +334,14 @@ export default class Analyzer {
 
         namedDeclarations.push(
           LSP.SymbolInformation.create(
-            name,
+            word,
             this.treeSitterTypeToLSPKind[n.type],
             TreeSitterUtil.range(n),
             uri,
             parentName,
           ),
         )
-        this.uriToDeclarations[uri][name] = namedDeclarations
+        this.uriToDeclarations[uri][word] = namedDeclarations
       }
     })
 

Diff for: server/src/config.ts

@@ -27,7 +27,7 @@ export function getGlobPattern(): string {
 export function getHighlightParsingError(): boolean {
   const { HIGHLIGHT_PARSING_ERRORS } = process.env
   return typeof HIGHLIGHT_PARSING_ERRORS !== 'undefined'
-    ? HIGHLIGHT_PARSING_ERRORS === 'true' || HIGHLIGHT_PARSING_ERRORS === '1'
+    ? toBoolean(HIGHLIGHT_PARSING_ERRORS)
     : false
 }
 
@@ -39,3 +39,5 @@ export function getBackgroundAnalysisMaxFiles(): number {
   const parsed = parseInt(BACKGROUND_ANALYSIS_MAX_FILES || '', 10)
   return !isNaN(parsed) ? parsed : DEFAULT_BACKGROUND_ANALYSIS_MAX_FILES
 }
+
+const toBoolean = (s: string): boolean => s === 'true' || s === '1'

Diff for: server/src/server.ts

@@ -321,7 +321,7 @@ export default class BashServer {
     if (!word) {
       return null
     }
-    return this.analyzer.findDefinition(word)
+    return this.analyzer.findDefinition({ word })
   }
 
   private onDocumentSymbol(params: LSP.DocumentSymbolParams): LSP.SymbolInformation[] {

Diff for: server/src/util/sh.ts

@@ -85,7 +85,9 @@ export async function getShellDocumentationWithoutCache({
           formattedDocumentation = formatManOutput(formattedDocumentation)
         }
 
-        return formattedDocumentation
+        if (formattedDocumentation) {
+          return formattedDocumentation
+        }
       }
     } catch (error) {
       // Ignoring if command fails and store failure in cache