#84678 add language-specific overrides for breadcrumb and outline settings #85081

petevdp · 2019-11-18T23:19:07Z

This PR fixes #84678 by setting the relevant configuration options as overridable and including override details when getting these values from the configuration.

I'm still working on getting the outline settings working the same way, but I'm opening this PR up early for any potential feedback and guidance.

Affected Settings

Affected settings include all of the settings in outline.contribution.tsand breadcrumbs.ts that have a corresponding filteredTypes setting.

Questions / Guidance

I'm currently trying to find out how to get the class responsible for filtering outlines OutlineFilter to have the correct context when reading the config. It seems like I either have to include a relevant service codeEditorService or pass OutlineFilter.update the necessary context. Does anyone have any thoughts? Currently leaning towards the former but I don't know the full implications that that might have.
When listening for configuration updates in the breadcrumbs model, I'm just checking for changes to configurations with either breadcrumbs or [<current language>] and updating that breadcrumb's outline if those are affected. Is this the way to do it or can I be more specific? It seems like the configuration service can only notify changes from the first layer of the configuration tree.

Testing

I haven't written any tests yet because I'm not sure if features like this are supposed to get them, but I can write some if that would be preferred.

jrieken · 2019-11-19T09:45:57Z

src/vs/workbench/browser/parts/editor/breadcrumbsModel.ts

+ });
+ }
+
+ return this._configurationService.getValue<boolean>(key);


You can use the ITextResourceConfigurationService which makes this a lot simpler

How's this? 9d9a99d

src/vs/workbench/browser/parts/editor/breadcrumbsModel.ts

jrieken · 2019-11-19T09:50:10Z

r pass OutlineFilter.update the necessary context. Does anyone have any thoughts? Currently leaning towards the former but I don't know the full implications that that might have.

Also use the ITextResourceConfigurationService and inside filter use the OutlineModel.get(element).textModel.uri

…guration overides when reading breadcrumb configurations involving filteredTypes

… corresponding filteredTypes

petevdp · 2019-11-19T23:29:50Z

r pass OutlineFilter.update the necessary context. Does anyone have any thoughts? Currently leaning towards the former but I don't know the full implications that that might have.

Also use the ITextResourceConfigurationService and inside filter use the OutlineModel.get(element).textModel.uri

implementation: 25a1bbb

petevdp · 2019-11-19T23:49:35Z

A callback is registered here which refilters the outline tree on config reload. Like the similar logic from BreadcrumbsModel, should we try to figure out what language is being used? I'm not sure where to get this information, or if that even makes sense in this context. A temporary fix would be to always filter on configuration change, but that wouldn't be ideal.

jrieken · 2019-11-20T08:14:05Z

A temporary fix would be to always filter on configuration change, but that wouldn't be ideal.

Ideally we get a better API here but what you could try is e.affectedKeys - it lists all changed keys and you could check for the occurrence of outline in there, e.g search for /$\.?outline\./

petevdp · 2019-11-20T16:17:09Z

e.affectedKeys is subject to the same limitation unfortunately, but maybe I could regex outline and language specific sections e.g /(outline|\[\w+\])/
edit: 33d8569

…new OutlineFilter implementation

jrieken · 2019-11-28T14:05:34Z

src/vs/workbench/browser/parts/editor/breadcrumbsModel.ts

@@ -53,9 +55,9 @@ export class EditorBreadcrumbsModel {
 private readonly _uri: URI,
 private readonly _editor: ICodeEditor | undefined,
 @IConfigurationService private readonly _configurationService: IConfigurationService,
+ @ITextResourceConfigurationService private readonly _textResourceConfigurationService: ITextResourceConfigurationService,


The "normal" ICOnfigurationService shouldn't be needed anymore and everything should be possible using the text resource based service

TextResourceConfigurationService doesn't appear to be a strict superset of ConfigurationService, and unfortunately BreadcrumbsConfig uses one of the unported methods updateValue right here in method BreadcrumbsConfig.updateValue This method is, in turn, bound and used by two breadcrumb configuration options, here and here.

This more directly relates to your other coment on BreadcrumbsControl since the references to updateValue are all in there, but I'm guessing we don't want to have to remove BreadcrumbsConfig as a dependency of either class.

What I have right now definitely isn't the ideal solution though, so I could try to bring TextResourceConfigurationService in line with ConfigurationService either in this PR, or get another pr merged first if this issue is too tangential.

I didn't really check to see if I could just use the one config service though, so thanks for pointing it out!

That's for the explaining - I learnt something :-). Yeah, the TextResourceConfigService seems to be limiting and causing less pretty code /cc @sandy081. Let's keep the PR free from cleaning that up.

Filed #85884 to enhance ITextResourceConfigService

jrieken · 2019-11-28T14:06:19Z

src/vs/workbench/browser/parts/editor/breadcrumbsControl.ts

@@ -168,6 +169,7 @@ export class BreadcrumbsControl {
 @IThemeService private readonly _themeService: IThemeService,
 @IQuickOpenService private readonly _quickOpenService: IQuickOpenService,
 @IConfigurationService private readonly _configurationService: IConfigurationService,
+ @ITextResourceConfigurationService private readonly _textResourceConfigurationService: ITextResourceConfigurationService,


Don't have two configuration services (see my other comment)

Left a reply over there as well which is relevant here.

src/vs/editor/contrib/documentSymbols/outlineTree.ts

jrieken · 2019-11-29T11:01:32Z

This is looking good. @petevdp Can you fix merge conflicts and then I'll bring this in for the Nov release

…settings-overrides

petevdp · 2019-11-29T16:52:04Z

~~Apologies, this merge is going to be broken... Not sure why I thought it would be a good idea to push this without at least testing it. doh. I'll try to resolve this shortly.~~

edit: I think everything still works actually. All tests are passing and after manually testing the feature I added, it all works still. Again, if any automated testing should be included, let me know and I'll see what I can do.

jrieken · 2019-12-02T09:18:49Z

src/vs/workbench/contrib/outline/browser/outlinePane.ts

- this._treeFilter.update();
+ // This is a temporary solution to try and minimize refilters while
+ // ConfigurationChangeEvents only provide the first section of the config path.
+ if (e.affectedKeys.some(key => key.search(/(outline|\[\w+\])/))) {


fyi - this lacks a check for === 0. I will fix this one master after merge.

petevdp · 2019-12-02T18:48:56Z

Thanks for everyone's help!

add language-specific overrides for breadcrumb settings

1420884

egamma assigned jrieken Nov 19, 2019

jrieken reviewed Nov 19, 2019

View reviewed changes

petevdp added 3 commits November 19, 2019 14:17

switch to using TextResourceConfigurationService to account for confi…

9d9a99d

…guration overides when reading breadcrumb configurations involving filteredTypes

implement language specific overrides for outline config options with…

25a1bbb

… corresponding filteredTypes

explain specific usage of e.affectsConfiguration

9497acd

cange condition on outline tree refiltering to bring it in line with …

33d8569

…new OutlineFilter implementation

jrieken requested changes Nov 28, 2019

View reviewed changes

petevdp requested a review from jrieken November 28, 2019 19:43

get rid ofunnecessary typecasting

e88573e

jrieken approved these changes Nov 29, 2019

View reviewed changes

Merge branch 'master' into language-specific-outline-and-breadcrumbs-…

57e705b

…settings-overrides

jrieken reviewed Dec 2, 2019

View reviewed changes

jrieken added this to the November 2019 milestone Dec 2, 2019

jrieken merged commit 574f66e into microsoft:master Dec 2, 2019

petevdp deleted the language-specific-outline-and-breadcrumbs-settings-overrides branch December 2, 2019 18:49

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

#84678 add language-specific overrides for breadcrumb and outline settings #85081

#84678 add language-specific overrides for breadcrumb and outline settings #85081

petevdp commented Nov 18, 2019

jrieken Nov 19, 2019

petevdp Nov 19, 2019

jrieken commented Nov 19, 2019

petevdp commented Nov 19, 2019

petevdp commented Nov 19, 2019 •

edited

Loading

jrieken commented Nov 20, 2019

petevdp commented Nov 20, 2019 •

edited

Loading

jrieken Nov 28, 2019

petevdp Nov 28, 2019

jrieken Nov 29, 2019

sandy081 Dec 1, 2019

jrieken Nov 28, 2019 •

edited

Loading

petevdp Nov 28, 2019

jrieken commented Nov 29, 2019

petevdp commented Nov 29, 2019 •

edited

Loading

jrieken Dec 2, 2019

petevdp commented Dec 2, 2019

#84678 add language-specific overrides for breadcrumb and outline settings #85081

#84678 add language-specific overrides for breadcrumb and outline settings #85081

Conversation

petevdp commented Nov 18, 2019

Affected Settings

Questions / Guidance

Testing

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrieken commented Nov 19, 2019

petevdp commented Nov 19, 2019

petevdp commented Nov 19, 2019 • edited Loading

jrieken commented Nov 20, 2019

petevdp commented Nov 20, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrieken Nov 28, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jrieken commented Nov 29, 2019

petevdp commented Nov 29, 2019 • edited Loading

Choose a reason for hiding this comment

petevdp commented Dec 2, 2019

petevdp commented Nov 19, 2019 •

edited

Loading

petevdp commented Nov 20, 2019 •

edited

Loading

jrieken Nov 28, 2019 •

edited

Loading

petevdp commented Nov 29, 2019 •

edited

Loading