nodejs_package_json 0.4.9

Shapes for Node.js package.json.
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use semver::Version;
use serde::Deserialize;
use std::fmt;
use std::path::PathBuf;
use std::str::FromStr;
use thiserror::Error;

#[derive(Debug, Error)]
#[cfg_attr(feature = "miette", derive(miette::Diagnostic))]
pub enum WorkspaceProtocolError {
    #[error("Star workspace (workspace:*) does not support versions.")]
    #[cfg_attr(
        feature = "miette",
        diagnostic(code(package_json::workspace::no_version_with_star))
    )]
    StarNoVersion,

    #[error("Failed to parse version: {0}")]
    #[cfg_attr(
        feature = "miette",
        diagnostic(code(package_json::workspace::invalid_version))
    )]
    Semver(#[from] semver::Error),
}

#[derive(Clone, Debug, Deserialize, PartialEq)]
#[cfg_attr(feature = "serialize", derive(serde::Serialize))]
#[serde(untagged, try_from = "String", into = "String")]
pub enum WorkspaceProtocol {
    // *
    Any {
        alias: Option<String>,
    },
    // ~
    Tilde {
        alias: Option<String>,
        version: Option<Version>,
    },
    // ^
    Caret {
        alias: Option<String>,
        version: Option<Version>,
    },
    // ../file
    File(PathBuf),
    // 1.2.3
    Version(Version),
}

impl WorkspaceProtocol {
    pub fn parse(value: impl AsRef<str>) -> Result<Self, WorkspaceProtocolError> {
        Self::from_str(value.as_ref())
    }
}

impl FromStr for WorkspaceProtocol {
    type Err = WorkspaceProtocolError;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        let mut alias = None;
        let mut value = value.trim();

        // https://pnpm.io/workspaces#referencing-workspace-packages-through-aliases
        if let Some(index) = value.rfind('@') {
            alias = Some(value[0..index].to_owned());
            value = &value[index + 1..];
        }

        if value.is_empty() {
            return Ok(WorkspaceProtocol::Any { alias });
        }

        match &value[0..1] {
            "*" => {
                if value.len() != 1 {
                    return Err(WorkspaceProtocolError::StarNoVersion);
                }

                return Ok(WorkspaceProtocol::Any { alias });
            }
            "^" | "~" => {
                let mut version = None;

                if value.len() > 1 {
                    version = Some(Version::parse(&value[1..])?);
                }

                if value.starts_with('^') {
                    return Ok(WorkspaceProtocol::Caret { alias, version });
                } else {
                    return Ok(WorkspaceProtocol::Tilde { alias, version });
                }
            }
            "." | "/" => {
                return Ok(WorkspaceProtocol::File(PathBuf::from(value)));
            }
            _ => {}
        };

        Ok(WorkspaceProtocol::Version(Version::parse(value)?))
    }
}

impl TryFrom<String> for WorkspaceProtocol {
    type Error = WorkspaceProtocolError;

    fn try_from(value: String) -> Result<Self, Self::Error> {
        Self::from_str(&value)
    }
}

impl From<WorkspaceProtocol> for String {
    fn from(value: WorkspaceProtocol) -> String {
        value.to_string()
    }
}

fn format_variant(prefix: char, alias: Option<&String>, version: Option<&Version>) -> String {
    let mut result = format!("{prefix}");

    if let Some(alias) = alias {
        result = format!("{alias}@{result}");
    }

    if let Some(version) = version {
        result.push_str(&version.to_string());
    }

    result
}

impl fmt::Display for WorkspaceProtocol {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}",
            match self {
                WorkspaceProtocol::Any { alias } => format_variant('*', alias.as_ref(), None),
                WorkspaceProtocol::Tilde { alias, version } =>
                    format_variant('~', alias.as_ref(), version.as_ref()),
                WorkspaceProtocol::Caret { alias, version } =>
                    format_variant('^', alias.as_ref(), version.as_ref()),
                WorkspaceProtocol::File(path) => path.display().to_string(),
                WorkspaceProtocol::Version(ver) => ver.to_string(),
            }
        )
    }
}