-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #37 from santisq/36-add-styles-to-pstree
Adds `TreeStyle` to PSTree
- Loading branch information
Showing
24 changed files
with
985 additions
and
102 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| --- | ||
| external help file: PSTree.dll-Help.xml | ||
| Module Name: PSTree | ||
| online version: | ||
| schema: 2.0.0 | ||
| --- | ||
|
|
||
| # Get-PSTreeStyle | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| Gets the instance of `TreeStyle` used for output rendering. | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```powershell | ||
| Get-PSTreeStyle | ||
| [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| The `Get-PSTreeStyle` cmdlet can be used to access the instance of `TreeStyle` used for rendering and customizing the `Get-PSTree` output. See [__about_TreeStyle__](./about_TreeStyle.md) for more information. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### Example 1 | ||
|
|
||
| ```powershell | ||
| PS ..\PSTree> $style = Get-PSTreeStyle | ||
| ``` | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### CommonParameters | ||
|
|
||
| This cmdlet supports the common parameters. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ### None | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### TreeStyle |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| # about_TreeStyle | ||
|
|
||
| ## SHORT DESCRIPTION | ||
|
|
||
| Describes the available support for ANSI escape sequences in PSTree Module. | ||
|
|
||
| ## LONG DESCRIPTION | ||
|
|
||
| PSTree v2.2.0 adds support for coloring the hierarchy output from `Get-PSTree` cmdlet via the `TreeStyle` type. The type offers a subset of capabilities that the built-in [`PSStyle`][1] has, more specifically, the [`FileInfoFormatting`][2] subset. | ||
|
|
||
| The instance of this type can be accessed via the [`Get-PSTreeStyle`][3] cmdlet or the `[PSTree.Style.TreeStyle]::Instance` property: | ||
|
|
||
| <div> | ||
| | ||
| <img src="../../assets/TreeStyle.png" alt="TreeStyle" width="35%" height="35%"> | ||
| </div> | ||
|
|
||
| It has some useful methods to combine escape sequences as well as add accents, see next section for more details. | ||
|
|
||
| ```powershell | ||
| TypeName: PSTree.Style.TreeStyle | ||
| Name MemberType Definition | ||
| ---- ---------- ---------- | ||
| CombineSequence Method string CombineSequence(string left, string right) | ||
| Equals Method bool Equals(System.Object obj) | ||
| EscapeSequence Method string EscapeSequence(string vt) | ||
| GetHashCode Method int GetHashCode() | ||
| GetType Method type GetType() | ||
| ResetSettings Method void ResetSettings() | ||
| ToBold Method string ToBold(string vt) | ||
| ToItalic Method string ToItalic(string vt) | ||
| ToString Method string ToString() | ||
| Directory Property string Directory {get;set;} | ||
| Executable Property string Executable {get;set;} | ||
| Extension Property PSTree.Style.Extension Extension {get;} | ||
| OutputRendering Property PSTree.Style.OutputRendering OutputRendering {get;set;} | ||
| Palette Property PSTree.Style.Palette Palette {get;} | ||
| Reset Property string Reset {get;} | ||
| ``` | ||
|
|
||
| The `EscapeSequence()` method can be used to see the escape sequence used to produce the color and accent, for example: | ||
|
|
||
| <div> | ||
| | ||
| <img src="../../assets/EscapeSequence.png" alt="TreeStyle" width="45%" height="45%"> | ||
| </div> | ||
|
|
||
| ## CUSTOMIZING OUTPUT | ||
|
|
||
| Similar to `PSStyle` you can update the properties of `TreeStyle` as well as add an remove coloring for different extensions. | ||
|
|
||
| > [!NOTE] | ||
| > | ||
| > - For now, customizing the output of files that are a __SymbolicLink__ is not supported. | ||
| > - The __Executable__ accent is only available for Windows Operating System. | ||
| For example, take the standard output: | ||
|
|
||
| <div> | ||
| | ||
| <img src="../../assets/Example.Before.png" alt="Example.Before" width="45%" height="45%"> | ||
| </div> | ||
|
|
||
| We can make a few changes to the style object: | ||
|
|
||
| ```powershell | ||
| $style = Get-PSTreeStyle | ||
| $palette = $style.Palette | ||
| # update the .ps1 extension | ||
| $style.Extension['.ps1'] = $style.CombineSequence($palette.Foreground.White, $palette.Background.Red) | ||
| # add the .cs extension | ||
| $style.Extension['.cs'] = $style.ToItalic($style.ToBold($palette.ForeGround.BrightCyan)) | ||
| # update the Directory style | ||
| $style.Directory = "`e[45m" | ||
| ``` | ||
|
|
||
| > [!TIP] | ||
| > | ||
| > - The `` `e `` escape character was added in PowerShell 6. __Windows PowerShell 5.1__ users can use `[char] 27` instead, for example from previous example, instead of ``"`e[45m"`` you can use `"$([char] 27)[45m"`. | ||
| See [__about_Special_Characters__][4] for more details. | ||
| > - The `TreeStyle` type has 3 public methods that you can use to add accents or combine VT sequences, `ToItalic()`, `ToBold()` and `CombineSequence()`. | ||
| > - You can also reset the style instance to its initial state using `.ResetSettings()` however if you had the instance stored in a variable you will need to re-assign its value, i.e.: `$style.ResetSettings()` then `$style = treestyle`. | ||
| Then, if we re-run the same command we can see those changes in the PSTree output: | ||
|
|
||
| <div> | ||
| | ||
| <img src="../../assets/Example.After.png" alt="Example.Before" width="45%" height="45%"> | ||
| </div> | ||
|
|
||
| ## DISABLING ANSI OUTPUT | ||
|
|
||
| Similarly to `PSStyle`, you can disable the ANSI rendering by updating the `OutputRendering` property: | ||
|
|
||
| ```powershell | ||
| (Get-PSTreeStyle).OutputRendering = 'PlainText' | ||
| ``` | ||
|
|
||
| [1]: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_ansi_terminals | ||
| [2]: https://learn.microsoft.com/en-us/dotnet/api/system.management.automation.psstyle.fileinfoformatting | ||
| [3]: ./Get-PSTreeStyle.md | ||
| [4]: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_special_characters?view=powershell-7.4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.