native desktop plugin (#19)

Co-authored-by: PZahnen <pascal.zahnen@gmx.de>

Author: azahnen

.npmrc

@@ -0,0 +1 @@
+@xtracfg:registry=https://dl.interactive-instruments.de/repository/npm/

.vscode/launch.json

@@ -5,18 +5,26 @@
 {
   "version": "0.2.0",
   "configurations": [
+    {
+      "name": "Run Native Extension",
+      "type": "extensionHost",
+      "request": "launch",
+      "args": ["--extensionDevelopmentPath=${workspaceFolder}", "${workspaceFolder}/data"],
+      "outFiles": ["${workspaceFolder}/dist/dev/*.js"],
+      "preLaunchTask": "prelaunch:native"
+    },
     {
       "name": "Run Web Extension ",
-      "type": "pwa-extensionHost",
+      "type": "extensionHost",
       "debugWebWorkerHost": true,
       "request": "launch",
       "args": [
         "--extensionDevelopmentPath=${workspaceFolder}",
         "--extensionDevelopmentKind=web",
         "${workspaceFolder}/data"
       ],
-      "outFiles": ["${workspaceFolder}/dist/*.js"],
-      "preLaunchTask": "${defaultBuildTask}",
+      "outFiles": ["${workspaceFolder}/dist/dev/*.js"],
+      "preLaunchTask": "prelaunch:web",
       "resolveSourceMapLocations": ["${workspaceFolder}/**", "!**/node_modules/**"]
     },
     {

.vscode/tasks.json

@@ -4,17 +4,27 @@
   "version": "2.0.0",
   "tasks": [
     {
+      "label": "prelaunch:native",
       "type": "npm",
-      "script": "build:all",
+      "script": "prelaunch:native",
       "group": {
         "kind": "build",
         "isDefault": true
       },
       "problemMatcher": []
     },
     {
+      "label": "prelaunch:web",
       "type": "npm",
-      "script": "watch-web",
+      "script": "prelaunch:web",
+      "group": {
+        "kind": "build"
+      },
+      "problemMatcher": []
+    },
+    {
+      "type": "npm",
+      "script": "watch:web",
       "group": "build",
       "isBackground": true,
       "problemMatcher": "$tsc-watch"

.vscodeignore

@@ -0,0 +1,37 @@
+when:
+  event: [push, tag]
+
+matrix:
+  PLATFORM:
+    - darwin-arm64
+    - linux-arm64
+    - linux-x64
+
+steps:
+  native:
+    image: node:20-alpine
+    environment:
+      VSIX_PLATFORM: ${PLATFORM}
+    commands:
+      - npm run install:all
+      - npm run package:native
+
+  nexus:
+    image: rockdrilla/woodpecker-sonatype-nexus
+    secrets:
+      - nexus_auth_b64
+    environment:
+      #NEXUS_URL: https://dl.interactive-instruments.de
+      #NEXUS_AUTH_BASE64 is stored as CI variable
+      NEXUS_REPOSITORY: ldproxy
+      NEXUS_PATHS: "dist/vsix/*.vsix"
+      NEXUS_PROPERTIES: "directory=/editor/${CI_COMMIT_TAG:-next}/"
+    settings:
+      nexus_url: https://dl.interactive-instruments.de
+      auth_base64:
+        from_secret: nexus_auth_b64
+  #      upload: '[{"repository": "ldproxy", "paths": ["dist/vsix/*.vsix"], "directory": "/editor/"}]'
+  #        - repository: ldproxy
+  #          paths:
+  #            - dist/vsix/*.vsix
+  #          directory: /editor/

.woodpecker/build.yml

@@ -0,0 +1,9 @@
+when:
+  event: push
+
+steps:
+  test:
+    image: node:20-alpine
+    commands:
+      - npm run install:all
+      - npm test

.woodpecker/check.yml

@@ -1,7 +1,28 @@
 when:
   event: tag
 
-pipeline:
+depends_on:
+  - build
+
+steps:
+  download:
+    image: alpine/curl
+    commands:
+      - mkdir -p dist/vsix
+      - curl -O --output-dir dist/vsix https://dl.interactive-instruments.de/repository/ldproxy/editor/${CI_COMMIT_TAG}/ldproxy-editor-darwin-arm64-${CI_COMMIT_TAG##v}.vsix
+      - curl -O --output-dir dist/vsix https://dl.interactive-instruments.de/repository/ldproxy/editor/${CI_COMMIT_TAG}/ldproxy-editor-linux-arm64-${CI_COMMIT_TAG##v}.vsix
+      - curl -O --output-dir dist/vsix https://dl.interactive-instruments.de/repository/ldproxy/editor/${CI_COMMIT_TAG}/ldproxy-editor-linux-x64-${CI_COMMIT_TAG##v}.vsix
+      - ls -la dist/vsix
+
+  publish:
+    image: node:20-alpine
+    environment:
+      VSCE_PAT:
+        from_secret: vscode_marketplace_token
+    commands:
+      - npm ci --ignore-scripts
+      - npm run publish
+
   docker:
     image: woodpeckerci/plugin-docker-buildx
     # TODO: see https://codeberg.org/woodpecker-plugins/docker-buildx/issues/50

.woodpecker/release.yml

@@ -1,7 +1,7 @@
 when:
   event: push
 
-pipeline:
+steps:
   docker:
     image: woodpeckerci/plugin-docker-buildx
     # TODO: see https://codeberg.org/woodpecker-plugins/docker-buildx/issues/50

.woodpecker/snapshot.yml

@@ -1,15 +1,15 @@
 FROM node:20-alpine as extension
 
 COPY . /src/
-RUN cd /src && npm run install:all && npm test && npm run package
+RUN cd /src && npm run install:all && npm test && npm run package:web
 
 
-FROM ghcr.io/ldproxy/xtracfg:maintenance-v3-528524f4 as xtracfg
+FROM ghcr.io/ldproxy/xtracfg:4.2.0 as xtracfg
 
 
 FROM codercom/code-server:latest
 
-COPY --chmod=0644 --from=extension /src/dist/ldproxy-editor.vsix /
+COPY --chmod=0644 --from=extension /src/dist/vsix/ldproxy-editor-web-*.vsix /ldproxy-editor.vsix
 COPY --chmod=0755 --from=extension /src/startup.sh /entrypoint.d/
 COPY --chmod=0755 --from=xtracfg /xtracfg /usr/bin/
 

Dockerfile

@@ -1,46 +1,67 @@
-# Editor
+# ldproxy for VS Code
 
 A [VS Code](https://code.visualstudio.com) extension that supports you in creating and updating [ldproxy](https://docs.ldproxy.net) configurations.
 
 ## Current state
 
-The first stable release (`v1.0.0`) is available.
-
-### Distribution
-
-Currently the only way to use the extension is the provided docker image that contains an open source version of VS Code for the Web.
+- The current stable release is `v1.1.0`.
+- It is available as a pre-release on the VS Code Marketplace (currently only for macOS and Linux).
+- It can be used as a web application with the docker image that contains an open source version of VS Code for the Web.
 
 ### Features
 
 - Command `Create new entities`: provides a graphical wizard to automatically generate provider and service configurations from data sources.
-- IntelliSense: shows available properties in YAML configuration files.
+- Command `Create new values`: provides a graphical wizard to automatically generate value configurations, currently only MapLibre styles.
+- IntelliSense: autocompletion, shows available properties in YAML configuration files.
 - Syntax checks: detects unknown or deprecated properties in YAML configuration files.
 - Tooltips: shows documentation for properties in YAML configuration files.
 
-## Outlook
+### Limitations
+
+- The extension is not yet available for Windows, only MacOS and Linux are supported for now.
+- The workspace root needs to be a ldproxy store directory for the extension to work properly. Parent directories that contain multiple store directories are not yet supported, and neither are multi-root workspaces.
+- Tile Providers cannot be generated yet.
 
-- `v1.1.0` automatically generate and edit MapLibre styles
-- `v2.0.0` general availability of the extension for VS Code Desktop (macOS, Windows, Linux)
+### Outlook
+
+- `v2.0.0` general availability of the extension for VS Code Desktop (macOS, Windows, Linux), no known limitations
 
 ## Installation
 
+### VS Code Desktop
+
+Open the extensions view from the activity bar and search for _ldproxy_, then install the extension _ldproxy for VS Code_. [This](https://marketplace.visualstudio.com/items?itemName=iide.ldproxy-editor) is a direct link to the extension on the VS Code Marketplace.
+
+When installed, you may open a ldproxy store directory in VS Code, for example by using `File -> Open Folder` or by calling `code` in a terminal. You can then start editing your files.
+
+### Docker
+
 The docker image is available at `ghcr.io/ldproxy/editor`. It expects the workspace to be mounted at `/data`. The application runs on port `80`.
 
-To start the editor with your ldproxy configuration directory in `/home/user/ldproxycfg` and access it at `http://localhost:8080`:
+To start the editor with your ldproxy configuration directory in `/path/to/ldproxy/cfg` and access it at `http://localhost:8080`:
 
 ```sh
-docker run -d -p 8080:80 -v /home/user/ldproxycfg:/data ghcr.io/ldproxy/editor
+docker run -d -p 8080:80 -v /path/to/ldproxy/cfg:/data ghcr.io/ldproxy/editor
 ```
 
+When you open the application at `http://localhost:8080` in the browser, you will see the mounted ldproxy configuration directory on the left. You can now start to edit your files.
+
 > [!NOTE]
 > Accessing the editor via `http` only works with `localhost`. If you want to setup an editor for remote access, you need a reverse proxy which provides `https`.
 
 ## Usage
 
-When you open the application at `http://localhost:8080` in the browser, you will see the mounted ldproxy configuration directory on the left. You can now start to edit your files.
+Unknown or deprecated properties will automatically be marked in open files. Hovering over a property will show the documentation.
 
 For general help, check the documentation for [VS Code](https://code.visualstudio.com/docs).
 
+### IntelliSense (autocompletion)
+
+To get a list of all available properties in a certain place in a YAML configuration file, you can press `Ctrl+Space`. (It is called `Trigger suggest` in the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette), which also shows the configured hotkey.)
+You can then use the cursor keys to navigate the suggestions and choose one with `Enter`. You might also start typing before or after triggering to narrow the suggestions.
+
+![](docs/screenshot2.png)
+
 ### Creating new entities
 
 When you open the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and start typing `ldproxy`, the command `ldproxy: Create new entities` should appear at the top. Upon selecting, the graphical wizard will open in a new tab.
@@ -50,11 +71,12 @@ It allows you to automatically generate provider and service configurations from
 > [!NOTE]
 > When trying to access a _PostgreSQL_ database on the same host where the docker container is runnning, you have to use `host.docker.internal` instead of `localhost`.
 
-![](screenshot.png)
+![](docs/screenshot.png)
 
-### IntelliSense (autocompletion)
+### Creating new values
 
-To get a list of all available properties in a certain place in a YAML configuration file, you can press `Ctrl+Space`. (It is called `Trigger suggest` in the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette), which also shows the configured hotkey.)
-You can then use the cursor keys to navigate the suggestions and choose one with `Enter`. You might also start typing before or after triggering to narrow the suggestions.
+When you open the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) and start typing `ldproxy`, the command `ldproxy: Create new values` should appear near the top. Upon selecting, the graphical wizard will open in a new tab.
+
+It currently only allows you to automatically generate a MapLibre style from a service configuration.
 
-![](screenshot2.png)
+![](docs/screenshot3.png)