Configure document formatting before organizing imports (#241)

* Configure document formatting before organizing imports

Fixes #236

* Lint fix

* Lint

* tests

Author: apexskier

CONTRIBUTING.md

@@ -16,6 +16,8 @@ Turn on extension development in Nova in Preferences > General > Extension Devel
 
 To debug the underlying language server, modify the `run.sh` file to use the [`--inspect` flag](https://nodejs.org/en/docs/guides/debugging-getting-started/) and use [your preferred inspector to debug](https://nodejs.org/en/docs/guides/debugging-getting-started/#inspector-clients).
 
+To debug the underlying `tsserver` modify the language server code to exec it through `node` with [`--inspect`](https://nodejs.org/en/docs/guides/debugging-getting-started/). The file to be modified is `~/Library/Application Support/Nova/Extensions/apexskier.typescript/dependencyManagement/node_modules/typescript-language-server/lib/tsp-client.js`. (Set `args = ['node', '--inspect-brk', tsserverPath]` and replace `tsserverPath` with `'/usr/bin/env'` in `cp.fork`/`cp.spawn`.) You can increase server shutdown timeouts in the file `~/Library/Application Support/Nova/Extensions/apexskier.typescript/dependencyManagement/node_modules/typescript-language-server/lib/utils.js`
+
 Use the Extension Console in Nova to debug the extension. I haven't found a way to get a debugger attached to the JavaScriptCore context.
 
 ### Extension dependencies

src/commands/organizeImports.test.ts

@@ -38,6 +38,8 @@ describe("organizeImports command", () => {
       },
       eol: "\n",
     },
+    softTabs: true,
+    tabLength: 2,
     edit: jest.fn(),
     selectWordsContainingCursors: jest.fn(),
     scrollToCursorPosition: jest.fn(),
@@ -59,7 +61,7 @@ describe("organizeImports command", () => {
     return command;
   }
 
-  it("asks the server to organize imports, then resets your selection", async () => {
+  it("configures formatting with the server, asks the server to organize imports, then resets your selection", async () => {
     const mockLanguageClient = {
       sendRequest: jest.fn().mockImplementationOnce(() => {
         mockEditor.document.length = 14;
@@ -72,8 +74,20 @@ describe("organizeImports command", () => {
     expect(mockEditor.selectedRanges).toEqual([new Range(2, 3)]);
     await command(mockEditor);
 
-    expect(mockLanguageClient.sendRequest).toBeCalledTimes(1);
-    expect(mockLanguageClient.sendRequest).toHaveBeenCalledWith(
+    expect(mockLanguageClient.sendRequest).toBeCalledTimes(2);
+    expect(mockLanguageClient.sendRequest).toHaveBeenNthCalledWith(
+      1,
+      "textDocument/formatting",
+      {
+        textDocument: { uri: "currentDocURI" },
+        options: {
+          insertSpaces: true,
+          tabSize: 2,
+        },
+      }
+    );
+    expect(mockLanguageClient.sendRequest).toHaveBeenNthCalledWith(
+      2,
       "workspace/executeCommand",
       {
         arguments: ["/path"],

src/commands/organizeImports.ts

@@ -38,6 +38,18 @@ export function registerOrganizeImports(client: LanguageClient) {
       return;
     }
 
+    // Ensure the language server is aware of the formatting settings for this editor
+    // Normally this command is used to apply formatting, but we just skip applying
+    // the response and rely on the server caching the formatting settings.
+    const documentFormatting: lspTypes.DocumentFormattingParams = {
+      textDocument: { uri: editor.document.uri },
+      options: {
+        insertSpaces: editor.softTabs,
+        tabSize: editor.tabLength,
+      },
+    };
+    await client.sendRequest("textDocument/formatting", documentFormatting);
+
     const organizeImportsCommand: lspTypes.ExecuteCommandParams = {
       command: "_typescript.organizeImports",
       arguments: [editor.document.path],

src/searchResults.test.ts

@@ -2,8 +2,8 @@
 import type * as lspTypes from "vscode-languageserver-protocol";
 import * as lsp from "vscode-languageserver-types";
 import {
-  createSymbolSearchResultsTree,
   createLocationSearchResultsTree,
+  createSymbolSearchResultsTree,
 } from "./searchResults";
 
 (global as any).nova = Object.assign(nova, {