Skip to content

Commit b65db2e

Browse files
authored
Merge pull request #553 from jpogran/release
(release) 0.20.0
2 parents 2f61a80 + f94e6cb commit b65db2e

File tree

4 files changed

+44
-37
lines changed

4 files changed

+44
-37
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
11
# Change Log
22

3-
All notable changes to the "vscode-puppet" extension will be documented in this file.
3+
All notable changes to the "puppet-vscode" extension will be documented in this file.
44

55
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
66

77
## [Unreleased]
88

9+
## [0.20.0] - 2019-08-30
10+
911
### Added
1012

1113
- ([GH-2](https://github.com/lingua-pupuli/docs/issues/2)) [docs-0.1.0](https://github.com/lingua-pupuli/docs/releases/tag/0.1.0) Puppet VSCode Website v1
14+
- ([GH-534](https://github.com/lingua-pupuli/puppet-vscode/issues/534)) Puppet Module Metadata hover provider
15+
- ([GH-541](https://github.com/lingua-pupuli/puppet-vscode/issues/541)) Check for latest PDK version and notify
1216

1317
### Changed
1418

@@ -17,6 +21,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
1721
- ([GH-106](https://github.com/lingua-pupuli/puppet-editor-services/issues/106)) [puppet-editor-services-0.21.0](https://github.com/lingua-pupuli/puppet-editor-services/releases/tag/0.21.0) Update puppet-lint to 2.3.6
1822

1923
### Fixed
24+
2025
- ([GH-43](https://github.com/lingua-pupuli/puppet-editor-syntax/issues/43)) [puppet-editor-syntax-1.3.3](https://github.com/lingua-pupuli/puppet-editor-syntax/commit/2ecb3d4b44e7d8b413b91676f39ade0ae0c4b2b4) Fix syntax highlighting for resource references and chain arrows
2126
- ([GH-34](https://github.com/lingua-pupuli/puppet-editor-syntax/issues/34)) [puppet-editor-syntax-1.3.3](https://github.com/lingua-pupuli/puppet-editor-syntax/commit/2ecb3d4b44e7d8b413b91676f39ade0ae0c4b2b4) Comments in hashes should tokenize
2227

README.md

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,17 @@
55
[![Appveyor](https://ci.appveyor.com/api/projects/status/8ke8fhdt9a7j688m/branch/master?svg=true)](https://ci.appveyor.com/project/lingua-pupuli/puppet-vscode/branch/master)
66
[![Travis Ci](https://travis-ci.com/lingua-pupuli/puppet-vscode.svg?branch=master)](https://travis-ci.com/lingua-pupuli/puppet-vscode)
77

8+
# New Puppet VSCode [Website](https://puppet-vscode.github.io)
9+
10+
We are proud to announce the new Puppet VSCode website [https://puppet-vscode.github.io/](https://puppet-vscode.github.io/)! This website will contain all of the existing documenation in this README, simplified and organinzed. There will be new content coming soon that shows off all the current features in greater detail, as well as new ways to use the Puppet VSCode Extension with other technologies like the [Microsoft Remote Development Extension Pack](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack). This README will be modified to point to the website for most of this content, but will retain some quick information on how to get started.
11+
812
## Table of Contents
913

1014
- [Quick Start](#quick-start)
1115
- [Features](#features)
1216
- [Requirements](#requirements)
1317
- [Platform Support](#platform-support)
14-
- [Usage](#usage)
18+
- [Usage](#usage)
1519
- [Syntax highlighting](#syntax-highlighting)
1620
- [Auto completion](#auto-completion)
1721
- [Hover Support](#hover-support)
@@ -77,25 +81,25 @@ This extension provides full Puppet Language support for [Visual Studio Code](ht
7781

7882
## Supported Puppet Versions
7983

80-
The Puppet Extension for VSCode works with Puppet 4 or higher. Some features will be slower or not work on Puppet 4, and are noted in the section for that feature. See [open source Puppet](https://puppet.com/docs/puppet/5.5/about_agent.html) and [Puppet Enterprise](https://puppet.com/docs/pe/2017.3/getting_support_for_pe.html#supported-puppet-enterprise-versions) lifecycle pages for version support details.
84+
The Puppet Extension for VSCode works with Puppet 4 or higher. Some features will be slower or not work on Puppet 4, and are noted in the section for that feature. See [open source Puppet](https://puppet.com/docs/puppet/5.5/about_agent.html) and [Puppet Enterprise](https://puppet.com/docs/pe/2017.3/getting_support_for_pe.html#supported-puppet-enterprise-versions) lifecycle pages for version support details.
8185

8286
## Requirements
8387

84-
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.
88+
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.
8589

8690
> Note: PDK version 1.5.0 or higher is required.
8791
8892
You can find instructions and installation links here:
8993

9094
### PDK
9195

92-
* [Download page](https://puppet.com/download-puppet-development-kit)
96+
- [Download page](https://puppet.com/download-puppet-development-kit)
9397

9498
### Puppet-Agent
9599

96-
* [Windows](https://docs.puppet.com/puppet/latest/install_windows.html)
97-
* [MacOSX](https://docs.puppet.com/puppet/latest/install_osx.html)
98-
* [Linux](https://docs.puppet.com/puppet/latest/install_linux.html)
100+
- [Windows](https://docs.puppet.com/puppet/latest/install_windows.html)
101+
- [MacOSX](https://docs.puppet.com/puppet/latest/install_osx.html)
102+
- [Linux](https://docs.puppet.com/puppet/latest/install_linux.html)
99103

100104
## Platform support
101105

@@ -111,7 +115,6 @@ The Puppet extension includes additional information in the form of a tooltip wh
111115

112116
![loading_status](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/loading_status.gif)
113117

114-
115118
### Syntax Highlighting
116119

117120
Syntax highlighting recognizes all versions of Puppet and displays as you type.
@@ -136,7 +139,7 @@ Hovering over any resource, class declaration or other Puppet symbol provides in
136139

137140
### Outline View
138141

139-
The new `Outline View` shows the symbol tree of the currently selected Puppet manifest.
142+
The new `Outline View` shows the symbol tree of the currently selected Puppet manifest.
140143

141144
Supported symbols:
142145

@@ -277,14 +280,13 @@ We have added support for VSCode Command Palatte commands for opening Bolt user
277280

278281
The Puppet extension is able to debug the compilation of a Puppet manifest; much like the Go, PowerShell, and C# languages. The debugger supports:
279282

280-
* Line breakpoints but not conditions on those breakpoints
281-
* Function breakpoints
282-
* Exception breakpoints
283-
* Call stack
284-
* Variables, but only at the top stack frame
285-
* Limited interactive debug console. For example, you can assign a variable a value, but just as in regular Puppet you can't change its value later
286-
* Step In, Out, and Over
287-
283+
- Line breakpoints but not conditions on those breakpoints
284+
- Function breakpoints
285+
- Exception breakpoints
286+
- Call stack
287+
- Variables, but only at the top stack frame
288+
- Limited interactive debug console. For example, you can assign a variable a value, but just as in regular Puppet you can't change its value later
289+
- Step In, Out, and Over
288290

289291
![Puppet Debug Adapter](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/puppet_debug.gif)
290292

@@ -298,9 +300,9 @@ The [VSCode Debugging - Launch Configurations](https://code.visualstudio.com/doc
298300

299301
#### Settings
300302

301-
- `manifest` - The manifest to apply. By default this is the currently open file in the editor
303+
- `manifest` - The manifest to apply. By default this is the currently open file in the editor
302304

303-
- `noop` - Whether the `puppet apply` sets No Operation (Noop) mode. By default, this is set to true. This means when running the debugger it will not make changes to your system. The [documentation about the puppet agent](https://puppet.com/docs/puppet/5.3/man/apply.html#OPTIONS) has more information about `puppet apply` and and the `noop` option.
305+
- `noop` - Whether the `puppet apply` sets No Operation (Noop) mode. By default, this is set to true. This means when running the debugger it will not make changes to your system. The [documentation about the puppet agent](https://puppet.com/docs/puppet/5.3/man/apply.html#OPTIONS) has more information about `puppet apply` and and the `noop` option.
304306

305307
- `args` - Additional arguements to pass to `puppet apply`, for example `['--debug']` will output debug information
306308

@@ -314,8 +316,8 @@ Enable using docker by adding the following configuration:
314316

315317
```json
316318
{
317-
"puppet.editorService.protocol":"docker",
318-
"puppet.editorService.docker.imageName":"linguapupuli/puppet-language-server:latest"
319+
"puppet.editorService.protocol": "docker",
320+
"puppet.editorService.docker.imageName": "linguapupuli/puppet-language-server:latest"
319321
}
320322
```
321323

@@ -350,7 +352,7 @@ To ensure that the extension uses the `PDK`, set the `puppet.installType` settin
350352

351353
```json
352354
{
353-
"puppet.installType":"pdk"
355+
"puppet.installType": "pdk"
354356
}
355357
```
356358

@@ -360,45 +362,45 @@ Windows:
360362

361363
```json
362364
{
363-
"puppet.installDirectory":"C:\\Program Files\\Puppet Labs\\DevelopmentKit"
365+
"puppet.installDirectory": "C:\\Program Files\\Puppet Labs\\DevelopmentKit"
364366
}
365367
```
366368

367369
OSX:
368370

369371
```json
370372
{
371-
"puppet.installDirectory":"/opt/puppetlabs/pdk"
373+
"puppet.installDirectory": "/opt/puppetlabs/pdk"
372374
}
373375
```
374376

375377
Linux:
376378

377379
```json
378380
{
379-
"puppet.installDirectory":"/opt/puppetlabs/pdk"
381+
"puppet.installDirectory": "/opt/puppetlabs/pdk"
380382
}
381383
```
382384

383385
To use a custom install path for the `PDK`, set the `puppet.installDirectory` setting to the path you installed the `PDK` to:
384386

385387
```json
386388
{
387-
"puppet.installDirectory":"D:/programs/pdk"
389+
"puppet.installDirectory": "D:/programs/pdk"
388390
}
389391
```
390392

391-
#### Configure Puppet Version in PDK
393+
#### Configure Puppet Version in PDK
392394

393395
The `PDK` has many versions of Puppet which can be used. Set the `puppet.editorService.puppet.version` setting to the version you would like to use, for example, if you wanted to use version 5.4.0, then set the configuration to:
394396

395397
```json
396398
{
397-
"puppet.editorService.puppet.version":"5.4.0"
399+
"puppet.editorService.puppet.version": "5.4.0"
398400
}
399401
```
400402

401-
You can also change the version from the status bar in Visual Studio Code. Click on the Puppet version text in the status bar and then select which Puppet version you would like to use. Note that this will require Visual Studio Code to be restarted to take effect.
403+
You can also change the version from the status bar in Visual Studio Code. Click on the Puppet version text in the status bar and then select which Puppet version you would like to use. Note that this will require Visual Studio Code to be restarted to take effect.
402404

403405
![changing_puppet_version](https://raw.githubusercontent.com/lingua-pupuli/puppet-vscode/master/docs/assets/change-puppet-version.gif)
404406

@@ -408,7 +410,7 @@ To ensure that the extension uses the Puppet-Agent, set the `puppet.installType`
408410

409411
```json
410412
{
411-
"puppet.installType":"puppet"
413+
"puppet.installType": "puppet"
412414
}
413415
```
414416

@@ -418,31 +420,31 @@ Windows:
418420

419421
```json
420422
{
421-
"puppet.installDirectory":"C:\\Program Files\\Puppet Labs\\Puppet",
423+
"puppet.installDirectory": "C:\\Program Files\\Puppet Labs\\Puppet"
422424
}
423425
```
424426

425427
OSX
426428

427429
```json
428430
{
429-
"puppet.installDirectory":"/opt/puppetlabs"
431+
"puppet.installDirectory": "/opt/puppetlabs"
430432
}
431433
```
432434

433435
Linux:
434436

435437
```json
436438
{
437-
"puppet.installDirectory":"/opt/puppetlabs"
439+
"puppet.installDirectory": "/opt/puppetlabs"
438440
}
439441
```
440442

441443
To use a custom install path for the Puppet-Agent, set the `puppet.installDirectory` setting to the path you installed the Puppet-Agent to:
442444

443445
```json
444446
{
445-
"puppet.installDirectory":"D:/programs/puppet"
447+
"puppet.installDirectory": "D:/programs/puppet"
446448
}
447449
```
448450

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "puppet-vscode",
33
"displayName": "Puppet",
44
"description": "Official Puppet VSCode extension. Provides full Puppet DSL intellisense, syntax highlighting, Puppet command support, Puppet node graphs, and much more",
5-
"version": "0.19.0",
5+
"version": "0.20.0",
66
"publisher": "jpogran",
77
"license": "SEE LICENSE IN LICENSE.txt",
88
"icon": "images/Puppet-Logo-Amber-sm.png",

0 commit comments

Comments
 (0)