Skip documentation for some builtins

Previously this was skipped as the parser logic was broken.

Author: skovhus

server/src/util/__tests__/sh.test.ts

@@ -20,6 +20,11 @@ describe('getDocumentation', () => {
     expect(lines[1]).toContain('list directory contents')
   })
 
+  it('skips documentation for some builtins', async () => {
+    const result = await sh.getShellDocumentation({ word: 'else' })
+    expect(result).toEqual(null)
+  })
+
   it('sanity checks the given word', async () => {
     await expect(sh.getShellDocumentation({ word: 'ls foo' })).rejects.toThrow()
   })

server/src/util/sh.ts

@@ -24,6 +24,18 @@ export function execShellScript(body: string): Promise<string> {
   })
 }
 
+// Currently only reserved words where documentation doesn't make sense.
+// At least on OS X these just return the builtin man. On ubuntu there
+// are no documentaiton for them.
+const WORDS_WITHOUT_DOCUMENTATION = new Set([
+  'else',
+  'fi',
+  'then',
+  'esac',
+  'elif',
+  'done',
+])
+
 /**
  * Get documentation for the given word by usingZZ help and man.
  */
@@ -36,6 +48,10 @@ export async function getShellDocumentationWithoutCache({
     throw new Error(`lookupDocumentation should be given a word, received "${word}"`)
   }
 
+  if (WORDS_WITHOUT_DOCUMENTATION.has(word)) {
+    return null
+  }
+
   const DOCUMENTATION_COMMANDS = [
     { type: 'help', command: `help ${word} | col -bx` },
     // We have experimented with setting MANWIDTH to different values for reformatting.