@visualautomate/cli 0.6.0 → 0.6.1

package/README.md

@@ -77,6 +77,10 @@ Types: `string`, `number`, `boolean`, `select`, `multiselect`, `json`, `color`,
 `date`, `connection`, `file`, `path`, `paths`. A `select` or `multiselect` needs
 `--options`, and a `connection` needs `--provider <name>`.
 
+The same field is added to `visualautomate.test.json` under `config`, with its
+default or a value of the right shape, so the next `vsa test` passes something
+for it instead of nothing. A value you have already put there is kept.
+
 At the root of an app's repository, `--module <name>` says which one — the same
 short names `test` and `dev` take. The manifest is edited where it stands: your
 comments, the examples underneath and your own formatting stay as they are.

package/dist/index.js

@@ -3,7 +3,7 @@
 // src/index.ts
 import { mkdir as mkdir2, readFile as readFile3, writeFile as writeFile2 } from "node:fs/promises";
 import { existsSync as existsSync4, watch } from "node:fs";
-import { join as join4, relative as relative3, resolve as resolve3, sep as sep2 } from "node:path";
+import { basename as basename3, join as join4, relative as relative3, resolve as resolve3, sep as sep2 } from "node:path";
 import { createRequire } from "node:module";
 import { build, stop as stopBundler } from "esbuild";
 
@@ -2051,24 +2051,25 @@ function lastContent(bare, from, to) {
 function indented(value, indent, depth) {
   return JSON.stringify(value, null, indent.length === 1 ? "	" : indent.length).replace(/\{\s*"label": ("(?:[^"\\]|\\.)*"),\s*"value": ("(?:[^"\\]|\\.)*")\s*\}/g, '{ "label": $1, "value": $2 }').split("\n").map((line2, index) => index === 0 ? line2 : indent.repeat(depth) + line2).join("\n");
 }
-function withProperty(text, name, property) {
+function withMember(text, container, key, value) {
   const bare = stripJsonComments(text);
   const { object, members } = topLevelMembers(bare);
-  if (!object || object.end === -1) throw new Error("This manifest is not a JSON object.");
+  if (!object || object.end === -1) throw new Error("This file is not a JSON object.");
   const indent = indentOf(text);
-  const entry = `"${name}": ${indented(property, indent, 2)}`;
-  const existing = members.get("properties");
+  const entry = `"${key}": ${indented(value, indent, 2)}`;
+  const existing = members.get(container);
   let next;
   if (existing && bare[existing.start] === "{") {
     const last = lastContent(bare, existing.start, existing.end);
+    const oneLine = last !== -1 && !text.slice(existing.start, existing.end).includes("\n");
     next = last === -1 ? text.slice(0, existing.start + 1) + `
 ${indent.repeat(2)}${entry}
-${indent}` + text.slice(existing.end) : text.slice(0, last + 1) + `,
+${indent}` + text.slice(existing.end) : oneLine ? text.slice(0, last + 1) + `, "${key}": ${JSON.stringify(value)}` + text.slice(last + 1) : text.slice(0, last + 1) + `,
 ${indent.repeat(2)}${entry}` + text.slice(last + 1);
   } else if (existing) {
-    throw new Error('"properties" in this manifest is not an object, so nothing can be added to it.');
+    throw new Error(`"${container}" in this file is not an object, so nothing can be added to it.`);
   } else {
-    const block = `"properties": {
+    const block = `"${container}": {
 ${indent.repeat(2)}${entry}
 ${indent}}`;
     const last = lastContent(bare, object.start, object.end);
@@ -2078,14 +2079,35 @@ ${indent}${block}
 ${indent}${block}` + text.slice(last + 1);
   }
   const parsed = JSON.parse(stripJsonComments(next));
-  if (!parsed.properties || !(name in parsed.properties)) {
-    throw new Error("The property could not be placed in this manifest. Add it by hand, or say where this went wrong.");
+  if (!parsed[container] || !(key in parsed[container])) {
+    throw new Error(`${key} could not be placed in this file. Add it by hand, or say where this went wrong.`);
   }
   return next;
 }
-function hasProperty(text, name) {
+function hasMember(text, container, key) {
   const parsed = JSON.parse(stripJsonComments(text));
-  return Boolean(parsed.properties && typeof parsed.properties === "object" && name in parsed.properties);
+  const inside = parsed[container];
+  return Boolean(inside && typeof inside === "object" && !Array.isArray(inside) && key in inside);
+}
+function sampleFor(property) {
+  if ("default" in property) return property.default;
+  switch (property.type) {
+    case "number":
+      return 0;
+    case "boolean":
+      return false;
+    case "multiselect":
+    case "paths":
+      return [];
+    case "json":
+      return {};
+    case "select": {
+      const options = property.options;
+      return options?.[0]?.value ?? "";
+    }
+    default:
+      return "";
+  }
 }
 
 // src/project.ts
@@ -2497,7 +2519,7 @@ function runInDocker(run) {
 }
 
 // src/index.ts
-var VERSION = true ? "0.6.0" : "0.0.0-dev";
+var VERSION = true ? "0.6.1" : "0.0.0-dev";
 function fail(message) {
   console.error(red(message));
   throw new SilentExit();
@@ -2817,30 +2839,44 @@ Types: ${PROPERTY_TYPES.join(", ")}`
   const file2 = join4(target.dir, "manifest.json");
   if (!existsSync4(file2)) fail(`${target.name} has no manifest.json.`);
   const text = await readFile3(file2, "utf8");
-  if (hasProperty(text, name)) {
+  if (hasMember(text, "properties", name)) {
     fail(`${target.name} already has a property called ${name}. Change it in ${target.name}/manifest.json.`);
   }
+  let property;
   let next;
   try {
-    next = withProperty(
-      text,
+    property = buildProperty({
+      type,
       name,
-      buildProperty({
-        type,
-        name,
-        description,
-        value,
-        label: flags.label,
-        required: flags.required === "true",
-        options: flags.options,
-        provider: flags.provider
-      })
-    );
+      description,
+      value,
+      label: flags.label,
+      required: flags.required === "true",
+      options: flags.options,
+      provider: flags.provider
+    });
+    next = withMember(text, "properties", name, property);
   } catch (error) {
     fail(error instanceof Error ? error.message : String(error));
   }
   await writeFile2(file2, next, "utf8");
-  ok(green(`\u2713 Added ${name} to ${target.name}`));
+  const written = [`${target.name}/manifest.json`];
+  const testPath = TEST_FILES.map((name2) => join4(target.dir, name2)).find((path) => existsSync4(path)) ?? join4(target.dir, TEST_FILES[0]);
+  const sample = sampleFor(property);
+  try {
+    const before = existsSync4(testPath) ? await readFile3(testPath, "utf8") : `{
+  "config": {},
+  "input": {}
+}
+`;
+    if (!hasMember(before, "config", name)) {
+      await writeFile2(testPath, withMember(before, "config", name, sample), "utf8");
+      written.push(`${target.name}/${basename3(testPath)}`);
+    }
+  } catch (error) {
+    ok(yellow(`  ${basename3(testPath)} was left alone: ${error instanceof Error ? error.message : String(error)}`));
+  }
+  ok(green(`\u2713 Added ${name} to ${written.join(" and ")}`));
   ok(dim(`  Read it in your code as config.${name}`));
 }
 async function cmdDev(args, flags) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@visualautomate/cli",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Build and test VisualAutomate plugins.",
   "license": "MIT",
   "type": "module",