Skip to content

Commit f29d54f

Browse files
coolreader18coolreader18
authored
[TS] Pretty-print objects passed to console.log (#4285)
# Description of Changes Uses the [`object-inspect`](https://www.npmjs.com/package/object-inspect) package to stringify objects passed to console methods, so that you can actually get useful information without having to `JSON.stringify`. Should've happened a long time ago. # Expected complexity level and risk 1 # Testing <!-- Describe any testing you've done, and any testing you'd like your reviewers to do, so that you're confident that all the changes work as expected! --> - [ ] <!-- maybe a test you want to do --> - [ ] <!-- maybe a test you want a reviewer to do, so they can check it off when they're satisfied. -->
1 parent 1592dec commit f29d54f

7 files changed

Lines changed: 126 additions & 105 deletions

File tree

‎crates/bindings-typescript/package.json‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@
171171
"dependencies": {
172172
"base64-js": "^1.5.1",
173173
"headers-polyfill": "^4.0.3",
174+
"object-inspect": "^1.13.4",
174175
"prettier": "^3.3.3",
175176
"pure-rand": "^7.0.1",
176177
"statuses": "^2.0.2",
@@ -179,9 +180,9 @@
179180
"peerDependencies": {
180181
"@tanstack/react-query": "^5.0.0",
181182
"react": "^18.0.0 || ^19.0.0-0 || ^19.0.0",
182-
"vue": "^3.3.0",
183183
"svelte": "^4.0.0 || ^5.0.0",
184-
"undici": "^6.19.2"
184+
"undici": "^6.19.2",
185+
"vue": "^3.3.0"
185186
},
186187
"peerDependenciesMeta": {
187188
"@tanstack/react-query": {
@@ -202,10 +203,10 @@
202203
},
203204
"devDependencies": {
204205
"@eslint/js": "^9.17.0",
205-
"svelte": "^5.0.0",
206206
"@size-limit/file": "^11.2.0",
207207
"@tanstack/react-query": "^5.90.19",
208208
"@types/fast-text-encoding": "^1.0.3",
209+
"@types/object-inspect": "^1.13.0",
209210
"@types/react": "^19.1.13",
210211
"@types/statuses": "^2.0.6",
211212
"@typescript-eslint/eslint-plugin": "^8.18.2",
@@ -216,6 +217,7 @@
216217
"eslint-plugin-jsdoc": "^61.5.0",
217218
"globals": "^15.14.0",
218219
"size-limit": "^11.2.0",
220+
"svelte": "^5.0.0",
219221
"ts-node": "^10.9.2",
220222
"tsup": "^8.1.0",
221223
"typescript": "^5.9.3",

‎crates/bindings-typescript/src/server/console.ts‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
import type { u32 } from 'spacetime:sys@2.0';
2+
import { sys } from './runtime';
3+
import inspect from 'object-inspect';
4+
5+
const fmtLog = (...data: any[]) =>
6+
data.map(x => (typeof x === 'string' ? x : inspect(x))).join(' ');
7+
8+
const console_level_error = 0;
9+
const console_level_warn = 1;
10+
const console_level_info = 2;
11+
const console_level_debug = 3;
12+
const console_level_trace = 4;
13+
const _console_level_panic = 101;
14+
15+
const timerMap = new Map<string, u32>();
16+
17+
export const console: Console = {
18+
// @ts-expect-error we want a blank prototype, but typescript complains
19+
__proto__: {},
20+
[Symbol.toStringTag]: 'console',
21+
assert: (condition = false, ...data: any[]) => {
22+
if (!condition) {
23+
sys.console_log(console_level_error, fmtLog(...data));
24+
}
25+
},
26+
clear: () => {},
27+
debug: (...data: any[]) => {
28+
sys.console_log(console_level_debug, fmtLog(...data));
29+
},
30+
error: (...data: any[]) => {
31+
sys.console_log(console_level_error, fmtLog(...data));
32+
},
33+
info: (...data: any[]) => {
34+
sys.console_log(console_level_info, fmtLog(...data));
35+
},
36+
log: (...data: any[]) => {
37+
sys.console_log(console_level_info, fmtLog(...data));
38+
},
39+
table: (tabularData: any, _properties: any) => {
40+
sys.console_log(console_level_info, fmtLog(tabularData));
41+
},
42+
trace: (...data: any[]) => {
43+
sys.console_log(console_level_trace, fmtLog(...data));
44+
},
45+
warn: (...data: any[]) => {
46+
sys.console_log(console_level_warn, fmtLog(...data));
47+
},
48+
dir: (_item: any, _options: any) => {},
49+
dirxml: (..._data: any[]) => {},
50+
// Counting
51+
count: (_label = 'default') => {},
52+
countReset: (_label = 'default') => {},
53+
// Grouping
54+
group: (..._data: any[]) => {},
55+
groupCollapsed: (..._data: any[]) => {},
56+
groupEnd: () => {},
57+
// Timing
58+
time: (label = 'default') => {
59+
if (timerMap.has(label)) {
60+
sys.console_log(console_level_warn, `Timer '${label}' already exists.`);
61+
return;
62+
}
63+
timerMap.set(label, sys.console_timer_start(label));
64+
},
65+
timeLog: (label = 'default', ...data: any[]) => {
66+
sys.console_log(console_level_info, fmtLog(label, ...data));
67+
},
68+
timeEnd: (label = 'default') => {
69+
const spanId = timerMap.get(label);
70+
if (spanId === undefined) {
71+
sys.console_log(console_level_warn, `Timer '${label}' does not exist.`);
72+
return;
73+
}
74+
sys.console_timer_end(spanId);
75+
timerMap.delete(label);
76+
},
77+
// Additional console methods to satisfy the Console interface
78+
timeStamp: () => {},
79+
profile: () => {},
80+
profileEnd: () => {},
81+
};

‎crates/bindings-typescript/src/server/polyfills.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
import 'url-polyfill';
2+
import { console } from './console';
3+
4+
globalThis.console = console;

‎crates/bindings-typescript/src/server/runtime.ts‎

Lines changed: 0 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -917,86 +917,3 @@ class IteratorHandle implements Disposable {
917917
}
918918
}
919919
}
920-
921-
function fmtLog(...data: any[]) {
922-
return data.join(' ');
923-
}
924-
925-
const console_level_error = 0;
926-
const console_level_warn = 1;
927-
const console_level_info = 2;
928-
const console_level_debug = 3;
929-
const console_level_trace = 4;
930-
const _console_level_panic = 101;
931-
932-
const timerMap = new Map<string, u32>();
933-
934-
const console: Console = {
935-
// @ts-expect-error we want a blank prototype, but typescript complains
936-
__proto__: {},
937-
[Symbol.toStringTag]: 'console',
938-
assert: (condition = false, ...data: any[]) => {
939-
if (!condition) {
940-
sys.console_log(console_level_error, fmtLog(...data));
941-
}
942-
},
943-
clear: () => {},
944-
debug: (...data: any[]) => {
945-
sys.console_log(console_level_debug, fmtLog(...data));
946-
},
947-
error: (...data: any[]) => {
948-
sys.console_log(console_level_error, fmtLog(...data));
949-
},
950-
info: (...data: any[]) => {
951-
sys.console_log(console_level_info, fmtLog(...data));
952-
},
953-
log: (...data: any[]) => {
954-
sys.console_log(console_level_info, fmtLog(...data));
955-
},
956-
table: (tabularData: any, _properties: any) => {
957-
sys.console_log(console_level_info, fmtLog(tabularData));
958-
},
959-
trace: (...data: any[]) => {
960-
sys.console_log(console_level_trace, fmtLog(...data));
961-
},
962-
warn: (...data: any[]) => {
963-
sys.console_log(console_level_warn, fmtLog(...data));
964-
},
965-
dir: (_item: any, _options: any) => {},
966-
dirxml: (..._data: any[]) => {},
967-
// Counting
968-
count: (_label = 'default') => {},
969-
countReset: (_label = 'default') => {},
970-
// Grouping
971-
group: (..._data: any[]) => {},
972-
groupCollapsed: (..._data: any[]) => {},
973-
groupEnd: () => {},
974-
// Timing
975-
time: (label = 'default') => {
976-
if (timerMap.has(label)) {
977-
sys.console_log(console_level_warn, `Timer '${label}' already exists.`);
978-
return;
979-
}
980-
timerMap.set(label, sys.console_timer_start(label));
981-
},
982-
timeLog: (label = 'default', ...data: any[]) => {
983-
sys.console_log(console_level_info, fmtLog(label, ...data));
984-
},
985-
timeEnd: (label = 'default') => {
986-
const spanId = timerMap.get(label);
987-
if (spanId === undefined) {
988-
sys.console_log(console_level_warn, `Timer '${label}' does not exist.`);
989-
return;
990-
}
991-
sys.console_timer_end(spanId);
992-
timerMap.delete(label);
993-
},
994-
// Additional console methods to satisfy the Console interface
995-
timeStamp: () => {},
996-
profile: () => {},
997-
profileEnd: () => {},
998-
};
999-
1000-
(console as any).Console = console;
1001-
1002-
globalThis.console = console;

‎crates/bindings-typescript/src/util-stub.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export const inspect = {};

‎crates/bindings-typescript/tsup.config.ts‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
// tsup.config.ts
22
import { defineConfig, type Options } from 'tsup';
33

4-
function commonEsbuildTweaks() {
5-
return (options: any) => {
4+
function commonEsbuildTweaks(): NonNullable<Options['esbuildOptions']> {
5+
return options => {
66
// Prefer "exports"."development" when deps provide it; harmless otherwise.
77
options.conditions = ['development', 'import', 'default'];
88
options.mainFields = ['browser', 'module', 'main'];
@@ -192,9 +192,14 @@ export default defineConfig([
192192
moduleSideEffects: ['src/server/polyfills.ts'],
193193
},
194194
external: ['undici', /^spacetime:sys.*$/],
195-
noExternal: ['base64-js', 'statuses', 'pure-rand'],
195+
noExternal: ['object-inspect', 'base64-js', 'statuses', 'pure-rand'],
196196
outExtension,
197-
esbuildOptions: commonEsbuildTweaks(),
197+
esbuildOptions: (options, ctx) => {
198+
// object-inspect tries to import the node `util` module,
199+
// which we want to disable.
200+
options.alias = { util: './src/util-stub.ts' };
201+
commonEsbuildTweaks()(options, ctx);
202+
},
198203
},
199204

200205
// TanStack subpath (SSR-friendly): dist/tanstack/index.{mjs,cjs}

‎pnpm-lock.yaml‎

Lines changed: 27 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)