Skip to content

Visualize Your Ideas With Code

feat(core): add `debug` helper function (#293)

Kai Sassnowskib8708732af0f
diff --git a/packages/core/src/utils/debug.test.ts b/packages/core/src/utils/debug.test.ts
new file mode 100644
index 00000000..bc64504b
--- /dev/null
+++ b/packages/core/src/utils/debug.test.ts
@@ -0,0 +1,51 @@
+import {describe, test, beforeEach, expect, vi} from 'vitest';
+import {setProject, useLogger, debug} from '../utils';
+import {Project, ProjectMetadata} from '../Project';
+import {Meta} from '../Meta';
+import {LogLevel, LogPayload} from '../Logger';
+import {Rect, Vector2} from '../types';
+
+describe('debug()', () => {
+ beforeEach(() => {
+ setProject(new Project({name: 'test', scenes: []}));
+ });
+
+ test.each([
+ ['Strings', 'test', {message: 'test'}],
+ ['Numbers', 5, {message: '5'}],
+ ['Null', null, {message: 'null'}],
+ ['Undefined', undefined, {message: 'undefined'}],
+ ['NaN', NaN, {message: 'NaN'}],
+ ['Vector2', Vector2.one, {message: '{"x":1,"y":1}', object: Vector2.one}],
+ [
+ 'Rect',
+ new Rect([10, 20, 30, 40]),
+ {
+ message: '{"x":10,"y":20,"width":30,"height":40}',
+ object: new Rect([10, 20, 30, 40]),
+ },
+ ],
+ [
+ 'Arrays',
+ [5, 'test', Vector2.one],
+ {message: '[5,"test",{"x":1,"y":1}]', object: [5, 'test', Vector2.one]},
+ ],
+ ['Empty Array', [], {message: '[]', object: []}],
+ [
+ 'Objects',
+ {foo: 'bar', baz: 'qux'},
+ {message: '{"foo":"bar","baz":"qux"}', object: {foo: 'bar', baz: 'qux'}},
+ ],
+ ['Empty Objects', {}, {message: '{}', object: {}}],
+ ])('log: %s', (_, payload, expected) => {
+ const spy = vi.fn();
+ useLogger().onLogged.subscribe(spy);
+
+ debug(payload);
+
+ expect(spy).toHaveBeenNthCalledWith(1, {
+ level: LogLevel.Debug,
+ ...expected,
+ });
+ });
+});
diff --git a/packages/core/src/utils/debug.ts b/packages/core/src/utils/debug.ts
new file mode 100644
index 00000000..18f9b5af
--- /dev/null
+++ b/packages/core/src/utils/debug.ts
@@ -0,0 +1,51 @@
+import {useLogger} from '.';
+import {LogPayload} from '../Logger';
+
+function stringify(value: any): string {
+ switch (typeof value) {
+ case 'string':
+ // Prevent strings from getting quoted again
+ return value;
+ case 'undefined':
+ // Prevent `undefined` from being turned into `null`
+ return 'undefined';
+ default:
+ // Prevent `NaN` from being turned into `null`
+ if (Number.isNaN(value)) {
+ return 'NaN';
+ }
+ return JSON.stringify(value);
+ }
+}
+
+/**
+ * Logs a debug message with an arbitrary payload.
+ *
+ * @remarks
+ * This method is a shortcut for calling `useLogger().debug()` which allows
+ * you to more easily log non-string values as well.
+ *
+ * @example
+ * ```ts
+ * export default makeScene2D(function* (view) {
+ * const circle = createRef<Circle>();
+ *
+ * view.add(
+ * <Circle ref={circle} width={320} height={320} fill={'lightseagreen'} />,
+ * );
+ *
+ * debug(circle().position());
+ * });
+ * ```
+ *
+ * @param payload - The payload to log
+ */
+export function debug(payload: any) {
+ const result: LogPayload = {message: stringify(payload)};
+
+ if (payload && typeof payload === 'object') {
+ result.object = payload;
+ }
+
+ useLogger().debug(result);
+}
diff --git a/packages/core/src/utils/index.ts b/packages/core/src/utils/index.ts
index b313e476..3ae44ec1 100644
--- a/packages/core/src/utils/index.ts
+++ b/packages/core/src/utils/index.ts
@@ -5,6 +5,7 @@
*/
export * from './capitalize';
+export * from './debug';
export * from './deprecate';
export * from './DetailedError';
export * from './errorToLog';