Skip to content

Commit

Permalink
enhanced readme. fixes #11
Browse files Browse the repository at this point in the history
Signed-off-by: Christian Dietrich <[email protected]>
  • Loading branch information
cdietrich committed Oct 20, 2016
1 parent 782a40a commit dd48fbe
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 5 deletions.
8 changes: 4 additions & 4 deletions demo/a.mydsl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Hello A!
Hello B from A!
Hello name
from Other!
Hello Xtext!
Hello VSCode from Xtext!
Hello ThisFile from Other!
Hello you!
1 change: 1 addition & 0 deletions demo/b.mydsl
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/* this is a definition in another file */
Hello Other!
39 changes: 38 additions & 1 deletion vscode-extension-self-contained/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,40 @@
# Xtext VS Code example

This is a simple example showing the Xtext integration for VS Code based on the Microsoft Language Server Protocol. It allows you to edit `*.mydsl` files inside an opened folder.
This is a simple example showing the [Xtext](https://www.eclipse.org/Xtext/) integration for VS Code based on the Microsoft [Language Server Protocol](https://github.com/Microsoft/language-server-protocol).

The base is following simple grammar

```
Model:
greetings+=Greeting*;
Greeting:
'Hello' name=ID ('from' from=[Greeting])? '!';
```

A typical example model would look like (Open a new folder in VSCode and create the files)

a.mydsl
```
Hello Xtext!
Hello VSCode from Xtext!
Hello ThisFile from Other!
Hello you!
```

b.mydsl
```
/* this is a definition in another file */
Hello Other!
```

The Xtext integration supports typical Xtext and Language Server features like

* Syntax Highlighting
* Validation
* Cross References
* Tooltips
* Formatter
* Mark Occurrences

A introductory article can be found [here](https://blogs.itemis.com/en/integrating-xtext-language-support-in-visual-studio-code)

0 comments on commit dd48fbe

Please sign in to comment.