{"body":"","parents":["60698e63c6a4072a3a390362489d057c7d82202f"],"commit":{"authorEmail":"poteto@users.noreply.github.com","revision":"32a83374be085a03942dd6e34358f9e8e285aef9","authorName":"Lauren Tan","subject":"Format CompilerErrors with Babel codeframes","authoredAt":"2023-01-19T11:37:49-05:00","shortRevision":"32a83374be"},"patch":"diff --git a\/compiler\/forget\/src\/CompilerError.ts b\/compiler\/forget\/src\/CompilerError.ts\nindex c3863a8a50..3be1020c08 100644\n--- a\/compiler\/forget\/src\/CompilerError.ts\n+++ b\/compiler\/forget\/src\/CompilerError.ts\n@@ -1,5 +1,6 @@\n-import { SourceLocation } from \".\/HIR\";\n+import { Node, NodePath } from \"@babel\/core\";\n import type { ExtractClassProperties } from \".\/Utils\/types\";\n+import { assertExhaustive } from \".\/Utils\/utils\";\n \n export enum ErrorSeverity {\n InvalidInput = \"InvalidInput\",\n@@ -7,28 +8,66 @@ export enum ErrorSeverity {\n }\n \n export type CompilerErrorOptions = ExtractClassProperties;\n+type AnyNodePath = NodePath;\n+\n+class InvalidInputError extends Error {\n+ constructor(message: string) {\n+ super(message);\n+ this.name = `${ErrorSeverity.InvalidInput}Error`;\n+ }\n+}\n+class TodoError extends Error {\n+ constructor(message: string) {\n+ super(message);\n+ this.name = `${ErrorSeverity.Todo}Error`;\n+ }\n+}\n+\n+function mapSeverityToErrorCtor(severity: ErrorSeverity) {\n+ switch (severity) {\n+ case ErrorSeverity.InvalidInput:\n+ return InvalidInputError;\n+ case ErrorSeverity.Todo:\n+ return TodoError;\n+ default:\n+ assertExhaustive(severity, `Unhandled severity level: ${severity}`);\n+ }\n+}\n+\n+function printPathCodeFrame(\n+ reason: string,\n+ severity: ErrorSeverity,\n+ path: AnyNodePath\n+) {\n+ return path\n+ .buildCodeFrameError(reason, mapSeverityToErrorCtor(severity))\n+ .toString();\n+}\n \n export class CompilerError {\n severity: ErrorSeverity;\n reason: string;\n- source: string | null;\n- loc: SourceLocation | null;\n+ \/**\n+ * If a NodePath is provided, we will prefer Babel's built in codeframe error generation which\n+ * will print error markers in the correct location.\n+ *\/\n+ nodePath: AnyNodePath | null;\n \n constructor(options: CompilerErrorOptions) {\n this.severity = options.severity;\n this.reason = options.reason;\n- this.source = options.source;\n- this.loc = options.loc;\n+ this.nodePath = options.nodePath;\n }\n \n toString(): string {\n- const buffer = [`[${this.severity.toUpperCase()}] ${this.reason}`];\n- if (this.loc != null && typeof this.loc != \"symbol\") {\n- buffer.push(` on lines ${this.loc.start.line}:${this.loc.end.line}`);\n- }\n- if (this.source != null) {\n- buffer.push(`\\n${this.source}`);\n+ const buffer = [];\n+ if (this.nodePath != null) {\n+ buffer.push(\n+ printPathCodeFrame(this.reason, this.severity, this.nodePath)\n+ );\n+ } else {\n+ buffer.push(`${this.severity}: ${this.reason}`);\n }\n- return `Forget Error: ${buffer.join(\"\")}`;\n+ return `[ReactForget] ${buffer.join(\"\")}`;\n }\n }\ndiff --git a\/compiler\/forget\/src\/HIR\/BuildHIR.ts b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\nindex 1d2b9da47a..be96db698f 100644\n--- a\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n+++ b\/compiler\/forget\/src\/HIR\/BuildHIR.ts\n@@ -71,13 +71,7 @@ export function lower(\n builder.pushError({\n reason: `Support non-identifier params: ${param.node.type}`,\n severity: ErrorSeverity.Todo,\n- \/\/ 1. We can't use NodePath.toString() because we're using @babel\/traverse directly, see\n- \/\/ https:\/\/fburl.com\/45x18dcm for details.\n- \/\/ 2. Only NodePaths override toString to print the source, so if you tried this with\n- \/\/ Node.toString() you'd just get [object Object].\n- \/\/ 3. You will see this in other calls to builder.pushError in this file.\n- source: func.toString(),\n- loc: param.node.loc ?? null,\n+ nodePath: param,\n });\n }\n });\n@@ -87,8 +81,7 @@ export function lower(\n builder.pushError({\n reason: \"Support arrow functions\",\n severity: ErrorSeverity.Todo,\n- source: func.toString(),\n- loc: body.node.loc ?? null,\n+ nodePath: body,\n });\n } else if (body.isBlockStatement()) {\n lowerStatement(builder, body);\n@@ -96,8 +89,7 @@ export function lower(\n builder.pushError({\n reason: `Unexpected function body kind: ${body.type}}`,\n severity: ErrorSeverity.InvalidInput,\n- source: func.toString(),\n- loc: body.node.loc ?? null,\n+ nodePath: body,\n });\n }\n \n@@ -339,8 +331,7 @@ function lowerStatement(\n builder.pushError({\n reason: \"Support non-variable initialization in for\",\n severity: ErrorSeverity.Todo,\n- source: stmt.toString(),\n- loc: init.node?.loc ?? null,\n+ nodePath: stmt,\n });\n return { kind: \"error\", id: makeInstructionId(0) };\n }\n@@ -359,8 +350,7 @@ function lowerStatement(\n builder.pushError({\n reason: \"Handle empty for updater\",\n severity: ErrorSeverity.Todo,\n- source: stmt.toString(),\n- loc: null,\n+ nodePath: stmt,\n });\n return { kind: \"error\", id: makeInstructionId(0) };\n }\n@@ -404,8 +394,7 @@ function lowerStatement(\n builder.pushError({\n reason: \"ForStatement without test\",\n severity: ErrorSeverity.Todo,\n- source: stmt.toString(),\n- loc: null,\n+ nodePath: stmt,\n });\n } else {\n builder.terminateWithContinuation(\n@@ -492,8 +481,7 @@ function lowerStatement(\n builder.pushError({\n reason: \"while statement must have a location\",\n severity: ErrorSeverity.InvalidInput,\n- source: stmt.toString(),\n- loc: null,\n+ nodePath: stmt,\n });\n } else {\n builder.terminateWithContinuation(\n@@ -587,8 +575,7 @@ function lowerStatement(\n reason:\n \"Expected at most one `default` branch, this code should have failed to parse\",\n severity: ErrorSeverity.InvalidInput,\n- source: stmt.toString(),\n- loc: case_.node.loc ?? null,\n+ nodePath: case_,\n });\n break;\n }\n@@ -671,8 +658,7 @@ function lowerStatement(\n builder.pushError({\n reason: \"`var` declarations are not supported, use let or const\",\n severity: ErrorSeverity.Todo,\n- source: stmt.toString(),\n- loc: stmt.node.loc ?? null,\n+ nodePath: stmt,\n });\n \/\/ TODO: should we lower this to an error variant\n return;\n@@ -756,8 +742,7 @@ function lowerStatement(\n builder.pushError({\n reason: `Unhandled statement type: ${stmtPath.type}`,\n severity: ErrorSeverity.Todo,\n- source: stmtPath.toString(),\n- loc: null,\n+ nodePath: stmtPath,\n });\n builder.push({\n id: makeInstructionId(0),\ndiff --git a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md\nindex 6f35790398..b25cb8b632 100644\n--- a\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md\n+++ b\/compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md\n@@ -24,102 +24,111 @@ function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n ## Error\n \n ```\n-Forget Error: [TODO] Support non-identifier params: ArrayPattern on lines 1:1\n-function foo([a, b], {\n- c,\n- d,\n- e = \"e\"\n-}, f = \"f\", ...args) {\n- let i = 0;\n- var x = [];\n- class Bar {}\n- with (true) {}\n- for (; i < 3; i += 1) {\n- x.push(i);\n- }\n- for (; i < 3;) {}\n- for (;;) {}\n-}\n-\n-Forget Error: [TODO] Support non-identifier params: ObjectPattern on lines 1:1\n-function foo([a, b], {\n- c,\n- d,\n- e = \"e\"\n-}, f = \"f\", ...args) {\n- let i = 0;\n- var x = [];\n- class Bar {}\n- with (true) {}\n- for (; i < 3; i += 1) {\n- x.push(i);\n- }\n- for (; i < 3;) {}\n- for (;;) {}\n-}\n-\n-Forget Error: [TODO] Support non-identifier params: AssignmentPattern on lines 1:1\n-function foo([a, b], {\n- c,\n- d,\n- e = \"e\"\n-}, f = \"f\", ...args) {\n- let i = 0;\n- var x = [];\n- class Bar {}\n- with (true) {}\n- for (; i < 3; i += 1) {\n- x.push(i);\n- }\n- for (; i < 3;) {}\n- for (;;) {}\n-}\n-\n-Forget Error: [TODO] Support non-identifier params: RestElement on lines 1:1\n-function foo([a, b], {\n- c,\n- d,\n- e = \"e\"\n-}, f = \"f\", ...args) {\n- let i = 0;\n- var x = [];\n- class Bar {}\n- with (true) {}\n- for (; i < 3; i += 1) {\n- x.push(i);\n- }\n- for (; i < 3;) {}\n- for (;;) {}\n-}\n-\n-Forget Error: [TODO] `var` declarations are not supported, use let or const on lines 3:3\n-var x = [];\n-\n-Forget Error: [TODO] Unhandled statement type: ClassDeclaration\n-class Bar {}\n-\n-Forget Error: [TODO] Unhandled statement type: WithStatement\n-with (true) {}\n-\n-Forget Error: [TODO] Support non-variable initialization in for\n-for (; i < 3; i += 1) {\n- x.push(i);\n-}\n-\n-Forget Error: [TODO] Support non-variable initialization in for\n-for (; i < 3;) {}\n-\n-Forget Error: [TODO] Handle empty for updater\n-for (; i < 3;) {}\n-\n-Forget Error: [TODO] Support non-variable initialization in for\n-for (;;) {}\n-\n-Forget Error: [TODO] Handle empty for updater\n-for (;;) {}\n-\n-Forget Error: [TODO] ForStatement without test\n-for (;;) {}\n+[ReactForget] TodoError: Support non-identifier params: ArrayPattern\n+> 1 | function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n+ | ^^^^^^\n+ 2 | let i = 0;\n+ 3 | var x = [];\n+ 4 |\n+\n+[ReactForget] TodoError: Support non-identifier params: ObjectPattern\n+> 1 | function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n+ | ^^^^^^^^^^^^^^^^^\n+ 2 | let i = 0;\n+ 3 | var x = [];\n+ 4 |\n+\n+[ReactForget] TodoError: Support non-identifier params: AssignmentPattern\n+> 1 | function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n+ | ^^^^^^^\n+ 2 | let i = 0;\n+ 3 | var x = [];\n+ 4 |\n+\n+[ReactForget] TodoError: Support non-identifier params: RestElement\n+> 1 | function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n+ | ^^^^^^^\n+ 2 | let i = 0;\n+ 3 | var x = [];\n+ 4 |\n+\n+[ReactForget] TodoError: `var` declarations are not supported, use let or const\n+ 1 | function foo([a, b], { c, d, e = \"e\" }, f = \"f\", ...args) {\n+ 2 | let i = 0;\n+> 3 | var x = [];\n+ | ^^^^^^^^^^^\n+ 4 |\n+ 5 | class Bar {}\n+ 6 |\n+\n+[ReactForget] TodoError: Unhandled statement type: ClassDeclaration\n+ 3 | var x = [];\n+ 4 |\n+> 5 | class Bar {}\n+ | ^^^^^^^^^^^^\n+ 6 |\n+ 7 | with (true) {\n+ 8 | }\n+\n+[ReactForget] TodoError: Unhandled statement type: WithStatement\n+ 5 | class Bar {}\n+ 6 |\n+> 7 | with (true) {\n+ | ^\n+ 8 | }\n+ 9 |\n+ 10 | for (; i < 3; i += 1) {\n+\n+[ReactForget] TodoError: Support non-variable initialization in for\n+ 8 | }\n+ 9 |\n+> 10 | for (; i < 3; i += 1) {\n+ | ^\n+ 11 | x.push(i);\n+ 12 | }\n+ 13 | for (; i < 3; ) {}\n+\n+[ReactForget] TodoError: Support non-variable initialization in for\n+ 11 | x.push(i);\n+ 12 | }\n+> 13 | for (; i < 3; ) {}\n+ | ^^^^^^^^^^^^^^^^^^\n+ 14 | for (;;) {}\n+ 15 | }\n+ 16 |\n+\n+[ReactForget] TodoError: Handle empty for updater\n+ 11 | x.push(i);\n+ 12 | }\n+> 13 | for (; i < 3; ) {}\n+ | ^^^^^^^^^^^^^^^^^^\n+ 14 | for (;;) {}\n+ 15 | }\n+ 16 |\n+\n+[ReactForget] TodoError: Support non-variable initialization in for\n+ 12 | }\n+ 13 | for (; i < 3; ) {}\n+> 14 | for (;;) {}\n+ | ^^^^^^^^^^^\n+ 15 | }\n+ 16 |\n+\n+[ReactForget] TodoError: Handle empty for updater\n+ 12 | }\n+ 13 | for (; i < 3; ) {}\n+> 14 | for (;;) {}\n+ | ^^^^^^^^^^^\n+ 15 | }\n+ 16 |\n+\n+[ReactForget] TodoError: ForStatement without test\n+ 12 | }\n+ 13 | for (; i < 3; ) {}\n+> 14 | for (;;) {}\n+ | ^^^^^^^^^^^\n+ 15 | }\n+ 16 |\n ```\n \n \n\\ No newline at end of file\n","files":[{"status":"M","path":"compiler\/forget\/src\/CompilerError.ts"},{"status":"M","path":"compiler\/forget\/src\/HIR\/BuildHIR.ts"},{"status":"M","path":"compiler\/forget\/src\/__tests__\/fixtures\/hir\/error.todo-kitchensink.expect.md"}]}

dillon1000/react

Files changed