Allow terminal environment to be set when created via extension API

[Tyriar]

No description provided.

[Tyriar]

/cc @dbaeumer we'll need this for tasks in an extension
/cc @daviwil

[daviwil]

Sweet, thanks!

[Tyriar]

Opening to PRs, the ideal change would plum through a new option in the terminal API "env" which includes additions to the environment. You can look a search on "waitOnExit" to see most of the places that need to change https://github.com/Microsoft/vscode/search?l=TypeScript&q=waitOnExit&type=&utf8=%E2%9C%93

[dbaeumer]

@Tyriar we might to think about this in the light of tasks being API now. If a extension other could execute a task programmatically then all is there. A task can already specify its env.

[Tyriar]

@dbaeumer I know that [platformio]](http://platformio.org/) needs this, going through tasks is more restrictive that the terminal so they probably wouldn't want to do that.

[ivankravets]

Hi all,

Ivan from @platformio. Thanks a lot for your work!

1. A task can already specify its env.

That is the first with which I stuck. We can't define custom environment variables in tasks.json per each task or as common for all. Again, we use some hook for that.

2. A custom environment for built-in Terminal is very important. We use dirty hook now. vscode.window.createTerminal('PlatformIO', env=dict) would be good!

[Tyriar]

@dbaeumer do you have a link to the new task contribution extension API?

[dbaeumer]

Was in vscode.proposed.d.ts in 1.12 and is now in vscode.d.ts. See https://github.com/Microsoft/vscode/blob/master/src/vs/vscode.d.ts#L3766

It still might change until we ship 1.1.3

[Tyriar]

I see we're deferring it. @ivankravets you might find this new API useful in an upcoming version e98c09c

[ivankravets]

Is possible to subscribe to onDidTaskRun()? Where would be an ability to catch up some tasks and perform some operations. We have pre and post callbacks in Atom Build for each task.

Simple use case. User open Serial Monitor via integrated Terminal, we see it. He triggers "Upload" task, we temporary close opened Serial Port Monitors/Terminals, then uploading firmware. If a task fails with an error, we don't re-open Monitor. However, if the upload was successful, we re-open last Serial Port Monitor.

Thanks for the hints!

[dbaeumer]

@ivankravets currently not but this is definitely something we can provide. Could you open an issue please.

[ivankravets]

@dbaeumer Thanks, done! #29855

[Tyriar]

@dbaeumer @ivankravets @dbaeumer hi all, @ramya-rao-a put together a PR for this #30352. We were thinking that the new env option in the API should add to the current environment rather than replace it. Wanted to get some opinions here because adding to the environment would certainly be more convenient for the vast majority of cases but we're just worried that people may need to remove keys from the environment. Does adding to the current environment cover your use cases?

[dbaeumer]

I currently merge / override the environments. This doesn't let you remove an value. We could say if a value is undefined it means to remove.

[ivankravets]

My proposition:

1. options.env accepts dictionary (key/value object)
2. Terminal iterates over these keys and REPLACE all occurences in the current process.env which later will be used by terminal instance
3. I like this @dbaeumer "We could say if a value is undefined it means to remove."

---

P.S: We should be able not only to override some environemnt variable but also to remove it (set to null/undefined).

Thanks!

[Tyriar]

@dbaeumer @ivankravets I like it 😄 @ramya-rao-a let's go additive but if the key exists and it's falsy, remove the key from the environment (note this in the API jsdoc).

[ivankravets]

How to use it with 1.18.0?

vscode.window.createTerminal('PlatformIO', constants.IS_WINDOWS ? 'cmd.exe' : null, [], { TEST: 13 });

Does not work.

[ramya-rao-a]

@ivankravets

code.window.createTerminal({name: 'PlatformIO', shellPath: constants.IS_WINDOWS ? 'cmd.exe' : null, shellArgs: [], env: { TEST: 13 }}

[ivankravets]

@ramya-rao-a Thanks, it works now!