feat: auto insert semicolon on import completion (#104)

NomicFoundation · Sep 20, 2022 · ae62417 · ae62417
1 parent b3f404c
commit ae62417
Show file tree

Hide file tree

Showing 30 changed files with 108 additions and 45 deletions.
diff --git a/client/src/commands/Command.ts b/client/src/commands/Command.ts
@@ -3,7 +3,7 @@ import { ExtensionState } from "../types";
 export default abstract class Command {
   constructor(public state: ExtensionState) {}
 
-  public abstract execute(commandArgs: unknown): Promise<unknown>;
+  public abstract execute(...commandArgs: unknown[]): Promise<unknown>;
 
   public abstract name(): string;
 }
diff --git a/client/src/commands/InsertSemicolonCommand.ts b/client/src/commands/InsertSemicolonCommand.ts
@@ -0,0 +1,26 @@
+import vscode, { Position } from "vscode";
+import Command from "./Command";
+
+export default class InsertSemicolonCommand extends Command {
+  public async execute(position: Position) {
+    const editor = vscode.window.activeTextEditor;
+
+    if (editor === undefined) return;
+
+    const document = editor.document;
+
+    const lineText = document.lineAt(position.line).text;
+
+    if (/.*;$/.test(lineText)) {
+      return;
+    }
+
+    await editor.edit((builder) =>
+      builder.insert(new Position(position.line, lineText.length), ";")
+    );
+  }
+
+  public name(): string {
+    return "insertSemicolon";
+  }
+}
diff --git a/client/src/setup/setupCommands.ts b/client/src/setup/setupCommands.ts
@@ -4,19 +4,24 @@ import { ExtensionState } from "../types";
 import CompileCommand from "../commands/CompileCommand";
 import FlattenCurrentFileCommand from "../commands/FlattenCurrentFileCommand";
 import CleanCommand from "../commands/CleanCommand";
+import InsertSemicolonCommand from "../commands/InsertSemicolonCommand";
+import Command from "../commands/Command";
 
-const commandClasses = [
+type ICommandClass = new (state: ExtensionState) => Command;
+
+const commandClasses: ICommandClass[] = [
   CompileCommand,
   FlattenCurrentFileCommand,
   CleanCommand,
+  InsertSemicolonCommand,
 ];
 
 export async function setupCommands(state: ExtensionState) {
   for (const commandClass of commandClasses) {
     const command = new commandClass(state);
     const disposable = vscode.commands.registerCommand(
       `hardhat.solidity.${command.name()}`,
-      () => command.execute()
+      (...args) => command.execute(...args)
     );
     state.context.subscriptions.push(disposable);
   }

diff --git a/package.json b/package.json
@@ -171,6 +171,11 @@
         "command": "hardhat.solidity.clean",
         "title": "Hardhat: Clear cache and artifacts "
       },
+      {
+        "command": "hardhat.solidity.insertSemicolon",
+        "title": "Insert semicolon",
+        "enablement": "false"
+      },
       {
         "command": "hardhat.solidity.flattenCurrentFile",
         "title": "Hardhat: Flatten this file and its dependencies",

diff --git a/server/src/services/completion/getImportPathCompletion.ts b/server/src/services/completion/getImportPathCompletion.ts
@@ -21,6 +21,8 @@ export function getImportPathCompletion(
   const currentImport = node.astNode.path.replace("_;", "");
   const importPath = toUnixStyle(path.join(node.realUri, "..", currentImport));
 
+  let items: CompletionItem[];
+
   if (currentImport === "") {
     const relativeImports = getRelativeImportPathCompletions(
       position,
@@ -33,18 +35,29 @@ export function getImportPathCompletion(
     const indexNodeModuleFolders =
       getIndexedNodeModuleFolderCompletions(projCtx);
 
-    return relativeImports.concat(indexNodeModuleFolders);
+    items = relativeImports.concat(indexNodeModuleFolders);
   } else if (isRelativeImport(currentImport)) {
-    return getRelativeImportPathCompletions(
+    items = getRelativeImportPathCompletions(
       position,
       currentImport,
       importPath,
       node,
       logger
     );
   } else {
-    return getDirectImportPathCompletions(position, currentImport, projCtx);
+    items = getDirectImportPathCompletions(position, currentImport, projCtx);
   }
+
+  // Trigger auto-insertion of semicolon after import completion
+  for (const item of items) {
+    item.command = {
+      command: "hardhat.solidity.insertSemicolon",
+      arguments: [position],
+      title: "",
+    };
+  }
+
+  return items;
 }
 
 function isRelativeImport(currentImport: string) {

diff --git a/server/src/services/completion/onCompletion.ts b/server/src/services/completion/onCompletion.ts
@@ -135,7 +135,7 @@ export function doComplete(
   }
 
   if (
-    context?.triggerCharacter === '"' &&
+    ['"', "'"].includes(context?.triggerCharacter ?? "") &&
     (!definitionNode || !isImportDirectiveNode(definitionNode))
   ) {
     return null;

diff --git a/server/src/services/initialization/onInitialize.ts b/server/src/services/initialization/onInitialize.ts
@@ -38,7 +38,7 @@ export const onInitialize = (serverState: ServerState) => {
         textDocumentSync: TextDocumentSyncKind.Incremental,
         // Tell the client that this server supports code completion.
         completionProvider: {
-          triggerCharacters: [".", "/", '"'],
+          triggerCharacters: [".", "/", '"', "'"],
         },
         signatureHelpProvider: {
           triggerCharacters: ["(", ","],

diff --git a/server/test/server.ts b/server/test/server.ts
@@ -45,7 +45,7 @@ describe("Solidity Language Server", () => {
       describe("completions", () => {
         it("advertises capability", () =>
           assert.deepStrictEqual(capabilities.completionProvider, {
-            triggerCharacters: [".", "/", '"'],
+            triggerCharacters: [".", "/", '"', "'"],
           }));
 
         it("registers onCompletion", () =>

diff --git a/server/test/services/completion/imports.ts b/server/test/services/completion/imports.ts
@@ -13,6 +13,14 @@ import {
 import { forceToUnixStyle } from "../../helpers/forceToUnixStyle";
 import { prependWithSlash } from "../../helpers/prependWithSlash";
 
+const semicolonCommand = (position: VSCodePosition) => ({
+  command: {
+    arguments: [position],
+    command: "hardhat.solidity.insertSemicolon",
+    title: "",
+  },
+});
+
 describe("Parser", () => {
   const workspaceFolder = prependWithSlash(
     forceToUnixStyle(path.join(__dirname, "../../../test"))
@@ -591,8 +599,6 @@ describe("Parser", () => {
       });
 
       describe("direct", function () {
-        this.timeout(5000);
-
         before(async () => {
           const openzepplinUri1 = forceToUnixStyle(
             path.join(
@@ -796,6 +802,7 @@ const assertImportCompletion = async (
     .map((comp) => ({
       ...comp,
       documentation: "Imports the package",
+      ...semicolonCommand(position),
     }))
     .sort((left, right) => left.label.localeCompare(right.label));
 

diff --git a/test/integration/index.ts b/test/integration/index.ts
@@ -3,12 +3,20 @@ import path from "path";
 import Mocha from "mocha";
 // eslint-disable-next-line import/no-extraneous-dependencies
 import glob from "glob";
+import { sleep } from "./helpers/sleep";
 
 export function run(): Promise<void> {
   // Create the mocha test
   const mocha = new Mocha({
     ui: "tdd",
     color: true,
+    rootHooks: {
+      beforeAll: async () => {
+        await sleep(5000); // Wait for the extension to be loaded
+      },
+    },
+    timeout: 30000,
+    retries: 1,
   });
 
   const testsRoot = path.resolve(__dirname, "tests");

diff --git a/test/integration/projects/main/contracts/completion/AddSemicolon.sol b/test/integration/projects/main/contracts/completion/AddSemicolon.sol
diff --git a/test/integration/tests/codeactions/addLicenseIdentifier.test.ts b/test/integration/tests/codeactions/addLicenseIdentifier.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - add license identifier", function () {
-  this.timeout(30000);
-
   test("add MIT license identifier", async () => {
     const uri = getTestContractUri("main/contracts/codeactions/NoLicense.sol");
     const editor = await openFileInEditor(uri);

diff --git a/test/integration/tests/codeactions/addMultiOverrideSpecifier.test.ts b/test/integration/tests/codeactions/addMultiOverrideSpecifier.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - add multi override specifier", function () {
-  this.timeout(30000);
-
   test("add multi override on multiple occurrences", async () => {
     const uri = getTestContractUri(
       "main/contracts/codeactions/AddMultioverrideSpecifier.sol"

diff --git a/test/integration/tests/codeactions/addOverrideSpecifier.test.ts b/test/integration/tests/codeactions/addOverrideSpecifier.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - add override specifier", function () {
-  this.timeout(30000);
-
   test("add override on multiple occurrences", async () => {
     const uri = getTestContractUri(
       "main/contracts/codeactions/AddOverrideSpecifier.sol"

diff --git a/test/integration/tests/codeactions/addPragmaVersion.test.ts b/test/integration/tests/codeactions/addPragmaVersion.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - add solidity pragma", function () {
-  this.timeout(30000);
-
   test("add version of current compiler", async () => {
     const uri = getTestContractUri("main/contracts/codeactions/NoPragma.sol");
     const editor = await openFileInEditor(uri);

diff --git a/test/integration/tests/codeactions/addVirtualSpecifier.test.ts b/test/integration/tests/codeactions/addVirtualSpecifier.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - add virtual specifier", function () {
-  this.timeout(30000);
-
   test("add virtual specifier on multiple occurrences", async () => {
     const uri = getTestContractUri(
       "main/contracts/codeactions/AddVirtualSpecifier.sol"

diff --git a/test/integration/tests/codeactions/constrainMutability.test.ts b/test/integration/tests/codeactions/constrainMutability.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - constrain mutability", function () {
-  this.timeout(30000);
-
   test("add view modifier", async () => {
     const uri = getTestContractUri(
       "main/contracts/codeactions/ConstrainMutabilityView.sol"

diff --git a/test/integration/tests/codeactions/markAbstract.test.ts b/test/integration/tests/codeactions/markAbstract.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - mark abstract", function () {
-  this.timeout(30000);
-
   test("add missing functions from interfaces", async () => {
     const uri = getTestContractUri(
       "main/contracts/codeactions/MarkAbstract.sol"

diff --git a/test/integration/tests/codeactions/specifyVisibility.test.ts b/test/integration/tests/codeactions/specifyVisibility.test.ts
@@ -10,8 +10,6 @@ import {
 } from "../../helpers/editor";
 
 suite("codeactions - specify visibility", function () {
-  this.timeout(30000);
-
   test("specify public", async () => {
     const uri = getTestContractUri(
       "main/contracts/codeactions/SpecifyVisibility.sol"

diff --git a/test/integration/tests/commands/clean.test.ts b/test/integration/tests/commands/clean.test.ts
@@ -7,8 +7,6 @@ import { sleep } from "../../helpers/sleep";
 import { getRootPath } from "../../helpers/workspace";
 
 suite("task - clean", function () {
-  this.timeout(30000);
-
   test("run clean task", async () => {
     // Close any active editor - since running a task saves the current file apparently
     await vscode.commands.executeCommand("workbench.action.closeActiveEditor");

diff --git a/test/integration/tests/commands/flatten.test.ts b/test/integration/tests/commands/flatten.test.ts
@@ -5,8 +5,6 @@ import { getTestContractUri } from "../../helpers/getTestContract";
 import { openFileInEditor, waitForUI } from "../../helpers/editor";
 
 suite("commands - flatten", function () {
-  this.timeout(30000);
-
   test("flatten via command palette", async () => {
     const uri = getTestContractUri("main/contracts/commands/Importer.sol");
     await openFileInEditor(uri);

diff --git a/test/integration/tests/completion/completion.test.ts b/test/integration/tests/completion/completion.test.ts
@@ -0,0 +1,32 @@
+import * as assert from "assert";
+import vscode from "vscode";
+import { openFileInEditor, waitForUI } from "../../helpers/editor";
+import { type } from "../../helpers/commands";
+import { sleep } from "../../helpers/sleep";
+import { getTestContractUri } from "../../helpers/getTestContract";
+
+suite("completion", function () {
+  test("[completion] - add semicolon automatically after import", async () => {
+    const uri = getTestContractUri(
+      "main/contracts/completion/AddSemicolon.sol"
+    );
+    const editor = await openFileInEditor(uri);
+    const document = editor.document;
+
+    await type(document, "import '");
+    await sleep(2000);
+    await vscode.commands.executeCommand("acceptSelectedSuggestion");
+    await waitForUI();
+    assert.equal(document.getText(), "import '@openzeppelin';");
+
+    await type(document, "/");
+    await sleep(1000);
+    await vscode.commands.executeCommand("acceptSelectedSuggestion");
+
+    await waitForUI();
+    assert.equal(
+      document.getText(),
+      "import '@openzeppelin/contracts/access/AccessControl.sol';"
+    );
+  });
+});
diff --git a/test/integration/tests/configuration/configuration.test.ts b/test/integration/tests/configuration/configuration.test.ts
@@ -24,7 +24,7 @@ suite("Configuration", function () {
         textDocumentSync: 2,
         codeActionProvider: true,
         completionProvider: {
-          triggerCharacters: [".", "/", '"'],
+          triggerCharacters: [".", "/", '"', "'"],
         },
         signatureHelpProvider: {
           triggerCharacters: ["(", ","],

diff --git a/test/integration/tests/definition/definition.test.ts b/test/integration/tests/definition/definition.test.ts
@@ -7,8 +7,6 @@ import { getTestContractUri } from "../../helpers/getTestContract";
 import { getRootPath } from "../../helpers/workspace";
 
 suite("Single-file Navigation", function () {
-  this.timeout(10000);
-
   const testUri = getTestContractUri("main/contracts/definition/Test.sol");
   const importTestUri = getTestContractUri(
     "main/contracts/definition/ImportTest.sol"

diff --git a/test/integration/tests/diagnostics/diagnostics.test.ts b/test/integration/tests/diagnostics/diagnostics.test.ts
@@ -4,8 +4,6 @@ import { getTestContractUri } from "../../helpers/getTestContract";
 import { openFileInEditor } from "../../helpers/editor";
 
 suite("diagnostics", function () {
-  this.timeout(30000);
-
   test("[diagnostics] missing semicolon", async () => {
     const uri = getTestContractUri(
       "main/contracts/diagnostics/MissingSemicolon.sol"

diff --git a/test/integration/tests/implementation/implementation.test.ts b/test/integration/tests/implementation/implementation.test.ts
@@ -4,8 +4,6 @@ import { assertLspCommand } from "../../common/assertLspCommand";
 import { getTestContractUri } from "../../helpers/getTestContract";
 
 suite("Single-file Navigation", function () {
-  this.timeout(10000);
-
   const testUri = getTestContractUri("main/contracts/implementation/Test.sol");
 
   let client!: Client;

diff --git a/test/integration/tests/references/references.test.ts b/test/integration/tests/references/references.test.ts
@@ -4,8 +4,6 @@ import { assertLspCommand } from "../../common/assertLspCommand";
 import { getTestContractUri } from "../../helpers/getTestContract";
 
 suite("Single-file Navigation", function () {
-  this.timeout(10000);
-
   const testUri = getTestContractUri("main/contracts/references/Test.sol");
   const importedUri = getTestContractUri(
     "main/contracts/references/Imported.sol"

diff --git a/test/integration/tests/remappings/remappings.test.ts b/test/integration/tests/remappings/remappings.test.ts
@@ -9,7 +9,6 @@ import {
 import { assertPositionEqual } from "../../helpers/assertions";
 
 suite("remappings", function () {
-  this.timeout(30000);
   test("[remappings] multiple navigations", async () => {
     const importerUri = getTestContractUri("remappings/src/Importer.sol");
     const importedUri = getTestContractUri("remappings/lib/myLib/Imported.sol");

diff --git a/test/integration/tests/rename/rename.test.ts b/test/integration/tests/rename/rename.test.ts
@@ -4,8 +4,6 @@ import { assertLspCommand } from "../../common/assertLspCommand";
 import { getTestContractUri } from "../../helpers/getTestContract";
 
 suite("Single-file Navigation", function () {
-  this.timeout(10000);
-
   const testUri = getTestContractUri("main/contracts/rename/Test.sol");
   const importTestUri = getTestContractUri(
     "main/contracts/rename/MultiImport.sol"

diff --git a/test/integration/tests/typedefinition/typedefinition.test.ts b/test/integration/tests/typedefinition/typedefinition.test.ts
@@ -4,8 +4,6 @@ import { assertLspCommand } from "../../common/assertLspCommand";
 import { getTestContractUri } from "../../helpers/getTestContract";
 
 suite("Single-file Navigation", function () {
-  this.timeout(10000);
-
   const testUri = getTestContractUri("main/contracts/typedefinition/Test.sol");
   const importedUri = getTestContractUri(
     "main/contracts/typedefinition/Imported.sol"