feat: add getExePath

Author: aminya

README.md

@@ -87,9 +87,10 @@ Note that you will also need to add various entries to the `providedServices` an
 
 If the LSP is a general executable (not a JavaScript file), you should use `spawn` inside `startServerProcess`.
 
+`getExePath` is a cross-platform utility function to get the exe path for the given exe name (under the `bin` folder by default).
+
 ```javascript
-const {AutoLanguageClient} = require('atom-languageclient')
-const {resolve} = require('path')
+const {AutoLanguageClient, getExePath} = require('atom-languageclient')
 
 class DLanguageClient extends AutoLanguageClient {
   getGrammarScopes () { return [ 'source.d' ] }
@@ -98,8 +99,8 @@ class DLanguageClient extends AutoLanguageClient {
 
   startServerProcess (projectPath) {
     return super.spawn(
-      resolve('./bin/serve-d'), // path to the LSP executable
-      [],                       // args used for spawning
+      getExePath('serve-d'),    // path to the LSP executable.
+      [],                       // args passed to spawn the exe
       { cwd: projectPath }      // child process spawn options
     )
   }

lib/main.ts

@@ -9,6 +9,7 @@ import { Logger, ConsoleLogger, FilteredLogger } from './logger';
 import DownloadFile from './download-file';
 import LinterPushV2Adapter from './adapters/linter-push-v2-adapter';
 import CommandExecutionAdapter from './adapters/command-execution-adapter';
+export { getExePath } from "./utils"
 
 export * from './auto-languageclient';
 export {

lib/utils.ts

@@ -1,3 +1,4 @@
+import { join, resolve } from 'path';
 import {
   Point,
   TextBuffer,
@@ -111,3 +112,18 @@ export function promiseWithTimeout<T>(ms: number, promise: Promise<T>): Promise<
     });
   });
 }
+
+
+/** Finds an exe file in the package assuming it is placed under `rootPath/platform/exe`
+ * For example on Windows, if the `exeName` is `serve-d`, it returns the absolute path to `bin/win32/exeName.exe`
+ * @param exeName name of the exe file
+ * @param rootPath the path of the folder of the exe file. Defaults to 'bin'
+ * @param exeExtention the extention of the exe file. Defaults to `process.platform === "win32" ? ".exe" : ""`
+ */
+export function getExePath(
+ exeName: string,
+ rootPath = "bin",
+ exeExtention = process.platform === "win32" ? ".exe" : ""
+): string {
+ return resolve(join(rootPath, process.platform, `${exeName}${exeExtention}`));
+}