Skip to content

Commit 0956f8c

Browse files
committed
(GH-434) Update readme for the new workspace intellisense feature
This commit updates the README with information about the new Live Workspace Intellisense feature which comes as part of Puppet Editor Services 0.16.0.
1 parent 4e12b4b commit 0956f8c

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- [Go to Symbol](#go-to-symbol)
2121
- [Code Snippets](#code-snippets)
2222
- [Linting](#linting)
23+
- [Live Workspace Intellisense](#live-workspace-intellisense)
2324
- [Puppet Commands](#puppet-commands)
2425
- [Puppet Resource](#puppet-resource)
2526
- [Puppet Node Graph](#puppet-node-graph)
@@ -71,7 +72,7 @@ This extension provides full Puppet Language support for [Visual Studio Code](ht
7172

7273
You will need to have the [Puppet Agent](https://puppet.com/docs/puppet/4.10/about_agent.html) or [Puppet Development Kit (PDK)](https://puppet.com/docs/pdk/1.x/pdk.html) installed in order to fully use this extension.
7374

74-
**Note:** PDK version 1.5.0 or higher is required.
75+
> Note: PDK version 1.5.0 or higher is required.
7576
7677
You can find instructions and installation links here:
7778

@@ -163,6 +164,14 @@ As part of IntelliSense and Snippets, you can quickly create templates to automa
163164

164165
Linting is automatically applied to the document as you edit, without having to save the file first. The validation uses [puppet-lint](https://github.com/rodjek/puppet-lint) to validate the Puppet syntax in all open puppet files. Errors and warnings appear in the Problems window in VSCode.
165166

167+
### Live Workspace Intellisense
168+
169+
If you are editing a module you will now get live intellisense of the [Puppet Custom Types](https://puppet.com/docs/puppet/latest/custom_types.html), [Functions](https://puppet.com/docs/puppet/latest/lang_write_functions_in_puppet.html), [Classes](https://puppet.com/docs/puppet/latest/lang_classes.html) and [Defined Types](https://puppet.com/docs/puppet/latest/lang_defined_types.html). For example if you are editing the [puppetlabs-apache module](https://github.com/puppetlabs/puppetlabs-apache) you will be able to get auto-complete for resources like `apache::vhost` or `apache::mod::php`.
170+
171+
Support for [Control Repositories](https://puppet.com/docs/pe/latest/control_repo.html) is _coming soon!_
172+
173+
> Note: Workspace Intellisense is only updated when you save a file, instead of features like linting which update as you type
174+
166175
### Puppet Commands
167176

168177
#### Puppet Resource
@@ -195,9 +204,9 @@ The node graph will appear next to the manifest
195204

196205
You can use the [Puppet Development Kit](https://puppet.com/blog/develop-modules-faster-new-puppet-development-kit) inside VS Code from the command palette. To use any of the above commands, open the command palette and start typing a command. You can also use the right-click context menu or the editor menu to reach these commands.
197206

198-
** Note: The PDK must be installed prior to using these commands
207+
> Note: The PDK must be installed prior to using these commands
199208
200-
** Note: `pdk convert` is not available in the command palette as it is a complicated command that requires user input to succeed. It is better to use it from the builtin terminal.
209+
> Note: `pdk convert` is not available in the command palette as it is a complicated command that requires user input to succeed. It is better to use it from the builtin terminal.
201210
202211
#### PDK new module
203212

@@ -274,9 +283,9 @@ The Puppet VSCode extension can use the PDK or the Puppet Agent to provide advan
274283
If no settings are chosen, the extension will attempt to use the Puppet Agent, to force it to use the PDK you have to select `pdk` for `puppet.installType`.
275284

276285

277-
**Note**: The `puppet.puppetAgentDir` setting name will be changed in the `0.12.0` release to `puppet.installDirectory`
286+
> Note: The `puppet.puppetAgentDir` setting name will be changed in the `0.12.0` release to `puppet.installDirectory`
278287
279-
**Note**: Only PDK v1.5.0 and above are supported.
288+
> Note: Only PDK v1.5.0 and above are supported.
280289
281290
### Configure extension to use PDK
282291

0 commit comments

Comments
 (0)