Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 512516 - Provide a way for users to see the JavaScript project information
Summary: Provide a way for users to see the JavaScript project information
Status: RESOLVED FIXED
Alias: None
Product: Orion
Classification: ECD
Component: JS Tools (show other bugs)
Version: 13.0   Edit
Hardware: PC Mac OS X
: P2 enhancement (vote)
Target Milestone: 15.0   Edit
Assignee: Michael Rennie CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2017-02-21 12:39 EST by Michael Rennie CLA
Modified: 2017-03-31 13:03 EDT (History)
2 users (show)

See Also:


Attachments
Proposed fix (6.56 KB, patch)
2017-03-07 11:40 EST, Michael Rennie CLA
no flags Details | Diff
Same patch + sections remember expanded state (11.22 KB, patch)
2017-03-07 13:08 EST, Silenio Quarti CLA
no flags Details | Diff
Updated patch (17.22 KB, patch)
2017-03-08 09:29 EST, Michael Rennie CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Michael Rennie CLA 2017-02-21 12:39:49 EST
Follow up from bug 511482, we need to provide a way for users to see / or perhaps configure the computed environment information.

Some ideas:

1. Provide some UI on the project explorer page to show the information
2. provide a command to write the files - for example, generate an eslintrc* file based on the env infos.
Comment 1 Michael Rennie CLA 2017-03-07 11:40:34 EST
Created attachment 267144 [details]
Proposed fix

Here is a proposed fix - it adds a project handler for the Javascript tools to provide environment infos in the project view pane (when you select a project).
Comment 2 Silenio Quarti CLA 2017-03-07 13:08:30 EST
Created attachment 267147 [details]
Same patch + sections remember expanded state
Comment 3 Steve Northover CLA 2017-03-07 13:08:37 EST
We took a look at the UI and there were a bunch of problems with it that I don't think we can address for Orion 14.

1) The ordering should be READ.ME, files, then project information.
2) The sections should be closed by default (otherwise it is overwhelming).
3) Any time there is an expand/collapse it has to be remembered
4) We need to look at all the information being displayed (non-tooling as well) and decide whether we want it, the styling etc.

I am guessing that changing the UI in any way that is obtrusive at this point will cause consternation.  Having said that, I love the feature because I can see what is happening.

The only thing I can suggest is dark launch or a setting to turn it on and have it turned off by default.
Comment 4 Steve Northover CLA 2017-03-07 13:09:14 EST
... and SSQ fixed some of the things we saw.  Do we need call to decide next steps?
Comment 5 Michael Rennie CLA 2017-03-08 09:29:55 EST
Created attachment 267169 [details]
Updated patch

This patch builds on Silenios' patch, and makes all section but the nav one collapsed by default, as well as adding a general preference to show / hide the additional project information when a project.json file is not present.
Comment 6 Steve Northover CLA 2017-03-09 11:53:28 EST
Do we think we are done?  If so, SSQ and I will give it a try soon.
Comment 7 Michael Rennie CLA 2017-03-09 12:56:06 EST
(In reply to Steve Northover from comment #6)
> Do we think we are done?  If so, SSQ and I will give it a try soon.

Yes, just waiting on review and / or blessing for 14.
Comment 8 Steve Northover CLA 2017-03-09 17:00:29 EST
Spoke to SSQ.  We should defer to Orion 15.  It's a shame but I'd also like to discuss with you more some of the things that we are showing.
Comment 9 Michael Rennie CLA 2017-03-10 12:48:43 EST
(In reply to Steve Northover from comment #8)
> Spoke to SSQ.  We should defer to Orion 15.  It's a shame but I'd also like
> to discuss with you more some of the things that we are showing.

No problem. I think it still needs some more refining such as:

1. how do we not show it for every project - for example if you have a Java project, you would never want to see a JavaScript info entry

2. we need to be able to tag a project (or something) like Git does to better apply our infos (this would pretty much fix point one as well).

3. what infos we show - we need to make sure paths do not show internal path names - for example the project path currently includes '/file/' when it should not. We should also try to make any path a link.

4. investigate if we can provide the functionality to create a config file that is not found - for example if we detect that you have no package.json file, rather than the UI just saying 'None', there could be a button to create one.
Comment 10 Michael Rennie CLA 2017-03-31 13:03:25 EDT
Fixed in:

http://git.eclipse.org/c/orion/org.eclipse.orion.client.git/commit/?id=367b68c7258698c606dbe9d843f5cb1a1faee17b

Chatting with Silenio, we opt'd to get rid of the preference since the project info sections are now always at the bottom of the preview page (past the nav section). This fix include an update for point 3 in comment #9. Points 1 and 2 were not needed with the sorting order update and point 4 is unnecessary - those types of config files take some thinking and planning to make "properly" simply allowing them to be created like that is not that helpful.