feat: support custom onApplyCodeActions

Co-Authored-By: Alex Butler <[email protected]>
atom-community · Jun 14, 2021 · 868f883 · 868f883
1 parent 949e624
commit 868f883
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/lib/adapters/code-action-adapter.ts b/lib/adapters/code-action-adapter.ts
@@ -42,7 +42,8 @@ export default class CodeActionAdapter {
     editor: TextEditor,
     range: Range,
     linterMessages: linter.Message[] | atomIde.Diagnostic[],
-    filterActions: (actions: (Command | CodeAction)[] | null) => (Command | CodeAction)[] | null = (actions) => actions
+    filterActions: (actions: (Command | CodeAction)[] | null) => (Command | CodeAction)[] | null = (actions) => actions,
+    onApply: (action: Command | CodeAction) => Promise<boolean> = () => Promise.resolve(true)
   ): Promise<atomIde.CodeAction[]> {
     if (linterAdapter == null) {
       return []
@@ -54,15 +55,19 @@ export default class CodeActionAdapter {
     if (actions === null) {
       return []
     }
-    return actions.map((action) => CodeActionAdapter.createCodeAction(action, connection))
+    return actions.map((action) => CodeActionAdapter.createCodeAction(action, connection, onApply))
   }
 
   private static createCodeAction(
     action: Command | CodeAction,
-    connection: LanguageClientConnection
+    connection: LanguageClientConnection,
+    onApply: (action: Command | CodeAction) => Promise<boolean>
   ): atomIde.CodeAction {
     return {
       async apply() {
+        if ((await onApply(action)) === false) {
+          return
+        }
         if (CodeAction.is(action)) {
           CodeActionAdapter.applyWorkspaceEdit(action.edit)
           await CodeActionAdapter.executeCommand(action.command, connection)

diff --git a/lib/auto-languageclient.ts b/lib/auto-languageclient.ts
@@ -945,7 +945,8 @@ export default class AutoLanguageClient {
       editor,
       range,
       diagnostics,
-      this.filterCodeActions.bind(this)
+      this.filterCodeActions.bind(this),
+      this.onApplyCodeActions.bind(this)
     )
   }
 
@@ -954,6 +955,14 @@ export default class AutoLanguageClient {
     return actions
   }
 
+  /**
+   * Optionally handle a code action before default handling. Return `false` to prevent default handling, `true` to
+   * continue with default handling.
+   */
+  protected async onApplyCodeActions(_action: ls.Command | ls.CodeAction): Promise<boolean> {
+    return true
+  }
+
   public provideRefactor(): atomIde.RefactorProvider {
     return {
       grammarScopes: this.getGrammarScopes(),