Skip to content

SkippedPathCheck ​

A declared flag.path() / arg.path() check that resolution had no means to run.

Recorded instead of raised when ResolveOptions.pathChecks is 'lenient' (the default): the value resolved and the handler ran, but the filesystem was never consulted, so a passing result does not prove the real CLI would accept the same path.

Signatures ​

ts
interface SkippedPathCheck {}

Members ​

Properties ​

checks ​

The checks the schema declared (mustExist, type, create).

ts
checks: PathChecks;

kind ​

Whether the path belongs to a flag or a positional arg.

ts
kind: "flag" | "arg";

missing ​

The capability resolution lacked: 'stat' when no probe was supplied so no check ran, or 'mkdir' when the path was missing, create was declared, and nothing could create it.

ts
missing: "stat" | "mkdir";

name ​

Name of the flag or arg.

ts
name: string;

See Also ​

Released under the MIT License.