fix: test and comment

Author: ayame113

lib/adapters/document-sync-adapter.ts

@@ -60,14 +60,14 @@ export default class DocumentSyncAdapter {
    * @param _editorSelector A predicate function that takes a {TextEditor} and returns a {boolean} indicating whether
    *   this adapter should care about the contents of the editor.
    * @param _getLanguageIdFromEditor A function that returns a {string} of `languageId` used for `textDocument/didOpen`
-   *   notification. If {null} or {undefined} is returned, it will fall back to the editor's grammar name.
+   *   notification.
    */
   constructor(
     private _connection: LanguageClientConnection,
     private _editorSelector: (editor: TextEditor) => boolean,
     documentSync: TextDocumentSyncOptions | TextDocumentSyncKind | undefined,
     private _reportBusyWhile: Utils.ReportBusyWhile,
-    private _getLanguageIdFromEditor: (editor: TextEditor) => string | void | null
+    private _getLanguageIdFromEditor: (editor: TextEditor) => string
   ) {
     if (typeof documentSync === "object") {
       this._documentSync = documentSync
@@ -163,7 +163,7 @@ export class TextEditorSyncAdapter {
     private _documentSync: TextDocumentSyncOptions,
     private _versions: Map<string, number>,
     private _reportBusyWhile: Utils.ReportBusyWhile,
-    private _getLanguageIdFromEditor: (editor: TextEditor) => string | void | null
+    private _getLanguageIdFromEditor: (editor: TextEditor) => string
   ) {
     this._fakeDidChangeWatchedFiles = atom.project.onDidChangeFiles == null
 
@@ -208,12 +208,9 @@ export class TextEditorSyncAdapter {
     this._disposable.dispose()
   }
 
-  /**
-   * Get the languageId field that will be sent to the language server by simply using the `_getLanguageIdFromEditor`.
-   * Fall back to the grammar name if `_getLanguageIdFromEditor` returns null or undefined.
-   */
+  /** Get the languageId field that will be sent to the language server by simply using the `_getLanguageIdFromEditor`. */
   public getLanguageId(): string {
-    return this._getLanguageIdFromEditor(this._editor) ?? this._editor.getGrammar().name
+    return this._getLanguageIdFromEditor(this._editor)
   }
 
   /**

lib/auto-languageclient.ts

@@ -296,8 +296,8 @@ export default class AutoLanguageClient {
   }
 
   /**
-   * (Optional) Determines the `languageId` string used for `textDocument/didOpen` notification. If {null} or
-   * {undefined} is returned, it will fall back to the {_editor}'s grammar name.
+   * (Optional) Determines the `languageId` string used for `textDocument/didOpen` notification. The default is to use
+   * the grammar name.
    *
    * You can override this like this:
    *
@@ -306,14 +306,15 @@ export default class AutoLanguageClient {
    *         if (editor.getGrammar().scopeName === "source.myLanguage") {
    *           return "myCustumLanguageId"
    *         }
+   *         return super.getLanguageIdFromEditor(editor)
    *       }
    *     }
    *
-   * @param _editor A {TextEditor} which is opened.
+   * @param editor A {TextEditor} which is opened.
    * @returns A {string} of `languageId` used for `textDocument/didOpen` notification.
    */
-  protected getLanguageIdFromEditor(_editor: TextEditor): string {
-    return this._editor.getGrammar().name
+  protected getLanguageIdFromEditor(editor: TextEditor): string {
+    return editor.getGrammar().name
   }
 
   // Helper methods that are useful for implementors

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

@@ -54,7 +54,7 @@ describe("DocumentSyncAdapter", () => {
         () => false,
         textDocumentSync,
         (_t, f) => f(),
-        () => undefined
+        () => ""
       )
     }
 
@@ -85,7 +85,7 @@ describe("DocumentSyncAdapter", () => {
   })
 
   describe("getLanguageId", () => {
-    function create(getLanguageIdFromEditor: () => string | null | void) {
+    function create(getLanguageIdFromEditor: () => string) {
       return new DocumentSyncAdapter(
         null as any,
         () => false,
@@ -102,32 +102,5 @@ describe("DocumentSyncAdapter", () => {
       const result = adapter.getEditorSyncAdapter(editor).getLanguageId()
       expect(result).toBe("someLanguageId")
     })
-
-    it("fall back to the grammar name if `_getLanguageIdFromEditor` returns undefined", () => {
-      const editor = createFakeEditor()
-      spyOn(editor, "getGrammar").and.returnValue({ name: "testGrammarName" } as any)
-      const adapter = create(() => undefined) as any
-      adapter._handleNewEditor(editor)
-      const result = adapter.getEditorSyncAdapter(editor).getLanguageId()
-      expect(result).toBe("testGrammarName")
-    })
-
-    it("fall back to the grammar name if `_getLanguageIdFromEditor` returns null", () => {
-      const editor = createFakeEditor()
-      spyOn(editor, "getGrammar").and.returnValue({ name: "testGrammarName" } as any)
-      const adapter = create(() => null) as any
-      adapter._handleNewEditor(editor)
-      const result = adapter.getEditorSyncAdapter(editor).getLanguageId()
-      expect(result).toBe("testGrammarName")
-    })
-
-    it("don't fall back to the grammar name if `_getLanguageIdFromEditor` returns an empty string", () => {
-      const editor = createFakeEditor()
-      spyOn(editor, "getGrammar").and.returnValue({ name: "testGrammarName" } as any)
-      const adapter = create(() => "") as any
-      adapter._handleNewEditor(editor)
-      const result = adapter.getEditorSyncAdapter(editor).getLanguageId()
-      expect(result).toBe("")
-    })
   })
 })