Struct NpmDependency 

pub struct NpmDependency {
    pub name: PackageName,
    pub name_range: Range,
    pub version_req: Option<VersionReq>,
    pub version_range: Option<Range>,
    pub section: NpmDependencySection,
    pub source: DependencySource,
    pub catalog: Option<CatalogOrigin>,
}

Parsed dependency from package.json with position tracking.

Stores all information about a dependency declaration, including its name, version requirement, and source positions for LSP operations. Positions are critical for features like hover, completion, and inlay hints.

Examples

use deps_npm::types::{NpmDependency, NpmDependencySection};
use tower_lsp_server::ls_types::{Position, Range};

let dep = NpmDependency {
    name: "express".into(),
    name_range: Range::new(Position::new(5, 4), Position::new(5, 13)),
    version_req: Some("^4.18.2".into()),
    version_range: Some(Range::new(Position::new(5, 16), Position::new(5, 25))),
    section: NpmDependencySection::Dependencies,
    source: deps_core::parser::DependencySource::Registry,
    catalog: None,
};

assert_eq!(dep.name, "express");
assert!(matches!(dep.section, NpmDependencySection::Dependencies));

Fields

name: PackageName

name_range: Range

version_req: Option<VersionReq>

version_range: Option<Range>

section: NpmDependencySection

source: DependencySource

Resolved by .npmrc lookup (spec 032-npm-npmrc-registry-support) — Registry (the public default) unless a registry=/@scope:registry= entry applies.

catalog: Option<CatalogOrigin>

Some when version_req (before/after resolution) came from a pnpm catalog:/catalog:<name> specifier (spec 046-pnpm-catalogs); None for every ordinary literal-range dependency.

Trait Implementations

impl Clone for NpmDependency

fn clone(&self) -> NpmDependency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NpmDependency

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

Formats the value using the given formatter.

impl Dependency for NpmDependency

fn name(&self) -> &PackageName

Package name

fn name_range(&self) -> Range

LSP range of the dependency name

fn version_requirement(&self) -> Option<&VersionReq>

Version requirement string (e.g., “^1.0”, “>=2.0”)

fn version_range(&self) -> Option<Range>

LSP range of the version string

fn source(&self) -> DependencySource

Dependency source (registry, git, path)

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

Downcast to concrete type

fn features(&self) -> &[String]

Feature flags (ecosystem-specific, empty if not supported)

fn features_range(&self) -> Option<Range>

LSP range of the features array (ecosystem-specific, None if not supported)

fn markers(&self) -> Option<&str>

Environment marker expression gating this dependency (e.g. PEP 508’s python_version >= '3.8'). Ecosystem-specific, None if not supported or not present on this dependency.

fn markers_range(&self) -> Option<Range>

LSP range of the environment marker expression (ecosystem-specific, None if not supported or not present).

fn version_literal(&self) -> Option<&str>

The raw manifest text spanned by version_range, when it differs from version_requirement.

impl Eq for NpmDependency

impl PartialEq for NpmDependency

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NpmDependency