Allow organizing imports on save

Author: apexskier

.nova/Configuration.json

@@ -1,4 +1,5 @@
 {
+  "apexskier.typescript.config.organizeImportsOnSave": "true",
   "editor.default_syntax": "typescript",
   "workspace.name": "TypeScript Extension"
 }

src/commands/organizeImports.ts

@@ -14,7 +14,17 @@ export function registerOrganizeImports(client: LanguageClient) {
     wrapCommand(organizeImports)
   );
 
-  async function organizeImports(editor: TextEditor) {
+  async function organizeImports(editor: TextEditor): Promise<void>;
+  async function organizeImports(
+    workspace: Workspace,
+    editor: TextEditor
+  ): Promise<void>;
+  async function organizeImports(
+    editorOrWorkspace: TextEditor | Workspace,
+    maybeEditor?: TextEditor
+  ) {
+    const editor: TextEditor = maybeEditor ?? (editorOrWorkspace as TextEditor);
+
     const originalSelections = editor.selectedRanges;
     const originalLength = editor.document.length;
 

src/main.test.ts

@@ -7,6 +7,9 @@ jest.mock("./tsLibPath", () => ({
 jest.mock("./isEnabledForJavascript", () => ({
   isEnabledForJavascript: () => true,
 }));
+jest.mock("./shouldOrganizeImportsOnSave", () => ({
+  shouldOrganizeImportsOnSave: jest.fn(() => true),
+}));
 jest.mock("nova-extension-utils");
 
 jest.useFakeTimers();
@@ -18,6 +21,7 @@ jest.useFakeTimers();
   },
   workspace: {
     path: "/workspace",
+    onDidAddTextEditor: jest.fn(),
   },
   extension: {
     path: "/extension",
@@ -69,6 +73,7 @@ describe("test suite", () => {
       .mockImplementation(() => Promise.resolve());
     nova.fs.access = jest.fn().mockReturnValue(true);
     (nova.commands.register as jest.Mock).mockReset();
+    (nova.commands.invoke as jest.Mock).mockReset();
     LanguageClientMock.mockReset().mockImplementation(() => ({
       onRequest: jest.fn(),
       onNotification: jest.fn(),
@@ -86,6 +91,7 @@ describe("test suite", () => {
       start: jest.fn(),
     }));
     (informationViewModule.InformationView as jest.Mock).mockReset();
+    (nova.workspace.onDidAddTextEditor as jest.Mock).mockReset();
   }
 
   const reload = (nova.commands.register as jest.Mock).mock.calls.find(
@@ -291,5 +297,44 @@ describe("test suite", () => {
 
       assertActivationBehavior();
     });
+
+    test("watches files for import organization", async () => {
+      resetMocks();
+
+      await activate();
+
+      expect(nova.workspace.onDidAddTextEditor).toBeCalledTimes(1);
+      const setupWatcher = (nova.workspace.onDidAddTextEditor as jest.Mock).mock
+        .calls[0][0];
+      const mockEditor = {
+        onWillSave: jest.fn(),
+        onDidDestroy: jest.fn(),
+        document: {
+          syntax: "typescript",
+        },
+      };
+      setupWatcher(mockEditor);
+      expect(mockEditor.onWillSave).toBeCalledTimes(1);
+      const saveHandler = (mockEditor.onWillSave as jest.Mock).mock.calls[0][0];
+      await saveHandler(mockEditor);
+      expect(nova.commands.invoke).toHaveBeenNthCalledWith(
+        1,
+        "apexskier.typescript.commands.organizeImports",
+        mockEditor
+      );
+
+      (nova.commands.invoke as jest.Mock).mockReset();
+      mockEditor.document.syntax = "__something_else__";
+      await saveHandler(mockEditor);
+      expect(nova.commands.invoke).not.toBeCalled();
+
+      (nova.commands.invoke as jest.Mock).mockReset();
+      mockEditor.document.syntax = "typescript";
+      require("./shouldOrganizeImportsOnSave").shouldOrganizeImportsOnSave.mockReturnValue(
+        false
+      );
+      await saveHandler(mockEditor);
+      expect(nova.commands.invoke).not.toBeCalled();
+    });
   });
 });

src/main.ts

@@ -1,13 +1,14 @@
 import { dependencyManagement } from "nova-extension-utils";
 import { registerFindReferences } from "./commands/findReferences";
 import { registerFindSymbol } from "./commands/findSymbol";
-import { registerRename } from "./commands/rename";
 import { registerOrganizeImports } from "./commands/organizeImports";
+import { registerRename } from "./commands/rename";
 import { registerSignatureHelp } from "./commands/signatureHelp";
-import { wrapCommand } from "./novaUtils";
 import { InformationView } from "./informationView";
-import { getTsLibPath } from "./tsLibPath";
 import { isEnabledForJavascript } from "./isEnabledForJavascript";
+import { wrapCommand } from "./novaUtils";
+import { shouldOrganizeImportsOnSave } from "./shouldOrganizeImportsOnSave";
+import { getTsLibPath } from "./tsLibPath";
 
 nova.commands.register(
   "apexskier.typescript.openWorkspaceConfig",
@@ -188,6 +189,24 @@ async function asyncActivate() {
 
   client.start();
 
+  compositeDisposable.add(
+    nova.workspace.onDidAddTextEditor((editor) => {
+      const listener = editor.onWillSave(async (editor) => {
+        if (
+          editor.document.syntax &&
+          syntaxes.includes(editor.document.syntax) &&
+          shouldOrganizeImportsOnSave()
+        ) {
+          await nova.commands.invoke(
+            "apexskier.typescript.commands.organizeImports",
+            editor
+          );
+        }
+      });
+      compositeDisposable.add(editor.onDidDestroy(() => listener.dispose()));
+    })
+  );
+
   getTsVersion(tslibPath).then((version) => {
     informationView.tsVersion = version;
   });

src/shouldOrganizeImportsOnSave.test.ts

@@ -0,0 +1,71 @@
+(global as any).nova = Object.assign(nova, {
+  commands: {
+    invoke: jest.fn(),
+  },
+  config: {
+    onDidChange: jest.fn(),
+    ["get"]: jest.fn(),
+  },
+  workspace: {
+    config: { onDidChange: jest.fn(), ["get"]: jest.fn() },
+  },
+});
+
+jest.mock("nova-extension-utils", () => ({
+  preferences: {
+    getOverridableBoolean: jest.fn(),
+  },
+}));
+
+describe("shouldOrganizeImportsOnSave", () => {
+  beforeEach(() => {
+    (nova.workspace.config.get as jest.Mock).mockReset();
+    (nova.config.get as jest.Mock).mockReset();
+  });
+
+  const {
+    shouldOrganizeImportsOnSave,
+  } = require("./shouldOrganizeImportsOnSave");
+
+  describe("reloads extension when it changes", () => {
+    it("globally and for the workspace", () => {
+      expect(nova.config.onDidChange).toBeCalledTimes(1);
+      expect(nova.config.onDidChange).toBeCalledWith(
+        "apexskier.typescript.config.organizeImportsOnSave",
+        expect.any(Function)
+      );
+      expect(nova.workspace.config.onDidChange).toBeCalledTimes(1);
+      expect(nova.workspace.config.onDidChange).toBeCalledWith(
+        "apexskier.typescript.config.organizeImportsOnSave",
+        expect.any(Function)
+      );
+      // same function
+      const onWorkspaceChange = (nova.workspace.config.onDidChange as jest.Mock)
+        .mock.calls[0][1];
+      const onGlobalChange = (nova.config.onDidChange as jest.Mock).mock
+        .calls[0][1];
+      expect(onWorkspaceChange).toBe(onGlobalChange);
+    });
+
+    it("by calling the reload command", () => {
+      const reload = (nova.config.onDidChange as jest.Mock).mock.calls[0][1];
+      reload();
+      expect(nova.commands.invoke).toBeCalledTimes(1);
+      expect(nova.commands.invoke).toBeCalledWith(
+        "apexskier.typescript.reload"
+      );
+    });
+  });
+
+  it("is false by default", () => {
+    expect(shouldOrganizeImportsOnSave()).toBe(false);
+  });
+
+  it("can be enabled", () => {
+    const {
+      preferences: { getOverridableBoolean },
+    } = require("nova-extension-utils");
+    getOverridableBoolean.mockReturnValue(true);
+    expect(shouldOrganizeImportsOnSave()).toBe(true);
+  });
+});

src/shouldOrganizeImportsOnSave.ts

@@ -0,0 +1,14 @@
+import { preferences } from "nova-extension-utils";
+
+const organizeImportsOnSaveKey =
+  "apexskier.typescript.config.organizeImportsOnSave";
+
+function reload() {
+  nova.commands.invoke("apexskier.typescript.reload");
+}
+nova.config.onDidChange(organizeImportsOnSaveKey, reload);
+nova.workspace.config.onDidChange(organizeImportsOnSaveKey, reload);
+
+export function shouldOrganizeImportsOnSave(): boolean {
+  return preferences.getOverridableBoolean(organizeImportsOnSaveKey) ?? false;
+}

typescript.novaextension/extension.json

@@ -33,6 +33,13 @@
       "link": "nova://extension/?id=apexskier.typescript",
       "type": "string"
     },
+    {
+      "key": "apexskier.typescript.config.organizeImportsOnSave",
+      "title": "Organize imports on save",
+      "description": "Run Organize Imports command on file save.",
+      "type": "boolean",
+      "default": false
+    },
     {
       "key": "apexskier.typescript.config.isEnabledForJavascript",
       "title": "Enable on Javascript Files",
@@ -50,6 +57,18 @@
       "link": "nova://extension/?id=apexskier.typescript",
       "type": "string"
     },
+    {
+      "key": "apexskier.typescript.config.organizeImportsOnSave",
+      "title": "Organize imports on save",
+      "description": "Run Organize Imports command on file save.",
+      "type": "enum",
+      "values": [
+        ["null", "Inherit from Global Settings"],
+        ["false", "Disable"],
+        ["true", "Enable"]
+      ],
+      "default": "null"
+    },
     {
       "key": "apexskier.typescript.config.isEnabledForJavascript",
       "title": "Enable on Javascript Files",