Skip to content

feat: add and implement verbosity option to run step #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LorisRue merged 1 commit into from
May 20, 2026
Merged

feat: add and implement verbosity option to run step #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions src/template-engine/application/execute-template/steps/execute-run-step.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,37 @@ describe("executeRunStep", () => {
runCommand,
);

expect(runCommand).toHaveBeenCalledWith("npm", ["run", "build"], ".");
expect(runCommand).toHaveBeenCalledWith(
"npm",
["run", "build"],
".",
"all",
);
});

it("uses an empty args array when none are provided", async () => {
const runCommand = vi.fn().mockResolvedValue(undefined);

await executeRunStep({ type: "run", command: "echo" }, [], runCommand);

expect(runCommand).toHaveBeenCalledWith("echo", [], undefined);
expect(runCommand).toHaveBeenCalledWith("echo", [], undefined, "all");
});

it("throws an error for invalid verbosity levels", async () => {
const runCommand = vi.fn().mockResolvedValue(undefined);

await expect(
executeRunStep(
{
type: "run",
command: "echo",
verbosity: "{{verbosity}}",
},
[{ name: "verbosity", content: "invalid" }],
runCommand,
),
).rejects.toThrow(
'Invalid verbosity level "invalid" in step "undefined". Valid options are "all", "warning", or "none".',
);
});
});
14 changes: 13 additions & 1 deletion src/template-engine/application/execute-template/steps/execute-run-step.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import type { VariableValue } from "@/template-engine/domain/variable-value";
import type { RunStep } from "@/template-engine/domain";
import { replaceVariablesInString } from "../replace-variable-in-string";
import type { RunCommandPort } from "@/template-engine/domain/ports/run-command.port";
import { ProjgenError } from "@/shared";

export const executeRunStep = async (
step: RunStep,
Expand All @@ -15,5 +16,16 @@ export const executeRunStep = async (
? replaceVariablesInString(step.cwd, variables)
: undefined;

await runCommand(command, args, cwd);
const verbosity = replaceVariablesInString(
step.verbosity ?? "all",
variables,
);

if (!["all", "warning", "none"].includes(verbosity)) {
throw new ProjgenError(
`Invalid verbosity level "${verbosity}" in step "${step.name}". Valid options are "all", "warning", or "none".`,
);
}

await runCommand(command, args, cwd, verbosity as "all" | "warning" | "none");
};
7 changes: 6 additions & 1 deletion src/template-engine/domain/ports/run-command.port.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
export interface RunCommandPort {
(command: string, args: string[], cwd?: string): Promise<void>;
(
command: string,
args: string[],
cwd?: string,
verbosity?: "all" | "warning" | "none",
): Promise<void>;
}
1 change: 1 addition & 0 deletions src/template-engine/domain/schemas/steps/run-step.schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export const RunStepSchema = baseStepSchema.safeExtend({
command: z.string(), // The command to run (for example 'npm')
args: z.array(z.string()).optional(), // Arguments to pass to the command (for example ['install'])
cwd: z.string().optional(), // The directory to run the command in relative to the project root, if not provided it will run in the root of the project
verbosity: z.string().optional(), // The level of output to show from the command, defaults to "all"
});

export type RunStep = z.infer<typeof RunStepSchema>;
20 changes: 19 additions & 1 deletion src/template-engine/infrastructure/run-command.adapter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,27 @@ export const runCommandAdapter: RunCommandPort = async (
command: string,
args: string[],
cwd?: string,
verbosity?: "all" | "warning" | "none",
) => {
await new Promise<void>((resolve, reject) => {
const child = spawn(command, args, { cwd, stdio: "inherit" });
const child = spawn(command, args, {
cwd,
stdio: verbosity === "none" ? "ignore" : "pipe",
});

if (verbosity !== "none") {
if (verbosity === "all" && child.stdout) {
child.stdout.on("data", (chunk) => {
process.stdout.write(chunk);
});
}

if ((verbosity === "all" || verbosity === "warning") && child.stderr) {
child.stderr.on("data", (chunk) => {
process.stderr.write(chunk);
});
}
}

child.on("error", reject);

Expand Down
97 changes: 83 additions & 14 deletions template.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,12 @@
"type": "boolean"
}
},
"required": ["name", "message", "type", "required"],
"required": [
"name",
"message",
"type",
"required"
],
"additionalProperties": false
},
{
Expand All @@ -72,7 +77,12 @@
"type": "boolean"
}
},
"required": ["name", "message", "type", "required"],
"required": [
"name",
"message",
"type",
"required"
],
"additionalProperties": false
},
{
Expand All @@ -92,7 +102,11 @@
"type": "boolean"
}
},
"required": ["name", "message", "type"],
"required": [
"name",
"message",
"type"
],
"additionalProperties": false
},
{
Expand Down Expand Up @@ -128,7 +142,13 @@
]
}
},
"required": ["name", "message", "type", "required", "options"],
"required": [
"name",
"message",
"type",
"required",
"options"
],
"additionalProperties": false
},
{
Expand Down Expand Up @@ -164,7 +184,13 @@
]
}
},
"required": ["name", "message", "type", "required", "options"],
"required": [
"name",
"message",
"type",
"required",
"options"
],
"additionalProperties": false
}
]
Expand Down Expand Up @@ -210,7 +236,11 @@
"$ref": "#/$defs/__schema0"
}
},
"required": ["variable", "operator", "value"],
"required": [
"variable",
"operator",
"value"
],
"additionalProperties": false
}
},
Expand All @@ -234,9 +264,20 @@
},
"cwd": {
"type": "string"
},
"verbosity": {
"type": "string",
"enum": [
"all",
"warning",
"none"
]
}
},
"required": ["type", "command"],
"required": [
"type",
"command"
],
"additionalProperties": false
},
{
Expand Down Expand Up @@ -275,7 +316,11 @@
"$ref": "#/$defs/__schema0"
}
},
"required": ["variable", "operator", "value"],
"required": [
"variable",
"operator",
"value"
],
"additionalProperties": false
}
},
Expand All @@ -298,7 +343,10 @@
"type": "string"
}
},
"required": ["type", "path"],
"required": [
"type",
"path"
],
"additionalProperties": false
},
{
Expand Down Expand Up @@ -337,7 +385,11 @@
"$ref": "#/$defs/__schema0"
}
},
"required": ["variable", "operator", "value"],
"required": [
"variable",
"operator",
"value"
],
"additionalProperties": false
}
},
Expand Down Expand Up @@ -373,7 +425,11 @@
"type": "string"
}
},
"required": ["type", "path", "operation"],
"required": [
"type",
"path",
"operation"
],
"additionalProperties": false
},
{
Expand Down Expand Up @@ -412,7 +468,11 @@
"$ref": "#/$defs/__schema0"
}
},
"required": ["variable", "operator", "value"],
"required": [
"variable",
"operator",
"value"
],
"additionalProperties": false
}
},
Expand All @@ -430,7 +490,11 @@
},
"operation": {
"type": "string",
"enum": ["set", "append", "remove"]
"enum": [
"set",
"append",
"remove"
]
},
"jsonPath": {
"type": "array",
Expand All @@ -442,7 +506,12 @@
"$ref": "#/$defs/__schema0"
}
},
"required": ["type", "path", "operation", "jsonPath"],
"required": [
"type",
"path",
"operation",
"jsonPath"
],
"additionalProperties": false
}
]
Expand Down
Loading