Skip to content

GateOptions

Options for gate.

Import:

import type { GateOptions } from 'obsidian-dev-utils/script-utils/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: integration runs have to be serialized across the whole set of sibling repositories, so a gate that always ran them would collide with another session's run.

Links to this page: