development · Command reference

`qzx scaffoldTypescript`

What it does

Creates a basic scaffolding for a TypeScript program

Canonical command: scaffoldTypescript

Accepted aliases: tsScaff, newTs, createTs, makeScaffProgramTypescript

Case-sensitive: no

Included in the published package

Available in PyPI 0.2.2.0.2. This page documents the 0.2.2.0.2 alpha development checkout.

Safety and effects

Can mutate state

No documented dry-run parameter

No native program invocation in the current classification

No documented network use

No inherent elevation requirement

This safety classification was reviewed against implementation digest sha256:cd00644fbc38206dd01cc138f3f914ac1e08d44b83ed73d64e58da3636e7a383 on 2026-07-24.

Exact syntax

qzx scaffoldTypescript <project_name> [path] [with_tests] --json

Parameters

Name	Type	Required	Default	Description
project_name	str	Yes	Not declared	Name of the TypeScript project to create
path	str	No	"."	Path where to create the project (default: current directory)
with_tests	str	No	"true"	Whether to include test scaffolding (jest & ts-jest)

Input examples

qzx makeScaffProgramTypescript my_ts_project

Creates a new TypeScript project named "my_ts_project" in the current directory

qzx tsScaff backend_api_ts /path/to/dir true

Creates a new TypeScript project with Jest/ts-jest tests in the specified directory

For the complete structured payload, add --json: qzx scaffoldTypescript <project_name> [path] [with_tests] --json

Representative output example

This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.

Example command: qzx makeScaffProgramTypescript my_ts_project --json

{
    "success": true,
    "message": "Creates a basic scaffolding for a TypeScript program. In this illustrative example, the command completed successfully.",
    "project_name": "Example value"
}

View the JSON result contract

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "type": "object",
    "required": [
        "success",
        "message"
    ],
    "properties": {
        "success": {
            "type": "boolean"
        },
        "message": {
            "type": "string"
        },
        "error": {
            "type": "string"
        },
        "project_name": []
    },
    "additionalProperties": true
}

Errors and limits

The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.

QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.

Evidence workflow: requires an isolated disposable target.

Evidence and provenance

Implementation: src/qzx/commands/development/scaffold_typescript.py
Tests: No command-specific test file with the same module name was found; this does not prove that all coverage is absent.
Documentation channel: Development documentation 0.2.2.0.2 · main · sha256:319b16857a87636ebc3b89734cc040a737bb56194464fca33ce73bdae2043096
Availability: 0.2.2.0.2 or earlier

Keep exploring

These commands also belong to the development category. Compare them to choose the operation that best fits your task.

Explore all QZX commands