https://github.com/seeminglyscience/editorastprovider
Browse script structure like a File System
https://github.com/seeminglyscience/editorastprovider
Last synced: about 2 months ago
JSON representation
Browse script structure like a File System
- Host: GitHub
- URL: https://github.com/seeminglyscience/editorastprovider
- Owner: SeeminglyScience
- License: mit
- Created: 2017-10-22T17:10:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-22T17:22:16.000Z (over 7 years ago)
- Last Synced: 2025-04-18T21:30:55.604Z (2 months ago)
- Language: PowerShell
- Size: 21.5 KB
- Stars: 25
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# EditorAstProvider
EditorAstProvider is a PowerShell module that adds a PSDrive containing the abstract syntax tree (AST)
of the current file. Requires VSCode or other [PowerShellEditorServices](https://github.com/PowerShell/PowerShellEditorServices) enabled editor.
This project adheres to the Contributor Covenant [code of conduct](https://github.com/SeeminglyScience/EditorAstProvider/tree/master/docs/CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
## Features
- Browse the AST like the file system
- Content relevant item names where possible
- Table formatted output
- Works with *-Ast and *-ScriptExtent EditorServices commands
## Demo
## Documentation
Check out our **[documentation](https://github.com/SeeminglyScience/EditorAstProvider/tree/master/docs/en-US/EditorAstProvider.md)** for information about how to use this project.
## Installation
### Gallery
```powershell
Install-Module EditorAstProvider -Scope CurrentUser
```
### Source
```powershell
git clone 'https://github.com/SeeminglyScience/EditorAstProvider.git'
Set-Location .\EditorAstProvider
Invoke-Build -Task Install
```
## Motivation
I absolutely adore the PowerShell AST, but it can be really difficult to navigate interactively if you
aren't already familar with how it all works. The goal of this project is to create an AST exploration
experience that can be used by anyone familar with PowerShell.
It may have also been a good excuse to play with the new and very awesome [SHiPS](https://github.com/PowerShell/SHiPS) module :)
## Usage
### First example
```powershell
New-EditorAstPSDrive
Get-ChildItem CurrentFile:\
# Container: CurrentFile:
#
# Mode Name AstType Preview
# ---- ---- ------- -------
# + Root ScriptBlockAst using namespace System.Collections.Generic...
Get-ChildItem CurrentFile:\ -Depth 2 -Filter *Item |
Select-Object -First 1 |
Get-ChildItem
# Container: CurrentFile:\Root\EndBlock\SinglePropertyItem
#
# Mode Name AstType Preview
# ---- ---- ------- -------
# + PropertyMap PropertyMemberAst hidden static [hashtable] $PropertyMap = @{...
# + ReturnPropertyName PropertyMemberAst hidden [string] $ReturnPropertyName;
# + SinglePropertyIte... FunctionMemberAst SinglePropertyItem([Ast] $ast, [string] $returnP...
# + GetChildItemImpl(0) FunctionMemberAst [object[]] GetChildItemImpl() {...
```
Creates the 'CurrentFile' PSDrive and browses the AST of the current file.
## Contributions Welcome!
We would love to incorporate community contributions into this project. If you would like to
contribute code, documentation, tests, or bug reports, please read our [Contribution Guide](https://github.com/SeeminglyScience/EditorAstProvider/tree/master/docs/CONTRIBUTING.md) to learn more.