Allow to provide description to environment collection API

[karrtikr]

Particularly for the Python environments, the list of environment vars can be long, hence the prompt which shows up can be too verbose:

It would be perhaps more helpful if we can provide a simple description instead of the exact changes.

cc/ @Tyriar

[karrtikr]

This could also be extended to show up as terminal.title the first time the terminal is relaunched. Fish shell does not have a prompt variable which we could set like cmd to indicate which environment is active, which could also make use of this feature:

[Tyriar]

Proposal:

#171108

export interface EnvironmentVariableCollection extends Iterable<[variable: string, mutator: EnvironmentVariableMutator]> {
	/**
	 * A description for the environment variable collection, this will be used to describe the
	 * changes in the UI.
	 */
	description: string | undefined;
}

We probably still want a way to show the actual environment variable changes even with this description though.

[meganrogge]

It would be nice if there were a View Changes action that opened a readonly editor with the changes. That would make it very accessible

[Tyriar]

@meganrogge I was thinking a button in the hover to toggle it, but I like your suggestion more

[Tyriar]

Feedback from API sync: Add MarkdownString

[jrieken]

@Tyriar @karrtikr Looks like #179476, #171173, and #171108 are all very closely related. For a holistic view at the changes a single discussion/issue/proposal might be more beneficial.

[Tyriar]

@jrieken created: #182069

[karrtikr]

Closing in favor of #182069 as these issues were only open to finalize proposed API.

[Tyriar]

@karrtikr they're all separate proposals, let's keep them open and have #182069 for a holistic view

[Tyriar]

I'm planning on finalizing this one independently of the workspace scope one this iteration.

[Tyriar]

To verify make sure the API shows up in the stable API and does not have a proposed check.

[DonJayamanne]

Tried this, not sure what I need to do to get this to work
I just updated the description property in the context.environmentVariableCollection and created a new terminal and nothing seems to be displayed.
@Tyriar Am i missing a step here?