Merge pull request #179 from ayame113/configurable-language-id

Author: aminya

lib/adapters/document-sync-adapter.ts

@@ -55,16 +55,19 @@ export default class DocumentSyncAdapter {
   /**
    * Public: Create a new {DocumentSyncAdapter} for the given language server.
    *
-   * @param connection A {LanguageClientConnection} to the language server to be kept in sync.
+   * @param _connection A {LanguageClientConnection} to the language server to be kept in sync.
    * @param documentSync The document syncing options.
-   * @param editorSelector A predicate function that takes a {TextEditor} and returns a {boolean} indicating whether
+   * @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.
    */
   constructor(
     private _connection: LanguageClientConnection,
     private _editorSelector: (editor: TextEditor) => boolean,
     documentSync: TextDocumentSyncOptions | TextDocumentSyncKind | undefined,
-    private _reportBusyWhile: Utils.ReportBusyWhile
+    private _reportBusyWhile: Utils.ReportBusyWhile,
+    private _getLanguageIdFromEditor: (editor: TextEditor) => string
   ) {
     if (typeof documentSync === "object") {
       this._documentSync = documentSync
@@ -119,7 +122,8 @@ export default class DocumentSyncAdapter {
       this._connection,
       this._documentSync,
       this._versions,
-      this._reportBusyWhile
+      this._reportBusyWhile,
+      this._getLanguageIdFromEditor
     )
     this._editors.set(editor, sync)
     this._disposable.add(sync)
@@ -149,16 +153,17 @@ export class TextEditorSyncAdapter {
   /**
    * Public: Create a {TextEditorSyncAdapter} in sync with a given language server.
    *
-   * @param editor A {TextEditor} to keep in sync.
-   * @param connection A {LanguageClientConnection} to a language server to keep in sync.
-   * @param documentSync The document syncing options.
+   * @param _editor A {TextEditor} to keep in sync.
+   * @param _connection A {LanguageClientConnection} to a language server to keep in sync.
+   * @param _documentSync The document syncing options.
    */
   constructor(
     private _editor: TextEditor,
     private _connection: LanguageClientConnection,
     private _documentSync: TextDocumentSyncOptions,
     private _versions: Map<string, number>,
-    private _reportBusyWhile: Utils.ReportBusyWhile
+    private _reportBusyWhile: Utils.ReportBusyWhile,
+    private _getLanguageIdFromEditor: (editor: TextEditor) => string
   ) {
     this._fakeDidChangeWatchedFiles = atom.project.onDidChangeFiles == null
 
@@ -203,9 +208,9 @@ export class TextEditorSyncAdapter {
     this._disposable.dispose()
   }
 
-  /** Get the languageId field that will be sent to the language server by simply using the grammar name. */
+  /** Get the languageId field that will be sent to the language server by simply using the `_getLanguageIdFromEditor`. */
   public getLanguageId(): string {
-    return this._editor.getGrammar().name
+    return this._getLanguageIdFromEditor(this._editor)
   }
 
   /**

lib/auto-languageclient.ts

@@ -295,6 +295,28 @@ export default class AutoLanguageClient {
     return configuration
   }
 
+  /**
+   * (Optional) Determines the `languageId` string used for `textDocument/didOpen` notification. The default is to use
+   * the grammar name.
+   *
+   * You can override this like this:
+   *
+   *     class MyLanguageClient extends AutoLanguageClient {
+   *       getLanguageIdFromEditor(editor: TextEditor) {
+   *         if (editor.getGrammar().scopeName === "source.myLanguage") {
+   *           return "myCustumLanguageId"
+   *         }
+   *         return super.getLanguageIdFromEditor(editor)
+   *       }
+   *     }
+   *
+   * @param editor A {TextEditor} which is opened.
+   * @returns A {string} of `languageId` used for `textDocument/didOpen` notification.
+   */
+  protected getLanguageIdFromEditor(editor: TextEditor): string {
+    return editor.getGrammar().name
+  }
+
   // Helper methods that are useful for implementors
   // ---------------------------------------------------------------------------
 
@@ -576,7 +598,8 @@ export default class AutoLanguageClient {
         server.connection,
         (editor) => this.shouldSyncForEditor(editor, server.projectPath),
         server.capabilities.textDocumentSync,
-        this.reportBusyWhile
+        this.reportBusyWhile,
+        (editor) => this.getLanguageIdFromEditor(editor)
       )
       server.disposable.add(docSyncAdapter)
     }

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

@@ -1,5 +1,6 @@
 import { TextDocumentSyncKind, TextDocumentSyncOptions } from "../../lib/languageclient"
 import DocumentSyncAdapter from "../../lib/adapters/document-sync-adapter"
+import { createFakeEditor } from "../helpers"
 
 describe("DocumentSyncAdapter", () => {
   describe("canAdapt", () => {
@@ -52,7 +53,8 @@ describe("DocumentSyncAdapter", () => {
         null as any,
         () => false,
         textDocumentSync,
-        (_t, f) => f()
+        (_t, f) => f(),
+        () => ""
       )
     }
 
@@ -81,4 +83,24 @@ describe("DocumentSyncAdapter", () => {
       expect(result).toBe(TextDocumentSyncKind.Full)
     })
   })
+
+  describe("getLanguageId", () => {
+    function create(getLanguageIdFromEditor: () => string) {
+      return new DocumentSyncAdapter(
+        null as any,
+        () => false,
+        TextDocumentSyncKind.Incremental,
+        (_t, f) => f(),
+        getLanguageIdFromEditor
+      )
+    }
+
+    it("use the return value of `_getLanguageIdFromEditor` as the languageId", () => {
+      const editor = createFakeEditor()
+      const adapter = create(() => "someLanguageId") as any
+      adapter._handleNewEditor(editor)
+      const result = adapter.getEditorSyncAdapter(editor).getLanguageId()
+      expect(result).toBe("someLanguageId")
+    })
+  })
 })

test/auto-languageclient.test.ts

@@ -209,4 +209,14 @@ describe("AutoLanguageClient", () => {
       expect(client.shouldSyncForEditor(editor, "/path/to/somewhere")).toBe(false)
     })
   })
+
+  describe("getLanguageIdFromEditor", () => {
+    const client = setupClient()
+
+    it("returns the editor's grammar name", () => {
+      const editor = new TextEditor()
+      spyOn(editor, "getGrammar").and.returnValue({ name: "testGrammarName" } as any)
+      expect((client as any).getLanguageIdFromEditor(editor)).toBe("testGrammarName")
+    })
+  })
 })