Skip to content

GateOptions

Options for gate.

Import:

import type { GateOptions } from '@mnaoumov/typescript-dev-toolkit/gate';

Signature:

export interface GateOptions

Properties

PropertyTypeDescription
shouldBuild?booleanWhether to run the build. The build is not a verification check — it is kept in the gate because it is the only step that type-checks the project, and a green lint is not a type-check.
shouldRunChecks?booleanWhether to run the verification checks. When false, only the build runs, which is what npm run version -- --no-checks does.
shouldRunIntegrationTests?booleanWhether to run the integration test suite. Off by default, on two reasons that are about COST rather than about contention — desktop runs stopped contending in obsidian-integration-testing 5.0.0, which gives every run its own user-data dir and CDP port, and the Android emulator that is still shared is serialized by that package's own android setup lock, which waits rather than failing.

The reasons that do hold: test:integration is the one preflight step reachable by a routine command of its own, unlike the four this gate exists for; and in a project whose suite includes an Android test it boots an AVD and an Appium server, then queues behind any other Android run for up to that lock's hour-long acquisition timeout. A command whose whole selling point is answering in seconds must not start one unasked. The release path opts in, so nothing is skipped before a publish.

Links to this page: