diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a4085de..50f0f691 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how - ([GH-366](https://github.com/lingua-pupuli/puppet-vscode/issues/366)) New Debug Adapter - ([GH-354](https://github.com/lingua-pupuli/puppet-vscode/issues/354)) Document PDK as source information +- ([GH-385](https://github.com/lingua-pupuli/puppet-vscode/issues/385)) New Outline View, Breadcrumb, and Go to Symbol Features ### Changed @@ -17,6 +18,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how - ([GH-373](https://github.com/lingua-pupuli/puppet-vscode/issues/373)) Refactor commands and providers to features - ([GH-351](https://github.com/lingua-pupuli/puppet-vscode/issues/351)) Updated Puppet Editor Services to version 0.14.0. Change Log is at [https://github.com/lingua-pupuli/puppet-editor-services/releases/tag/0.14.0](https://github.com/lingua-pupuli/puppet-editor-services/releases/tag/0.15.0) - ([GH-323](https://github.com/lingua-pupuli/puppet-vscode/issues/323)) Update readme with gif examples +- ([GH-399](https://github.com/lingua-pupuli/puppet-vscode/issues/399)) Update Puppet loading UI to be more user friendly ### Deprecated diff --git a/README.md b/README.md index 0193ea04..5a1fa3ba 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ - [Syntax highlighting](#syntax-highlighting) - [Auto completion](#auto-completion) - [Hover Support](#hover-support) + - [Outline View](#outline-view) + - [Breadcrumbs](#breadcrumbs) + - [Go to Symbol](#go-to-symbol) - [Code Snippets](#code-snippets) - [Linting](#linting) - [Puppet Commands](#puppet-commands) @@ -50,6 +53,9 @@ This extension provides full Puppet Language support for [Visual Studio Code](ht - Syntax highlighting - IntelliSense for resources, parameters and more +- Outline View +- Breadcrumbs +- Go to Symbol - Linting - Code snippets - Go to Definition of functions, types and classes @@ -85,7 +91,14 @@ You can find instructions and installation links here: - MacOSX - Linux -## Usage +## Usage + +### Loading indicator + +The Puppet extension includes additional information in the form of a tooltip which describes the features that are loaded and still loading during startup. + +![loading_status](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/loading_status.gif) + ### Syntax Highlighting @@ -109,6 +122,35 @@ Hovering over any resource, class declaration or other Puppet symbol provides in ![hover_support](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/hover_support.gif) +### Outline View + +The new `Outline View` shows the symbol tree of the currently selected Puppet manifest. + +Supported symbols: + +Symbol | Puppet Class + -- | -- +Class | `Puppet::Pops::Model::HostClassDefinition` +Defined Type | `Puppet::Pops::Model::ResourceTypeDefinition` +Attribute | `Puppet::Pops::Model::AttributeOperation` +Variable | `Puppet::Pops::Model::AssignmentExpression` + +More symbols are planned to be added. + +![outline_view](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/outline_view.gif) + +### Breadcrumbs + +When the `breadcrumbs.enabled` setting is set to true, both the file path and the symbol tree hierarchy are shown in the Breadcrumb view. + +![breadcrumbs](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/breadcrumbs.gif) + +### Go to Symbol + +Opening the `Command Palette` and typing the `@` symbol initiates the `Go to Symbol` view which allows you to navigate around inside a Puppet manifest more quickly. + +![go_to_symbol](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/go_to_symbol.gif) + ### Code Snippets As part of IntelliSense and Snippets, you can quickly create templates to automate repetitive series of code. diff --git a/docs/assets/breadcrumbs.gif b/docs/assets/breadcrumbs.gif new file mode 100644 index 00000000..21972e8f Binary files /dev/null and b/docs/assets/breadcrumbs.gif differ diff --git a/docs/assets/go_to_symbol.gif b/docs/assets/go_to_symbol.gif new file mode 100644 index 00000000..299062ee Binary files /dev/null and b/docs/assets/go_to_symbol.gif differ diff --git a/docs/assets/loading_status.gif b/docs/assets/loading_status.gif new file mode 100644 index 00000000..18de2cbf Binary files /dev/null and b/docs/assets/loading_status.gif differ diff --git a/docs/assets/outline_view.gif b/docs/assets/outline_view.gif new file mode 100644 index 00000000..b5173503 Binary files /dev/null and b/docs/assets/outline_view.gif differ