chore: use debug package for debug logging

[KermanX]

Previously, !!process.env.DEBUG was used to check whether to debug in @typescript/vfs and @typescript/twoslash. However, most of the packages are using the debug package to debug. When we set DEBUG=vite:hmr, @typescript/vfs will output lots of things, which immediately fill the terminal and prevent us from watching logs from Vite.

Also, the debug package has been installed as a dependency in @typescript/vfs, but seems unused:

TypeScript-Website/packages/typescript-vfs/package.json

Line 44 in c341935

"debug": "^4.1.1"

And the README also said it's using the debug package:

TypeScript-Website/README.md

Line 33 in c341935

- All packages use [debug](https://www.npmjs.com/package/debug) - which means you can do `env DEBUG="*" pnpm test` to get verbose logs

[jakebailey]

CI will fail here because this change is missing a changeset.

[jakebailey]

This seems to imply that sandbox needs a dep on debug; I think that's true given we vendor the vfs into this package?

[KermanX]

Yes. The DTS build of @typescript/sandbox would fail unless @types/debug is installed, because @typescript/vfs is vendored.

[jakebailey]

Right but I mean that this package should also depend on "debug" too so the code doesn't crash.

[jakebailey]

Checking out the vendored code, it does now import from debug. I'm not 100% certain if that's desirable, though; I believe this code is intended to be loaded in the browser directly so this code may break there now that it's not dependency free.

What confuses me though is why lzstring is bundled and not debug. I guess we locally vendor lzstring? Maybe we need to tweak our config to ensure that these packages are still self contained?

@orta do you recall the restrictions here?

[github-actions]

Azure Static Web Apps: Your stage site is ready! Visit it here: https://victorious-plant-05c166c10-3167.centralus.5.azurestaticapps.net

[orta]

I just didn't think that debug was important enough of a dependency to add it to the playground's web bundle - given how little I was using of it, could replicate the check for the substring in this package to copy the behavior they are looking for?

[jakebailey]

The debug module does a lot of stuff, especially on web; I'm not sure it would be exactly trivial to copy that bit.

But, I think maybe we could just change the original code to check DEBUG=typescript:vfs (and similar) instead, and just not document that we use the debug module?

(sorry for this reversal, I just looked at the output and noticed that this would break someone)

[orta]

Yeah, I think that's the right call