@quonfig/cli 0.0.15 → 0.0.17

package/dist/util/quonfig-json.js

@@ -0,0 +1,65 @@
+/**
+ * Reader/writer for the workspace's `quonfig.json` file.
+ *
+ * Today the file is `{ environments: string[] }`. We are adding an optional
+ * `workspace: "<slug>"` pin (Guard 1 in `project/plans/cli-git-sync.md`)
+ * so commands like `qfg push` can confirm that the local dir belongs to the
+ * cloud workspace they think it does.
+ *
+ * The reader is permissive: missing file or missing field returns `undefined`
+ * (no throw). It only throws when the file exists but cannot be parsed.
+ *
+ * The writer preserves all unknown fields, sticks to 2-space indent, and
+ * always ends with a trailing newline — matching how `qfg init` and the
+ * migrate flow create the file today.
+ */
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+const QUONFIG_JSON = 'quonfig.json';
+async function readQuonfigJson(dir) {
+    const filePath = path.join(dir, QUONFIG_JSON);
+    let raw;
+    try {
+        raw = await fs.promises.readFile(filePath, 'utf8');
+    }
+    catch (error) {
+        if (error.code === 'ENOENT')
+            return undefined;
+        throw error;
+    }
+    // JSON.parse will throw on malformed JSON — that's the documented behavior.
+    const parsed = JSON.parse(raw);
+    if (parsed === null || typeof parsed !== 'object' || Array.isArray(parsed)) {
+        throw new TypeError(`${QUONFIG_JSON} must be a JSON object`);
+    }
+    return parsed;
+}
+/**
+ * Read the workspace slug pin from `<dir>/quonfig.json`.
+ *
+ * Returns `undefined` when the file is missing OR when the `workspace`
+ * field is absent OR when the field is present but not a string.
+ * Throws only when the file exists but contains malformed JSON, since
+ * that is a real bug a caller should surface.
+ */
+export async function readWorkspaceSlug(dir) {
+    const parsed = await readQuonfigJson(dir);
+    if (!parsed)
+        return undefined;
+    const slug = parsed.workspace;
+    return typeof slug === 'string' ? slug : undefined;
+}
+/**
+ * Write the workspace slug pin into `<dir>/quonfig.json`.
+ *
+ * If the file exists, all other fields are preserved and only `workspace`
+ * is set/overwritten. If the file is missing, a minimal `{workspace: slug}`
+ * file is created. Format is 2-space indent + trailing newline to match
+ * the file shape produced by `qfg init` and `qfg migrate`.
+ */
+export async function writeWorkspaceSlug(dir, slug) {
+    const existing = (await readQuonfigJson(dir)) ?? {};
+    const next = { ...existing, workspace: slug };
+    const filePath = path.join(dir, QUONFIG_JSON);
+    await fs.promises.writeFile(filePath, JSON.stringify(next, null, 2) + '\n', 'utf8');
+}

package/dist/verify/validate.js

@@ -279,7 +279,9 @@ export function validateWorkspace(workspaceDir) {
                 quonfigParsed = null;
                 issues.push({ file: 'quonfig.json', message: `Invalid JSON: ${error.message}`, severity: 'error' });
             }
-            const quonfigResult = z.object({ environments: z.array(z.string()) }).safeParse(quonfigParsed);
+            const quonfigResult = z
+                .object({ environments: z.array(z.string()), workspace: z.string().optional() })
+                .safeParse(quonfigParsed);
             if (quonfigResult.success) {
                 for (const envId of quonfigResult.data.environments) {
                     declaredEnvIds.add(envId);
@@ -606,7 +608,9 @@ export function validateFileMap(files) {
             issues.push({ file: 'quonfig.json', message: `Invalid JSON: ${error.message}`, severity: 'error' });
         }
         if (quonfigParsed !== null) {
-            const quonfigResult = z.object({ environments: z.array(z.string()) }).safeParse(quonfigParsed);
+            const quonfigResult = z
+                .object({ environments: z.array(z.string()), workspace: z.string().optional() })
+                .safeParse(quonfigParsed);
             if (quonfigResult.success) {
                 for (const envId of quonfigResult.data.environments) {
                     declaredEnvIds.add(envId);

package/oclif.manifest.json

@@ -567,6 +567,14 @@
           "name": "samples",
           "allowNo": true,
           "type": "boolean"
+        },
+        "workspace": {
+          "description": "Workspace slug to pin in quonfig.json (Guard 1). If omitted, no pin is written.",
+          "name": "workspace",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
@@ -1287,6 +1295,101 @@
         "pull.js"
       ]
     },
+    "push": {
+      "aliases": [],
+      "args": {},
+      "description": "Push local config changes up to your workspace on Quonfig cloud.\n\nEnforces three guards before touching the remote:\n  1. The dir's quonfig.json \"workspace\" pin must match the backend (if set).\n  2. The dir's git origin must match the backend repo URL (if set).\n  3. A diff summary is shown; destructive changes (10+ deletes, >=25% of\n     files, or an unpinned dir) require typing the workspace slug to confirm.\n\n  qfg push                                 # uses QUONFIG_DIR + profile workspace\n  qfg push --dir ./our-config\n  qfg push --dir ./our-config --workspace acme-prod\n  qfg push --dir ./our-config --yes        # skip normal Y/N (never skips typed-slug)\n  qfg push --dir ./our-config --skip-validate",
+      "examples": [
+        "<%= config.bin %> push --dir ./our-config",
+        "<%= config.bin %> push --workspace acme-prod --dir ./our-config",
+        "<%= config.bin %> push --dir ./our-config --yes"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "interactive": {
+          "description": "Force interactive mode",
+          "helpGroup": "GLOBAL",
+          "name": "interactive",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "no-color": {
+          "description": "Do not colorize output",
+          "env": "NO_COLOR",
+          "helpGroup": "GLOBAL",
+          "name": "no-color",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "verbose": {
+          "description": "Verbose output",
+          "helpGroup": "GLOBAL",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "dir": {
+          "description": "Local directory to push (defaults to QUONFIG_DIR env var)",
+          "name": "dir",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "workspace": {
+          "description": "Workspace slug or UUID (defaults to active profile)",
+          "name": "workspace",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "yes": {
+          "description": "Skip the standard Y/N confirm. Never skips typed-slug prompts.",
+          "name": "yes",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "skip-validate": {
+          "description": "Skip `qfg validate` preflight",
+          "name": "skip-validate",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "no-pin-write": {
+          "description": "Do not offer to write workspace slug into quonfig.json on success",
+          "name": "no-pin-write",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "message": {
+          "char": "m",
+          "description": "Commit message for bare-path pushes (ignored on clone-path; push what is already committed)",
+          "name": "message",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "push",
+      "pluginAlias": "@quonfig/cli",
+      "pluginName": "@quonfig/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "push.js"
+      ]
+    },
     "schema": {
       "aliases": [],
       "args": {
@@ -2586,5 +2689,5 @@
       ]
     }
   },
-  "version": "0.0.15"
+  "version": "0.0.17"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "packageManager": "yarn@4.11.0+sha512.4e54aeace9141df2f0177c266b05ec50dc044638157dae128c471ba65994ac802122d7ab35bcd9e81641228b7dcf24867d28e750e0bcae8a05277d600008ad54",
   "name": "@quonfig/cli",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "bugs": {
     "url": "https://github.com/quonfig/cli/issues"
   },
@@ -32,6 +32,7 @@
     "lodash.camelcase": "^4.3.0",
     "mustache": "^4.2.0",
     "node-forge": "^1.4.0",
+    "typescript": "^5",
     "zod": "^4.1.12"
   },
   "description": "Quonfig CLI. For arbitrary targeting rules (email, plan, segment, custom property), run `qfg config-schema` then `qfg pull`.",
@@ -58,8 +59,7 @@
     "prettier": "^3.6.2",
     "shx": "^0.3.4",
     "ts-node": "^10.9.1",
-    "tsx": "^4.21.0",
-    "typescript": "^5"
+    "tsx": "^4.21.0"
   },
   "engines": {
     "node": ">=18.0.0"