Merge pull request #145 from atom-community/update-eslint

UziTech · web-flow · commit 15820004a47b · 2021-04-13T23:01:50.000-05:00
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,7 +1,17 @@
 {
-  "extends": "eslint-config-atomic/strict",
+  "extends": ["eslint-config-atomic/strict", "plugin:chai-friendly/recommended"],
   "ignorePatterns": ["build/", "node_modules/"],
   "rules": {
+    "no-eq-null": "warn",
+    "eqeqeq": "warn",
+    "no-empty-function": "warn",
+    "class-methods-use-this": "warn",
+    "default-case": "warn",
+    "no-new": "warn",
+    "no-shadow": "warn",
+    "no-invalid-this": "warn",
+    "require-await": "warn",
+    "no-useless-constructor": "warn",
     "@typescript-eslint/ban-types": [
       "error",
       {
@@ -16,7 +26,7 @@
         "allowArgumentsExplicitlyTypedAsAny": true
       }
     ],
-    "@typescript-eslint/no-empty-function": "off",
+    "@typescript-eslint/no-empty-function": "warn",
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-unused-vars": [
       "error",
diff --git a/lib/adapters/command-execution-adapter.ts b/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,13 +24,13 @@ 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 {
     return {
-      command: command,
+      command,
       arguments: commandArgs,
     }
   }
diff --git a/lib/adapters/outline-view-adapter.ts b/lib/adapters/outline-view-adapter.ts
@@ -111,11 +111,13 @@ export default class OutlineViewAdapter {
    * @returns An {OutlineTree} containing the given symbols that the Outline View can display.
    */
   public static createOutlineTrees(symbols: SymbolInformation[]): atomIde.OutlineTree[] {
-    symbols.sort((a, b) =>
-      a.location.range.start.line === b.location.range.start.line
-        ? a.location.range.start.character - b.location.range.start.character
-        : a.location.range.start.line - b.location.range.start.line
-    )
+    symbols.sort((a, b) => {
+      if (a.location.range.start.line === b.location.range.start.line) {
+        return a.location.range.start.character - b.location.range.start.character
+      } else {
+        return a.location.range.start.line - b.location.range.start.line
+      }
+    })
 
     // Temporarily keep containerName through the conversion process
     // Also filter out symbols without a name - it's part of the spec but some don't include it
diff --git a/lib/auto-languageclient.ts b/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))
   }
 
diff --git a/lib/download-file.ts b/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) {
diff --git a/lib/server-manager.ts b/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
   }
 
diff --git a/package.json b/package.json
@@ -38,11 +38,9 @@
     "@types/mocha": "^8.2.0",
     "@types/node": "14.14.22",
     "@types/sinon": "^9.0.10",
-    "@typescript-eslint/eslint-plugin": "^4.14.1",
-    "@typescript-eslint/parser": "^4.14.1",
     "chai": "^4.2.0",
-    "eslint": "^7.18.0",
-    "eslint-config-atomic": "1.10.1",
+    "eslint-config-atomic": "^1.14.0",
+    "eslint-plugin-chai-friendly": "^0.6.0",
     "mocha": "^8.2.1",
     "mocha-appveyor-reporter": "^0.4.2",
     "shx": "^0.3.3",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/test/adapters/apply-edit-adapter.test.ts b/test/adapters/apply-edit-adapter.test.ts
@@ -12,7 +12,7 @@ const TEST_PATH4 = normalizeDriveLetterName(path.join(__dirname, "test4.txt"))
 
 function normalizeDriveLetterName(filePath: string): string {
   if (process.platform === "win32") {
-    return filePath.replace(/^([a-z]):/, ([driveLetter]) => driveLetter.toUpperCase() + ":")
+    return filePath.replace(/^([a-z]):/, ([driveLetter]) => `${driveLetter.toUpperCase()}:`)
   } else {
     return filePath
   }
diff --git a/test/adapters/autocomplete-adapter.test.ts b/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(
             [
diff --git a/test/adapters/code-action-adapter.test.ts b/test/adapters/code-action-adapter.test.ts
@@ -57,7 +57,7 @@ describe("CodeActionAdapter", () => {
       expect((languageClient as any).codeAction.called).to.be.true
       const args = (languageClient as any).codeAction.getCalls()[0].args
       const params: ls.CodeActionParams = args[0]
-      expect(params.textDocument.uri).to.equal("file://" + testPath)
+      expect(params.textDocument.uri).to.equal(`file://${testPath}`)
       expect(params.range).to.deep.equal({
         start: { line: 1, character: 2 },
         end: { line: 3, character: 4 },
diff --git a/test/adapters/show-document-adapter.test.ts b/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) {
diff --git a/test/auto-languageclient.test.ts b/test/auto-languageclient.test.ts
@@ -31,12 +31,12 @@ describe("AutoLanguageClient", () => {
     })
 
     it("does not select documents in unsupported language", () => {
-      const editor = mockEditor("/path/to/somewhere", client.getGrammarScopes()[0] + "-dummy")
+      const editor = mockEditor("/path/to/somewhere", `${client.getGrammarScopes()[0]}-dummy`)
       expect(client.shouldSyncForEditor(editor, "/path/to/somewhere")).equals(false)
     })
 
     it("does not select documents in unsupported language outside of project", () => {
-      const editor = mockEditor("/path/to/elsewhere/file", client.getGrammarScopes()[0] + "-dummy")
+      const editor = mockEditor("/path/to/elsewhere/file", `${client.getGrammarScopes()[0]}-dummy`)
       expect(client.shouldSyncForEditor(editor, "/path/to/somewhere")).equals(false)
     })
   })
diff --git a/test/convert.test.ts b/test/convert.test.ts
@@ -132,7 +132,7 @@ describe("Convert", () => {
     it("uses getath which returns a path to create the URI", () => {
       const path = "/c/d/e/f/g/h/i/j.txt"
       const identifier = Convert.editorToTextDocumentIdentifier(createFakeEditor(path))
-      expect(identifier.uri).equals("file://" + path)
+      expect(identifier.uri).equals(`file://${path}`)
     })
   })
 
@@ -142,7 +142,7 @@ describe("Convert", () => {
       const editor = createFakeEditor(path, "abc\ndefgh\nijkl")
       editor.setCursorBufferPosition(new Point(1, 2))
       const params = Convert.editorToTextDocumentPositionParams(editor)
-      expect(params.textDocument.uri).equals("file://" + path)
+      expect(params.textDocument.uri).equals(`file://${path}`)
       expect(params.position).deep.equals({ line: 1, character: 2 })
     })
 
@@ -152,7 +152,7 @@ describe("Convert", () => {
       const editor = createFakeEditor(path, "abcdef\nghijkl\nmnopq")
       editor.setCursorBufferPosition(new Point(1, 1))
       const params = Convert.editorToTextDocumentPositionParams(editor, specifiedPoint)
-      expect(params.textDocument.uri).equals("file://" + path)
+      expect(params.textDocument.uri).equals(`file://${path}`)
       expect(params.position).deep.equals({ line: 911, character: 112 })
     })
   })
diff --git a/test/utils.test.ts b/test/utils.test.ts
@@ -50,7 +50,7 @@ describe("Utils", () => {
     it("returns the exe path under bin folder by default", () => {
       let expectedExe = join(process.cwd(), "bin", `${process.platform}-${process.arch}`, "serve-d")
       if (process.platform === "win32") {
-        expectedExe = expectedExe + ".exe"
+        expectedExe = `${expectedExe}.exe`
       }
 
       const fsMock = sinon.mock(fs)
@@ -65,7 +65,7 @@ describe("Utils", () => {
       const rootPath = join(__dirname, `${process.platform}-${process.arch}`)
       let expectedExe = join(rootPath, "serve-d")
       if (process.platform === "win32") {
-        expectedExe = expectedExe + ".exe"
+        expectedExe = `${expectedExe}.exe`
       }
 
       const fsMock = sinon.mock(fs)

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,8 @@ export default class CommandExecutionAdapter {`
`14`	`14`	`this.commandsCustomCallbacks.set(command, callback)`
`15`	`15`	`}`
`16`	`16`
`17`		`- public static async executeCommand(`
	`17`	`+ /** Returns a {Promise} */`
	`18`	`+ public static executeCommand(`
`18`	`19`	`connection: LanguageClientConnection,`
`19`	`20`	`command: string,`
`20`	`21`	`commandArgs?: any[]`
`@@ -23,13 +24,13 @@ export default class CommandExecutionAdapter {`
`23`	`24`	`const commandCustomCallback = this.commandsCustomCallbacks.get(command)`
`24`	`25`
`25`	`26`	`return commandCustomCallback !== undefined`
`26`		`- ? await commandCustomCallback(executeCommandParams)`
`27`		`- : await connection.executeCommand(executeCommandParams)`
	`27`	`+ ? commandCustomCallback(executeCommandParams)`
	`28`	`+ : connection.executeCommand(executeCommandParams)`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`private static createExecuteCommandParams(command: string, commandArgs?: any[]): ExecuteCommandParams {`
`31`	`32`	`return {`
`32`		`- command: command,`
	`33`	`+ command,`
`33`	`34`	`arguments: commandArgs,`
`34`	`35`	`}`
`35`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -428,7 +428,9 @@ export default class AutoLanguageClient {`
`428`	`428`	`lsProcess.on("close", (code, signal) => this.onSpawnClose(code, signal))`
`429`	`429`	`lsProcess.on("disconnect", () => this.onSpawnDisconnect())`
`430`	`430`	`lsProcess.on("exit", (code, signal) => this.onSpawnExit(code, signal))`
	`431`	`+ // eslint-disable-next-line chai-friendly/no-unused-expressions`
`431`	`432`	`lsProcess.stderr?.setEncoding("utf8")`
	`433`	`+ // eslint-disable-next-line chai-friendly/no-unused-expressions`
`432`	`434`	`lsProcess.stderr?.on("data", (chunk: Buffer) => this.onSpawnStdErrData(chunk, projectPath))`
`433`	`435`	`}`
`434`	`436`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,8 @@ export class ServerManager {`
`138`	`138`	`if (startingPromise) {`
`139`	`139`	`return startingPromise`
`140`	`140`	`}`
`141`		`-`
	`141`	`+ // TODO remove eslint-disable`
	`142`	`+ // eslint-disable-next-line no-return-await`
`142`	`143`	`return shouldStart && this._startForEditor(textEditor) ? await this.startServer(finalProjectPath) : null`
`143`	`144`	`}`
`144`	`145`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ const TEST_PATH4 = normalizeDriveLetterName(path.join(__dirname, "test4.txt"))`
`12`	`12`
`13`	`13`	`function normalizeDriveLetterName(filePath: string): string {`
`14`	`14`	`if (process.platform === "win32") {`
`15`		`- return filePath.replace(/^([a-z]):/, ([driveLetter]) => driveLetter.toUpperCase() + ":")`
	`15`	+ return filePath.replace(/^([a-z]):/, ([driveLetter]) => `${driveLetter.toUpperCase()}:`)
`16`	`16`	`} else {`
`17`	`17`	`return filePath`
`18`	`18`	`}`