-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
mod.rs
448 lines (393 loc) · 15.1 KB
/
mod.rs
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
mod npm;
mod pnpm;
mod yarn;
use std::{
fmt, fs,
path::{Path, PathBuf},
};
use anyhow::{anyhow, Result};
use itertools::Itertools;
use regex::Regex;
use serde::{Deserialize, Serialize};
use turbopath::AbsoluteSystemPathBuf;
use crate::{
commands::CommandBase,
package_json::PackageJson,
package_manager::{npm::NpmDetector, pnpm::PnpmDetector, yarn::YarnDetector},
ui::UNDERLINE,
};
#[derive(Debug, Deserialize)]
struct PnpmWorkspace {
pub packages: Vec<String>,
}
#[derive(Debug, Deserialize)]
struct PackageJsonWorkspaces {
workspaces: Workspaces,
}
#[derive(Debug, Deserialize, PartialEq, Eq, Clone)]
#[serde(untagged)]
enum Workspaces {
TopLevel(Vec<String>),
Nested { packages: Vec<String> },
}
impl AsRef<[String]> for Workspaces {
fn as_ref(&self) -> &[String] {
match self {
Workspaces::TopLevel(packages) => packages.as_slice(),
Workspaces::Nested { packages } => packages.as_slice(),
}
}
}
impl From<Workspaces> for Vec<String> {
fn from(value: Workspaces) -> Self {
match value {
Workspaces::TopLevel(packages) => packages,
Workspaces::Nested { packages } => packages,
}
}
}
#[derive(Debug, Serialize, PartialEq, Eq, Clone)]
#[serde(rename_all = "lowercase")]
pub enum PackageManager {
Berry,
Npm,
Pnpm,
Pnpm6,
Yarn,
}
impl fmt::Display for PackageManager {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
// Do not change these without also changing `GetPackageManager` in
// packagemanager.go
match self {
PackageManager::Berry => write!(f, "berry"),
PackageManager::Npm => write!(f, "npm"),
PackageManager::Pnpm => write!(f, "pnpm"),
PackageManager::Pnpm6 => write!(f, "pnpm6"),
PackageManager::Yarn => write!(f, "yarn"),
}
}
}
#[derive(Debug)]
pub struct Globs {
pub inclusions: Vec<String>,
pub exclusions: Vec<String>,
}
impl Globs {
pub fn test(&self, root: PathBuf, target: PathBuf) -> Result<bool> {
let search_value = target
.strip_prefix(root)?
.to_str()
.ok_or_else(|| anyhow!("The relative path is not UTF8."))?;
let includes = &self
.inclusions
.iter()
.any(|inclusion| glob_match::glob_match(inclusion, search_value));
let excludes = &self
.exclusions
.iter()
.any(|exclusion| glob_match::glob_match(exclusion, search_value));
Ok(*includes && !*excludes)
}
}
impl PackageManager {
/// Returns a list of globs for the package workspace.
/// NOTE: We return a `Vec<PathBuf>` instead of a `GlobSet` because we
/// may need to iterate through these globs and a `GlobSet` doesn't allow
/// that.
///
/// # Arguments
///
/// * `root_path`:
///
/// returns: Result<Option<Globs>, Error>
///
/// # Examples
///
/// ```
/// ```
pub fn get_workspace_globs(&self, root_path: &Path) -> Result<Option<Globs>> {
let globs = match self {
PackageManager::Pnpm | PackageManager::Pnpm6 => {
let workspace_yaml = fs::read_to_string(root_path.join("pnpm-workspace.yaml"))?;
let pnpm_workspace: PnpmWorkspace = serde_yaml::from_str(&workspace_yaml)?;
if pnpm_workspace.packages.is_empty() {
return Ok(None);
} else {
pnpm_workspace.packages
}
}
PackageManager::Berry | PackageManager::Npm | PackageManager::Yarn => {
let package_json_text = fs::read_to_string(root_path.join("package.json"))?;
let package_json: PackageJsonWorkspaces = serde_json::from_str(&package_json_text)?;
if package_json.workspaces.as_ref().is_empty() {
return Ok(None);
} else {
package_json.workspaces.into()
}
}
};
let mut inclusions = Vec::new();
let mut exclusions = Vec::new();
for glob in globs {
if let Some(exclusion) = glob.strip_prefix('!') {
exclusions.push(exclusion.to_string());
} else {
inclusions.push(glob);
}
}
Ok(Some(Globs {
inclusions,
exclusions,
}))
}
pub fn get_package_manager(base: &CommandBase, pkg: Option<&PackageJson>) -> Result<Self> {
// We don't surface errors for `read_package_manager` as we can fall back to
// `detect_package_manager`
if let Some(package_json) = pkg {
if let Ok(Some(package_manager)) =
Self::read_package_manager(&base.repo_root, package_json)
{
return Ok(package_manager);
}
}
Self::detect_package_manager(base)
}
// Attempts to read the package manager from the package.json
fn read_package_manager(
repo_root: &AbsoluteSystemPathBuf,
pkg: &PackageJson,
) -> Result<Option<Self>> {
let Some(package_manager) = &pkg.package_manager else {
return Ok(None)
};
let (manager, version) = Self::parse_package_manager_string(package_manager)?;
let version = version.parse()?;
let manager = match manager {
"npm" => Some(PackageManager::Npm),
"yarn" => Some(YarnDetector::detect_berry_or_yarn(repo_root, &version)?),
"pnpm" => Some(PnpmDetector::detect_pnpm6_or_pnpm(&version)?),
_ => None,
};
Ok(manager)
}
fn detect_package_manager(base: &CommandBase) -> Result<PackageManager> {
let mut detected_package_managers = PnpmDetector::new(&base.repo_root)
.chain(NpmDetector::new(&base.repo_root))
.chain(YarnDetector::new(&base.repo_root))
.collect::<Result<Vec<_>>>()?;
match detected_package_managers.len() {
0 => {
let url = base.ui.apply(
UNDERLINE.apply_to("https://nodejs.org/api/packages.html#packagemanager"),
);
Err(anyhow!(
"We did not find a package manager specified in your root package.json. \
Please set the \"packageManager\" property in your root package.json ({url}) \
or run `npx @turbo/codemod add-package-manager` in the root of your monorepo."
))
}
1 => Ok(detected_package_managers.pop().unwrap()),
_ => Err(anyhow!(
"We detected multiple package managers in your repository: {}. Please remove one \
of them.",
detected_package_managers.into_iter().join(", ")
)),
}
}
pub(crate) fn parse_package_manager_string(manager: &str) -> Result<(&str, &str)> {
let package_manager_pattern =
Regex::new(r"(?P<manager>npm|pnpm|yarn)@(?P<version>\d+\.\d+\.\d+(-.+)?)")?;
if let Some(captures) = package_manager_pattern.captures(manager) {
let manager = captures.name("manager").unwrap().as_str();
let version = captures.name("version").unwrap().as_str();
Ok((manager, version))
} else {
Err(anyhow!(
"We could not parse packageManager field in package.json, expected: {}, received: \
{}",
package_manager_pattern,
manager
))
}
}
}
#[cfg(test)]
mod tests {
use std::{fs::File, path::Path};
use tempfile::tempdir;
use super::*;
use crate::{get_version, package_manager::yarn::YARN_RC, Args};
struct TestCase {
name: String,
package_manager: String,
expected_manager: String,
expected_version: String,
expected_error: bool,
}
#[test]
fn test_parse_package_manager_string() {
let tests = vec![
TestCase {
name: "errors with a tag version".to_owned(),
package_manager: "npm@latest".to_owned(),
expected_manager: "".to_owned(),
expected_version: "".to_owned(),
expected_error: true,
},
TestCase {
name: "errors with no version".to_owned(),
package_manager: "npm".to_owned(),
expected_manager: "".to_owned(),
expected_version: "".to_owned(),
expected_error: true,
},
TestCase {
name: "requires fully-qualified semver versions (one digit)".to_owned(),
package_manager: "npm@1".to_owned(),
expected_manager: "".to_owned(),
expected_version: "".to_owned(),
expected_error: true,
},
TestCase {
name: "requires fully-qualified semver versions (two digits)".to_owned(),
package_manager: "npm@1.2".to_owned(),
expected_manager: "".to_owned(),
expected_version: "".to_owned(),
expected_error: true,
},
TestCase {
name: "supports custom labels".to_owned(),
package_manager: "npm@1.2.3-alpha.1".to_owned(),
expected_manager: "npm".to_owned(),
expected_version: "1.2.3-alpha.1".to_owned(),
expected_error: false,
},
TestCase {
name: "only supports specified package managers".to_owned(),
package_manager: "pip@1.2.3".to_owned(),
expected_manager: "".to_owned(),
expected_version: "".to_owned(),
expected_error: true,
},
TestCase {
name: "supports npm".to_owned(),
package_manager: "npm@0.0.1".to_owned(),
expected_manager: "npm".to_owned(),
expected_version: "0.0.1".to_owned(),
expected_error: false,
},
TestCase {
name: "supports pnpm".to_owned(),
package_manager: "pnpm@0.0.1".to_owned(),
expected_manager: "pnpm".to_owned(),
expected_version: "0.0.1".to_owned(),
expected_error: false,
},
TestCase {
name: "supports yarn".to_owned(),
package_manager: "yarn@111.0.1".to_owned(),
expected_manager: "yarn".to_owned(),
expected_version: "111.0.1".to_owned(),
expected_error: false,
},
];
for case in tests {
let result = PackageManager::parse_package_manager_string(&case.package_manager);
let Ok((received_manager, received_version)) = result else {
assert!(case.expected_error, "{}: received error", case.name);
continue
};
assert_eq!(received_manager, case.expected_manager);
assert_eq!(received_version, case.expected_version);
}
}
#[test]
fn test_read_package_manager() -> Result<()> {
let repo_root = tempdir()?;
let mut package_json = PackageJson::default();
let repo_root_path = AbsoluteSystemPathBuf::new(repo_root.path())?;
// Set up .yarnrc.yml file
let yarn_rc_path = repo_root.path().join(YARN_RC);
fs::write(&yarn_rc_path, "nodeLinker: node-modules")?;
package_json.package_manager = Some("npm@8.19.4".to_string());
let package_manager = PackageManager::read_package_manager(&repo_root_path, &package_json)?;
assert_eq!(package_manager, Some(PackageManager::Npm));
package_json.package_manager = Some("yarn@2.0.0".to_string());
let package_manager = PackageManager::read_package_manager(&repo_root_path, &package_json)?;
assert_eq!(package_manager, Some(PackageManager::Berry));
package_json.package_manager = Some("yarn@1.9.0".to_string());
let package_manager = PackageManager::read_package_manager(&repo_root_path, &package_json)?;
assert_eq!(package_manager, Some(PackageManager::Yarn));
package_json.package_manager = Some("pnpm@6.0.0".to_string());
let package_manager = PackageManager::read_package_manager(&repo_root_path, &package_json)?;
assert_eq!(package_manager, Some(PackageManager::Pnpm6));
package_json.package_manager = Some("pnpm@7.2.0".to_string());
let package_manager = PackageManager::read_package_manager(&repo_root_path, &package_json)?;
assert_eq!(package_manager, Some(PackageManager::Pnpm));
Ok(())
}
#[test]
fn test_detect_multiple_package_managers() -> Result<()> {
let repo_root = tempdir()?;
let repo_root_path = AbsoluteSystemPathBuf::new(repo_root.path())?;
let base = CommandBase::new(Args::default(), repo_root_path, get_version())?;
let package_lock_json_path = repo_root.path().join(npm::LOCKFILE);
File::create(&package_lock_json_path)?;
let pnpm_lock_path = repo_root.path().join(pnpm::LOCKFILE);
File::create(&pnpm_lock_path)?;
let error = PackageManager::detect_package_manager(&base).unwrap_err();
assert_eq!(
error.to_string(),
"We detected multiple package managers in your repository: pnpm, npm. Please remove \
one of them."
);
fs::remove_file(&package_lock_json_path)?;
let package_manager = PackageManager::detect_package_manager(&base)?;
assert_eq!(package_manager, PackageManager::Pnpm);
Ok(())
}
#[test]
fn test_get_workspace_globs() {
let package_manager = PackageManager::Npm;
let globs = package_manager
.get_workspace_globs(Path::new("../../examples/with-yarn"))
.unwrap()
.unwrap();
assert_eq!(globs.inclusions, vec!["apps/*", "packages/*"]);
}
#[test]
fn test_globs_test() {
struct TestCase {
globs: Globs,
root: PathBuf,
target: PathBuf,
output: Result<bool>,
}
let tests = [TestCase {
globs: Globs {
inclusions: vec!["d/**".to_string()],
exclusions: vec![],
},
root: PathBuf::from("/a/b/c"),
target: PathBuf::from("/a/b/c/d/e/f"),
output: Ok(true),
}];
for test in tests {
match test.globs.test(test.root, test.target) {
Ok(value) => assert_eq!(value, test.output.unwrap()),
Err(value) => assert_eq!(value.to_string(), test.output.unwrap_err().to_string()),
};
}
}
#[test]
fn test_nested_workspace_globs() -> Result<()> {
let top_level: PackageJsonWorkspaces =
serde_json::from_str("{ \"workspaces\": [\"packages/**\"]}")?;
assert_eq!(top_level.workspaces.as_ref(), vec!["packages/**"]);
let nested: PackageJsonWorkspaces =
serde_json::from_str("{ \"workspaces\": {\"packages\": [\"packages/**\"]}}")?;
assert_eq!(nested.workspaces.as_ref(), vec!["packages/**"]);
Ok(())
}
}