diff --git a/.gitignore b/.gitignore index fa42e18c..82ce78fa 100644 --- a/.gitignore +++ b/.gitignore @@ -9,4 +9,4 @@ out/ node_modules/ xtext-server/ package-lock.json - +*.vsix diff --git a/README.md b/README.md index 358cd116..0e099433 100644 --- a/README.md +++ b/README.md @@ -38,9 +38,10 @@ Run the tests (in `org.metafacture.fix/src/test/java`) and checks (`.editorconfi ## Extension -The project `org.metafacture.fix.vsc` provides an extension for Visual Studio Code for `fix` via the language server protocol (LSP). In the current state the extension supports auto completion, simple syntax highlighting and auto closing brackets and quotes. This project was created using this [tutorial](https://www.typefox.io/blog/building-a-vs-code-extension-with-xtext-and-the-language-server-protocol) and the corresponding [example](https://github.com/TypeFox/languageserver-example). +The project `org.metafacture.fix.vsc` provides an extension for Visual Studio Code / Codium for `fix` via the language server protocol (LSP). In the current state the extension supports auto completion, simple syntax highlighting and auto closing brackets and quotes. This project was created using this [tutorial](https://www.typefox.io/blog/building-a-vs-code-extension-with-xtext-and-the-language-server-protocol) and the corresponding [example](https://github.com/TypeFox/languageserver-example). -Start extension (in development mode, starting a second code/codium instance): + +Build extension: 1. Install Visual Studio Code / alternative: VS Codium 2. Install Node.js (including npm) @@ -49,9 +50,23 @@ Unix: `./gradlew installServer` Windows: `.\gradlew.bat installServer` 4. In org.metafacture.fix.vsc execute (tip: if you use windows, install cygwin to execute npm commands): `npm install` -5. Open org.metafacture.fix.vsc in Visual Studio Code -6. Launch vscode extension by pressing F5 (opens new window of Visual Studio Code) -7. Open new file (file-ending .fix) or open existing fix-file (see sample below) + +To start the extension in development mode (starting a second code/codium instance), follow A. To create an vsix file to install the extension permanently follow B. + +A) Run in dev mode: +1. Open org.metafacture.fix.vsc in Visual Studio Code / Codium +2. Launch vscode extension by pressing F5 (opens new window of Visual Studio Code) +3. Open new file (file-ending .fix) or open existing fix-file (see sample below) + +B) Install vsix file: +1. Install vsce: `npm install -g vsce` +2. In org.metafacture.fix.vsc execute: `vsce package` +vsce will create a vsix file in the vsc directory which can be used for installation: +3. Open VS Code / Codium +4. Click 'Extensions' section +5. Click menu bar and choose 'Install from VSIX...' + + ## Web Server diff --git a/build.gradle b/build.gradle index 1c17a8c7..01db0c04 100644 --- a/build.gradle +++ b/build.gradle @@ -11,7 +11,8 @@ editorconfig { '**/.*', 'gradlew*', '**/out', - '**/node_modules' + '**/node_modules', + '**/*.vsix' ] } diff --git a/org.metafacture.fix.vsc/package.json b/org.metafacture.fix.vsc/package.json index 8f4e7958..e6c5adcf 100644 --- a/org.metafacture.fix.vsc/package.json +++ b/org.metafacture.fix.vsc/package.json @@ -1,9 +1,9 @@ { "name": "fix", "displayName": "fix", - "description": "Fix Language Support (Xtext Language Server for Fix)", + "description": "Language Support for Metafacture Fix (Xtext Language Server for Metafacture Fix). For more information, visit https://metafacture.org", "version": "0.0.1", - "publisher": "katauber", + "publisher": "metafacture", "engines": { "vscode": "^1.18.0" }, @@ -47,5 +47,9 @@ }, "dependencies": { "vscode-languageclient": "^3.0.3" + }, + "repository": { + "type": "git", + "url": "https://github.com/metafacture/metafacture-fix.git" } }