Code actions (#156)

Author: maskmaster

packages/analyzer/src/issue.ts

@@ -1,4 +1,4 @@
-import type { Position } from "@knuckles/location";
+import type { Position, Range } from "@knuckles/location";
 
 export enum AnalyzerSeverity {
   Error = "error",
@@ -11,4 +11,15 @@ export interface AnalyzerIssue {
   message: string;
   start: Position | undefined;
   end: Position | undefined;
+  quickFix?: AnalyzerQuickFix | undefined;
+}
+
+export interface AnalyzerQuickFix {
+  label?: string | undefined;
+  edits: AnalyzerQuickFixEdit[];
+}
+
+export interface AnalyzerQuickFixEdit {
+  range: Range;
+  text: string;
 }

packages/analyzer/src/standard/rules/virtual-element-end-notation.ts

@@ -10,9 +10,8 @@ export default {
   check({ report, document }) {
     document.visit(
       (node): void => {
-        const regex = new RegExp(
-          `\\/ko\\s+${escapeStringRegexp(node.binding.name.value)}`,
-        );
+        const bindingName = node.binding.name.value;
+        const regex = new RegExp(`\\/ko\\s+${escapeStringRegexp(bindingName)}`);
 
         if (!regex.test(node.endComment.content)) {
           report({
@@ -21,6 +20,15 @@ export default {
             severity: this.severity,
             start: node.endComment.start,
             end: node.endComment.end,
+            quickFix: {
+              label: "Add notation",
+              edits: [
+                {
+                  range: node.endComment,
+                  text: `<!-- /ko ${bindingName} -->`,
+                },
+              ],
+            },
           });
         }
       },

packages/language-service/src/features/code-actions.ts

@@ -0,0 +1,112 @@
+import type { LanguageServiceWorker } from "../private.js";
+import {
+  type ProtocolPosition,
+  type ProtocolRange,
+} from "../utils/position.js";
+import { Range } from "@knuckles/location";
+
+export interface DiagnosticIdentifier {
+  code: string;
+  range: ProtocolRange;
+}
+
+export interface CodeActionParams {
+  fileName: string;
+  position: ProtocolPosition;
+  diagnostics?: DiagnosticIdentifier[];
+}
+
+export interface CodeAction {
+  label: string;
+  edits: CodeActionEdit[];
+  diagnostic?: DiagnosticIdentifier;
+}
+
+export type CodeActionEdit =
+  | {
+      type: "create-file";
+      fileName: string;
+    }
+  | {
+      type: "delete-file";
+      fileName: string;
+    }
+  | {
+      type: "rename-file";
+      oldFileName: string;
+      newFileName: string;
+    }
+  | {
+      type: "delete";
+      fileName: string;
+      range: ProtocolRange;
+    }
+  | {
+      type: "replace";
+      fileName: string;
+      range: ProtocolRange;
+      text: string;
+    }
+  | {
+      type: "insert";
+      fileName: string;
+      position: ProtocolPosition;
+      text: string;
+    };
+
+export type CodeActions = CodeAction[];
+
+export default async function getCodeActions(
+  this: LanguageServiceWorker,
+  params: CodeActionParams,
+): Promise<CodeActions> {
+  const state = await this.getDocumentState(params.fileName);
+  if (state.broken) return [];
+
+  const codeActions: CodeActions = [];
+
+  for (const issue of state.issues) {
+    if (issue.quickFix) {
+      const diagnostic = (params.diagnostics ?? []).find((diagnostic) =>
+        Range.fromLinesAndColumns(
+          diagnostic.range.start.line,
+          diagnostic.range.start.column,
+          diagnostic.range.end.line,
+          diagnostic.range.end.column,
+          state.document.text,
+        ),
+      );
+      const label = issue.quickFix.label ?? "Fix this issue";
+      const edits = issue.quickFix.edits.map((edit): CodeActionEdit => {
+        if (edit.text.length === 0) {
+          return {
+            type: "delete",
+            fileName: params.fileName,
+            range: edit.range,
+          };
+        } else if (edit.range.size === 0) {
+          return {
+            type: "insert",
+            fileName: params.fileName,
+            position: edit.range.start.toJSON(),
+            text: edit.text,
+          };
+        } else {
+          return {
+            type: "replace",
+            fileName: params.fileName,
+            range: edit.range.toJSON(),
+            text: edit.text,
+          };
+        }
+      });
+      codeActions.push({
+        label,
+        edits,
+        diagnostic,
+      });
+    }
+  }
+
+  return codeActions;
+}

packages/language-service/src/features/completion.ts

@@ -86,7 +86,6 @@ export default async function getCompletion(
       includeCompletionsForImportStatements: false,
       includeCompletionsForModuleExports: false,
       allowRenameOfImportPath: false,
-      // TODO: get quote from current binding attribute
       quotePreference,
       triggerCharacter: params.context?.triggerCharacter as
         | ts.CompletionsTriggerCharacter

packages/language-service/src/features/diagnostics.ts

@@ -1,7 +1,8 @@
 import type { LanguageServiceWorker } from "../private.js";
+import type { Document } from "../utils/document.js";
+import { getFullIssueRange } from "../utils/issue.js";
 import type { ProtocolRange } from "../utils/position.js";
 import { AnalyzerSeverity, type AnalyzerIssue } from "@knuckles/analyzer";
-import { Position, Range } from "@knuckles/location";
 
 export interface DiagnosticsParams {
   fileName: string;
@@ -31,19 +32,17 @@ export default async function getDiagnostics(
   const state = await this.getDocumentState(params.fileName);
 
   const diagnostics = state.issues.map((issue) =>
-    translateIssueToDiagnostic(issue, state.document.text),
+    translateIssueToDiagnostic(state.document, issue),
   );
 
   return diagnostics;
 }
 
 function translateIssueToDiagnostic(
+  document: Document,
   issue: AnalyzerIssue,
-  text: string,
 ): Diagnostic {
-  const start = issue.start ?? Position.fromOffset(0, text);
-  const end = issue.end ?? Position.fromOffset(start.offset + 1, text);
-  const range = new Range(start, end);
+  const range = getFullIssueRange(document, issue);
   const severity = {
     [AnalyzerSeverity.Error]: DiagnosticSeverity.Error,
     [AnalyzerSeverity.Warning]: DiagnosticSeverity.Warning,

packages/language-service/src/index.ts

@@ -1,4 +1,5 @@
 export * from "./public.js";
+export type * from "./features/code-actions.js";
 export type * from "./features/completion.js";
 export type * from "./features/definition.js";
 export type * from "./features/diagnostics.js";

packages/language-service/src/private.ts

@@ -1,3 +1,4 @@
+import getCodeActions from "./features/code-actions.js";
 import getCompletion from "./features/completion.js";
 import getDefinition from "./features/definition.js";
 import getDiagnostics from "./features/diagnostics.js";
@@ -31,6 +32,7 @@ export class LanguageServiceWorker {
     "document/definition": getDefinition.bind(this),
     "document/diagnostics": getDiagnostics.bind(this),
     "document/hover": getHover.bind(this),
+    "document/quick-fixes": getCodeActions.bind(this),
   };
 
   #programProvider = new ProgramProvider();

packages/language-service/src/public.ts

@@ -1,3 +1,4 @@
+import type { CodeActions, CodeActionParams } from "./features/code-actions.js";
 import type { Completion, CompletionParams } from "./features/completion.js";
 import type { Definition, DefinitionParams } from "./features/definition.js";
 import type { Diagnostics, DiagnosticsParams } from "./features/diagnostics.js";
@@ -129,5 +130,9 @@ export class LanguageService {
   getHover(params: HoverParams): Promise<Hover | null> {
     return this.#client.request("document/hover", params);
   }
+
+  getCodeActions(params: CodeActionParams): Promise<CodeActions> {
+    return this.#client.request("document/quick-fixes", params);
+  }
   //#endregion
 }

packages/language-service/src/utils/issue.ts

@@ -0,0 +1,10 @@
+import type { Document } from "./document.js";
+import type { AnalyzerIssue } from "@knuckles/analyzer";
+import { Position, Range } from "@knuckles/location";
+
+export function getFullIssueRange(document: Document, issue: AnalyzerIssue) {
+  const start = issue.start ?? Position.fromOffset(0, document.text);
+  const end = issue.end ?? Position.fromOffset(start.offset + 1, document.text);
+  const range = new Range(start, end);
+  return range;
+}