Default to shellcheck binary found on path

Author: skovhus

server/src/__tests__/linter.test.ts

@@ -2,7 +2,7 @@ import * as path from 'path'
 import * as LSP from 'vscode-languageserver'
 
 import { FIXTURE_DOCUMENT, FIXTURE_FOLDER } from '../../../testing/fixtures'
-import Linter, { assertShellcheckResult } from '../linter'
+import { assertShellcheckResult, Linter } from '../linter'
 
 function textToDoc(txt: string) {
   return LSP.TextDocument.create('foo', 'bar', 0, txt)

server/src/linter.ts

@@ -1,6 +1,9 @@
 import { spawn } from 'child_process'
 import * as LSP from 'vscode-languageserver'
 
+import * as config from './config'
+import { execShellScript } from './util/sh'
+
 function formatMessage(comment: ShellcheckComment): string {
   return (comment.code ? `SC${comment.code}: ` : '') + comment.message
 }
@@ -10,8 +13,23 @@ type LinterOptions = {
   cwd?: string
 }
 
-export default class Linter {
-  private executablePath: string | null
+export async function getLinterExecutablePath(): Promise<string | null> {
+  const pathFromConfig = config.getShellcheckPath()
+
+  if (pathFromConfig) {
+    return pathFromConfig
+  }
+
+  try {
+    const path = (await execShellScript('which shellcheck')).trim()
+    return path === '' ? null : path
+  } catch (e) {
+    return null
+  }
+}
+
+export class Linter {
+  public executablePath: string | null
   private cwd: string
   _canLint: boolean
 

server/src/server.ts

@@ -8,7 +8,7 @@ import Analyzer from './analyser'
 import * as Builtins from './builtins'
 import * as config from './config'
 import Executables from './executables'
-import Linter from './linter'
+import { getLinterExecutablePath, Linter } from './linter'
 import { initializeParser } from './parser'
 import * as ReservedWords from './reservedWords'
 import { BashCompletionItem, CompletionItemDataType } from './types'
@@ -41,8 +41,9 @@ export default class BashServer {
     return Promise.all([
       Executables.fromPath(PATH),
       Analyzer.fromRoot({ connection, rootPath, parser }),
-      new Linter({ executablePath: config.getShellcheckPath() }),
-    ]).then(([executables, analyzer, linter]) => {
+      getLinterExecutablePath(),
+    ]).then(([executables, analyzer, linterExecutablePath]) => {
+      const linter = new Linter({ executablePath: linterExecutablePath })
       return new BashServer(connection, executables, analyzer, linter, capabilities)
     })
   }

server/src/util/sh.ts

@@ -29,7 +29,7 @@ export function execShellScript(body: string, cmd = 'bash'): 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.
+// are no documentation for them.
 const WORDS_WITHOUT_DOCUMENTATION = new Set([
   'else',
   'fi',