-
Notifications
You must be signed in to change notification settings - Fork 167
Expand file tree
/
Copy pathpackage_json.rs
More file actions
204 lines (177 loc) · 6.15 KB
/
package_json.rs
File metadata and controls
204 lines (177 loc) · 6.15 KB
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
//! Package.json parsing utilities for Node.js version resolution.
//!
//! This module provides shared types for parsing `devEngines.runtime` and `engines.node`
//! fields from package.json, used across multiple crates for version resolution.
use serde::Deserialize;
use vite_str::Str;
/// A single runtime engine configuration.
#[derive(Deserialize, Default, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct RuntimeEngine {
/// The name of the runtime (e.g., "node", "deno", "bun")
#[serde(default)]
pub name: Str,
/// The version requirement (e.g., "^24.4.0")
#[serde(default)]
pub version: Str,
/// Action to take on failure (e.g., "download", "error", "warn")
/// Currently not used but parsed for future use.
#[serde(default)]
pub on_fail: Str,
}
/// Runtime field can be a single object or an array.
#[derive(Deserialize, Debug, Clone)]
#[serde(untagged)]
pub enum RuntimeEngineConfig {
/// A single runtime configuration
Single(RuntimeEngine),
/// Multiple runtime configurations
Multiple(Vec<RuntimeEngine>),
}
impl RuntimeEngineConfig {
/// Find the first runtime with the given name.
#[must_use]
pub fn find_by_name(&self, name: &str) -> Option<&RuntimeEngine> {
match self {
Self::Single(engine) if engine.name == name => Some(engine),
Self::Single(_) => None,
Self::Multiple(engines) => engines.iter().find(|e| e.name == name),
}
}
}
/// The devEngines section of package.json.
#[derive(Deserialize, Default, Debug, Clone)]
pub struct DevEngines {
/// Runtime configuration(s)
#[serde(default)]
pub runtime: Option<RuntimeEngineConfig>,
}
/// The engines section of package.json.
#[derive(Deserialize, Default, Debug, Clone)]
pub struct Engines {
/// Node.js version requirement (e.g., ">=20.0.0")
#[serde(default)]
pub node: Option<Str>,
}
/// Partial package.json structure for reading devEngines and engines.
#[derive(Deserialize, Default, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct PackageJson {
/// The package name
#[serde(default)]
pub name: Option<Str>,
/// The devEngines configuration
#[serde(default)]
pub dev_engines: Option<DevEngines>,
/// The engines configuration
#[serde(default)]
pub engines: Option<Engines>,
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_parse_single_runtime() {
let json = r#"{
"devEngines": {
"runtime": {
"name": "node",
"version": "^24.4.0",
"onFail": "download"
}
}
}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
let dev_engines = pkg.dev_engines.unwrap();
let runtime = dev_engines.runtime.unwrap();
let node = runtime.find_by_name("node").unwrap();
assert_eq!(node.name, "node");
assert_eq!(node.version, "^24.4.0");
assert_eq!(node.on_fail, "download");
assert!(runtime.find_by_name("deno").is_none());
}
#[test]
fn test_parse_multiple_runtimes() {
let json = r#"{
"devEngines": {
"runtime": [
{
"name": "node",
"version": "^24.4.0",
"onFail": "download"
},
{
"name": "deno",
"version": "^2.4.3",
"onFail": "download"
}
]
}
}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
let dev_engines = pkg.dev_engines.unwrap();
let runtime = dev_engines.runtime.unwrap();
let node = runtime.find_by_name("node").unwrap();
assert_eq!(node.name, "node");
assert_eq!(node.version, "^24.4.0");
let deno = runtime.find_by_name("deno").unwrap();
assert_eq!(deno.name, "deno");
assert_eq!(deno.version, "^2.4.3");
assert!(runtime.find_by_name("bun").is_none());
}
#[test]
fn test_parse_no_dev_engines() {
let json = r#"{"name": "test"}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
assert!(pkg.dev_engines.is_none());
}
#[test]
fn test_parse_empty_dev_engines() {
let json = r#"{"devEngines": {}}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
let dev_engines = pkg.dev_engines.unwrap();
assert!(dev_engines.runtime.is_none());
}
#[test]
fn test_parse_runtime_with_missing_fields() {
let json = r#"{
"devEngines": {
"runtime": {
"name": "node"
}
}
}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
let dev_engines = pkg.dev_engines.unwrap();
let runtime = dev_engines.runtime.unwrap();
let node = runtime.find_by_name("node").unwrap();
assert_eq!(node.name, "node");
assert!(node.version.is_empty());
assert!(node.on_fail.is_empty());
}
#[test]
fn test_parse_engines_node() {
let json = r#"{"engines":{"node":">=20.0.0"}}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
assert_eq!(pkg.engines.unwrap().node, Some(">=20.0.0".into()));
}
#[test]
fn test_parse_engines_node_empty() {
let json = r#"{"engines":{}}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
assert!(pkg.engines.unwrap().node.is_none());
}
#[test]
fn test_parse_both_engines_and_dev_engines() {
let json = r#"{
"engines": {"node": ">=20.0.0"},
"devEngines": {"runtime": {"name": "node", "version": "^24.4.0"}}
}"#;
let pkg: PackageJson = serde_json::from_str(json).unwrap();
assert_eq!(pkg.engines.unwrap().node, Some(">=20.0.0".into()));
let dev_engines = pkg.dev_engines.unwrap();
let runtime = dev_engines.runtime.unwrap();
let node = runtime.find_by_name("node").unwrap();
assert_eq!(node.version, "^24.4.0");
}
}