Visualize Your Ideas With Code
feat(docs): fiddle error highlighting (#713)
Jacobf281aff27e31
diff --git a/packages/docs/src/components/Fiddle/SharedPlayer.ts b/packages/docs/src/components/Fiddle/SharedPlayer.tsindex 0ba2c869..f865bfd9 100644--- a/packages/docs/src/components/Fiddle/SharedPlayer.ts+++ b/packages/docs/src/components/Fiddle/SharedPlayer.ts@@ -4,7 +4,6 @@ import type {Stage as StageType,FullSceneDescription,ThreadGeneratorFactory,- LogPayload,} from '@motion-canvas/core';import type {View2D} from '@motion-canvas/2d';@@ -15,7 +14,7 @@ let StageInstance: StageType = null;let CurrentSetter: (value: PlayerType) => void = null;let CurrentParent: HTMLElement = null;let CurrentRatio = 1;-let ErrorHandler: (message: LogPayload) => void = null;+let ErrorHandler: (message: string) => void = null;export function disposePlayer(setter: (value: PlayerType) => void) {if (CurrentSetter !== setter || !ProjectInstance) return;@@ -35,7 +34,7 @@ export async function borrowPlayer(setter: (value: PlayerType) => void,parent: HTMLDivElement,ratio: number,- onError?: (message: LogPayload) => void,+ onError?: (message: string) => void,): Promise<PlayerType> {if (setter === CurrentSetter) return;if (@@ -99,7 +98,7 @@ export async function borrowPlayer(ProjectInstance.logger.onLogged.subscribe(payload => {if (payload.level === 'error') {- ErrorHandler?.(payload);+ ErrorHandler?.(`Runtime error: ${payload.message}`);}});}@@ -125,7 +124,7 @@ export async function tryBorrowPlayer(setter: (value: PlayerType) => void,parent: HTMLDivElement,ratio: number,- onError?: (error: LogPayload) => void,+ onError?: (error: string) => void,): Promise<PlayerType | null> {if (!CurrentSetter) {return borrowPlayer(setter, parent, ratio, onError);diff --git a/packages/docs/src/components/Fiddle/errorHighlighting.ts b/packages/docs/src/components/Fiddle/errorHighlighting.tsnew file mode 100644index 00000000..ea576b6c--- /dev/null+++ b/packages/docs/src/components/Fiddle/errorHighlighting.ts@@ -0,0 +1,138 @@+import {+ StateEffect,+ StateField,+ EditorState,+ RangeValue,+ RangeSet,+} from '@codemirror/state';+import {syntaxTree} from '@codemirror/language';+import {+ EditorView,+ Decoration,+ DecorationSet,+ Tooltip,+ hoverTooltip,+} from '@codemirror/view';++const ClearErrors = StateEffect.define();+const AddError = StateEffect.define<{+ from: number;+ to: number;+ tooltip: string;+}>({+ map: ({from, to, tooltip}, change) => ({+ from: change.mapPos(from),+ to: change.mapPos(to),+ tooltip,+ }),+});++const UnderlineMark = Decoration.mark({class: 'cm-underline'});+const UnderlineTheme = EditorView.baseTheme({+ // eslint-disable-next-line @typescript-eslint/naming-convention+ '.cm-underline': {+ textDecoration: 'var(--ifm-color-danger-dark) wavy underline',+ },+});++const UnderlineField = StateField.define<DecorationSet>({+ create: () => Decoration.none,+ update: (underlines, transaction) => {+ underlines = underlines.map(transaction.changes);+ for (const effect of transaction.effects) {+ if (effect.is(ClearErrors)) {+ underlines = underlines.update({+ filter: () => false,+ });+ break;+ }+ if (effect.is(AddError)) {+ underlines = underlines.update({+ add: [UnderlineMark.range(effect.value.from, effect.value.to)],+ });+ }+ }+ return underlines;+ },+ provide: field => EditorView.decorations.from(field),+});++class TooltipRange extends RangeValue {+ public constructor(public tooltip: string) {+ super();+ }+}++const TooltipField = StateField.define<RangeSet<TooltipRange>>({+ create: () => RangeSet.empty,+ update: (tooltips, transaction) => {+ tooltips = tooltips.map(transaction.changes);+ for (const effect of transaction.effects) {+ if (effect.is(ClearErrors)) {+ tooltips = tooltips.update({+ filter: () => false,+ });+ break;+ }+ if (effect.is(AddError)) {+ tooltips = tooltips.update({+ add: [+ new TooltipRange(effect.value.tooltip).range(+ effect.value.from,+ effect.value.to,+ ),+ ],+ });+ }+ }+ return tooltips;+ },+ provide: field =>+ hoverTooltip((view, pos) => {+ let tooltip: Tooltip;+ view.state.field(field, false).between(pos, pos, (from, to, value) => {+ tooltip = {+ pos: from,+ end: to,+ create: () => {+ const dom = document.createElement('div');+ dom.textContent = value.tooltip;+ return {dom};+ },+ };+ return false;+ });+ return tooltip;+ }),+});++function getRange(state: EditorState, position: number) {+ const tree = syntaxTree(state);+ const node = tree.resolveInner(position, 1);+ return {from: node.from, to: node.to};+}++export function errorExtension() {+ return [UnderlineField, TooltipField, UnderlineTheme];+}++export function underlineErrors(+ view: EditorView,+ ranges: {from: number; to: number}[],+ error: string,+) {+ const effects: StateEffect<unknown>[] = ranges.map(range => {+ if (range.from === range.to) {+ range = getRange(view.state, range.from);+ }++ return AddError.of({tooltip: error, ...range});+ });++ view.dispatch({effects});+ return true;+}++export function clearErrors(view: EditorView) {+ view.dispatch({effects: [ClearErrors.of(null)]});+}diff --git a/packages/docs/src/components/Fiddle/index.tsx b/packages/docs/src/components/Fiddle/index.tsxindex a13efe7d..3eeee346 100644--- a/packages/docs/src/components/Fiddle/index.tsx+++ b/packages/docs/src/components/Fiddle/index.tsx@@ -27,7 +27,11 @@ import {updatePlayer,} from '@site/src/components/Fiddle/SharedPlayer';import styles from './styles.module.css';-import {compileScene, transform} from '@site/src/components/Fiddle/transformer';+import {+ compileScene,+ transform,+ TransformError,+} from '@site/src/components/Fiddle/transformer';import {parseFiddle} from '@site/src/components/Fiddle/parseFiddle';import Dropdown from '@site/src/components/Dropdown';import clsx from 'clsx';@@ -39,6 +43,11 @@ import {} from '@site/src/components/Fiddle/folding';import {useLocation} from '@docusaurus/router';import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';+import {+ clearErrors,+ errorExtension,+ underlineErrors,+} from '@site/src/components/Fiddle/errorHighlighting';export interface FiddleProps {className?: string;@@ -74,7 +83,7 @@ export default function Fiddle({const [mode, setMode] = useState(initialMode);const {pathname} = useLocation();- const [error, setError] = useState<{message: string}>(null);+ const [error, setError] = useState<string>(null);const duration = useSubscribableValue(player?.onDurationChanged);const frame = useSubscribableValue(player?.onFrameChanged);const state = useSubscribableValue(player?.onStateChanged);@@ -105,7 +114,10 @@ export default function Fiddle({}return true;} catch (e) {- setError(e);+ if (e instanceof TransformError) {+ underlineErrors(editorView.current, e.errors, e.message);+ }+ setError(e.message);player?.togglePlayback(false);return false;}@@ -145,10 +157,12 @@ export default function Fiddle({setDoc(update.state.doc);if (update.docChanged) {setError(null);+ clearErrors(editorView.current);}}),autocomplete(),folding(),+ errorExtension(),javascript({jsx: true,typescript: true,@@ -329,7 +343,7 @@ export default function Fiddle({)}</div></div>- {error && <pre className={styles.error}>{error.message}</pre>}+ {error && <pre className={styles.error}>{error}</pre>}<div className={styles.editor} ref={editorRef}><CodeBlock className={styles.source} language="tsx">{mode === 'code'diff --git a/packages/docs/src/components/Fiddle/transformer.ts b/packages/docs/src/components/Fiddle/transformer.tsindex b286b25d..1953794f 100644--- a/packages/docs/src/components/Fiddle/transformer.ts+++ b/packages/docs/src/components/Fiddle/transformer.ts@@ -6,56 +6,84 @@ import type {ThreadGeneratorFactory,} from '@motion-canvas/core';-export interface TransformError {- message: string;- loc: {line: number; column: number; index: number};+export class TransformError extends Error {+ public constructor(+ message: string,+ public errors: {from: number; to: number; tooltip?: string}[],+ ) {+ super(message);+ }}export function transform(code: string, name: string): string {+ const filename = `${name}.tsx`;const undeclaredVariables = new Set();- let referenceError = null;- const result = Babel.transform(code, {- filename: `${name}.tsx`,- presets: [- 'typescript',- [- 'react',- {- runtime: 'automatic',- importSource: '@motion-canvas/2d',- },- ],- ],- plugins: [- ({types}) => ({- visitor: {- ImportDeclaration(path) {- if (path.node.source.value.startsWith('@motion-canvas/core')) {- path.node.source.value = '@motion-canvas/core';- }- if (path.node.source.value.startsWith('@motion-canvas/2d')) {- path.node.source.value = '@motion-canvas/2d';- }+ const errors: {from: number; to: number; tooltip: string}[] = [];+ let result: {code: string};+ let errorMessage: string = null;+ try {+ result = Babel.transform(code, {+ filename,+ presets: [+ 'typescript',+ [+ 'react',+ {+ runtime: 'automatic',+ importSource: '@motion-canvas/2d',},- ReferencedIdentifier(path) {- const {node, scope} = path;+ ],+ ],+ plugins: [+ ({types}) => ({+ visitor: {+ ImportDeclaration(path) {+ if (path.node.source.value.startsWith('@motion-canvas/core')) {+ path.node.source.value = '@motion-canvas/core';+ }+ if (path.node.source.value.startsWith('@motion-canvas/2d')) {+ path.node.source.value = '@motion-canvas/2d';+ }+ },+ ReferencedIdentifier(path) {+ const {node, scope} = path;- if (types.isIdentifier(node) && !scope.hasBinding(node.name)) {- undeclaredVariables.add(node.name);- referenceError ??= path.buildCodeFrameError(- `Undeclared variable: ${node.name}`,- );- }+ if (types.isIdentifier(node) && !scope.hasBinding(node.name)) {+ undeclaredVariables.add(node.name);+ errors.push({+ from: node.start,+ to: node.end,+ tooltip: `Cannot find name '${node.name}'.`,+ });+ }+ },},- },- post() {- if (undeclaredVariables.size > 0) {- throw referenceError;- }- },- }),- ],- });+ }),+ ],+ });+ } catch (error) {+ const match = /(.*) \(\d+:\d+\)/.exec(+ error.message.slice(filename.length + 1),+ );+ errorMessage = match ? match[1] : error.message;+ if (error.loc) {+ errors.push({+ from: error.pos as number,+ to: error.pos as number,+ tooltip: errorMessage,+ });+ }+ }++ if (errors.length > 0) {+ throw new TransformError(+ errorMessage ??+ `Cannot find names: ${Array.from(undeclaredVariables).join(+ ', ',+ )}\nDid you forget to import them?`,+ errors,+ );+ }return result.code;}