Skip to main content

Crate skif_cli

Crate skif_cli 

Source
Expand description

The skif command line as a library: a thin consumer of the skif library.

It is the only code that reads the environment, prints, prompts, writes files, spawns a process and opens a network connection (skif update only); run returns an exit code and no function below calls std::process::exit. The npm addon calls run; the binary calls run_to_exit, which also changes the current directory under bazel run and leaves the memory of a run to the operating system.

Structs§

CliError
A failure that stops skif from checking the repository.
LintCache
The cache of lint_to_json_cached, as a host’s options give it; each field left unset falls back to the environment (SKIF_CACHE, SKIF_CACHE_DIR, SKIF_CACHE_MAX_SIZE), then [cache] of the root configuration, then the defaults (on, 512 MiB, the default location).

Enums§

Kind
Machine-readable category of a failure.

Functions§

configure_global_pool
Builds rayon’s global pool, once per process, with 64 MiB stacks. The thread count still follows RAYON_NUM_THREADS. A host that built the global pool first keeps its own.
lint_to_json
Lints the workspace containing path, or with recursive every root at or below it, and returns the report as the JSON document skif --format json [-r] PATH prints, with overrides in place of the flags that set configuration.
lint_to_json_cached
Like lint_to_json, through the cache store of the command line (ADR 0007), on unless cache or the environment turns it off: the report is the same, and the run reads and writes the store as skif does, with the same location chain, size cap and rule for CI. A cache that cannot be read or written never fails the lint.
run
Runs the CLI with args (the first item is the program name, as in std::env::args_os) and returns the exit code. The npm addon calls this; the skif binary calls run_to_exit, which differs only in what happens to memory and in entering the bazel run directory; everything else is shared, so their behaviour cannot drift.
run_to_exit
Like run, for a process that exits as soon as this returns: the lint command leaves its diagnostics, workspace model and file caches to the operating system instead of freeing them one allocation at a time, a measurable part of a large run. Never call it from a long-lived host such as the npm addon: that memory would leak on every call.