daipendency-extractor 1.3.0

Core library for Daipendency extractors
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

use thiserror::Error;

/// Metadata about a library.
///
/// The metadata is typically extracted from a library's manifest file (e.g., `package.json`, `Cargo.toml`).
#[derive(Debug)]
pub struct LibraryMetadata<EntryPoint> {
    /// The name of the library as specified in its manifest
    pub name: String,

    /// The version of the library, if specified in its manifest
    pub version: Option<String>,

    /// Documentation string for the library, typically extracted from its manifest or documentation files
    pub documentation: String,

    /// The entry point(s) for the library.
    ///
    /// Whilst this is typically a single path (e.g. Rust's `src/lib.rs`), some languages/frameworks
    /// may have multiple entry points, such as TypeScript's `exports` directive in `package.json`.
    pub entry_point: EntryPoint,
}

#[derive(Error, Debug)]
pub enum LibraryMetadataError {
    #[error(transparent)]
    MissingManifest(#[from] std::io::Error),
    #[error("{0}")]
    MalformedManifest(String),
}