feat(developer): new Keyman Vancouver prototype

keymanapp/keyman#12456

.gitignore

@@ -0,0 +1,7 @@
+node_modules
+.browser_modules
+lib
+*.log
+*-app/*
+!*-app/package.json
+!*-app/resources

.node-version

@@ -0,0 +1 @@
+20

.vscode/launch.json

@@ -0,0 +1,64 @@
+{
+    // Use IntelliSense to learn about possible Node.js debug attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Start Browser Backend",
+            "program": "${workspaceRoot}/browser-app/src-gen/backend/main.js",
+            "args": [
+                "--loglevel=debug",
+                "--port=3000",
+                "--no-cluster",
+                "--plugins=local-dir:${workspaceRoot}/plugins",
+                "--hostname=0.0.0.0",
+                "--ignore-certificate-errors",
+            ],
+            "env": {
+                "NODE_ENV": "development"
+            },
+            "sourceMaps": true,
+            // "outFiles": [
+            //     "${workspaceRoot}/node_modules/@theia/*/lib/**/*.js",
+            //     "${workspaceRoot}/*/lib/**/*.js",
+            //     "${workspaceRoot}/browser-app/src-gen/**/*.js"
+            // ],
+            "smartStep": true,
+            "internalConsoleOptions": "openOnSessionStart",
+            "outputCapture": "std",
+            "runtimeExecutable": "/Users/srl295/.nvm/versions/node/v20.18.0/bin/node",
+            "autoAttachChildProcesses": true,
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Start Electron Backend",
+            "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron",
+            "windows": {
+                "runtimeExecutable": "${workspaceRoot}/node_modules/.bin/electron.cmd"
+            },
+            "program": "${workspaceRoot}/electron-app/src-gen/backend/electron-main.js",
+            "args": [
+                "--loglevel=debug",
+                "--hostname=localhost",
+                "--no-cluster"
+            ],
+            "env": {
+                "NODE_ENV": "development"
+            },
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceRoot}/electron-app/src-gen/backend/electron-main.js",
+                "${workspaceRoot}/electron-app/src-gen/backend/main.js",
+                "${workspaceRoot}/*/lib/**/*.js",
+                "${workspaceRoot}/node_modules/@theia/*/lib/**/*.js"
+            ],
+            "smartStep": true,
+            "internalConsoleOptions": "openOnSessionStart",
+            "outputCapture": "std"
+        }
+    ]
+}

.vscodeignore

@@ -0,0 +1 @@
+plugins/**

LICENSE.md

@@ -0,0 +1,31 @@
+# License
+
+Copyright (c) 2017-2024 SIL Global. All rights reserved.
+
+Licensed under the MIT License.
+
+[Keyman for Linux](./linux) is licensed under the MIT License apart from [ibus-kmfl](./linux/ibus-kmfl) which is licensed under the GNU General Public License as published by the Free Software Foundation; either [version 2](./linux/ibus-kmfl/COPYING) of the License, or (at your option) any later version.
+
+---
+
+The MIT License
+
+Copyright (c) 2017-2024 SIL Global
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,81 @@
+# keyman-vancouver
+
+A playground for Keyman Developer application.
+
+## Getting started
+
+Please install all necessary [prerequisites](https://github.com/eclipse-theia/theia/blob/master/doc/Developing.md#prerequisites).
+
+## Running the browser example
+
+    yarn build:browser
+    yarn start:browser
+
+*or:*
+
+    yarn build:browser
+    cd browser-app
+    yarn start
+
+*or:* launch `Start Browser Backend` configuration from VS code.
+
+Open http://localhost:3000 in the browser.
+
+## Running the Electron example
+
+    yarn build:electron
+    yarn start:electron
+
+*or:*
+
+    yarn build:electron
+    cd electron-app
+    yarn start
+
+*or:* launch `Start Electron Backend` configuration from VS code.
+
+
+## Packaging Electron
+
+    yarn package:electron
+
+## Developing with the browser example
+
+Start watching all packages, including `browser-app`, of your application with
+
+    yarn watch:browser
+
+*or* watch only specific packages with
+
+    cd keyman-vancouver
+    yarn watch
+
+and the browser example.
+
+    cd browser-app
+    yarn watch
+
+Run the example as [described above](#Running-the-browser-example)
+## Developing with the Electron example
+
+Start watching all packages, including `electron-app`, of your application with
+
+    yarn watch:electron
+
+*or* watch only specific packages with
+
+    cd keyman-vancouver
+    yarn watch
+
+and the Electron example.
+
+    cd electron-app
+    yarn watch
+
+Run the example as [described above](#Running-the-Electron-example)
+
+## License
+
+Copyright (c) SIL Global.
+
+Keyman is an open source project distributed under the [MIT license](LICENSE.md).

browser-app/package.json

@@ -0,0 +1,36 @@
+{
+  "private": true,
+  "name": "browser-app",
+  "version": "0.0.0",
+  "dependencies": {
+    "@keymanapp/vancouver-kpj-builder": "^0.0.1",
+    "@theia/core": "latest",
+    "@theia/editor": "latest",
+    "@theia/filesystem": "latest",
+    "@theia/getting-started": "latest",
+    "@theia/markers": "latest",
+    "@theia/messages": "latest",
+    "@theia/monaco": "latest",
+    "@theia/navigator": "latest",
+    "@theia/plugin-ext-vscode": "^1.54.0",
+    "@theia/preferences": "latest",
+    "@theia/process": "latest",
+    "@theia/task": "^1.54.0",
+    "@theia/terminal": "latest",
+    "@theia/workspace": "latest",
+    "keyman-vancouver": "0.0.0"
+  },
+  "devDependencies": {
+    "@theia/cli": "latest"
+  },
+  "scripts": {
+    "bundle": "npm run rebuild && theia build --mode development",
+    "rebuild": "theia rebuild:browser --cacheRoot ..",
+    "start": "theia start --plugins=local-dir:../plugins --hostname=0.0.0.0 --ignore-certificate-errors",
+    "watch": "npm run rebuild && theia build --watch --mode development"
+  },
+  "theia": {
+    "target": "browser"
+  },
+  "license": "MIT"
+}

electron-app/package.json

@@ -0,0 +1,54 @@
+{
+  "private": true,
+  "name": "keyman-vancouver-app",
+  "description": "Next Generation Keyman Developer App",
+  "author": "Steven R. Loomis <srl295@codehivetx.us>",
+  "license": "MIT",
+  "version": "0.0.0",
+  "main": "lib/backend/electron-main.js",
+  "dependencies": {
+    "@keymanapp/vancouver-kpj-builder": "^0.0.1",
+    "@theia/core": "latest",
+    "@theia/editor": "latest",
+    "@theia/electron": "latest",
+    "@theia/filesystem": "latest",
+    "@theia/getting-started": "latest",
+    "@theia/markers": "latest",
+    "@theia/messages": "latest",
+    "@theia/monaco": "latest",
+    "@theia/navigator": "latest",
+    "@theia/plugin-ext-vscode": "^1.54.0",
+    "@theia/preferences": "latest",
+    "@theia/process": "latest",
+    "@theia/task": "^1.54.0",
+    "@theia/terminal": "latest",
+    "@theia/workspace": "latest",
+    "keyman-vancouver": "0.0.0"
+  },
+  "devDependencies": {
+    "@theia/cli": "latest",
+    "electron": "30.1.2"
+  },
+  "scripts": {
+    "bundle": "npm run rebuild && theia build --mode development --plugins=local-dir:../plugins",
+    "rebuild": "theia rebuild:electron --cacheRoot .. --plugins=local-dir:../plugins",
+    "start": "theia start --plugins=local-dir:../plugins",
+    "watch": "npm run rebuild && theia build --watch --mode development",
+    "package": "npx electron-builder -c.mac.identity=null --publish never"
+  },
+  "theia": {
+    "target": "electron",
+    "frontend": {
+      "config": {
+        "applicationName": "Keyman Developer Vancouver",
+        "electron": {
+          "splashScreenOptions": {
+            "content": "resources/KeymanVancouverSplash.svg",
+            "height": 533,
+            "width": 752
+          }
+        }
+      }
+    }
+  }
+}

extensions/keyman-kpj/.gitignore

@@ -0,0 +1,5 @@
+out
+dist
+node_modules
+.vscode-test/
+*.vsix

extensions/keyman-kpj/.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+});

extensions/keyman-kpj/.vscode/extensions.json

@@ -0,0 +1,8 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"dbaeumer.vscode-eslint",
+		"ms-vscode.extension-test-runner"
+	]
+}

extensions/keyman-kpj/.vscode/launch.json

@@ -0,0 +1,23 @@
+// 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.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--disable-extensions",
+				"/Users/srl295/src/keymanapp/ldml_test"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		}
+	]
+}

extensions/keyman-kpj/.vscode/settings.json

@@ -0,0 +1,11 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+	"files.exclude": {
+		"out": false // set this to true to hide the "out" folder with the compiled JS files
+	},
+	"search.exclude": {
+		"out": true // set this to false to include "out" folder in search results
+	},
+	// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+	"typescript.tsc.autoDetect": "off"
+}

extensions/keyman-kpj/.vscode/tasks.json

@@ -0,0 +1,20 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "watch",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		}
+	]
+}

extensions/keyman-kpj/.vscodeignore

@@ -0,0 +1,11 @@
+.vscode/**
+.vscode-test/**
+src/**
+.gitignore
+.yarnrc
+vsc-extension-quickstart.md
+**/tsconfig.json
+**/eslint.config.mjs
+**/*.map
+**/*.ts
+**/.vscode-test.*