Add `Show-ObjectTree` cmdlet #179

tznind · 2023-01-04T13:54:42Z

PR Summary

Adds the out-ShowObject command which presents the passed objects in a tree. Below each object passed appear its public fields/properties.

Value, Null, String (or where an Exception was grenerated querying property) appear as leaf elements
All other properties can be expanded as branches

TreeView fetches children as branches are expanded so the full tree is not built up front which helps with performance in cases of deep or expansive nesting.

PR Context

This is my first time working with powershell commandlets so please be gentle.

I thought I would look into implementing #178 . Let me know if this is not what you were expecting. If its not wildly out.

I am happy to look into adding whatever else is required (e.g. filtering / highlighting etc).

tznind · 2023-01-04T14:02:34Z

@microsoft-github-policy-service agree

I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

claudio-salvio · 2023-01-16T13:44:58Z

Hello @tznind

First of all, thank you for your contribution

I would like to propose you to consider another name, out-showobject seems to me a bit strange.
Maybe, you could consider something like Show-ObjectTree or Show-ObjectAsTree.

Best regards

tznind · 2023-01-16T21:21:13Z

I would like to propose you to consider another name, out-showobject seems to me a bit strange.
Maybe, you could consider something like Show-ObjectTree or Show-ObjectAsTree.

Good point. I've renamed it Show-ObjectTree.

I also added a StatusBar that shows original object count and selected leaf Type. And I've made it expand IEnumerable values (except string) similarly to how VisualStudio watch window does:

MrFly72 · 2023-05-03T16:09:57Z

I like this idea.
It helps debugging object values. That would even drive me to put it on a windows-box :-)

SteveL-MSFT · 2023-05-05T02:25:35Z

@tznind This is really neat, are you still working on this? I think you can do it iteratively when thinking about adding more features.

tig · 2023-05-05T07:34:55Z

@tznind This is really neat, are you still working on this? I think you can do it iteratively when thinking about adding more features.

I am now curious about how we can make ocgv and this work together seemlessly. By default selecting something in ocgv and having show-object launch will cause a bunch of screeen repaint.

We really need non-full-screen Terminal.Gui apps... gui-cs/Terminal.Gui#272

tznind · 2023-05-05T07:44:27Z

@tznind This is really neat, are you still working on this? I think you can do it iteratively when thinking about adding more features.

Yes! I'm excited to get back to this. I agree an iterative approach would be good. I've marked it ready for review. Let me know if there are required features for a first version. Theres a lot that would be nice to add later (e.g. search, handling big arrays smarter).

I am now curious about how we can make ocgv and this work together seemlessly. By default selecting something in ocgv and having show-object launch will cause a bunch of screeen repaint.

Yes I'd love to explore this also. Maybe a shortcut or something in ocgv to show a modal with the tree for currently selected object (or all objects)?

This prevents Ctrl+Right causing infinite loop where a property references a parent.

andyleejordan · 2023-05-08T17:58:22Z

@tig, @tznind, and @SteveL-MSFT are we thinking this is good to review and potentially merge? I can't quite tell from the discussion above.

tznind · 2023-05-10T06:15:10Z

@tig, @tznind, and @SteveL-MSFT are we thinking this is good to review and potentially merge? I can't quite tell from the discussion above.

Its a yes from me.

In terms of iterative improvement of this feature, I have a PR in Terminal.Gui to support filtering in TreeView<T> component (gui-cs/Terminal.Gui#2599).

It is merged to develop and will be in the next library release. Once that is out I can update this feature to have search. But can do that on a subsequent PR.

But if you want to wait and review it all at once that's fine too.

tig · 2023-05-10T18:02:43Z

If I can get T.Gui v1.11 out before Andrew gets to this we should include it. I'll try in next 24 hrs but no promises.

tig

I'm going to pull down and play with it, but here's my CR.

src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs

tig · 2023-05-20T06:13:58Z

src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs

+    {
+        #region Properties
+
+        private const string DataNotQualifiedForGridView = nameof(DataNotQualifiedForGridView);


Is this named correctly? Shouldn't it be "...ForShowObject"?

We should be consistent in parameters supported between OCGV and this. I think you should add:

-Title

-Filter

-MinUI

-Focus (if you want to tackle OCGV: Request: Focus a specific row on opening the grid view #127 (comment))

-Search (OCGV: Request: Focus a specific row on opening the grid view #127 (comment))

I have added in support for

-Title
-Filter
-MinUI

I have made the filter logic and ux match console grid view (i.e. Regex support with error label).

I think for -Focus and -Search that if it is not in the base ocgv yet then its not much point implementing it in the tree view at this stage.

For example you can now do:

($A = Get-ChildItem -Path $pshome -Recurse) | Show-ObjectTree -Title "Files in ps home" -MinUI -Filter manifest

src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectView.cs

tig

Usability issues:

src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs

tig · 2023-05-20T06:49:09Z

I wanted to use Show-ObjectTree to act as an interactive version of tree.

How would I do that?

tig

You need to add docs. See:

src\Microsoft.PowerShell.ConsoleGuiTools\OutConsoleGridviewCmdletCommand.cs

And to the README.md

tig · 2023-05-20T06:56:34Z

src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs

+    {
+        #region Properties
+
+        private const string DataNotQualifiedForGridView = nameof(DataNotQualifiedForGridView);


We should be consistent in parameters supported between OCGV and this. I think you should add:

-Title

-Filter

-MinUI

-Focus (if you want to tackle OCGV: Request: Focus a specific row on opening the grid view #127 (comment))

-Search (OCGV: Request: Focus a specific row on opening the grid view #127 (comment))

src/Microsoft.PowerShell.ConsoleGuiTools/Microsoft.PowerShell.ConsoleGuiTools.psd1

Now correctly refers to ObjectTree not GridView

tznind · 2023-05-22T19:58:31Z

I wanted to use Show-ObjectTree to act as an interactive version of tree.

How would I do that?

So Get-ChildItem | Show-ObjectTree probably makes the most sense for this use case.

This gives DirectoryInfo and FileInfo typed objects.

The current behaviour of Show-ObjectTree for any object type is to show the public fields/properties of the objects passed. In the case of DirectoryInfo this is Length, IsReadOnly, LastAccessTime etc.

We could detect when all the passed objects are IO objects and change the behaviour to enumerate children on expansion instead.

Optionally the user could pass a flag to prevent that behaviour?

tig · 2023-07-19T14:45:27Z

@tznind - A bunch of the comments I added above have not been addressed in this PR.

docs
lowercase show-object isn't working
inconsistent UI with ocgv
...

Will you be able to tackle these sometime soon?

tznind · 2023-07-19T18:46:44Z

Yes sorry has fallen down my list a bit but can look again at it. ALthough with the new TreeTable data source in v2 I have been wondering if just adding a --tree flag to existing command would be easier. It would allow viewing and selecting child elements in line. For example pipe some folders to ocgv then expand one and select some files within as the ogcv command output.

…

On Wed, 19 Jul 2023, 15:45 Tig, ***@***.***> wrote: @tznind <https://github.com/tznind> - A bunch of the comments I added above have not been addressed in this PR. - docs - lowercase show-object isn't working - inconsistent UI with ocgv - ... Will you be able to tackle these sometime soon? — Reply to this email directly, view it on GitHub <#179 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AHO3C5FGMXTEYTTZIXFI4VDXQ7XJHANCNFSM6AAAAAATQ2JIDY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

tznind · 2023-07-22T08:37:37Z

I wanted to use Show-ObjectTree to act as an interactive version of tree.

How would I do that?

The default 'child getter' is to enumerate the properties on the PSObject and express as <prop name>:<prop value>. This works well for all objects I have tried it with.

I have added a 'special cases' method called GetExtraChildren which allows adding additional tree elements for specific types of objects. So now DirectoryInfo objects also show child files/directories.

I am open to suggestions on how to do this. Some ideas I thought about included:

For DirectoryInfo adding a new property Contents and adding the children under that
Having a command line switch that changes behaviour between either displaying props or files/subdirs (or both)

I don't really like the Contents idea as it adds an extra layer to the tree you have to expand which is onerous for deep trees and just generally annoying.

andyleejordan · 2023-08-14T23:28:27Z

@tig are you happy enough with this for me to do a review and potential merge now?

StartAutomating · 2023-08-17T01:25:01Z

@tznind @tig really cool work!

Can't wait to figure out how it will integrate with Write-FormatTreeView so that any object can be formatted as a tree!

andyleejordan · 2023-10-18T00:25:31Z

@tznind - A bunch of the comments I added above have not been addressed in this PR.

@tig it looks like this has been updated since you last looked. I'd prefer to merge this before the next release! Do you agree?

tig · 2023-10-18T11:16:18Z

@tznind - A bunch of the comments I added above have not been addressed in this PR.

@tig it looks like this has been updated since you last looked. I'd prefer to merge this before the next release! Do you agree?

@tznind can you add support for -Debug and -UseNetConsole as I did to ocgv so we remain consistent?

tznind · 2023-10-18T20:19:57Z

@tznind - A bunch of the comments I added above have not been addressed in this PR.

@tig it looks like this has been updated since you last looked. I'd prefer to merge this before the next release! Do you agree?

@tznind can you add support for -Debug and -UseNetConsole as I did to ocgv so we remain consistent?

I have added these settings in 3c654e9

andyleejordan

This looks good to me! I'm going to merge it and then run it through an automated formatter because I don't believe in requesting just formatting / whitespace changes. I'm not super familiar with the code but I didn't spot anything obvious. Let's get it in!

Add Show-Object

4574c70

tznind added 3 commits January 16, 2023 20:12

Rename Show-ObjectTree

f5e6407

Sort members alphabetically and add statusbar

3562e47

Support for expanding IEnumerables

cc19635

tznind marked this pull request as ready for review May 5, 2023 07:31

Disable ExpandAll

49ae67a

This prevents Ctrl+Right causing infinite loop where a property references a parent.

tznind mentioned this pull request May 6, 2023

Support filtering in TreeView gui-cs/Terminal.Gui#2601

Closed

Add window title with quit shortcut hint and fix NRT warning

62e14e4

tznind added 2 commits May 19, 2023 11:07

Merge branch 'master' into showobj

7afd683

Add search to Show-ObjectTree

db96d55

tig requested changes May 20, 2023

View reviewed changes

src/Microsoft.PowerShell.ConsoleGuiTools/ShowObjectTreeCmdletCommand.cs Show resolved Hide resolved

tig requested changes May 20, 2023

View reviewed changes

tznind added 4 commits May 22, 2023 20:39

Fix format/environment error strings

37a207f

Now correctly refers to ObjectTree not GridView

Add bracers to else block

5c6238c

Add command name as tag

fe7da7e

Remove Ctrl+Q prompt and use Esc for exit

b377d15

Adjust look and feel to match grid view

1805fa6

andyleejordan force-pushed the master branch from f4691a9 to 1aef026 Compare July 19, 2023 18:51

tznind and others added 9 commits July 20, 2023 11:21

Merge branch 'master' into showobj

d08b0e5

Add Filter, MinUI and Title options and started docs

72e165f

Change Filter to match ocgv (regex support with error box)

3501e4b

Remove invalid examples and docs on output types to show tree

6e25364

Add prototype implementation of directory contents listing

90f6797

Don't output full path names of child objects

ef309ad

Adjust logic to be more readable

ca6baf1

Fix class name

0070117

Add alias 'sot' for Show-ObjectTree

b05aac7

Add sot to AliasesToExport

ac6d2d3

SteveL-MSFT requested a review from andyleejordan July 24, 2023 12:48

andyleejordan changed the title ~~Fixes #178 Add Show-Object~~ Add Show-ObjectTree cmdlet Aug 17, 2023

tznind and others added 2 commits October 18, 2023 20:45

Merge branch 'PowerShell:master' into showobj

e19c3eb

Add UseNetDriver and Debug flags to Show-ObjectTree

3c654e9

andyleejordan approved these changes Oct 23, 2023

View reviewed changes

andyleejordan merged commit 5ee4888 into PowerShell:master Oct 23, 2023
6 checks passed

tig mentioned this pull request Nov 6, 2023

Show-Object cmdlet #178

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Show-ObjectTree` cmdlet #179

Add `Show-ObjectTree` cmdlet #179

tznind commented Jan 4, 2023 •

edited

Loading

tznind commented Jan 4, 2023 •

edited

Loading

claudio-salvio commented Jan 16, 2023

tznind commented Jan 16, 2023

MrFly72 commented May 3, 2023

SteveL-MSFT commented May 5, 2023

tig commented May 5, 2023

tznind commented May 5, 2023 •

edited

Loading

andyleejordan commented May 8, 2023

tznind commented May 10, 2023 •

edited

Loading

tig commented May 10, 2023

tig left a comment

tig May 20, 2023

tig May 20, 2023

tznind Jul 22, 2023

tznind Jul 22, 2023

tig left a comment

tig commented May 20, 2023

tig left a comment •

edited

Loading

tig May 20, 2023

tznind commented May 22, 2023

tig commented Jul 19, 2023

tznind commented Jul 19, 2023 via email

tznind commented Jul 22, 2023 •

edited

Loading

andyleejordan commented Aug 14, 2023

StartAutomating commented Aug 17, 2023

andyleejordan commented Oct 18, 2023

tig commented Oct 18, 2023

tznind commented Oct 18, 2023

andyleejordan left a comment

Add Show-ObjectTree cmdlet #179

Add Show-ObjectTree cmdlet #179

Conversation

tznind commented Jan 4, 2023 • edited Loading

PR Summary

PR Context

tznind commented Jan 4, 2023 • edited Loading

claudio-salvio commented Jan 16, 2023

tznind commented Jan 16, 2023

MrFly72 commented May 3, 2023

SteveL-MSFT commented May 5, 2023

tig commented May 5, 2023

tznind commented May 5, 2023 • edited Loading

andyleejordan commented May 8, 2023

tznind commented May 10, 2023 • edited Loading

tig commented May 10, 2023

tig left a comment

Choose a reason for hiding this comment

tig May 20, 2023

Choose a reason for hiding this comment

tig May 20, 2023

Choose a reason for hiding this comment

tznind Jul 22, 2023

Choose a reason for hiding this comment

tznind Jul 22, 2023

Choose a reason for hiding this comment

tig left a comment

Choose a reason for hiding this comment

tig commented May 20, 2023

tig left a comment • edited Loading

Choose a reason for hiding this comment

tig May 20, 2023

Choose a reason for hiding this comment

tznind commented May 22, 2023

tig commented Jul 19, 2023

tznind commented Jul 19, 2023 via email

tznind commented Jul 22, 2023 • edited Loading

andyleejordan commented Aug 14, 2023

StartAutomating commented Aug 17, 2023

andyleejordan commented Oct 18, 2023

tig commented Oct 18, 2023

tznind commented Oct 18, 2023

andyleejordan left a comment

Choose a reason for hiding this comment

Add `Show-ObjectTree` cmdlet #179

Add `Show-ObjectTree` cmdlet #179

tznind commented Jan 4, 2023 •

edited

Loading

tznind commented Jan 4, 2023 •

edited

Loading

tznind commented May 5, 2023 •

edited

Loading

tznind commented May 10, 2023 •

edited

Loading

tig left a comment •

edited

Loading

tznind commented Jul 22, 2023 •

edited

Loading