chore: remove excess await/async + add TODOs

Author: aminya

lib/adapters/command-execution-adapter.ts

@@ -14,7 +14,8 @@ export default class CommandExecutionAdapter {
     this.commandsCustomCallbacks.set(command, callback)
   }
 
-  public static async executeCommand(
+  /** Returns a {Promise} */
+  public static executeCommand(
     connection: LanguageClientConnection,
     command: string,
     commandArgs?: any[]
@@ -23,8 +24,8 @@ export default class CommandExecutionAdapter {
     const commandCustomCallback = this.commandsCustomCallbacks.get(command)
 
     return commandCustomCallback !== undefined
-      ? await commandCustomCallback(executeCommandParams)
-      : await connection.executeCommand(executeCommandParams)
+      ? commandCustomCallback(executeCommandParams)
+      : connection.executeCommand(executeCommandParams)
   }
 
   private static createExecuteCommandParams(command: string, commandArgs?: any[]): ExecuteCommandParams {

lib/auto-languageclient.ts

@@ -428,7 +428,9 @@ export default class AutoLanguageClient {
     lsProcess.on("close", (code, signal) => this.onSpawnClose(code, signal))
     lsProcess.on("disconnect", () => this.onSpawnDisconnect())
     lsProcess.on("exit", (code, signal) => this.onSpawnExit(code, signal))
+    // eslint-disable-next-line chai-friendly/no-unused-expressions
     lsProcess.stderr?.setEncoding("utf8")
+    // eslint-disable-next-line chai-friendly/no-unused-expressions
     lsProcess.stderr?.on("data", (chunk: Buffer) => this.onSpawnStdErrData(chunk, projectPath))
   }
 

lib/download-file.ts

@@ -60,6 +60,8 @@ async function streamWithProgress(
 
   // eslint-disable-next-line no-constant-condition
   while (true) {
+    // TODO use Promise.all
+    // eslint-disable-next-line no-await-in-loop
     const result = await reader.read()
     if (result.done) {
       if (progressCallback != null) {

lib/server-manager.ts

@@ -138,7 +138,8 @@ export class ServerManager {
     if (startingPromise) {
       return startingPromise
     }
-
+    // TODO remove eslint-disable
+    // eslint-disable-next-line no-return-await
     return shouldStart && this._startForEditor(textEditor) ? await this.startServer(finalProjectPath) : null
   }
 

test/adapters/autocomplete-adapter.test.ts

@@ -44,7 +44,7 @@ describe("AutoCompleteAdapter", () => {
   type getSuggestionParams = Parameters<typeof autoCompleteAdapter.getSuggestions>
 
   /** Function that stubs `server.connection.completion` and returns the `autoCompleteAdapter.getSuggestions(...)`  */
-  async function getSuggestionsMock(
+  function getSuggestionsMock(
     items: CompletionItem[],
     request: getSuggestionParams[1],
     onDidConvertCompletionItem?: getSuggestionParams[2],
@@ -288,7 +288,7 @@ describe("AutoCompleteAdapter", () => {
 
     it("respects onDidConvertCompletionItem", async () => {
       const results = await getSuggestionsMock([{ label: "label" }], createRequest({}), (c, a, r) => {
-        ;(a as ac.TextSuggestion).text = c.label + " ok"
+        ;(a as ac.TextSuggestion).text = `${c.label} ok`
         a.displayText = r.scopeDescriptor.getScopesArray()[0]
       })
 
@@ -448,7 +448,7 @@ describe("AutoCompleteAdapter", () => {
       expect(result.replacementPrefix).equals("")
     })
 
-    describe("applies changes from TextEdit to text", async () => {
+    describe("applies changes from TextEdit to text", () => {
       const customRequest = createRequest({ prefix: "", position: new Point(0, 10) })
       customRequest.editor.setText("foo #align bar")
 
@@ -473,7 +473,7 @@ describe("AutoCompleteAdapter", () => {
         expect((results[0] as TextSuggestion).customReplacmentPrefix).equals("#align")
       })
 
-      describe("applies the change if shouldReplace is true", async () => {
+      describe("applies the change if shouldReplace is true", () => {
         it("1", async () => {
           const results = await getSuggestionsMock(
             [
@@ -575,7 +575,7 @@ describe("AutoCompleteAdapter", () => {
         })
       })
 
-      describe("applies the change if shouldReplace is false", async () => {
+      describe("applies the change if shouldReplace is false", () => {
         it("1", async () => {
           const results = await getSuggestionsMock(
             [

test/adapters/show-document-adapter.test.ts

@@ -10,21 +10,23 @@ import { createSpyConnection } from "../helpers"
 
 describe("ShowDocumentAdapter", () => {
   describe("can attach to a server", () => {
-    it("subscribes to onShowDocument", async () => {
+    it("subscribes to onShowDocument", () => {
       const connection = createSpyConnection()
       const lcc = new LanguageClientConnection(connection)
 
       const spy = sinon.spy()
-      lcc["_onRequest"] = spy
+      // eslint-disable-next-line dot-notation
+      lcc["_onRequest"] = spy // private method access
 
       ShowDocumentAdapter.attach(lcc)
+      // eslint-disable-next-line dot-notation
       expect((lcc["_onRequest"] as sinon.SinonSpy).calledOnce).to.be.true
       const spyArgs = spy.firstCall.args
       expect(spyArgs[0]).to.deep.equal({ method: "window/showDocument" })
       expect(spyArgs[1]).to.equal(ShowDocumentAdapter.showDocument)
     })
 
-    it("onRequest connection is called", async () => {
+    it("onRequest connection is called", () => {
       const connection = createSpyConnection()
       const lcc = new LanguageClientConnection(connection)
 
@@ -39,7 +41,7 @@ describe("ShowDocumentAdapter", () => {
     })
   })
   describe("can show documents", () => {
-    describe("shows the document inside Atom", async () => {
+    describe("shows the document inside Atom", () => {
       const helloPath = join(dirname(__dirname), "fixtures", "hello.js")
 
       async function canShowDocumentInAtom(params: ShowDocumentParams) {