Enum ScopeReason 

pub enum ScopeReason {
    Diff,
    ChangedSince,
    PackageBaselines,
    ChangedFiles,
    Workspace,
    ChangedWorkspaces,
    Scope,
    File,
    IssueTypeFilter,
    Production,
    IncludeEntryExports,
}

One channel that narrowed a run to part of the project.

Serialized as kebab-case inside scope_reasons and published as an OPEN set, the same tolerate-unknown contract gate_outcomes keys carry: a name this build does not emit means “some narrowing”, not an error.

Which names a command can emit differs per command, because the three narrowing predicates see different state. dead-code reads the flags themselves and can name every channel. dupes and health see an already resolved changed-file set and report changed-files, because at that point the flag that produced it is gone. health reports workspace for both --workspace and --changed-workspaces for the same reason. A consumer must therefore not assume a given command emits a given name.

Variants

Diff

A diff index reached the analysis, from --diff-file, --diff-stdin, FALLOW_DIFF_FILE or the shared index a CI format installs.

ChangedSince

--changed-since.

PackageBaselines

The per-package refs of workspaces.changedSince in the config. --no-package-baselines turns them off for one run.

ChangedFiles

A resolved changed-file set, on the commands that see the set rather than the flag that produced it.

Workspace

--workspace. On health this also covers --changed-workspaces, which it cannot distinguish.

ChangedWorkspaces

--changed-workspaces.

Scope

--scope.

File

One or more --file.

IssueTypeFilter

An active issue-type filter such as --unused-exports, which drops whole baseline categories before the comparison.

Production

Production mode, from the flag or the resolved project config. It drops test, story and dev files at discovery.

IncludeEntryExports

--include-entry-exports or the includeEntryExports config key. It changes which exports unused-exports reports, so the run judges a different export surface than a run without it.

Implementations

impl ScopeReason

pub const fn as_str(self) -> &'static str

The kebab-case name this reason serializes as, for prose that has to name it outside the JSON envelope.

pub const fn is_removable_by_rerun(self) -> bool

Whether repeating the run without this channel judges the same project.

A channel the caller added for one run, a diff, a base ref, a path or an issue-type filter, is removable: dropping it widens the run to the whole project, which is exactly what judging a whole-project baseline needs. Production mode and workspace scoping are the caller’s own statement about what the project is, and they resolve from the project config and the environment as well as from a flag, so repeating the command without the flag analyzes something nobody asked about and, on the config and environment routes, is not even narrower. The package map is the one config channel that is removable: --no-package-baselines turns it off for the repeated run.

This is the rule the GitHub Action and the GitLab template already apply before re-reading a baseline unscoped, and the one the scope_reasons documentation states.

Trait Implementations

impl Clone for ScopeReason

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ScopeReason

impl Debug for ScopeReason

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScopeReason

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ScopeReason

impl From<ScopeReason> for FindingIdQueryReason

fn from(reason: ScopeReason) -> Self

Converts to this type from the input type.

impl Ord for ScopeReason

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ScopeReason

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for ScopeReason

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ScopeReason

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScopeReason