@uns-kit/cli 0.0.4 → 0.0.6

package/README.md

@@ -24,8 +24,25 @@ pnpm run dev
 ## Commands
 
 - `uns-kit create <name>` – create a new UNS project in the specified directory.
+- `uns-kit configure-devops [path]` – add Azure DevOps tooling (dependencies, script, config) to an existing project.
 - `uns-kit help` – display usage information.
 
+### Configure Azure DevOps
+
+Run inside a scaffolded project to add the Azure DevOps pull-request tooling:
+
+```bash
+uns-kit configure-devops
+pnpm install
+pnpm run pull-request
+```
+
+The command prompts for your Azure DevOps organization and updates `config.json` along with the necessary dev dependencies.
+
+### Extend the Config Schema
+
+Edit `src/config/project.config.extension.ts` inside your generated project and run `pnpm run generate-config-schema`. This regenerates `config.schema.json` and `src/config/app-config.ts` so editors and runtime types stay in sync.
+
 ## License
 
 MIT © Aljoša Vister

package/dist/index.js

@@ -4,6 +4,7 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { createRequire } from "node:module";
 import process from "node:process";
+import readline from "node:readline/promises";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const require = createRequire(import.meta.url);
@@ -15,6 +16,17 @@ async function main() {
         printHelp();
         return;
     }
+    if (command === "configure-devops") {
+        const targetPath = args[1];
+        try {
+            await configureDevops(targetPath);
+        }
+        catch (error) {
+            console.error(error.message);
+            process.exitCode = 1;
+        }
+        return;
+    }
     if (command === "create") {
         const projectName = args[1];
         if (!projectName) {
@@ -36,7 +48,7 @@ async function main() {
     process.exitCode = 1;
 }
 function printHelp() {
-    console.log(`\nUsage: uns-kit <command> [options]\n\nCommands:\n  create <name>   Scaffold a new UNS application\n  help            Show this message\n`);
+    console.log(`\nUsage: uns-kit <command> [options]\n\nCommands:\n  create <name>           Scaffold a new UNS application\n  configure-devops [dir]  Configure Azure DevOps tooling in an existing project\n  help                    Show this message\n`);
 }
 async function createProject(projectName) {
     const targetDir = path.resolve(process.cwd(), projectName);
@@ -53,6 +65,81 @@ async function createProject(projectName) {
     console.log("  pnpm install");
     console.log("  pnpm run dev");
 }
+async function configureDevops(targetPath) {
+    const targetDir = path.resolve(process.cwd(), targetPath ?? ".");
+    const packagePath = path.join(targetDir, "package.json");
+    const configPath = path.join(targetDir, "config.json");
+    let pkgRaw;
+    try {
+        pkgRaw = await readFile(packagePath, "utf8");
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            throw new Error(`Could not find package.json in ${targetDir}`);
+        }
+        throw error;
+    }
+    let configRaw;
+    try {
+        configRaw = await readFile(configPath, "utf8");
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            throw new Error(`Could not find config.json in ${targetDir}`);
+        }
+        throw error;
+    }
+    const pkg = JSON.parse(pkgRaw);
+    const config = JSON.parse(configRaw);
+    const defaultOrg = config.devops?.organization ?? "sijit";
+    const answer = (await promptQuestion(`Azure DevOps organization [${defaultOrg}]: `)).trim();
+    const organization = answer || defaultOrg;
+    if (!config.devops || typeof config.devops !== "object") {
+        config.devops = {};
+    }
+    config.devops.organization = organization;
+    const requiredDevDeps = {
+        "azure-devops-node-api": "^15.1.0",
+        "simple-git": "^3.27.0",
+        "chalk": "^5.4.1",
+        "prettier": "^3.5.3"
+    };
+    let pkgChanged = false;
+    const devDeps = (pkg.devDependencies ??= {});
+    const deps = pkg.dependencies ?? {};
+    for (const [name, version] of Object.entries(requiredDevDeps)) {
+        if (!devDeps[name] && !deps[name]) {
+            devDeps[name] = version;
+            pkgChanged = true;
+        }
+    }
+    const scripts = (pkg.scripts ??= {});
+    if (!scripts["pull-request"]) {
+        scripts["pull-request"] = "node ./node_modules/@uns-kit/core/dist/tools/pull-request.js";
+        pkgChanged = true;
+    }
+    await writeFile(configPath, JSON.stringify(config, null, 2) + "\n", "utf8");
+    if (pkgChanged) {
+        await writeFile(packagePath, JSON.stringify(pkg, null, 2) + "\n", "utf8");
+    }
+    console.log(`\nDevOps tooling configured.`);
+    console.log(`  Azure organization: ${organization}`);
+    if (pkgChanged) {
+        console.log("  Updated package.json scripts/devDependencies. Run pnpm install to fetch new packages.");
+    }
+    else {
+        console.log("  Existing package.json already contained required entries.");
+    }
+}
+async function promptQuestion(message) {
+    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
+    try {
+        return await rl.question(message);
+    }
+    finally {
+        rl.close();
+    }
+}
 async function ensureTargetDir(dir) {
     try {
         const stats = await stat(dir);
@@ -84,12 +171,20 @@ async function patchPackageJson(targetDir, packageName) {
 }
 async function patchConfigJson(targetDir, packageName) {
     const configFile = path.join(targetDir, "config.json");
-    const raw = await readFile(configFile, "utf8");
-    const config = JSON.parse(raw);
-    if (config.uns && typeof config.uns === "object") {
-        config.uns.processName = packageName;
+    try {
+        const raw = await readFile(configFile, "utf8");
+        const config = JSON.parse(raw);
+        if (config.uns && typeof config.uns === "object") {
+            config.uns.processName = packageName;
+        }
+        await writeFile(configFile, JSON.stringify(config, null, 2) + "\n", "utf8");
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            return;
+        }
+        throw error;
     }
-    await writeFile(configFile, JSON.stringify(config, null, 2) + "\n", "utf8");
 }
 async function replacePlaceholders(targetDir, packageName) {
     const replacements = {
@@ -97,7 +192,8 @@ async function replacePlaceholders(targetDir, packageName) {
     };
     const filesToUpdate = [
         path.join(targetDir, "README.md"),
-        path.join(targetDir, "src/index.ts")
+        path.join(targetDir, "src/index.ts"),
+        path.join(targetDir, "config.json")
     ];
     for (const file of filesToUpdate) {
         try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Command line scaffolding tool for UNS applications",
   "type": "module",
   "license": "MIT",
@@ -25,7 +25,7 @@
     "templates"
   ],
   "dependencies": {
-    "@uns-kit/core": "^0.0.1"
+    "@uns-kit/core": "^0.0.4"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",

package/templates/default/README.md

@@ -8,6 +8,7 @@ Generated with `@uns-kit/cli`.
 pnpm run dev    # start the local development loop
 pnpm run build  # emit dist/ output
 pnpm run start  # run the compiled entrypoint
+pnpm run generate-config-schema  # regenerate config.schema.json and AppConfig types
 ```
 
 ## Configuration
@@ -18,4 +19,6 @@ Update `config.json` with your broker, UNS URLs, and credentials. The generated
 
 - Install additional plugins: `pnpm add @uns-kit/api` etc.
 - Create MQTT proxies or Temporal workflows inside `src/index.ts`.
+- Extend `src/config/project.config.extension.ts` with project-specific sections and run `pnpm run generate-config-schema`.
+- Run `uns-kit configure-devops` to add the Azure DevOps pull-request tooling.
 - Commit your new project and start building!

package/templates/default/config.json

@@ -16,5 +16,8 @@
   },
   "input": {
     "host": "localhost:1883"
+  },
+  "devops": {
+    "organization": "sijit"
   }
 }

package/templates/default/package.json

@@ -10,7 +10,8 @@
     "generate-config-schema": "node ./node_modules/@uns-kit/core/dist/tools/generate-config-schema.js"
   },
   "dependencies": {
-    "@uns-kit/core": "__UNS_KIT_CORE_VERSION__"
+    "@uns-kit/core": "__UNS_KIT_CORE_VERSION__",
+    "zod": "^3.23.8"
   },
   "devDependencies": {
     "tsx": "^4.20.5",

package/templates/default/src/config/project.config.extension.example

@@ -0,0 +1,23 @@
+import { z } from "zod";
+import { secretValueSchema } from "@uns-kit/core/dist/uns-config/secret-placeholders";
+import { hostValueSchema } from "@uns-kit/core/dist/uns-config/host-placeholders";
+
+// Extend this schema with project-specific configuration sections.
+export const projectExtrasSchema = z.object({
+  pg: z.object({
+    user: z.string().min(1, "pg.user is required"),
+    host: hostValueSchema,
+    port: z.number().int().positive().default(5432),
+    ssl: z.boolean().default(false),
+    database: z.string().min(1, "pg.database is required"),
+    isPoolConnection: z.boolean().default(false),
+    password: secretValueSchema.optional(),
+  }),
+
+  caddy: z.object({
+    adminUrl: z.string().url(),
+    proxyHost: z.string().url(),
+  }),
+});
+
+export type ProjectExtras = z.infer<typeof projectExtrasSchema>;

package/templates/default/src/config/project.config.extension.ts

@@ -0,0 +1,6 @@
+import { z } from "zod";
+
+// Extend this schema with project-specific configuration sections.
+export const projectExtrasSchema = z.object({});
+
+export type ProjectExtras = z.infer<typeof projectExtrasSchema>;