Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

Added config files for debugging and compiling. Slight change to README #9

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
12 changes: 0 additions & 12 deletions VSCode-Extensions/.gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,4 @@

.vscode/

*.vsix

out/

node_modules/

kuksa/kuksa.yaml

kuksa/temp.txt

Dockerfile

package-lock.json
36 changes: 36 additions & 0 deletions VSCode-Extensions/.vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// A launch configuration that compiles the extension and then opens it inside a new window
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.

{
"version": "0.2.0",
"configurations": [
{
"name": "Run Extension",
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}"
],
"outFiles": [
"${workspaceFolder}/out/**/*.js"
],
"preLaunchTask": "npm: watch"
},
{
"name": "Extension Tests",
"type": "extensionHost",
"request": "launch",
"runtimeExecutable": "${execPath}",
"args": [
"--extensionDevelopmentPath=${workspaceFolder}",
"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
],
"outFiles": [
"${workspaceFolder}/out/test/**/*.js"
],
"preLaunchTask": "npm: watch"
}
]
}
19 changes: 19 additions & 0 deletions VSCode-Extensions/.vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

{
"version": "2.0.0",
"tasks": [
{
"type": "npm",
"script": "watch",
"problemMatcher": "$tsc-watch",
"isBackground": true,
"presentation": {
"reveal": "never"
},
"group": {
"kind": "build",
"isDefault": true
}
}
]
}
22 changes: 10 additions & 12 deletions VSCode-Extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Therefore, a build script allows to generate target-specific docker images.
Based on a generated .yaml config file and a Python-based script, the resulting docker images can then be published to the app store and hawkbit respectively.
This process is depicted in the following image:

![](images/kuksa_ide.png)
![](https://github.com/eclipse/kuksa.ide/blob/master/VSCode-Extensions/images/kuksa_ide.png)

## Architecture

Expand Down Expand Up @@ -70,12 +70,17 @@ In this way, changes to the IDE can be be done.
2. Open a new terminal (Menu bar / Ctrl+Shift+Ö / cmd+shift+P on MAC) in Visual Studio Code
3. Install prerequisite:
* "npm install"
* "npm install vsce" (optional, depends on the system configuration)
* "npm install vsce"
* Install .vsix extensions from https://marketplace.visualstudio.com/items?itemName=fabiospampinato.vscode-install-vsix
4. Run "vsce package". A "xxx.vsix" file should be generated
4. Run "vsce package". A "xxx.vsix" file should be generated ( in-case of any errors delete the node_modules directory and install vsce again)
5. Run "Extensions:Install from VSIX" and select the accoring .vsix file
6. Reload VSCode

### Development Flow

1. Press `F5` from the Editor.
2. An Extension Development Window will open which enables to test Kuksa Extensions in real time.

### Using Kuksa IDE

Open the command palette (View -> Command Palette / Ctrl+Shift+P) and search for "kuksa"
Expand All @@ -85,7 +90,7 @@ Open the command palette (View -> Command Palette / Ctrl+Shift+P) and search for
1. Provide folder/workspace name
2. Project tree will be generated as follows:

![](images/tree.png)
![](https://github.com/eclipse/kuksa.ide/blob/master/VSCode-Extensions/images/tree.png)

*The project folder will be created inside the folder VSCode was open (by default the $HOME directory)*

Expand All @@ -101,7 +106,7 @@ Open the command palette (View -> Command Palette / Ctrl+Shift+P) and search for
1. Open a Kuksa project in VSCode.
2. Run command and provide the details:

![](images/yaml_form.png)
![](https://github.com/eclipse/kuksa.ide/blob/master/VSCode-Extensions/images/yaml_form.png)


3. Check if kuksa.yaml file is populated.
Expand All @@ -126,10 +131,3 @@ In OSX, if you are running into `bash: code: command not found` please open the
2. Generate YAML config file through form
3. Generate Docker image
4. Push docker image (.tar) through app-publisher

## Work in progress

1. File system not compatible with online IDE (gitpod)
2. Custom Gitpod repo for Kuksa
3. Verification and validation in Kuksa forms
4. Error Handling