@empire-builder-kit/desktop 0.0.1-alpha.4

package/README.md

@@ -0,0 +1,11 @@
+# @empire-builder-kit/desktop
+
+Standardized Nx plugin for Empire Builder Kit workspace tooling.
+
+## Building
+
+Run `pnpm nx build @empire-builder-kit/desktop` to build the library.
+
+## Running unit tests
+
+Run `pnpm nx test @empire-builder-kit/desktop` to execute the unit tests via [Vitest](https://vitest.dev/).

package/dist/executors.json

@@ -0,0 +1,3 @@
+{
+  "executors": {}
+}

package/dist/generators/app/app.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from '@nx/devkit';
+import { AppGeneratorSchema } from './schema';
+export declare function desktopAppGenerator(tree: Tree, options: AppGeneratorSchema): Promise<void>;
+export default desktopAppGenerator;
+//# sourceMappingURL=app.d.ts.map

package/dist/generators/app/app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../../src/generators/app/app.ts"],"names":[],"mappings":"AAAA,OAAO,EAQL,IAAI,EACL,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AA4M9C,wBAAsB,mBAAmB,CACvC,IAAI,EAAE,IAAI,EACV,OAAO,EAAE,kBAAkB,iBAyC5B;AAED,eAAe,mBAAmB,CAAC"}

package/dist/generators/app/app.js

@@ -0,0 +1,195 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.desktopAppGenerator = desktopAppGenerator;
+const tslib_1 = require("tslib");
+const devkit_1 = require("@nx/devkit");
+const path = tslib_1.__importStar(require("node:path"));
+function runtimeForLanguage(language) {
+    switch (language) {
+        case 'typescript':
+            return 'node';
+        case 'rust':
+            return 'native';
+        case 'go':
+            return 'native';
+        case 'python':
+            return 'python';
+    }
+}
+function frameworkForLanguage(language) {
+    switch (language) {
+        case 'typescript':
+            return 'electron';
+        case 'rust':
+            return 'tauri';
+        case 'go':
+            return 'wails';
+        case 'python':
+            return 'pyqt';
+    }
+}
+function targetsForLanguage(language, projectRoot) {
+    const cwd = projectRoot;
+    switch (language) {
+        case 'typescript':
+            return {
+                build: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'tsc -p tsconfig.json && cp src/*.html dist/' },
+                },
+                serve: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'tsc -p tsconfig.json && cp src/*.html dist/ && electron .' },
+                },
+                lint: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'eslint .' },
+                },
+                typecheck: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'tsc --noEmit -p tsconfig.json' },
+                },
+                test: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'vitest run' },
+                },
+                package: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'tsc -p tsconfig.json && electron-builder build --publish never' },
+                },
+            };
+        case 'rust':
+            return {
+                build: {
+                    executor: 'nx:run-commands',
+                    options: { cwd: `${cwd}/src-tauri`, command: 'cargo build' },
+                },
+                serve: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'cargo tauri dev' },
+                },
+                lint: {
+                    executor: 'nx:run-commands',
+                    options: { cwd: `${cwd}/src-tauri`, command: 'cargo clippy -- -D warnings' },
+                },
+                test: {
+                    executor: 'nx:run-commands',
+                    options: { cwd: `${cwd}/src-tauri`, command: 'cargo test' },
+                },
+                package: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'cargo tauri build' },
+                },
+            };
+        case 'go':
+            return {
+                build: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'wails build' },
+                },
+                serve: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'wails dev' },
+                },
+                lint: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'golangci-lint run' },
+                },
+                typecheck: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'go vet ./...' },
+                },
+                test: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'go test ./...' },
+                },
+                package: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'wails build' },
+                },
+            };
+        case 'python':
+            return {
+                serve: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'python src/main.py' },
+                },
+                lint: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'ruff check .' },
+                },
+                typecheck: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'mypy src/' },
+                },
+                test: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'pytest' },
+                },
+                package: {
+                    executor: 'nx:run-commands',
+                    options: { cwd, command: 'pyinstaller --onefile src/main.py' },
+                },
+            };
+    }
+}
+function normalizeOptions(tree, options) {
+    const appNames = (0, devkit_1.names)(options.app);
+    const desktopNames = (0, devkit_1.names)(options.name);
+    const language = options.language ?? 'typescript';
+    const directory = (options.directory ?? 'packages').replace(/\\/g, '/');
+    const appRoot = (0, devkit_1.joinPathFragments)(directory, appNames.fileName);
+    const projectRoot = (0, devkit_1.joinPathFragments)(directory, appNames.fileName, 'apps', 'desktop', desktopNames.fileName);
+    const userTags = options.tags
+        ?.split(',')
+        .map((tag) => tag.trim())
+        .filter(Boolean) ?? [];
+    return {
+        app: appNames.fileName,
+        appRoot,
+        className: appNames.className,
+        directory,
+        language,
+        name: desktopNames.fileName,
+        offsetFromRoot: (0, devkit_1.offsetFromRoot)(projectRoot),
+        projectName: `${appNames.fileName}-desktop-${desktopNames.fileName}`,
+        projectRoot,
+        projectTitle: `${appNames.className} Desktop ${desktopNames.className}`,
+        skipFormat: options.skipFormat,
+        tags: [
+            `scope:${appNames.fileName}`,
+            'layer:app',
+            'type:desktop',
+            `runtime:${runtimeForLanguage(language)}`,
+            'deploy:native',
+            'visibility:internal',
+            ...userTags,
+        ],
+    };
+}
+async function desktopAppGenerator(tree, options) {
+    const normalized = normalizeOptions(tree, options);
+    if (!tree.exists(normalized.appRoot)) {
+        throw new Error(`App group "${normalized.app}" does not exist at "${normalized.appRoot}". Generate the app group first.`);
+    }
+    if (tree.exists((0, devkit_1.joinPathFragments)(normalized.projectRoot, 'project.json')) ||
+        tree.exists((0, devkit_1.joinPathFragments)(normalized.projectRoot, 'package.json'))) {
+        throw new Error(`Desktop app "${normalized.name}" already exists at "${normalized.projectRoot}".`);
+    }
+    (0, devkit_1.addProjectConfiguration)(tree, normalized.projectName, {
+        root: normalized.projectRoot,
+        projectType: 'application',
+        sourceRoot: `${normalized.projectRoot}/src`,
+        tags: normalized.tags,
+        targets: targetsForLanguage(normalized.language, normalized.projectRoot),
+    });
+    (0, devkit_1.generateFiles)(tree, path.join(__dirname, `files-${normalized.language}`), normalized.projectRoot, {
+        ...normalized,
+        framework: frameworkForLanguage(normalized.language),
+        tmpl: '',
+    });
+    if (!normalized.skipFormat) {
+        await (0, devkit_1.formatFiles)(tree);
+    }
+}
+exports.default = desktopAppGenerator;

package/dist/generators/app/files-go/README.md.template

@@ -0,0 +1,11 @@
+# <%= projectTitle %>
+
+Wails desktop app for the `<%= app %>` app group.
+
+## Commands
+
+- `pnpm nx run <%= projectName %>:serve` — start Wails dev mode
+- `pnpm nx run <%= projectName %>:build` — build for current platform
+- `pnpm nx run <%= projectName %>:test` — run tests
+- `pnpm nx run <%= projectName %>:lint` — run golangci-lint
+- `pnpm nx run <%= projectName %>:package` — build for all platforms

package/dist/generators/app/files-go/frontend/index.html.template

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <title><%= projectTitle %></title>
+</head>
+<body>
+  <h1><%= projectTitle %></h1>
+  <p>Wails desktop app for the <%= app %> app group.</p>
+</body>
+</html>

package/dist/generators/app/files-go/go.mod.template

@@ -0,0 +1,5 @@
+module github.com/org/<%= projectName %>
+
+go 1.22
+
+require github.com/wailsapp/wails/v2 v2.9.2

package/dist/generators/app/files-go/main.go.template

@@ -0,0 +1,43 @@
+package main
+
+import (
+	"embed"
+	"fmt"
+
+	"github.com/wailsapp/wails/v2"
+	"github.com/wailsapp/wails/v2/pkg/options"
+	"github.com/wailsapp/wails/v2/pkg/options/assetserver"
+)
+
+//go:embed frontend
+var assets embed.FS
+
+type App struct{}
+
+func NewApp() *App {
+	return &App{}
+}
+
+func (a *App) Greet(name string) string {
+	return fmt.Sprintf("Hello, %s! From <%= projectTitle %>.", name)
+}
+
+func main() {
+	app := NewApp()
+
+	err := wails.Run(&options.App{
+		Title:  "<%= projectTitle %>",
+		Width:  1200,
+		Height: 800,
+		AssetServer: &assetserver.Options{
+			Assets: assets,
+		},
+		Bind: []interface{}{
+			app,
+		},
+	})
+
+	if err != nil {
+		println("Error:", err.Error())
+	}
+}

package/dist/generators/app/files-go/wails.json.template

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://wails.io/schemas/config.v2.json",
+  "name": "<%= projectName %>",
+  "outputfilename": "<%= name %>",
+  "frontend:install": "",
+  "frontend:build": "",
+  "frontend:dev:watcher": "",
+  "frontend:dev:serverUrl": "",
+  "author": {
+    "name": "<%= app %>"
+  }
+}

package/dist/generators/app/files-python/README.md.template

@@ -0,0 +1,11 @@
+# <%= projectTitle %>
+
+PyQt6 desktop app for the `<%= app %>` app group.
+
+## Commands
+
+- `pnpm nx run <%= projectName %>:serve` — run the app
+- `pnpm nx run <%= projectName %>:test` — run pytest
+- `pnpm nx run <%= projectName %>:lint` — run ruff
+- `pnpm nx run <%= projectName %>:typecheck` — run mypy
+- `pnpm nx run <%= projectName %>:package` — build distributable with pyinstaller

package/dist/generators/app/files-python/pyproject.toml.template

@@ -0,0 +1,15 @@
+[project]
+name = "<%= projectName %>"
+version = "0.1.0"
+requires-python = ">=3.12"
+dependencies = [
+    "PyQt6>=6.7",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8",
+    "ruff>=0.8",
+    "mypy>=1.13",
+    "pyinstaller>=6",
+]

package/dist/generators/app/files-python/src/main.py.template

@@ -0,0 +1,28 @@
+"""<%= projectTitle %> — PyQt6 desktop app for the <%= app %> app group."""
+
+import sys
+from PyQt6.QtWidgets import QApplication, QMainWindow, QLabel, QVBoxLayout, QWidget
+
+
+class MainWindow(QMainWindow):
+    def __init__(self):
+        super().__init__()
+        self.setWindowTitle("<%= projectTitle %>")
+        self.setMinimumSize(800, 600)
+
+        central = QWidget()
+        layout = QVBoxLayout(central)
+        layout.addWidget(QLabel("<%= projectTitle %>"))
+        layout.addWidget(QLabel("PyQt6 desktop app for the <%= app %> app group."))
+        self.setCentralWidget(central)
+
+
+def main():
+    app = QApplication(sys.argv)
+    window = MainWindow()
+    window.show()
+    sys.exit(app.exec())
+
+
+if __name__ == "__main__":
+    main()

package/dist/generators/app/files-rust/README.md.template

@@ -0,0 +1,11 @@
+# <%= projectTitle %>
+
+Tauri desktop app for the `<%= app %>` app group.
+
+## Commands
+
+- `pnpm nx run <%= projectName %>:serve` — start Tauri dev mode
+- `pnpm nx run <%= projectName %>:build` — build for distribution
+- `pnpm nx run <%= projectName %>:test` — run tests
+- `pnpm nx run <%= projectName %>:lint` — run clippy
+- `pnpm nx run <%= projectName %>:package` — package for distribution

package/dist/generators/app/files-rust/src/index.html.template

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <title><%= projectTitle %></title>
+</head>
+<body>
+  <h1><%= projectTitle %></h1>
+  <p>Tauri desktop app for the <%= app %> app group.</p>
+</body>
+</html>

package/dist/generators/app/files-rust/src-tauri/Cargo.toml.template

@@ -0,0 +1,9 @@
+[package]
+name = "<%= projectName %>"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+tauri = { version = "2", features = [] }
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"

package/dist/generators/app/files-rust/src-tauri/src/main.rs.template

@@ -0,0 +1,11 @@
+fn main() {
+    tauri::Builder::default()
+        .invoke_handler(tauri::generate_handler![greet])
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}
+
+#[tauri::command]
+fn greet(name: &str) -> String {
+    format!("Hello, {}! From <%= projectTitle %>.", name)
+}

package/dist/generators/app/files-rust/src-tauri/tauri.conf.json.template

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://raw.githubusercontent.com/nicholasgasior/tauri-docs/master/schemas/config.schema.json",
+  "productName": "<%= projectTitle %>",
+  "version": "0.1.0",
+  "identifier": "com.<%= app %>.<%= name %>",
+  "build": {
+    "frontendDist": "../src"
+  },
+  "app": {
+    "title": "<%= projectTitle %>",
+    "windows": [
+      {
+        "title": "<%= projectTitle %>",
+        "width": 1200,
+        "height": 800
+      }
+    ]
+  },
+  "bundle": {
+    "active": true,
+    "targets": "all"
+  }
+}

package/dist/generators/app/files-typescript/README.md.template

@@ -0,0 +1,11 @@
+# <%= projectTitle %>
+
+Electron desktop app for the `<%= app %>` app group.
+
+## Commands
+
+- `pnpm nx run <%= projectName %>:serve` — launch Electron
+- `pnpm nx run <%= projectName %>:build` — build distributable
+- `pnpm nx run <%= projectName %>:test` — run tests
+- `pnpm nx run <%= projectName %>:lint` — lint
+- `pnpm nx run <%= projectName %>:package` — package for distribution

package/dist/generators/app/files-typescript/package.json.template

@@ -0,0 +1,18 @@
+{
+  "name": "@org/<%= projectName %>",
+  "version": "0.1.0",
+  "private": true,
+  "main": "dist/main.js",
+  "scripts": {
+    "compile": "tsc -p tsconfig.json",
+    "start": "tsc -p tsconfig.json && electron .",
+    "build": "tsc -p tsconfig.json && electron-builder build --publish never"
+  },
+  "dependencies": {
+    "electron": "^33.0.0"
+  },
+  "devDependencies": {
+    "electron-builder": "^25.0.0",
+    "typescript": "~5.8.0"
+  }
+}

package/dist/generators/app/files-typescript/src/app.spec.ts.template

@@ -0,0 +1,7 @@
+import { describe, expect, it } from 'vitest';
+
+describe('<%= projectName %>', () => {
+  it('should be configured', () => {
+    expect('<%= projectName %>').toBeTruthy();
+  });
+});

package/dist/generators/app/files-typescript/src/index.html.template

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8" />
+  <meta http-equiv="Content-Security-Policy" content="default-src 'self'; script-src 'self'" />
+  <title><%= projectTitle %></title>
+</head>
+<body>
+  <h1><%= projectTitle %></h1>
+  <p>Electron desktop app for the <%= app %> app group.</p>
+</body>
+</html>

package/dist/generators/app/files-typescript/src/main.ts.template

@@ -0,0 +1,22 @@
+import { app, BrowserWindow } from 'electron';
+import * as path from 'path';
+
+function createWindow() {
+  const win = new BrowserWindow({
+    width: 1200,
+    height: 800,
+    webPreferences: {
+      preload: path.join(__dirname, 'preload.js'),
+    },
+  });
+
+  win.loadFile(path.join(__dirname, 'index.html'));
+}
+
+app.whenReady().then(createWindow);
+
+app.on('window-all-closed', () => {
+  if (process.platform !== 'darwin') {
+    app.quit();
+  }
+});

package/dist/generators/app/files-typescript/src/preload.ts.template

@@ -0,0 +1,5 @@
+import { contextBridge } from 'electron';
+
+contextBridge.exposeInMainWorld('app', {
+  name: '<%= projectName %>',
+});

package/dist/generators/app/files-typescript/tsconfig.json.template

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "commonjs",
+    "lib": ["ES2022"],
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["node_modules", "dist"]
+}

package/dist/generators/app/schema.d.ts

@@ -0,0 +1,8 @@
+export interface AppGeneratorSchema {
+  name: string;
+  app: string;
+  language?: 'typescript' | 'rust' | 'go' | 'python';
+  directory?: string;
+  tags?: string;
+  skipFormat?: boolean;
+}

package/dist/generators/app/schema.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "$id": "DesktopAppGenerator",
+  "title": "Generate an EBK desktop app",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Name for the desktop app within the app group.",
+      "$default": { "$source": "argv", "index": 0 },
+      "x-prompt": "What name should the desktop app have?"
+    },
+    "app": {
+      "type": "string",
+      "description": "Owning Empire Builder Kit app-group name.",
+      "x-prompt": "Which app group should receive the desktop app?"
+    },
+    "language": {
+      "type": "string",
+      "description": "Programming language and framework for the desktop app.",
+      "enum": ["typescript", "rust", "go", "python"],
+      "default": "typescript"
+    },
+    "directory": {
+      "type": "string",
+      "description": "Base directory for app groups.",
+      "default": "packages"
+    },
+    "tags": {
+      "type": "string",
+      "description": "Comma-separated additional tags."
+    },
+    "skipFormat": {
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": ["name", "app"]
+}

package/dist/generators.json

@@ -0,0 +1,9 @@
+{
+  "generators": {
+    "app": {
+      "factory": "./dist/generators/app/app",
+      "schema": "./dist/generators/app/schema.json",
+      "description": "Generate app artifacts for @empire-builder-kit/desktop."
+    }
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { desktopAppGenerator } from './generators/app/app';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.desktopAppGenerator = void 0;
+var app_1 = require("./generators/app/app");
+Object.defineProperty(exports, "desktopAppGenerator", { enumerable: true, get: function () { return app_1.desktopAppGenerator; } });

package/executors.json

@@ -0,0 +1,3 @@
+{
+  "executors": {}
+}

package/generators.json

@@ -0,0 +1,9 @@
+{
+  "generators": {
+    "app": {
+      "factory": "./dist/generators/app/app",
+      "schema": "./dist/generators/app/schema.json",
+      "description": "Generate app artifacts for @empire-builder-kit/desktop."
+    }
+  }
+}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@empire-builder-kit/desktop",
+  "version": "0.0.1-alpha.4",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "@org/source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "nx": {
+    "name": "@empire-builder-kit/desktop",
+    "targets": {
+      "build": {
+        "executor": "@nx/js:tsc",
+        "outputs": [
+          "{options.outputPath}"
+        ],
+        "options": {
+          "outputPath": "packages/desktop/dist",
+          "main": "packages/desktop/src/index.ts",
+          "tsConfig": "packages/desktop/tsconfig.lib.json",
+          "rootDir": "packages/desktop/src",
+          "generatePackageJson": false,
+          "assets": [
+            {
+              "input": "./packages/desktop/src",
+              "glob": "**/!(*.ts)",
+              "output": "."
+            },
+            {
+              "input": "./packages/desktop/src",
+              "glob": "**/.*",
+              "output": "."
+            },
+            {
+              "input": "./packages/desktop/src",
+              "glob": "**/*.d.ts",
+              "output": "."
+            },
+            {
+              "input": "./packages/desktop",
+              "glob": "generators.json",
+              "output": "."
+            },
+            {
+              "input": "./packages/desktop",
+              "glob": "executors.json",
+              "output": "."
+            }
+          ]
+        }
+      }
+    },
+    "tags": [
+      "scope:workspace",
+      "layer:tooling",
+      "visibility:public",
+      "npm:public"
+    ]
+  },
+  "dependencies": {
+    "@nx/devkit": "22.6.5",
+    "tslib": "^2.3.0",
+    "vitest": "4.1.4"
+  },
+  "generators": "./generators.json",
+  "executors": "./executors.json",
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo",
+    "generators.json",
+    "executors.json"
+  ]
+}