Add push option in createOutputChannel API

[sandy081]

After implementing Output channels to log into files directly from extension host and let the renderer listen to file changes, a delay got introduced between adding the data and it is shown in the UI. It might not be expected for some output channels who intend to show real time data. This PR introduces an option push that extension authors can use while creating an output channel to decide whether to push the data and show in the UI immediately.

#57618

[jrieken]

Alternative ideas for the parameter name are force, live, noBuffer, inMemory, or something that expresses this is for logging.

[sandy081]

I liked live option out of all as it also goes well with what we describes about the output channel. Also how about noDelay?

Creates a new [output channel](#OutputChannel) with the given name.
		 * By default there will be a delay in showing the appended data in the UI.
		 * Pass `true` for `live` argument to show the data immediately.
		 *
		 * *NOTE* Default output channels help in improving the performance of VS Code

[sandy081]

@jrieken Any updates on this. I would like to change the second parameter to options object so that it can be extensible in future

options: {noDelay: boolean}

[jrieken]

Not a fan of noDelay because that sounds like I would never want a delay. We should pick a word that expresses this being hard on vscode, like force or noBuffer

[sandy081]

I think noBuffer also has similar sense of noDelay. force might be good one to use. Updated the PR.

[jrieken]

why an object? are there plans for more options?

[sandy081]

Yeah, there is a request to set a lang id for channels. If so it has to be set while creating

[jrieken]

Hm, we should sell this better... How about: "Output channels use a separate transport mechanism when appending data. This helps to reduce CPU load on the UI process but also means that the output channel UI updates with a small delay. Use the force-flag to enforce immediate updates at the cost of higher CPU usage"

[sandy081]

I like it. You have better marketing skills 👍 😄

[sandy081]

Updated

[jrieken]

🚢 it