Skip to content

Commit 4f5d015

Browse files
jpogranjpogran
committed
readme updates and package.json formatting
1 parent 2ca9344 commit 4f5d015

File tree

2 files changed

+75
-49
lines changed

2 files changed

+75
-49
lines changed

‎client/README.md‎

Lines changed: 35 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
<!--
2-
TODO: Need correct marketplace ID
1+
32
[![Version](https://vsmarketplacebadge.apphb.com/version/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
43
[![Installs](https://vsmarketplacebadge.apphb.com/installs-short/jpogran.Puppet.svg)](https://marketplace.visualstudio.com/items?itemName=jpogran.Puppet)
5-
-->
64

7-
![Puppet Logo](images/Puppet-Logo-Amber-sm.png)
5+
[![Build status](https://ci.appveyor.com/api/projects/status/kwt06e0lgs70us4c?svg=true)](https://ci.appveyor.com/project/jpogran/puppet-vscode) [![Build Status](https://travis-ci.org/jpogran/puppet-vscode.svg?branch=master)](https://travis-ci.org/jpogran/puppet-vscode)
86

97
# Puppet Language Support for Visual Studio Code
108

@@ -23,17 +21,16 @@ This extension provides Puppet Language support for [Visual Studio Code](https:/
2321
- Import from `puppet resource` directly into manifests
2422
- Node graph preview
2523

24+
2625
![Example of features](docs/assets/language_server.gif)
2726

2827
## Requirements
2928

30-
- Puppet Agent
31-
32-
[Windows](https://docs.puppet.com/puppet/4.10/install_windows.html)
33-
34-
[MacOSX](https://docs.puppet.com/puppet/4.10/install_osx.html)
29+
You will need to have Puppet Agent installed in order to fully use this extension. You can find installation links here:
3530

36-
[Linux](https://docs.puppet.com/puppet/4.10/install_linux.html)
31+
* [Windows](https://docs.puppet.com/puppet/4.10/install_windows.html)
32+
* [MacOSX](https://docs.puppet.com/puppet/4.10/install_osx.html)
33+
* [Linux](https://docs.puppet.com/puppet/4.10/install_linux.html)
3734

3835
## Feature information
3936

@@ -48,6 +45,10 @@ Syntax highlighting uses [puppet-lint](https://github.com/rodjek/puppet-lint) an
4845

4946
As part of IntelliSense and Snippets, you can quickly create blocks of code
5047

48+
### Linting
49+
50+
Our validation uses [puppet-lint](https://github.com/rodjek/puppet-lint) to validate the Pupept syntax in all open puppet files. Linting is automatically applied to the document as you edit, without having to save the file first.
51+
5152
### Puppet Resource
5253

5354
You can import existing resources directly using `puppet resource`
@@ -68,31 +69,40 @@ You can preview the [node graph](https://puppet.com/blog/visualize-your-infrastr
6869

6970
The node graph will appear next to the manifest
7071

72+
## Installing the Extension
7173

72-
## Extension Settings
73-
74-
Coming!
75-
76-
<!-- TODO -->
74+
You can install the official release of the Puppet extension by following the steps
75+
in the [Visual Studio Code documentation](https://code.visualstudio.com/docs/editor/extension-gallery).
76+
In the Extensions pane, search for "jpogran-puppet" extension and install it there. You will
77+
get notified automatically about any future extension updates!
7778

78-
## Known Issues
79+
## Reporting Problems
7980

80-
None yet.
81+
If you're having trouble with the PowerShell extension, please follow these instructions
82+
to file an issue on our GitHub repository:
8183

82-
## Release Notes
84+
### 1. File an issue on our [Issues Page](https://github.com/PowerShell/vscode-powershell/issues)
8385

84-
**Note** Not released yet. Work in Progress
86+
Make sure to fill in the information that is requested in the issue template as it
87+
will help us investigate the problem more quickly.
8588

86-
### 0.0.3
89+
### 2. Capture verbose logs and send them to us
8790

88-
Puppet Parser validate linter added
91+
If you're having an issue with crashing or other erratic behavior, add the following
92+
line to your User Settings in Visual Studio Code:
8993

90-
### 0.0.2
94+
```json
95+
"puppet.languageserver.debugFilePath": "C:\\Some\\file\\path.txt"
96+
```
9197

92-
Puppet Resource and Puppet Module commands.
98+
Restart Visual Studio Code and try to reproduce the problem, then examine the log. If the issue persists please open an issue.
9399

94-
### 0.0.1
100+
## Maintainers
95101

96-
Initial release of the puppet extension.
102+
- [James Pogran](https://github.com/jpogran) - [@ender2025](http://twitter.com/ender2025)
103+
- [Glenn Sarti](https://github.com/glennsarti) - [@glennsarti](http://twitter.com/glennsarti)
104+
- [Austin Blatt](https://github.com/austb)
97105

106+
## License
98107

108+
This extension is [licensed under the Apache-2.0 License](LICENSE.txt).

‎client/package.json‎

Lines changed: 40 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,18 @@
44
"description": "Puppet VSCode extension",
55
"version": "0.0.4",
66
"publisher": "puppet",
7-
"license": "Apache-2.0",
8-
"icon":"images/Puppet-Logo-Amber-sm.png",
9-
"repository":{
7+
"license": "SEE LICENSE IN LICENSE.txt",
8+
"icon": "images/Puppet-Logo-Amber-sm.png",
9+
"galleryBanner": {
10+
"color": "#000000",
11+
"theme": "dark"
12+
},
13+
"homepage": "https://github.com/jpogran/puppet-vscode",
14+
"repository": {
1015
"type": "git",
1116
"url": "https://github.com/jpogran/puppet-vscode"
1217
},
13-
"bugs":{
18+
"bugs": {
1419
"type": "git",
1520
"url": "https://github.com/jpogran/puppet-vscode/issues"
1621
},
@@ -31,17 +36,27 @@
3136
],
3237
"main": "./out/src/extension",
3338
"contributes": {
34-
"languages": [{
35-
"id": "puppet",
36-
"aliases": ["Puppet", "puppet"],
37-
"extensions": [".pp", ".epp"],
38-
"configuration": "./languages/puppet.configuration.json"
39-
}],
40-
"grammars": [{
41-
"language": "puppet",
42-
"scopeName": "source.puppet",
43-
"path": "./syntaxes/puppet.tmLanguage"
44-
}],
39+
"languages": [
40+
{
41+
"id": "puppet",
42+
"aliases": [
43+
"Puppet",
44+
"puppet"
45+
],
46+
"extensions": [
47+
".pp",
48+
".epp"
49+
],
50+
"configuration": "./languages/puppet.configuration.json"
51+
}
52+
],
53+
"grammars": [
54+
{
55+
"language": "puppet",
56+
"scopeName": "source.puppet",
57+
"path": "./syntaxes/puppet.tmLanguage"
58+
}
59+
],
4560
"snippets": [
4661
{
4762
"language": "puppet",
@@ -67,12 +82,13 @@
6782
],
6883
"configurationDefaults": {
6984
"files.encoding": "utf8",
70-
"files.associations":[
71-
".pp", ".epp"
85+
"files.associations": [
86+
".pp",
87+
".epp"
7288
],
73-
"[puppet]":{
89+
"[puppet]": {
7490
"editor.tabSize": 2,
75-
"editor.insertSpaces":true,
91+
"editor.insertSpaces": true,
7692
"files.insertFinalNewline": true
7793
}
7894
},
@@ -96,12 +112,12 @@
96112
"description": "The timeout to connect to the local Puppet Language Server"
97113
},
98114
"puppet.languageserver.preLoadPuppet": {
99-
"type":"boolean",
115+
"type": "boolean",
100116
"default": true,
101117
"description": "Initalize Puppet and Facter when local Puppet Language Server starts"
102118
},
103119
"puppet.languageserver.debugFilePath": {
104-
"type":"string",
120+
"type": "string",
105121
"default": "",
106122
"description": "Set the local Puppet Language Server to send debug information to a file"
107123
}
@@ -121,13 +137,13 @@
121137
"vsce": "^1.18.0",
122138
"gulp": "^3.9.1",
123139
"gulp-bump": "^2.7.0",
124-
"yargs":"^8.0.1",
140+
"yargs": "^8.0.1",
125141
"del": "^2.2.2",
126-
"run-sequence":"^1.2.2",
142+
"run-sequence": "^1.2.2",
127143
"@types/node": "^6.0.40",
128144
"@types/mocha": "^2.2.32"
129145
},
130146
"dependencies": {
131147
"vscode-languageclient": "^3.1.0"
132148
}
133-
}
149+
}

0 commit comments

Comments
 (0)