Skip to content

Commit f0fb2ed

Browse files
jpogranjpogran
authored
Merge pull request #87 from jpogran/update-branding
Update Branding
2 parents fff05bc + 545223a commit f0fb2ed

File tree

3 files changed

+84
-56
lines changed

3 files changed

+84
-56
lines changed

‎client/README.md

+38-26
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
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

11-
This extension provides Puppet Language support for [Visual Studio Code](https://code.visualstudio.com/)
9+
This extension provides Puppet Language support for [Visual Studio Code](https://code.visualstudio.com/).
10+
11+
**It is currently in technical preview, so that we can gather bug reports and find out what new features to add.**
1212

1313
## Platform support
1414

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

26+
2627
![Example of features](docs/assets/language_server.gif)
2728

2829
## Requirements
2930

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)
31+
You will need to have Puppet Agent installed in order to fully use this extension. You can find installation links here:
3532

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

3837
## Feature information
3938

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

4948
As part of IntelliSense and Snippets, you can quickly create blocks of code
5049

50+
### Linting
51+
52+
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.
53+
5154
### Puppet Resource
5255

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

6972
The node graph will appear next to the manifest
7073

74+
## Installing the Extension
7175

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

78-
## Known Issues
81+
## Reporting Problems
7982

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

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

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

86-
### 0.0.3
91+
### 2. Capture verbose logs and send them to us
8792

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

90-
### 0.0.2
96+
```json
97+
"puppet.languageserver.debugFilePath": "C:\\Some\\file\\path.txt"
98+
```
9199

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

94-
### 0.0.1
102+
## Maintainers
95103

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

108+
## License
98109

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

‎client/gulpfile.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ var exec = require('child_process').exec;
66
var bump = require('gulp-bump');
77
var args = require('yargs').argv;
88

9-
// The default task (called when you run `gulp` from cli)
9+
// The default task (called when you run `gulp` from cli)
1010
gulp.task('default', ['build']);
1111

1212
gulp.task('clean', function () {
@@ -22,7 +22,7 @@ gulp.task('copy_language_server', function () {
2222
})
2323

2424
gulp.task('build_extension', function (callback) {
25-
exec('node ./node_modules/vsce/out/vsce package',
25+
exec('node ./node_modules/vsce/out/vsce package --baseContentUrl https://github.com/jpogran/puppet-vscode/client --baseImagesUrl https://github.com/jpogran/puppet-vscode/client',
2626
function (err, stdout, stderr) {
2727
console.log(stdout);
2828
console.log(stderr);
@@ -41,9 +41,9 @@ gulp.task('bump', function () {
4141
/// Usage:
4242
/// 1. gulp bump : bumps the package.json and bower.json to the next minor revision.
4343
/// i.e. from 0.1.1 to 0.1.2
44-
/// 2. gulp bump --version 1.1.1 : bumps/sets the package.json and bower.json to the
44+
/// 2. gulp bump --version 1.1.1 : bumps/sets the package.json and bower.json to the
4545
/// specified revision.
46-
/// 3. gulp bump --type major : bumps 1.0.0
46+
/// 3. gulp bump --type major : bumps 1.0.0
4747
/// gulp bump --type minor : bumps 0.1.0
4848
/// gulp bump --type patch : bumps 0.0.2
4949
/// gulp bump --type prerelease : bumps 0.0.1-2

‎client/package.json

+42-26
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,20 @@
22
"name": "puppet-vscode",
33
"displayName": "Puppet",
44
"description": "Puppet VSCode extension",
5-
"version": "0.0.4",
6-
"publisher": "puppet",
7-
"license": "Apache-2.0",
8-
"icon":"images/Puppet-Logo-Amber-sm.png",
9-
"repository":{
5+
"version": "0.4.0",
6+
"publisher": "jpogran",
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
},
@@ -126,13 +142,13 @@
126142
"vsce": "^1.18.0",
127143
"gulp": "^3.9.1",
128144
"gulp-bump": "^2.7.0",
129-
"yargs":"^8.0.1",
145+
"yargs": "^8.0.1",
130146
"del": "^2.2.2",
131-
"run-sequence":"^1.2.2",
147+
"run-sequence": "^1.2.2",
132148
"@types/node": "^6.0.40",
133149
"@types/mocha": "^2.2.32"
134150
},
135151
"dependencies": {
136152
"vscode-languageclient": "^3.1.0"
137153
}
138-
}
154+
}

0 commit comments

Comments
 (0)