Spruce-up the readme of cf editor with some screenshots

This commit is contained in:
Kris De Volder
2016-12-19 11:03:16 -08:00
parent a6f3e2a564
commit d9bfa5763f
6 changed files with 68 additions and 59 deletions

View File

@@ -1,57 +1,30 @@
# VS Code Language Server for Cloudfoundry Manifest Files
# Cloud Foundry Manifest Editor for Visual Studio Code
A VSCode extension and Language Server providing support for
editing `manifest.yml` files, aka 'Cloudfoundry Deployment Manifest'.
This extension adds basic validation, content-assist and hover infos
while editing Cloud Foundry [Manifest](https://docs.cloudfoundry.org/devguide/deploy-apps/manifest.html) Files.
The manifest editor provides content assist and basic validation of
the manifest's structure as you type.
## Validation
# Developer notes
As you type the manifest is parsed and checked for basic syntactic and structural correctness. Hover over
an error marker to see an explanation.
## Bulding and Running
![Linting Screenshot](https://github.com/spring-projects/sts4/raw/master/vscode-extensions/vscode-manifest-yaml/readme-imgs/linting.png)
This project consists of three pieces:
## Content assist
- a vscode-extension which is a language-server client implemented in TypeScript.
- commons-vscode: a local npm module with some utilities implemented in TypeScript.
- a language server implemented in Java.
Having trouble remembering all the names of the attributesm, and their spelling? Content assist to the
rescue:
To build all these pieces you normally only need to run:
![Content Assist Screenshot](https://github.com/spring-projects/sts4/raw/master/vscode-extensions/vscode-manifest-yaml/readme-imgs/content-assist.png)
npm install
## Documentation Hovers
**However, the first time you build** it might fail trying to
find the `commons-vscode` module on npm central. Once we publish a stable
version of that module on npm central that will no longer be a problem.
Until that time, you can work around this by doing a one time manual
run of the `preinstall` script prior to running `npm install`:
Having trouble remembering exactly what the meaning of each attribute is? Hover over any attribute and
read its detailed documentation.
./scripts/preinstall.sh
npm install
![Hover Docs Screenshot](https://github.com/spring-projects/sts4/raw/master/vscode-extensions/vscode-manifest-yaml/readme-imgs/hovers.png)
Now you can open the client-app in vscode. From the root of this project.
## Activation
code .
To launch the language server in a vscode runtime, press F5.
## Debugging
To debug the language server, open `lib/Main.ts` and edit to set the
`DEBUG` option to `true`. When you laucnh the app next by pressing
`F5` it will launch with debug options being passed to the JVM.
You can then connect a 'Remote Java' Eclipse debugger on port 8000.
## Packaging as a vscode extension
First make sure the stuff is all built locally:
./scripts/preinstall.sh # only needed if this is the first build.
npm install
Then package it:
npm run vsce-package
This produces a `.vsix` file which you can install directly into vscode.
The CF manifest editor automatically activates when the name of the `.yml` file you are editing,
matches the glob pattern: `manifest*.yml`.

View File

@@ -0,0 +1,49 @@
# Developer notes
## Bulding and Running
This project consists of three pieces:
- a vscode-extension which is a language-server client implemented in TypeScript.
- commons-vscode: a local npm module with some utilities implemented in TypeScript.
- a language server implemented in Java.
To build all these pieces you normally only need to run:
npm install
**However, the first time you build** it might fail trying to
find the `commons-vscode` module on npm central. Once we publish a stable
version of that module on npm central that will no longer be a problem.
Until that time, you can work around this by doing a one time manual
run of the `preinstall` script prior to running `npm install`:
./scripts/preinstall.sh
npm install
Now you can open the client-app in vscode. From the root of this project.
code .
To launch the language server in a vscode runtime, press F5.
## Debugging
To debug the language server, open `lib/Main.ts` and edit to set the
`DEBUG` option to `true`. When you laucnh the app next by pressing
`F5` it will launch with debug options being passed to the JVM.
You can then connect a 'Remote Java' Eclipse debugger on port 8000.
## Packaging as a vscode extension
First make sure the stuff is all built locally:
./scripts/preinstall.sh # only needed if this is the first build.
npm install
Then package it:
npm run vsce-package
This produces a `.vsix` file which you can install directly into vscode.

View File

@@ -1,7 +1,7 @@
{
"name": "vscode-manifest-yaml",
"displayName": "Cloudfoundry Manifest YML Support",
"description": "Provides validation and content assist for Cloudfoundry manifest.yml files",
"description": "Adds linting, content assist and hoverinfo's for Cloudfoundry Deployment Manifests (a.k.a. `manifest.yml` files.",
"icon": "icon.png",
"version": "0.0.1",
"publisher": "Pivotal",
@@ -27,19 +27,6 @@
"onLanguage:yaml"
],
"main": "./out/lib/Main",
"contributes": {
"configuration": {
"type": "object",
"title": "Example configuration",
"properties": {
"languageServerExample.maxNumberOfProblems": {
"type": "number",
"default": 100,
"description": "Controls the maximum number of problems produced by the server."
}
}
}
},
"preview": true,
"scripts": {
"prepublish": "tsc -p .",

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB