fix(cli): add --vars refuses a value of the wrong type instead of writing it (#4369)

* fix(cli): add --vars refuses a value of the wrong type instead of writing it

* fix(cli): a refused --vars writes none of the item's dependencies either

* fix(cli): keep a file edited while add was still downloading the rest of the plan

* style(cli): shorten the --vars refusal comment
This commit is contained in:
Miguel Ángel
2026-09-23 19:29:16 -04:00
committed by GitHub
parent 29fc95395d
commit 0aa3cb82aa
7 changed files with 245 additions and 75 deletions
+23 -21
View File
@@ -16,7 +16,11 @@
* silently discarded for every component in the catalog.
*/
import { isCompositionVariable, type CompositionVariable } from "@hyperframes/core/variables";
import {
isCompositionVariable,
validateVariables,
type CompositionVariable,
} from "@hyperframes/core/variables";
export interface ApplyResult {
/** The source with defaults rewritten. Unchanged when nothing applied. */
@@ -29,6 +33,14 @@ export interface ApplyResult {
invalid: { id: string; reason: string }[];
}
/** `--vars` values the item's declaration cannot take; the install writes nothing. */
export class InvalidVariableValuesError extends Error {
constructor(readonly invalid: { id: string; reason: string }[]) {
super(`--vars refused: ${invalid.map(({ id, reason }) => `${id}: ${reason}`).join("; ")}`);
this.name = "InvalidVariableValuesError";
}
}
const ATTR = "data-composition-variables";
/** Locate the attribute's quoted value, tolerating either delimiter. */
@@ -52,23 +64,6 @@ function encode(json: string, quote: string): string {
return quote === "'" ? json.replace(/'/g, "'") : json.replace(/"/g, """);
}
function optionValues(decl: CompositionVariable): string[] | null {
return decl.type === "enum" ? decl.options.map((option) => option.value) : null;
}
/**
* Reject a value the declaration cannot represent, rather than writing it.
*
* A bad enum falls back to the default at runtime and warns, so writing one
* here would produce a file that renders as if the value had been ignored --
* which is the exact failure this function exists to remove.
*/
function rejectEnum(decl: CompositionVariable, value: unknown): string | null {
const options = optionValues(decl);
if (!options) return null;
return options.includes(String(value)) ? null : `not one of ${options.join(", ")}`;
}
function rejectNumber(decl: CompositionVariable, value: unknown): string | null {
if (decl.type !== "number") return null;
const n = typeof value === "number" ? value : Number(value);
@@ -78,8 +73,15 @@ function rejectNumber(decl: CompositionVariable, value: unknown): string | null
return null;
}
// Refuse what the runtime would ignore. Numbers keep their own check (string input, min/max);
// every other type goes through the runtime's validator.
function reject(decl: CompositionVariable, value: unknown): string | null {
return rejectEnum(decl, value) ?? rejectNumber(decl, value);
if (decl.type === "number") return rejectNumber(decl, value);
const [issue] = validateVariables({ [decl.id]: value }, [decl]);
if (!issue) return null;
if (issue.kind === "enum-out-of-range") return `not one of ${issue.allowed.join(", ")}`;
if (issue.kind === "type-mismatch") return `expected ${issue.expected}, got ${issue.actual}`;
return null;
}
export function applyVariableDefaults(
@@ -116,7 +118,7 @@ export function applyVariableDefaults(
const applied: string[] = [];
const invalid: { id: string; reason: string }[] = [];
const byId = new Map(declared.map((decl) => [decl.id, decl]));
const updated = new Map<string, string | number>();
const updated = new Map<string, unknown>();
for (const [id, value] of Object.entries(values)) {
const decl = byId.get(id);
@@ -129,7 +131,7 @@ export function applyVariableDefaults(
// The declaration's own type decides how the value is stored. A number
// written as the string "76" would trip the composition's guard and fall
// back, which looks exactly like the value being ignored.
updated.set(id, decl.type === "number" ? Number(value) : String(value));
updated.set(id, decl.type === "number" ? Number(value) : value);
applied.push(id);
}