Documentation menu

Commands

flog check typesEXPERIMENTAL

Experimental: This check may change before stabilization. It remains read-only and reports incomplete checks rather than guessing.

Run Stick's bounded type checker on one explicitly named TypeScript file.

Usage#

flog check types <file.ts> [--json]
flog check types --workspace <selector> [--json]

Examples#

flog check types src/value.ts
flog check types src/value.ts --json
flog check types --workspace apps/website
flog check types --workspace @example/library --json

Behaviour#

The file form reads only the named executable .ts file. The workspace form selects exactly one workspace and checks every regular executable .ts file below it in deterministic path order, excluding .d.ts, .git, and node_modules. An applicable symlink or unreadable source makes the workspace result incomplete rather than disappearing from coverage.

Each workspace file is parsed and checked independently. The command does not load TypeScript configuration, resolve imports or cross-file types, build a project program, or invoke tsc. The currently supported Stick slice checks annotated string, number, and boolean variable declarations initialized by matching literals or earlier supported bindings in the same file.

Human diagnostics use file:line:column. Single-file --json output retains its existing versioned report. Workspace JSON adds workspace identity, explicit coverage, aggregate completeness/cleanliness, and a deterministic result for every applicable file. Diagnostics retain exact byte spans and one-based line and UTF-16 column values.

Exit status 0 means every selected file was completely checked and clean. Fully completed checks with type errors exit 1 after writing all file results. If any file is unreadable, invalid, or unsupported, the command still reports every other file and then exits 5, so incomplete checking cannot look clean. Usage errors exit 2.

Run flog check types --help for complete current help.

flog check · Format