replace settings variables in debugger config #8042 #8784

DonJayamanne · 2016-07-06T06:00:57Z

Provide the ability to expose (share) settings from the settings.json file to the launch.json file, using the dollar notation. #8042

settings.json:

"python.pythonPath": "/Library/Frameworks/Python.framework/Versions/3.5/bin/python3"

launch.json:

"pythonPath": "${settings.python.pythonPath}",

mention-bot · 2016-07-06T06:00:59Z

@DonJayamanne, thanks for your PR! By analyzing the annotation information on this pull request, we identified @isidorn and @egamma to be potential reviewers

isidorn · 2016-07-06T08:02:09Z

src/vs/workbench/parts/lib/node/settingsVariables.ts

+	}
+
+	protected resolveString(value: string): string {
+		let regexp = /\$\{settings\.(.*?)\}/g;


I would prefer if you just read the configuration every time you need to resolve the string.
Not sure if doing it the current way you can end up with a stale configuration.

isidorn · 2016-07-06T08:09:52Z

@DonJayamanne PR looks good overall - I added comments in the commits directly. Also:

Did you test this both on the folder and no-folder workspace?
Can you please squash all the commits as the first 4 commits in this PR should be removed?
It would be great if this also worked for tasks.json
Is it possible that SettingsVariables just extends from SystemVariables - using that approach we would not need both SettingsVariables and SystemVariables in DebugConfigurationManager and we would get this feature for free in the tasks world?
We should not call this 'setting.' but 'config.' to align with other places where we have this

Adding @weinand

DonJayamanne · 2016-07-07T00:57:08Z

@isidorn, @weinand

Did you test this both on the folder and no-folder workspace?

I have only tested this with a folder workspace.
Didn't know we can have VS Code with a no-folder workspace. How does that work?

Can you please squash all the commits as the first 4 commits in this PR should be removed?

Will do.

It would be great if this also worked for tasks.json
Is it possible that SettingsVariables just extends from SystemVariables - using that approach we would not need both SettingsVariables and SystemVariables in DebugConfigurationManager and we would get this feature for free in the tasks world?

Great idea. However, wouldn't this render SystemVariables obsolete? From what I can see this is only used in two places, running tasks and debug adapters.

Also it could be a little misleading, if we used this new class SettingsVariables where ever SystemVariables was being used, then one would be mistaken into assuming that only Settings (config) variables were being replaced.

I think this all boils down to the fact that this SettingsVariables (having extended SystemVariables) class will be doing two things:

Replacing System variables (base class functionality)
Replacing Settings (config) variables (overridden method functionality).

If you agree with the above then, how about we proceed with the following approach:

SettingsVaraibles extends SystemVariables (as per the suggestion)
Replace references to SystemVaraibles and SettingsVariables with ISystemVariables
Get ISystemVariables passed in as a constructor argument resolved via DI (resolved using the serviceCollection - no sure what the right terminology is here)

We should not call this 'setting.' but 'config.' to align with other places where we have this

Agreed, for now I'll continue using the word "Setting" and SettingsVariables so there's no confusion.

isidorn · 2016-07-07T10:03:56Z

@DonJayamanne no folder workspace is the purple vscode - the window which you get when you say 'new window'. In that scenario we do not support debugging but just open that window and check for exceptions - since a lot of things are missing in that scenario.

Your proposed approach sounds good to me, can you code it up and then we can provide more comments?

Thanks!

isidorn · 2016-07-08T13:54:53Z

src/vs/workbench/parts/debug/node/debugConfigurationManager.ts

@@ -169,8 +168,8 @@ export class ConfigurationManager implements debug.IConfigurationManager {
 		@IQuickOpenService private quickOpenService: IQuickOpenService,
 		@IKeybindingService private keybindingService: IKeybindingService
 	) {


This will probably throw an exception if you open the no-folder workspace.
That is the reason why I originally check for this.contextService.getWorkspace(), I think you need to re-introduce that check.

isidorn · 2016-07-08T13:58:43Z

@DonJayamanne pr looks great! There are only two things which should be updated - I commented in the code directly!

DonJayamanne · 2016-07-10T22:41:43Z

@isidorn , please check again, Thanks

isidorn · 2016-07-19T07:24:59Z

@DonJayamanne looks great! Sorry for the slow response, last week I was on vacation -> merging

isidorn · 2016-07-20T08:46:27Z

@DonJayamanne please create a test plan item for this so we can test it next week in the endgame - thanks!

DonJayamanne · 2016-07-21T02:36:43Z

@isidorn, done, please check the test plan (#9560) and let me know how it looks.

isidorn · 2016-07-21T05:59:34Z

@DonJayamanne looks great! I just assigned it to the current milestone (july) so it is easier for the endgame master to find it. I would also mention to try it for tasks.json as well.
My personal preference is to write more concise test plan items so the tester is given more freedom as to how to exactly test the new feature. But that is up to you

msftclas added the cla-already-signed label Jul 6, 2016

isidorn self-assigned this Jul 6, 2016

isidorn added this to the July 2016 milestone Jul 6, 2016

isidorn reviewed Jul 6, 2016
View reviewed changes

isidorn assigned weinand Jul 6, 2016

changes to resolve code review issues #8042

b8c4a03

isidorn reviewed Jul 8, 2016
View reviewed changes

reolved code review comments #8042

a81902c

isidorn merged commit 971ed27 into microsoft:master Jul 19, 2016

DonJayamanne mentioned this pull request Jul 21, 2016

Test: Provide ability to expose/share settings from settings.json to the launch.json #9560

Closed

3 tasks

isidorn mentioned this pull request Jul 21, 2016

RFE - Provide ability to expose/share settings form settings.json to the launch.json #8042

Closed

DonJayamanne mentioned this pull request Aug 31, 2016

Support variables when resolving values in settings #2809

Open

github-actions bot locked and limited conversation to collaborators Mar 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

replace settings variables in debugger config #8042 #8784

replace settings variables in debugger config #8042 #8784

DonJayamanne commented Jul 6, 2016

mention-bot commented Jul 6, 2016

isidorn Jul 6, 2016

isidorn commented Jul 6, 2016 •

edited

Loading

DonJayamanne commented Jul 7, 2016

isidorn commented Jul 7, 2016

isidorn Jul 8, 2016

isidorn commented Jul 8, 2016

DonJayamanne commented Jul 10, 2016

isidorn commented Jul 19, 2016

isidorn commented Jul 20, 2016

DonJayamanne commented Jul 21, 2016 •

edited

Loading

isidorn commented Jul 21, 2016

replace settings variables in debugger config #8042 #8784

replace settings variables in debugger config #8042 #8784

Conversation

DonJayamanne commented Jul 6, 2016

mention-bot commented Jul 6, 2016

isidorn Jul 6, 2016

Choose a reason for hiding this comment

isidorn commented Jul 6, 2016 • edited Loading

DonJayamanne commented Jul 7, 2016

isidorn commented Jul 7, 2016

isidorn Jul 8, 2016

Choose a reason for hiding this comment

isidorn commented Jul 8, 2016

DonJayamanne commented Jul 10, 2016

isidorn commented Jul 19, 2016

isidorn commented Jul 20, 2016

DonJayamanne commented Jul 21, 2016 • edited Loading

isidorn commented Jul 21, 2016

isidorn commented Jul 6, 2016 •

edited

Loading

DonJayamanne commented Jul 21, 2016 •

edited

Loading