Skip to main content

GithubActionsEcosystem

Struct GithubActionsEcosystem 

pub struct GithubActionsEcosystem { /* private fields */ }
Expand description

GitHub Actions ecosystem implementation.

Provides LSP functionality for .github/workflows/*.yml/*.yaml files, including:

  • Dependency parsing with position tracking (see parser module docs for the pin contract)
  • Version information from the GitHub tags API
  • Inlay hints, hover, completions, diagnostics, and code actions/lenses via the shared deps_core::lsp_helpers machinery

Implementations§

§

impl GithubActionsEcosystem

pub fn new(cache: Arc<HttpCache>) -> GithubActionsEcosystem

Creates a new GitHub Actions ecosystem with the given HTTP cache.

Trait Implementations§

§

impl Ecosystem for GithubActionsEcosystem

§

fn manifest_directory_patterns(&self) -> &[(&'static str, &'static str)]

GHA declares no fixed filename or extension — it is routed solely by directory path (D1): a .github/workflows/*.yml/*.yaml file, regardless of how many ancestor directories precede .github.

§

fn generate_diagnostics<'a>( &'a self, parse_result: &'a dyn ParseResult, versions: VersionData<'a>, uri: &'a Uri, freshness: FreshnessSettings, severities: DiagnosticSeverities, ) -> Pin<Box<dyn Future<Output = Vec<Diagnostic>> + Send + 'a>>

Appends the mutable-ref-pin diagnostic (issue #473) to the shared default’s output, one per PinStyle::Tag step — an additive, independent signal from the outdated-version diagnostic the shared default already computes (spec 031 NFR-004: this override never changes that behavior, only appends to it).

Gated on severities.mutable_ref_pin_enabled (spec 031 FR-009, corrected during implementation review): severities.mutable_ref_pin alone cannot silence this diagnostic, since DiagnosticSeverity has no suppression value.

§

fn generate_code_actions<'a>( &'a self, parse_result: &'a dyn ParseResult, position: Position, uri: &'a Uri, versions: VersionData<'a>, content: &'a str, ) -> Pin<Box<dyn Future<Output = Vec<CodeAction>> + Send + 'a>>

Appends the “Pin to commit SHA” quickfix (issue #473) to the shared default’s output when the position’s dependency is a PinStyle::Tag step with a resolvable TagIndex entry.

§

fn generate_hover<'a>( &'a self, parse_result: &'a dyn ParseResult, position: Position, versions: VersionData<'a>, freshness: FreshnessSettings, ) -> Pin<Box<dyn Future<Output = Option<Hover>> + Send + 'a>>

One documented NFR-004 divergence (S3): appends a **Resolved** line naming the tag a SHA pin’s commit actually corresponds to, per crate::registry::GithubActionsRegistry’s [crate::registry::TagIndex].

Necessary, not merely additive: versions.resolved (the shared helper’s **Current** source) is keyed by package name and is unconditionally empty for GHA (no lockfile provider), so it cannot express per-occurrence resolution when the same action is pinned at two different SHAs in one workflow. The splice also makes a stale or hand-edited # vX.Y.Z comment visible for free (M4): the tag shown here comes from TagIndex.sha_to_tag, not from trusting the comment text.

Scoped to [PinStyle::Sha] only — the SHA is the one pin form GitHub itself does not render as a readable version, so it is the only form where naming the tag it resolves to adds information; a PinStyle::Tag pin already shows the tag text directly. Guarded on dep.version_range().is_some() (N3): a non-resolvable dependency (a reusable-workflow call, ./local, docker://…) still matches the shared helper’s own hover-target predicate and must not have a **Resolved** line spliced onto it.

§

fn id(&self) -> &'static str

Unique identifier (e.g., “cargo”, “npm”, “pypi”) Read more
§

fn display_name(&self) -> &'static str

Human-readable name (e.g., “Cargo (Rust)”, “npm (JavaScript)”) Read more
§

fn manifest_filenames(&self) -> &[&'static str]

Manifest filenames this ecosystem handles (e.g., [“Cargo.toml”]) Read more
§

fn lockfile_filenames(&self) -> &[&'static str]

Lock file filenames this ecosystem uses (e.g., [“Cargo.lock”]) Read more
§

fn parse_manifest<'a>( &'a self, content: &'a str, uri: &'a Uri, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn ParseResult>, DepsError>> + Send + 'a>>

Parse a manifest file and return parsed result Read more
§

fn registry(&self) -> Arc<dyn Registry>

Get the registry client for this ecosystem Read more
§

fn formatter(&self) -> &dyn EcosystemFormatter

Get the ecosystem-specific formatter for LSP response generation. Read more
§

fn generate_completions<'a>( &'a self, parse_result: &'a dyn ParseResult, position: Position, content: &'a str, freshness: FreshnessSettings, ) -> Pin<Box<dyn Future<Output = Completions> + Send + 'a>>

Generate completions for a position. Read more
§

fn as_any(&self) -> &(dyn Any + 'static)

Support for downcasting to concrete ecosystem type Read more
Source§

fn manifest_extensions(&self) -> &[&'static str]

File extensions this ecosystem handles when the manifest basename is not fixed (e.g. [".csproj", ".fsproj"] for NuGet project files). Read more
Source§

fn manifest_patterns(&self) -> &[&'static str]

Basename glob patterns this ecosystem handles, each containing exactly one * wildcard (e.g. ["requirements*.txt"]). Read more
Source§

fn watched_config_filenames(&self) -> &[&'static str]

Non-lockfile config filenames this ecosystem resolves during Self::parse_manifest (e.g. ["pnpm-workspace.yaml", ".npmrc"] for npm’s catalog and registry resolution), whose values end up baked into a manifest’s ParseResult rather than looked up separately the way a Self::lockfile_provider is. Read more
Source§

fn lockfile_provider(&self) -> Option<Arc<dyn LockFileProvider>>

Get the lock file provider for this ecosystem. Read more
Source§

fn generate_inlay_hints<'a>( &'a self, parse_result: &'a dyn ParseResult, versions: VersionData<'a>, loading_state: LoadingState, config: &'a EcosystemConfig, ) -> Pin<Box<dyn Future<Output = Vec<InlayHint>> + Send + 'a>>

Generate inlay hints for the document. Read more
Generate textDocument/documentLink targets for the document. Read more
Source§

fn generate_code_lenses<'a>( &'a self, parse_result: &'a dyn ParseResult, content: &'a str, versions: VersionData<'a>, uri: &'a Uri, command_id: &'a str, ) -> Pin<Box<dyn Future<Output = Vec<CodeLens>> + Send + 'a>>

Generate the “Update N outdated dependencies” code lens for the document. Read more
Source§

fn package_search_is_incomplete(&self) -> bool

Whether this ecosystem’s package-name search may return a truncated view of a larger candidate set (see e.g. PypiRegistry::search’s doc comment). Read more
§

impl Sealed for GithubActionsEcosystem

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more