Fix build, move LintItem defn, change literal to constant kCodeViewGetDiagnostics

Author: vezwork

apps/lsp/src/custom.ts

@@ -28,10 +28,10 @@ import { LspConnection, registerLspServerMethods } from "core-node";
 import { userDictionaryDir, Document } from "quarto-core";
 import { CompletionList } from "vscode-languageserver-types";
 import { Hover, Position, TextDocuments } from "vscode-languageserver";
-import { CodeViewCellContext, CodeViewCompletionContext, kCodeViewAssist, kCodeViewGetCompletions } from "editor-types";
+import { CodeViewCellContext, CodeViewCompletionContext, kCodeViewAssist, kCodeViewGetDiagnostics, kCodeViewGetCompletions, LintItem } from "editor-types";
 import { yamlCompletions } from "./service/providers/completion/completion-yaml";
 import { yamlHover } from "./service/providers/hover/hover-yaml";
-import { EditorContext, LintItem, Quarto, codeEditorContext } from "./service/quarto";
+import { EditorContext, Quarto, codeEditorContext } from "./service/quarto";
 
 export function registerCustomMethods(
   quarto: Quarto,
@@ -63,11 +63,11 @@ export function registerCustomMethods(
     // we have the yaml hover and completions here so provide entry points for them
     [kCodeViewAssist]: args => codeViewAssist(quarto, args[0]),
     [kCodeViewGetCompletions]: args => codeViewCompletions(quarto, args[0]),
-    'codeViewGetDiagnostics': args => codeViewDiagnostics(quarto, args[0])
+    [kCodeViewGetDiagnostics]: args => codeViewDiagnostics(quarto, args[0])
   });
 }
 
-async function codeViewDiagnostics(quarto: Quarto, context: CodeViewCellContext) {
+async function codeViewDiagnostics(quarto: Quarto, context: CodeViewCellContext): Promise<LintItem[] | undefined> {
   const edContext = codeEditorContext(
     context.filepath,
     context.language == "yaml" ? "yaml" : "script",

apps/lsp/src/quarto.ts

@@ -35,12 +35,12 @@ import {
   CompletionResult,
   EditorContext,
   HoverResult,
-  LintItem,
   AttrContext,
   AttrToken,
   kContextDiv,
   kContextDivSimple
 } from "./service/quarto";
+import { LintItem } from "editor-types";
 
 export async function initializeQuarto(context: QuartoContext): Promise<Quarto> {
   const quartoModule = await initializeQuartoYamlModule(context.resourcePath) as QuartoYamlModule;

apps/lsp/src/service/providers/diagnostics-yaml.ts

@@ -24,14 +24,10 @@ import {
 import { Document } from "quarto-core";
 
 import {
-  kEndColumn,
-  kEndRow,
-  kStartColumn,
-  kStartRow,
-  LintItem,
   Quarto,
   docEditorContext
 } from "../quarto";
+import { kEndColumn, kEndRow, kStartColumn, kStartRow, LintItem } from "editor-types";
 
 export async function provideYamlDiagnostics(
   quarto: Quarto,

apps/lsp/src/service/quarto.ts

@@ -18,21 +18,7 @@ import { CompletionItem, Position } from "vscode-languageserver-types";
 import { QuartoContext, Document, filePathForDoc, isQuartoDoc, isQuartoRevealDoc, isQuartoYaml, isQuartoDashboardDoc } from "quarto-core";
 
 import { lines } from "core";
-
-
-export const kStartRow = "start.row";
-export const kStartColumn = "start.column";
-export const kEndRow = "end.row";
-export const kEndColumn = "end.column";
-
-export interface LintItem {
-  [kStartRow]: number;
-  [kStartColumn]: number;
-  [kEndRow]: number;
-  [kEndColumn]: number;
-  text: string;
-  type: string;
-}
+import { LintItem } from "editor-types";
 
 export interface CompletionResult {
   token: string;

apps/vscode/src/providers/editor/codeview.ts

@@ -43,6 +43,8 @@ import {
   CodeViewServer,
   DiagramState,
   kCodeViewGetCompletions,
+  kCodeViewGetDiagnostics,
+  LintItem
 } from "editor-types";
 
 import { hasHooks } from "../../host/hooks";
@@ -73,10 +75,10 @@ export function vscodeCodeViewServer(_engine: MarkdownEngine, document: TextDocu
           break;
       }
     },
-    async codeViewDiagnostics(context: CodeViewCellContext): Promise<any> {
+    async codeViewDiagnostics(context: CodeViewCellContext): Promise<LintItem[] | undefined> {
       // if this is yaml then call the lsp directly
       if (context.language === "yaml") {
-        return lspRequest('codeViewGetDiagnostics', [context]);
+        return lspRequest(kCodeViewGetDiagnostics, [context]);
       }
     },
     async codeViewCompletions(context: CodeViewCompletionContext): Promise<CompletionList> {

packages/editor-codemirror/src/behaviors/completion.ts

@@ -42,7 +42,7 @@ import md from "markdown-it";
 
 import { editorLanguage } from "editor-core";
 
-import { CodeViewCompletionContext, codeViewCompletionContext } from "editor";
+import { CodeViewCompletionContext, codeViewCompletionContext, LintItem } from "editor";
 
 import { Behavior, BehaviorContext } from ".";
 import { escapeRegExpCharacters } from "core";
@@ -109,15 +109,11 @@ async function getDiagnostics(
   context: CompletionContext,
   cvContext: CodeViewCompletionContext,
   behaviorContext: BehaviorContext
-): Promise<any> {
-
+): Promise<LintItem[] | undefined> {
   const diagnostics = await behaviorContext.pmContext.ui.codeview?.codeViewDiagnostics(cvContext);
-  if (context.aborted || !diagnostics) {
-    console.log('DEBUG FAILED DIAGNOSTICS!', diagnostics)
-    return null;
-  }
-  console.log('DEBUG GOT DIAGNOSTICS!', diagnostics)
-  return diagnostics
+  if (context.aborted || !diagnostics) return undefined;
+
+  return diagnostics;
 }
 
 async function getCompletions(

packages/editor-core/src/services.ts

@@ -48,7 +48,7 @@ import {
   CodeViewActiveBlockContext,
   DiagramState,
   CodeViewCellContext,
-
+  kCodeViewGetDiagnostics
 } from "editor-types";
 
 
@@ -88,7 +88,7 @@ export function editorCodeViewJsonRpcServer(request: JsonRpcRequestTransport): C
       return request(kCodeViewExecute, [execute, context]);
     },
     codeViewDiagnostics(context: CodeViewCellContext) {
-      return request('codeViewGetDiagnostics', [context])
+      return request(kCodeViewGetDiagnostics, [context])
     },
     codeViewCompletions(context: CodeViewCompletionContext) {
       return request(kCodeViewGetCompletions, [context]);

packages/editor-server/src/services/codeview.ts

@@ -21,6 +21,7 @@ import {
   kCodeViewExecute,
   kCodeViewPreviewDiagram,
   kCodeViewAssist,
+  kCodeViewGetDiagnostics
 } from "editor-types";
 
 
@@ -30,7 +31,7 @@ export function codeViewServerMethods(server: CodeViewServer): Record<string, Js
     [kCodeViewAssist]: args => server.codeViewAssist(args[0]),
     [kCodeViewExecute]: args => server.codeViewExecute(args[0], args[1]),
     [kCodeViewGetCompletions]: args => server.codeViewCompletions(args[0]),
-    'codeViewGetDiagnostics': args => server.codeViewDiagnostics(args[0]),
+    [kCodeViewGetDiagnostics]: args => server.codeViewDiagnostics(args[0]),
     [kCodeViewPreviewDiagram]: args => server.codeViewPreviewDiagram(args[0], args[1])
   }
   return methods;

packages/editor-types/src/codeview.ts

@@ -20,6 +20,7 @@ export const kCodeViewAssist = 'code_view_assist';
 export const kCodeViewGetCompletions = 'code_view_get_completions';
 export const kCodeViewExecute = 'code_view_execute';
 export const kCodeViewPreviewDiagram = 'code_view_preview_diagram';
+export const kCodeViewGetDiagnostics = 'code_view_get_diagnostics';
 
 export type CodeViewExecute = "selection" | "cell" | "cell+advance" | "above" | "below";
 
@@ -41,14 +42,29 @@ export interface CodeViewCellContext {
   selection: Range;
 }
 
+// copy&pasted these from `apps/lsp/src/service/quarto.ts`
+// is there a way to import from there?
+export const kStartRow = "start.row";
+export const kStartColumn = "start.column";
+export const kEndRow = "end.row";
+export const kEndColumn = "end.column";
+export interface LintItem {
+  [kStartRow]: number;
+  [kStartColumn]: number;
+  [kEndRow]: number;
+  [kEndColumn]: number;
+  text: string;
+  type: string;
+}
+
 export interface CodeViewCompletionContext extends CodeViewCellContext {
   explicit: boolean;
 }
 
 export interface CodeViewServer {
   codeViewAssist: (contxt: CodeViewCellContext) => Promise<void>;
   codeViewExecute: (execute: CodeViewExecute, context: CodeViewActiveBlockContext) => Promise<void>;
-  codeViewDiagnostics: (context: CodeViewCellContext) => Promise<any>;
+  codeViewDiagnostics: (context: CodeViewCellContext) => Promise<LintItem[] | undefined>;
   codeViewCompletions: (context: CodeViewCompletionContext) => Promise<CompletionList>;
   codeViewPreviewDiagram: (state: DiagramState, activate: boolean) => Promise<void>;
 }

packages/editor/src/api/ui-types.ts

@@ -26,7 +26,8 @@ import {
   CodeViewExecute,
   CodeViewActiveBlockContext,
   DiagramState,
-  CodeViewCellContext
+  CodeViewCellContext,
+  LintItem
 } from 'editor-types';
 
 export * from './spelling';
@@ -133,7 +134,7 @@ export interface EditorUICodeView {
   codeViewAssist: (context: CodeViewCellContext) => Promise<void>;
   codeViewExecute: (execute: CodeViewExecute, context: CodeViewActiveBlockContext) => Promise<void>;
   codeViewCompletions: (context: CodeViewCompletionContext) => Promise<CompletionList>;
-  codeViewDiagnostics: (context: CodeViewCompletionContext) => Promise<any>;
+  codeViewDiagnostics: (context: CodeViewCompletionContext) => Promise<LintItem[] | undefined>;
   codeViewPreviewDiagram: (state: DiagramState, activate: boolean) => Promise<void>;
 }