Views: Support contributing welcome-views to empty tree view #8678

EstherPerelman · 2020-10-28T14:49:00Z

Signed-off-by: Esther Perelman [email protected]

Welcome-views can be contributed by extensions in order to be applied to empty tree views, A view is considered empty if the tree has no children.
see vscode doc: vs-code-contributes.viewsWelcome

What it does

Partially solves #7178 #8667 (For now supports contributing to custom-views and 'explorer' view but not the other built-in views: 'scm', 'debugger', 'test').

How to test

Deploy test extension run-configuration.zip
When opening it from the left menu - you should see the contributed welcome-view:

2. You can now contribute more welcome-views to the run-configuration view by adding a viewWelcome to any extension package.json under "contributes" key, For example:

"viewsWelcome": [{
"view": runConfigurations,
"contents": "In order to use git features, you can open a folder containing a git repository or clone from a URL.\nOpen Folder\nClone Repository\nTo learn more about how to use git and source control in VS Code read our docs.",
}]

Now it should look like this:

You can play around... (add when clause etc...)

open theia without opening a workspace/folder - you should see a new welcome view in the Explorer tab, You can contribute additional views-welcome to the Explorer view by specifying "view": "explorer" .

The contentns are rendered like this:
'/n' - for new line.
'[here goes the label](here goes a command or a link)' - If there's only a command/link in a line without any other text - it will be displayed as a button, Otherwise as a link.

Review checklist

as an author, I have thoroughly tested my changes and carefully followed the review guidelines

Reminder for reviewers

as a reviewer, I agree to behave in accordance with the review guidelines

vince-fugnitto

We can perform a comprehensive review after the next release (tomorrow) 👍

packages/plugin-ext/src/main/browser/style/tree.css

packages/plugin-ext/src/main/browser/view/plugin-view-welcome.tsx

kittaakos

I tried it with a VS Code extension, and it works perfectly. I look forward to seeing this feature in Theia. Nice job, @EstherPerelman 👍

packages/core/src/browser/tree/tree-view-welcome-widget.tsx

kittaakos · 2020-10-30T13:35:36Z

packages/filesystem/src/browser/file-tree/file-tree-widget.tsx

@@ -33,7 +33,7 @@ export const DIR_NODE_CLASS = 'theia-DirNode';
 export const FILE_STAT_ICON_CLASS = 'theia-FileStatIcon';

 @injectable()
-export class FileTreeWidget extends TreeWidget {
+export class FileTreeWidget extends TreeViewWelcomeWidget {


Can we enable the welcome-support in all other trees as well? It isn't FS specific. What do you think, @akosyakov?

EstherPerelman · 2020-11-01T14:02:44Z

@kittaakos @vince-fugnitto Can you continue reviewing the code?

packages/search-in-workspace/package.json

amiramw · 2020-11-19T12:46:34Z

@kittaakos @vince-fugnitto other then the CQ (which is approved now) do you have more comments?

vince-fugnitto

The changes look good to me, I verified with the simple extension but not the additional configuration as I do not have the source code.

I'm wondering about the following https://github.com/eclipse-theia/theia/pull/8678/files#r515101313 however. I'll add reviewers who are more familiar with the plugin-system to see if they have any comments as well.

kittaakos

It works nicely, very good job. I added a few comments.

One question; if Clone Repository is not supported when there is no opened workspace, why do we show it?

packages/core/src/browser/style/tree.css

packages/core/src/browser/tree/tree-view-welcome-widget.tsx

packages/plugin-ext/src/hosted/node/scanners/scanner-theia.ts

packages/plugin-ext/src/main/browser/view/plugin-view-registry.ts

EstherPerelman · 2020-11-22T08:59:28Z

It works nicely, very good job. I added a few comments.

One question; if Clone Repository is not supported when there is no opened workspace, why do we show it?

@amiramw What do you think?

amiramw · 2020-11-22T09:20:02Z

It works nicely, very good job. I added a few comments.
One question; if Clone Repository is not supported when there is no opened workspace, why do we show it?

@amiramw What do you think?

It should be supported when there is no opened workspace. At least in vscode it is with vscode builtin git support. Did you test with builtin git extension?

EstherPerelman · 2020-11-22T10:16:00Z

It works nicely, very good job. I added a few comments.

@kittaakos Thanks for reviewing! I updated the code accordingly

kittaakos · 2020-11-23T12:36:29Z

It should be supported when there is no opened workspace

There was no workspace opened:

Did you test with builtin git extension?

I tested with the electron example app.

EstherPerelman · 2020-11-23T15:18:32Z

It should be supported when there is no opened workspace

There was no workspace opened:

Did you test with builtin git extension?

I tested with the electron example app.

Anyway, I removed it and when working with the builtin git extension - it will be contributed by it (and supported).

amiramw · 2020-11-25T13:22:14Z

@kittaakos are there any more comments or can we merge? (after CI is working and release is over)

kittaakos · 2020-11-25T13:29:05Z

are there any more comments or can we merge?

I haven't had time to look into the updates, probably it is good to merge if all remarks have been addressed, but we need to restore the CI first.

Signed-off-by: Esther Perelman <[email protected]>

amiramw · 2020-12-02T09:26:25Z

@kittaakos PR is rebased and build passed. could you give final approval?

kittaakos

Thank you, @EstherPerelman. Nice feature👍

@amiramw, please help with the merging. I've checked and tried the changeset twice already.

amiramw

Went over the code again and tested successfully

EstherPerelman force-pushed the views-welcome branch from a1fb1ee to cc058f2 Compare October 28, 2020 15:41

vince-fugnitto added the vscode issues related to VSCode compatibility label Oct 28, 2020

vince-fugnitto reviewed Oct 28, 2020

View reviewed changes

packages/plugin-ext/src/main/browser/style/tree.css Outdated Show resolved Hide resolved

packages/plugin-ext/src/main/browser/style/tree.css Outdated Show resolved Hide resolved

packages/plugin-ext/src/main/browser/view/plugin-view-welcome.tsx Outdated Show resolved Hide resolved

EstherPerelman marked this pull request as draft October 29, 2020 08:20

EstherPerelman force-pushed the views-welcome branch from cc058f2 to 82a93c7 Compare October 29, 2020 19:48

EstherPerelman changed the title ~~Views: Support contributing welcome-views to custom-views~~ Views: Support contributing welcome-views to empty tree view Oct 29, 2020

EstherPerelman force-pushed the views-welcome branch 3 times, most recently from 3d9e3ce to a03e2fe Compare October 29, 2020 21:49

kittaakos self-requested a review October 30, 2020 08:00

kittaakos reviewed Oct 30, 2020

View reviewed changes

EstherPerelman force-pushed the views-welcome branch 2 times, most recently from bf52574 to 9372a7a Compare November 1, 2020 13:50

EstherPerelman marked this pull request as ready for review November 1, 2020 14:00

DucNgn reviewed Nov 2, 2020

View reviewed changes

packages/search-in-workspace/package.json Outdated Show resolved Hide resolved

EstherPerelman force-pushed the views-welcome branch from 9372a7a to d9f8a02 Compare November 2, 2020 22:40

kittaakos added the CQ Required (deprecated) issues requiring a CQ (contributor questionnaire) label Nov 3, 2020

vince-fugnitto reviewed Nov 19, 2020

View reviewed changes

vince-fugnitto requested review from azatsarynnyy and tolusha November 19, 2020 15:35

kittaakos reviewed Nov 20, 2020

View reviewed changes

EstherPerelman force-pushed the views-welcome branch 4 times, most recently from 3399afd to f4ec5a6 Compare November 22, 2020 10:11

EstherPerelman force-pushed the views-welcome branch from f4ec5a6 to eddb30c Compare November 25, 2020 13:59

Views: Support contributing welcome-views to empty views

e45de40

Signed-off-by: Esther Perelman <[email protected]>

EstherPerelman force-pushed the views-welcome branch from eddb30c to e45de40 Compare December 1, 2020 19:58

kittaakos approved these changes Dec 3, 2020

View reviewed changes

amiramw approved these changes Dec 17, 2020

View reviewed changes

amiramw merged commit 44f0d28 into eclipse-theia:master Dec 17, 2020

vince-fugnitto mentioned this pull request Jan 26, 2021

Drag and drop availability indicator for file explorer #8988

Open

amiramw mentioned this pull request Feb 11, 2021

9012-registerTerminalLinkProvider-stub: for vscode-java-debug #9048

Merged

1 task

EstherPerelman mentioned this pull request Apr 15, 2021

[vscode] support viewsWelcome contribution point #7178

Closed

clovis-dugue mentioned this pull request Apr 15, 2021

viewsWelcome behavior does not match VSCode's #9361

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Views: Support contributing welcome-views to empty tree view #8678

Views: Support contributing welcome-views to empty tree view #8678

EstherPerelman commented Oct 28, 2020 •

edited

Loading

vince-fugnitto left a comment

kittaakos left a comment

kittaakos Oct 30, 2020

EstherPerelman commented Nov 1, 2020

amiramw commented Nov 19, 2020 •

edited

Loading

vince-fugnitto left a comment

kittaakos left a comment

EstherPerelman commented Nov 22, 2020

amiramw commented Nov 22, 2020

EstherPerelman commented Nov 22, 2020 •

edited

Loading

kittaakos commented Nov 23, 2020

EstherPerelman commented Nov 23, 2020

amiramw commented Nov 25, 2020 •

edited

Loading

kittaakos commented Nov 25, 2020

amiramw commented Dec 2, 2020

kittaakos left a comment

amiramw left a comment

Views: Support contributing welcome-views to empty tree view #8678

Views: Support contributing welcome-views to empty tree view #8678

Conversation

EstherPerelman commented Oct 28, 2020 • edited Loading

What it does

How to test

Review checklist

Reminder for reviewers

vince-fugnitto left a comment

Choose a reason for hiding this comment

kittaakos left a comment

Choose a reason for hiding this comment

kittaakos Oct 30, 2020

Choose a reason for hiding this comment

EstherPerelman commented Nov 1, 2020

amiramw commented Nov 19, 2020 • edited Loading

vince-fugnitto left a comment

Choose a reason for hiding this comment

kittaakos left a comment

Choose a reason for hiding this comment

EstherPerelman commented Nov 22, 2020

amiramw commented Nov 22, 2020

EstherPerelman commented Nov 22, 2020 • edited Loading

kittaakos commented Nov 23, 2020

EstherPerelman commented Nov 23, 2020

amiramw commented Nov 25, 2020 • edited Loading

kittaakos commented Nov 25, 2020

amiramw commented Dec 2, 2020

kittaakos left a comment

Choose a reason for hiding this comment

amiramw left a comment

Choose a reason for hiding this comment

EstherPerelman commented Oct 28, 2020 •

edited

Loading

amiramw commented Nov 19, 2020 •

edited

Loading

EstherPerelman commented Nov 22, 2020 •

edited

Loading

amiramw commented Nov 25, 2020 •

edited

Loading