feat: Stabilize Deno.consoleSize() API

[bartlomieju]

Closes #15929

[littledivy]

LGTM. Just a note: this op can be a fast call, if the ConsoleSize result is put into a Uint32Array buffer.

[lucacasonato]

I am not in favor of stabilizing as is, because it takes in a rid parameter. Should be Deno.stdin.consoleSize. See also the stabilization issue for Deno.setRaw.

[bartlomieju]

@littledivy good point, I'll update the PR.

@lucacasonato also a good point. I'll rework it.

[bartlomieju]

@lucacasonato one question though: should we make it Deno.stdin.consoleSize()? Seems a bit strange to get a size of console from stdin, maybe it should be a method on Deno.stdout and Deno.stderr?

[lucacasonato]

Yeah sorry, that makes a lot more sense indeed.

[dsherret]

maybe it should be a method on Deno.stdout and Deno.stderr

What if both stdout and stderr are piped, but you still want to get the console size? I think this should just be on the Deno namespace, though it also begs the question of if this should be providing a rid of stdout and stderr (https://github.com/denoland/deno/pull/15933/files#r976653975).

[dsherret]

We should think more about how this would work with a pty before stabilizing (also, not done yet, but we shouldn't move this method to stdout and stderr). Additionally, this function should probably just work without providing an rid, then you provide the rid of a pty to get its size.

[lucacasonato]

In that case, does it even need a rid parameter? Can it just be Deno.consoleSize() with no args?

[dsherret]

In that case, does it even need a rid parameter? Can it just be Deno.consoleSize() with no args?

Yes, I think that would be best.

Also, related to the other Deno.stdin.setRaw, we could just have a pty.consoleSize() or something for ptys.

[shadowspawn]

I'm not sure it makes sense to provide stdout and stderr here because if those are piped there doesn't seem to be a way to get the console screen size.

If they are both piped, is there even a console? I might have the concept wrong!

The use case I came looking for consoleSize was for finding the word-wrap width for displaying help text from a command-line utility. The help is being displayed to either stdout or stderr, and I was expecting to find the width of the one being used, which might be a pipe (and hence width not known).

[dsherret]

If they are both piped, is there even a console?

@shadowspawn huh, I thought there was some low level api to still get it based on the parent process (or console group or whatever it's called) because I had seen api's like let size = terminal_size()? or in the case of .net var width = Console.WindowWidth;, but looking at all those implementations I found they're all providing stdout's handle. Additionally, it seems it's possible to get the console size via stdin (https://stackoverflow.com/a/59717851/188246).

That said, I still think we should consider just making this Deno.consoleSize() and perhaps have it try to get the size via stdout, stderr, then stdin, and if not then throw. Otherwise, then perhaps it should be on all three (Deno.stdout.consoleSize(), Deno.stdin...., Deno.stdin....) if that indeed works on stdin. Making it Deno.consoleSize() seems easiest for users, but maybe it's not versitle enough?

The use case I came looking for consoleSize was for finding the word-wrap width for displaying help text from a command-line utility. The help is being displayed to either stdout or stderr, and I was expecting to find the width of the one being used, which might be a pipe (and hence width not known).

Perhaps in a future api (with isatty moved to Deno.stdout.isatty()) the code would do:

const size = Deno.stdout.isatty() ? Deno.consoleSize() : undefined;

[bartlomieju]

I changed the API to not accept any arguments. It will use stdin handle to get the size of the console. @dsherret @lucacasonato please take a look

[dsherret]

LGTM, but there is an std submodule update that I think should be reverted?

[bartlomieju]

LGTM, but there is an std submodule update that I think should be reverted?

Not really, after merging this PR I will update deno_std in accordance with this API and then update it again in CLI

[dsherret]

Oh, I see.