Skip to content

The IDE you know, rebuilt in Rust. IntelliJ IDEA–style keymap, tool windows and search-everywhere in a fast native app: editor, code insight, debugger, Git, terminal, database and HTTP clients for 60+ languages.

1.7 KB
Raw Blame
//! Manifest dependencies and repository versions, independent of editor and transport.
mod cache;
pub mod cargo;
pub mod go;

pub use cache::VersionCache;
use ide_core::{CancellationToken, IdeResult};
use serde::{Deserialize, Serialize};
use specta::Type;

/// A repository adapter; Maven/npm can use the same cache and editor protocol.
pub trait DependencyVersionSource: Send + Sync {
    /// A filesystem-safe, stable repository identifier.
    fn id(&self) -> &'static str;
    /// Override for case-sensitive module paths or project-specific repositories.
    fn cache_key(&self, package: &str) -> Option<String> {
        let safe = |s: &str| !s.is_empty() && s.bytes().all(|b| b.is_ascii_alphanumeric() || b"-_".contains(&b));
        let id = self.id();
        (safe(id) && safe(package) && package.len() <= 64).then(|| format!("{id}-{}", package.to_ascii_lowercase()))
    }
    /// Non-yanked versions in descending semantic order.
    fn fetch(&self, package: &str, cancel: &CancellationToken) -> IdeResult<Vec<String>>;
}

#[derive(Clone, Debug, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct DependencyUpdate {
    pub latest: String,
    pub replacement: String,
}

#[derive(Clone, Debug, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct ManifestDependency {
    pub package: String,
    pub requirement: String,
    /// UTF-16 offsets of the string's contents (quotes excluded).
    pub from: u32,
    pub to: u32,
}

#[derive(Clone, Debug, Serialize, Deserialize, Type)]
#[serde(rename_all = "camelCase")]
pub struct DependencyVersions {
    pub dependency: ManifestDependency,
    pub versions: Vec<String>,
    pub update: Option<DependencyUpdate>,
}