Surface warnings to frontend and LSP (#4603)
* Send multiple errors and warnings to the frontend and LSP Signed-off-by: Nick Cameron <nrc@ncameron.org> * Refactor the parser to use CompilationError for parsing errors rather than KclError Signed-off-by: Nick Cameron <nrc@ncameron.org> * Refactoring: move CompilationError, etc. Signed-off-by: Nick Cameron <nrc@ncameron.org> * Integrate compilation errors with the frontend and CodeMirror Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix tests Signed-off-by: Nick Cameron <nrc@ncameron.org> * Review comments Signed-off-by: Nick Cameron <nrc@ncameron.org> * Fix module id/source range stuff Signed-off-by: Nick Cameron <nrc@ncameron.org> * More test fixups Signed-off-by: Nick Cameron <nrc@ncameron.org> --------- Signed-off-by: Nick Cameron <nrc@ncameron.org>
This commit is contained in:
Nick Cameron
GitHub
@ -1,88 +1,90 @@
|
||||
import { KclError as RustKclError } from '../wasm-lib/kcl/bindings/KclError'
|
||||
import { CompilationError } from 'wasm-lib/kcl/bindings/CompilationError'
|
||||
import { Diagnostic as CodeMirrorDiagnostic } from '@codemirror/lint'
|
||||
import { posToOffset } from '@kittycad/codemirror-lsp-client'
|
||||
import { Diagnostic as LspDiagnostic } from 'vscode-languageserver-protocol'
|
||||
import { Text } from '@codemirror/state'
|
||||
|
||||
const TOP_LEVEL_MODULE_ID = 0
|
||||
import { EditorView } from 'codemirror'
|
||||
import { SourceRange } from 'lang/wasm'
|
||||
|
||||
type ExtractKind<T> = T extends { kind: infer K } ? K : never
|
||||
export class KCLError extends Error {
|
||||
kind: ExtractKind<RustKclError> | 'name'
|
||||
sourceRanges: [number, number, number][]
|
||||
sourceRange: SourceRange
|
||||
msg: string
|
||||
|
||||
constructor(
|
||||
kind: ExtractKind<RustKclError> | 'name',
|
||||
msg: string,
|
||||
sourceRanges: [number, number, number][]
|
||||
sourceRange: SourceRange
|
||||
) {
|
||||
super()
|
||||
this.kind = kind
|
||||
this.msg = msg
|
||||
this.sourceRanges = sourceRanges
|
||||
this.sourceRange = sourceRange
|
||||
Object.setPrototypeOf(this, KCLError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLLexicalError extends KCLError {
|
||||
constructor(msg: string, sourceRanges: [number, number, number][]) {
|
||||
super('lexical', msg, sourceRanges)
|
||||
constructor(msg: string, sourceRange: SourceRange) {
|
||||
super('lexical', msg, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLSyntaxError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLInternalError extends KCLError {
|
||||
constructor(msg: string, sourceRanges: [number, number, number][]) {
|
||||
super('internal', msg, sourceRanges)
|
||||
constructor(msg: string, sourceRange: SourceRange) {
|
||||
super('internal', msg, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLSyntaxError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLSyntaxError extends KCLError {
|
||||
constructor(msg: string, sourceRanges: [number, number, number][]) {
|
||||
super('syntax', msg, sourceRanges)
|
||||
constructor(msg: string, sourceRange: SourceRange) {
|
||||
super('syntax', msg, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLSyntaxError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLSemanticError extends KCLError {
|
||||
constructor(msg: string, sourceRanges: [number, number, number][]) {
|
||||
super('semantic', msg, sourceRanges)
|
||||
constructor(msg: string, sourceRange: SourceRange) {
|
||||
super('semantic', msg, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLSemanticError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLTypeError extends KCLError {
|
||||
constructor(msg: string, sourceRanges: [number, number, number][]) {
|
||||
super('type', msg, sourceRanges)
|
||||
constructor(msg: string, sourceRange: SourceRange) {
|
||||
super('type', msg, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLTypeError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLUnimplementedError extends KCLError {
|
||||
constructor(msg: string, sourceRanges: [number, number, number][]) {
|
||||
super('unimplemented', msg, sourceRanges)
|
||||
constructor(msg: string, sourceRange: SourceRange) {
|
||||
super('unimplemented', msg, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLUnimplementedError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLUnexpectedError extends KCLError {
|
||||
constructor(msg: string, sourceRanges: [number, number, number][]) {
|
||||
super('unexpected', msg, sourceRanges)
|
||||
constructor(msg: string, sourceRange: SourceRange) {
|
||||
super('unexpected', msg, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLUnexpectedError.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLValueAlreadyDefined extends KCLError {
|
||||
constructor(key: string, sourceRanges: [number, number, number][]) {
|
||||
super('name', `Key ${key} was already defined elsewhere`, sourceRanges)
|
||||
constructor(key: string, sourceRange: SourceRange) {
|
||||
super('name', `Key ${key} was already defined elsewhere`, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLValueAlreadyDefined.prototype)
|
||||
}
|
||||
}
|
||||
|
||||
export class KCLUndefinedValueError extends KCLError {
|
||||
constructor(key: string, sourceRanges: [number, number, number][]) {
|
||||
super('name', `Key ${key} has not been defined`, sourceRanges)
|
||||
constructor(key: string, sourceRange: SourceRange) {
|
||||
super('name', `Key ${key} has not been defined`, sourceRange)
|
||||
Object.setPrototypeOf(this, KCLUndefinedValueError.prototype)
|
||||
}
|
||||
}
|
||||
@ -99,27 +101,14 @@ export function lspDiagnosticsToKclErrors(
|
||||
.flatMap(
|
||||
({ range, message }) =>
|
||||
new KCLError('unexpected', message, [
|
||||
[
|
||||
posToOffset(doc, range.start)!,
|
||||
posToOffset(doc, range.end)!,
|
||||
TOP_LEVEL_MODULE_ID,
|
||||
],
|
||||
posToOffset(doc, range.start)!,
|
||||
posToOffset(doc, range.end)!,
|
||||
true,
|
||||
])
|
||||
)
|
||||
.filter(({ sourceRanges }) => {
|
||||
const [from, to, moduleId] = sourceRanges[0]
|
||||
return (
|
||||
from !== null &&
|
||||
to !== null &&
|
||||
from !== undefined &&
|
||||
to !== undefined &&
|
||||
// Filter out errors that are not from the top-level module.
|
||||
moduleId === TOP_LEVEL_MODULE_ID
|
||||
)
|
||||
})
|
||||
.sort((a, b) => {
|
||||
const c = a.sourceRanges[0][0]
|
||||
const d = b.sourceRanges[0][0]
|
||||
const c = a.sourceRange[0]
|
||||
const d = b.sourceRange[0]
|
||||
switch (true) {
|
||||
case c < d:
|
||||
return -1
|
||||
@ -137,17 +126,48 @@ export function lspDiagnosticsToKclErrors(
|
||||
export function kclErrorsToDiagnostics(
|
||||
errors: KCLError[]
|
||||
): CodeMirrorDiagnostic[] {
|
||||
return errors?.flatMap((err) => {
|
||||
const sourceRanges: CodeMirrorDiagnostic[] = err.sourceRanges
|
||||
// Filter out errors that are not from the top-level module.
|
||||
.filter(([_start, _end, moduleId]) => moduleId === TOP_LEVEL_MODULE_ID)
|
||||
.map(([from, to]) => {
|
||||
return { from, to, message: err.msg, severity: 'error' }
|
||||
})
|
||||
// Make sure we didn't filter out all the source ranges.
|
||||
if (sourceRanges.length === 0) {
|
||||
sourceRanges.push({ from: 0, to: 0, message: err.msg, severity: 'error' })
|
||||
}
|
||||
return sourceRanges
|
||||
})
|
||||
return errors
|
||||
?.filter((err) => err.sourceRange[2])
|
||||
.map((err) => {
|
||||
return {
|
||||
from: err.sourceRange[0],
|
||||
to: err.sourceRange[1],
|
||||
message: err.msg,
|
||||
severity: 'error',
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
export function complilationErrorsToDiagnostics(
|
||||
errors: CompilationError[]
|
||||
): CodeMirrorDiagnostic[] {
|
||||
return errors
|
||||
?.filter((err) => err.sourceRange[2] === 0)
|
||||
.map((err) => {
|
||||
let severity: any = 'error'
|
||||
if (err.severity === 'Warning') {
|
||||
severity = 'warning'
|
||||
}
|
||||
let actions
|
||||
const suggestion = err.suggestion
|
||||
if (suggestion) {
|
||||
actions = [
|
||||
{
|
||||
name: suggestion.title,
|
||||
apply: (view: EditorView, from: number, to: number) => {
|
||||
view.dispatch({
|
||||
changes: { from, to, insert: suggestion.insert },
|
||||
})
|
||||
},
|
||||
},
|
||||
]
|
||||
}
|
||||
return {
|
||||
from: err.sourceRange[0],
|
||||
to: err.sourceRange[1],
|
||||
message: err.message,
|
||||
severity,
|
||||
actions,
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user