@uns-kit/cli 0.0.34 → 0.0.36

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 Aljoša Vister
-
-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.
+MIT License
+
+Copyright (c) 2023 Aljoša Vister
+
+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.

package/README.md

@@ -1,128 +1,128 @@
-# @uns-kit/cli
-
-Command line scaffolding tool for the UNS toolkit. It bootstraps a new project with `@uns-kit/core` preconfigured and ready to extend with additional plugins.
-
-## Prerequisites
-
-- Node.js 18 or newer (ES2022 runtime features)
-- A package manager such as `pnpm`, `npm`, or `yarn`
-- `git` available on PATH (required for `configure-devops`, used to initialize new projects automatically)
-
-## Usage
-
-```bash
-pnpm --package=@uns-kit/cli dlx uns-kit create my-uns-app
-# or with npx
-npx @uns-kit/cli create my-uns-app
-# or after installing globally
-npm install -g @uns-kit/cli
-uns-kit create my-uns-app
-```
-
-The command creates a new directory, copies the starter template, and pins `@uns-kit/core` to the currently published version. After the scaffold finishes:
-
-```bash
-cd my-uns-app
-pnpm install
-pnpm run dev
-```
-
-When `git` is available on your PATH the scaffold also initializes a fresh repository so you can commit immediately.
-
-## Commands
-
-- `uns-kit create <name>` – create a new UNS project in the specified directory.
-- `uns-kit configure [path] [features...]` – run multiple configure templates in sequence (`--all` applies every template).
-- `uns-kit configure-devops [path]` – add Azure DevOps tooling (dependencies, script, config) to an existing project.
-- `uns-kit configure-vscode [path]` – copy VS Code launch/workspace files into an existing project.
-- `uns-kit configure-codegen [path]` – scaffold GraphQL code generation and UNS refresh scripts.
-- `uns-kit configure-api [path]` – copy UNS API examples and add `@uns-kit/api`.
-- `uns-kit configure-cron [path]` – copy UNS cron examples and add `@uns-kit/cron`.
-- `uns-kit configure-temporal [path]` – copy UNS Temporal examples and add `@uns-kit/temporal`.
-- `uns-kit configure-python [path]` – copy Python gateway client scaffolding (no npm dependency required).
-- `uns-kit help` – display usage information.
-
-### Configure multiple features at once
-
-Chain several add-ons without running each subcommand manually:
-
-```bash
-uns-kit configure --all
-uns-kit configure ./apps/gateway devops vscode codegen
-```
-
-Mix and match feature names after an optional target directory. Use `--all` to apply every available template in one shot.
-
-### 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/project, ensures the remote repository exists, and updates `config.json` along with the necessary dev dependencies.
-
-### Configure VS Code workspace
-
-```bash
-uns-kit configure-vscode
-```
-
-Copies `.vscode/launch.json` plus a baseline workspace file into the project. Existing files are never overwritten, making it safe to re-run after hand edits.
-
-### Configure GraphQL code generation
-
-```bash
-uns-kit configure-codegen
-pnpm install
-pnpm run codegen
-pnpm run refresh-uns
-```
-
-Adds `codegen.ts`, seeds `src/uns/` placeholder types, and wires the GraphQL Code Generator / `refresh-uns` script into `package.json`. After installing the new dev dependencies you can regenerate strongly-typed operations (`pnpm run codegen`) and rebuild UNS topics/tags from your environment (`pnpm run refresh-uns`).
-
-### Add UNS API scaffolding
-
-```bash
-uns-kit configure-api
-pnpm install
-```
-
-Copies API-oriented examples (under `src/examples/`) and adds `@uns-kit/api` to your project dependencies.
-
-### Add cron-based scaffolding
-
-```bash
-uns-kit configure-cron
-pnpm install
-```
-
-Adds cron-oriented example stubs and installs `@uns-kit/cron`.
-
-### Add Temporal scaffolding
-
-```bash
-uns-kit configure-temporal
-pnpm install
-```
-
-Copies Temporal example placeholders and installs `@uns-kit/temporal`.
-
-### Add Python gateway scaffolding
-
-```bash
-uns-kit configure-python
-```
-
-Copies the Python gateway client template (examples, scripts, requirements, proto) into your project so you can iterate on the gRPC gateway from Python alongside your TypeScript project.
-
-### 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`, augmenting `@uns-kit/core`'s `AppConfig` so editors and runtime types stay in sync. If completions lag, reload the TypeScript server in your editor.
-
-## License
-
-MIT © Aljoša Vister
+# @uns-kit/cli
+
+Command line scaffolding tool for the UNS toolkit. It bootstraps a new project with `@uns-kit/core` preconfigured and ready to extend with additional plugins.
+
+## Prerequisites
+
+- Node.js 18 or newer (ES2022 runtime features)
+- A package manager such as `pnpm`, `npm`, or `yarn`
+- `git` available on PATH (required for `configure-devops`, used to initialize new projects automatically)
+
+## Usage
+
+```bash
+pnpm --package=@uns-kit/cli dlx uns-kit create my-uns-app
+# or with npx
+npx @uns-kit/cli create my-uns-app
+# or after installing globally
+npm install -g @uns-kit/cli
+uns-kit create my-uns-app
+```
+
+The command creates a new directory, copies the starter template, and pins `@uns-kit/core` to the currently published version. After the scaffold finishes:
+
+```bash
+cd my-uns-app
+pnpm install
+pnpm run dev
+```
+
+When `git` is available on your PATH the scaffold also initializes a fresh repository so you can commit immediately.
+
+## Commands
+
+- `uns-kit create <name>` – create a new UNS project in the specified directory.
+- `uns-kit configure [path] [features...]` – run multiple configure templates in sequence (`--all` applies every template).
+- `uns-kit configure-devops [path]` – add Azure DevOps tooling (dependencies, script, config) to an existing project.
+- `uns-kit configure-vscode [path]` – copy VS Code launch/workspace files into an existing project.
+- `uns-kit configure-codegen [path]` – scaffold GraphQL code generation and UNS refresh scripts.
+- `uns-kit configure-api [path]` – copy UNS API examples and add `@uns-kit/api`.
+- `uns-kit configure-cron [path]` – copy UNS cron examples and add `@uns-kit/cron`.
+- `uns-kit configure-temporal [path]` – copy UNS Temporal examples and add `@uns-kit/temporal`.
+- `uns-kit configure-python [path]` – copy Python gateway client scaffolding (no npm dependency required).
+- `uns-kit help` – display usage information.
+
+### Configure multiple features at once
+
+Chain several add-ons without running each subcommand manually:
+
+```bash
+uns-kit configure --all
+uns-kit configure ./apps/gateway devops vscode codegen
+```
+
+Mix and match feature names after an optional target directory. Use `--all` to apply every available template in one shot.
+
+### 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/project, ensures the remote repository exists, and updates `config.json` along with the necessary dev dependencies.
+
+### Configure VS Code workspace
+
+```bash
+uns-kit configure-vscode
+```
+
+Copies `.vscode/launch.json` plus a baseline workspace file into the project. Existing files are never overwritten, making it safe to re-run after hand edits.
+
+### Configure GraphQL code generation
+
+```bash
+uns-kit configure-codegen
+pnpm install
+pnpm run codegen
+pnpm run refresh-uns
+```
+
+Adds `codegen.ts`, seeds `src/uns/` placeholder types, and wires the GraphQL Code Generator / `refresh-uns` script into `package.json`. After installing the new dev dependencies you can regenerate strongly-typed operations (`pnpm run codegen`) and rebuild UNS topics/tags from your environment (`pnpm run refresh-uns`).
+
+### Add UNS API scaffolding
+
+```bash
+uns-kit configure-api
+pnpm install
+```
+
+Copies API-oriented examples (under `src/examples/`) and adds `@uns-kit/api` to your project dependencies.
+
+### Add cron-based scaffolding
+
+```bash
+uns-kit configure-cron
+pnpm install
+```
+
+Adds cron-oriented example stubs and installs `@uns-kit/cron`.
+
+### Add Temporal scaffolding
+
+```bash
+uns-kit configure-temporal
+pnpm install
+```
+
+Copies Temporal example placeholders and installs `@uns-kit/temporal`.
+
+### Add Python gateway scaffolding
+
+```bash
+uns-kit configure-python
+```
+
+Copies the Python gateway client template (examples, scripts, requirements, proto) into your project so you can iterate on the gRPC gateway from Python alongside your TypeScript project.
+
+### 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`, augmenting `@uns-kit/core`'s `AppConfig` so editors and runtime types stay in sync. If completions lag, reload the TypeScript server in your editor.
+
+## License
+
+MIT © Aljoša Vister

package/dist/index.js

@@ -23,6 +23,17 @@ async function main() {
         printHelp();
         return;
     }
+    if (command === "configure-config") {
+        const targetPath = args[1];
+        try {
+            await configureConfigFiles(targetPath);
+        }
+        catch (error) {
+            console.error(error.message);
+            process.exitCode = 1;
+        }
+        return;
+    }
     if (command === "configure") {
         const configureArgs = args.slice(1);
         try {
@@ -137,6 +148,7 @@ function printHelp() {
         "\nCommands:\n" +
         "  create <name>           Scaffold a new UNS application\n" +
         "  configure [dir] [features...] Configure multiple templates (--all for everything)\n" +
+        "  configure-config [dir]  Copy configuration example files\n" +
         "  configure-devops [dir]  Configure Azure DevOps tooling in an existing project\n" +
         "  configure-vscode [dir]  Add VS Code workspace configuration files\n" +
         "  configure-codegen [dir] Copy GraphQL codegen template and dependencies\n" +
@@ -365,6 +377,53 @@ async function configureVscode(targetPath) {
         console.log("  No files were found in the VS Code template directory.");
     }
 }
+async function configureConfigFiles(targetPath) {
+    const targetDir = path.resolve(process.cwd(), targetPath ?? ".");
+    const templateDir = path.resolve(__dirname, "../templates/config-files");
+    try {
+        await access(templateDir);
+    }
+    catch (error) {
+        throw new Error("Configuration template directory is missing. Please ensure templates/config-files is available.");
+    }
+    const { copied, skipped } = await copyTemplateDirectory(templateDir, targetDir, targetDir);
+    const configFilesToAdjust = copied.filter((file) => {
+        const filename = path.basename(file);
+        return filename.toLowerCase().startsWith("config") && filename.toLowerCase().endsWith(".json");
+    });
+    if (configFilesToAdjust.length) {
+        await applyConfigTemplatePlaceholders(targetDir, configFilesToAdjust);
+    }
+    console.log("\nConfiguration example files processed.");
+    if (copied.length) {
+        console.log("  Added:");
+        for (const file of copied) {
+            console.log(`    ${file}`);
+        }
+    }
+    if (skipped.length) {
+        console.log("  Skipped (already exists):");
+        for (const file of skipped) {
+            console.log(`    ${file}`);
+        }
+    }
+    if (!copied.length && !skipped.length) {
+        console.log("  No configuration files were found in templates/config-files.");
+    }
+}
+async function applyConfigTemplatePlaceholders(targetDir, relativePaths) {
+    const packageName = await resolvePackageNameFromTarget(targetDir);
+    for (const relativePath of relativePaths) {
+        const absolutePath = path.join(targetDir, relativePath);
+        const replacements = {
+            __APP_CONFIG__: deriveConfigIdentifier(absolutePath),
+        };
+        if (packageName) {
+            replacements.__APP_NAME__ = packageName;
+        }
+        await replaceConfigTemplatePlaceholders(absolutePath, replacements, packageName);
+    }
+}
 async function configureCodegen(targetPath) {
     const targetDir = path.resolve(process.cwd(), targetPath ?? ".");
     const templateDir = path.resolve(__dirname, "../templates/codegen");
@@ -476,6 +535,7 @@ async function configurePython(targetPath) {
 const configureFeatureHandlers = {
     devops: configureDevops,
     vscode: configureVscode,
+    config: configureConfigFiles,
     codegen: configureCodegen,
     api: configureApi,
     cron: configureCron,
@@ -486,6 +546,7 @@ const AVAILABLE_CONFIGURE_FEATURES = Object.keys(configureFeatureHandlers);
 const configureFeatureLabels = {
     devops: "Azure DevOps tooling",
     vscode: "VS Code workspace",
+    config: "Configuration example files",
     codegen: "GraphQL codegen tooling",
     api: "UNS API resources",
     cron: "UNS cron resources",
@@ -551,6 +612,8 @@ const configureFeatureAliases = {
     "configure-devops": "devops",
     vscode: "vscode",
     "configure-vscode": "vscode",
+    config: "config",
+    "configure-config": "config",
     codegen: "codegen",
     "configure-codegen": "codegen",
     api: "api",
@@ -983,22 +1046,28 @@ async function patchConfigJson(targetDir, packageName) {
     }
 }
 async function replacePlaceholders(targetDir, packageName) {
+    const configFilePath = path.join(targetDir, "config.json");
     const replacements = {
-        __APP_NAME__: packageName
+        __APP_NAME__: packageName,
+        __APP_CONFIG__: deriveConfigIdentifier(configFilePath),
     };
     const filesToUpdate = [
         path.join(targetDir, "README.md"),
         path.join(targetDir, "src/index.ts"),
-        path.join(targetDir, "config.json")
+        configFilePath,
     ];
     for (const file of filesToUpdate) {
         try {
             await access(file);
-            let content = await readFile(file, "utf8");
-            for (const [placeholder, value] of Object.entries(replacements)) {
-                content = content.replace(new RegExp(placeholder, "g"), value);
+            if (path.resolve(file) === path.resolve(configFilePath)) {
+                await replaceConfigTemplatePlaceholders(file, replacements, packageName);
+                continue;
+            }
+            const original = await readFile(file, "utf8");
+            const updated = replaceInString(original, replacements);
+            if (updated !== original) {
+                await writeFile(file, updated, "utf8");
             }
-            await writeFile(file, content, "utf8");
         }
         catch (error) {
             if (error.code !== "ENOENT") {
@@ -1007,6 +1076,112 @@ async function replacePlaceholders(targetDir, packageName) {
         }
     }
 }
+async function resolvePackageNameFromTarget(targetDir) {
+    const packagePath = path.join(targetDir, "package.json");
+    try {
+        const raw = await readFile(packagePath, "utf8");
+        const pkg = JSON.parse(raw);
+        const name = typeof pkg.name === "string" ? pkg.name.trim() : "";
+        return name || undefined;
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            return undefined;
+        }
+        throw error;
+    }
+}
+function deriveConfigIdentifier(filePath) {
+    const baseName = path.basename(filePath, path.extname(filePath));
+    if (baseName.startsWith("config-")) {
+        const suffix = baseName.slice("config-".length);
+        return suffix || "config";
+    }
+    return baseName || "config";
+}
+async function replaceConfigTemplatePlaceholders(filePath, replacements, packageName) {
+    let raw;
+    try {
+        raw = await readFile(filePath, "utf8");
+    }
+    catch (error) {
+        if (error.code === "ENOENT") {
+            return;
+        }
+        throw error;
+    }
+    let parsed;
+    try {
+        parsed = JSON.parse(raw);
+    }
+    catch (error) {
+        const updated = replaceInString(raw, replacements);
+        if (updated !== raw) {
+            await writeFile(filePath, updated, "utf8");
+        }
+        return;
+    }
+    let modified = applyJsonTemplateReplacements(parsed, replacements);
+    if (packageName && parsed && typeof parsed === "object") {
+        const root = parsed;
+        const unsSection = root["uns"];
+        if (unsSection && typeof unsSection === "object") {
+            const unsRecord = unsSection;
+            if (unsRecord["processName"] !== packageName) {
+                unsRecord["processName"] = packageName;
+                modified = true;
+            }
+        }
+    }
+    if (!modified) {
+        return;
+    }
+    const formatted = JSON.stringify(parsed, null, 2) + "\n";
+    await writeFile(filePath, formatted, "utf8");
+}
+function applyJsonTemplateReplacements(target, replacements) {
+    let modified = false;
+    const visit = (value) => {
+        if (typeof value === "string") {
+            const replaced = replaceInString(value, replacements);
+            if (replaced !== value) {
+                modified = true;
+            }
+            return replaced;
+        }
+        if (Array.isArray(value)) {
+            for (let index = 0; index < value.length; index += 1) {
+                const next = visit(value[index]);
+                if (next !== value[index]) {
+                    value[index] = next;
+                }
+            }
+            return value;
+        }
+        if (value && typeof value === "object") {
+            const record = value;
+            for (const [key, child] of Object.entries(record)) {
+                const next = visit(child);
+                if (next !== child) {
+                    record[key] = next;
+                }
+            }
+            return record;
+        }
+        return value;
+    };
+    visit(target);
+    return modified;
+}
+function replaceInString(input, replacements) {
+    let result = input;
+    for (const [needle, replacement] of Object.entries(replacements)) {
+        if (needle && result.includes(needle)) {
+            result = result.split(needle).join(replacement);
+        }
+    }
+    return result;
+}
 function normalizePackageName(input) {
     const trimmed = input.trim();
     if (trimmed.startsWith("@")) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uns-kit/cli",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "description": "Command line scaffolding tool for UNS applications",
   "type": "module",
   "license": "MIT",
@@ -26,7 +26,7 @@
   ],
   "dependencies": {
     "azure-devops-node-api": "^15.1.1",
-    "@uns-kit/core": "0.0.34"
+    "@uns-kit/core": "0.0.36"
   },
   "scripts": {
     "build": "tsc -p tsconfig.build.json",