@zuke/tsc
`@zuke/tsc` — typed `tsc` task wrappers for Zuke builds.
@zuke/tsc on JSR ↗ 5 symbols
Symbols
class TscBaseSettings extends ToolSettings Shared base for tsc settings; resolves the tsc binary.
class TscBuildSettings extends TscBaseSettings Settings for a tsc --build project-references run.
| Member | Signature | Doc |
|---|---|---|
projects | projects(...values: PathLike[]): this | Project config files or directories to build (positional); repeatable. |
noEmit | noEmit(): this | Type-check without emitting output (--noEmit). tsc --build accepts the same compiler-option overrides as a plain compile, applied on top of each project's build; this is not inherited from TscBaseSettings — TscSettings.noEmit is a separate, unrelated field on the other subclass. |
clean | clean(): this | Delete the outputs of all projects (--clean). |
force | force(): this | Build all projects, even those that appear up to date (--force). |
dry | dry(): this | Show what would be built without building it (--dry). |
watch | watch(): this | Rebuild projects on file changes (--watch). |
verbose | verbose(): this | Print verbose logging about the build (--verbose). |
incremental | incremental(): this | Reuse prior build information for faster rebuilds (--incremental). |
class TscSettings extends TscBaseSettings Settings for a standard tsc run.
| Member | Signature | Doc |
|---|---|---|
paths | paths(...values: PathLike[]): this | Source files to compile (positional); repeatable. |
project | project(path: PathLike): this | Compile the project at the given config or directory (-p/--project). |
noEmit | noEmit(): this | Type-check without emitting output (--noEmit). |
outDir | outDir(path: PathLike): this | Directory for emitted files (--outDir). |
declaration | declaration(): this | Generate .d.ts declaration files (--declaration). |
emitDeclarationOnly | emitDeclarationOnly(): this | Emit declarations only, no JavaScript (--emitDeclarationOnly). |
incremental | incremental(): this | Reuse prior build information for faster rebuilds (--incremental). |
watch | watch(): this | Recompile on file changes (--watch). |
strict | strict(): this | Enable all strict type-checking options (--strict). |
pretty | pretty(): this | Colourise and format diagnostics (--pretty). |
listFiles | listFiles(): this | Print the names of files included in the compilation (--listFiles). |
skipLibCheck | skipLibCheck(): this | Skip type-checking of declaration files (--skipLibCheck). |
noEmitOnError | noEmitOnError(): this | Do not emit output if any errors are reported (--noEmitOnError). |
target | target(value: string): this | Target ECMAScript version, e.g. es2022 (--target). |
module | module(value: string): this | Module system, e.g. esnext, nodenext (--module). |
const TscTasks: TscTasksApi Typed task functions for the tsc TypeScript compiler.
interface TscTasksApi The shape of TscTasks.
| Member | Signature | Doc |
|---|---|---|
tsc | tsc(configure?: Configure<TscSettings>): Promise<CommandOutput> | Type-check (or compile) with tsc. |
build | build(configure?: Configure<TscBuildSettings>): Promise<CommandOutput> | Run a project-references build with tsc --build. |