vkit 0.1.4

Fast Rust dev CLI: manage git worktrees, Node ports, run scripts, install & sync VS Code / Cursor extensions.
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
//! 发现当前目录及子目录下 package.json 里的可运行 scripts。
//!
//! 纯函数(解析 / 过滤 / 排序)与副作用(读文件、遍历目录)分离,前者可单测。
//! 目录遍历用 `ignore` crate,天然尊重 .gitignore 并跳过 node_modules 等。

use std::collections::{BTreeMap, HashSet};
use std::fs;
use std::path::{Path, PathBuf};

use anyhow::{anyhow, Result};
use ignore::WalkBuilder;
use serde::Deserialize;

/// 包管理器种类。
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PackageManager {
    Pnpm,
    Npm,
    Yarn,
}

impl PackageManager {
    /// 命令行可执行名。
    pub fn bin(self) -> &'static str {
        match self {
            PackageManager::Pnpm => "pnpm",
            PackageManager::Npm => "npm",
            PackageManager::Yarn => "yarn",
        }
    }

    pub fn label(self) -> &'static str {
        self.bin()
    }
}

/// package.json 里我们关心的字段(其余忽略)。
#[derive(Debug, Default, Deserialize)]
pub struct PackageJson {
    pub name: Option<String>,
    /// script 名 → 命令;BTreeMap 天然按名字排序,与 TS 版按 script 名排序一致。
    #[serde(default)]
    pub scripts: BTreeMap<String, String>,
    #[serde(rename = "packageManager")]
    pub package_manager: Option<String>,
}

/// 一条可运行的 script。
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ScriptEntry {
    pub package_name: String,
    pub package_path: PathBuf,
    pub script: String,
    pub command: String,
    /// 是否属于当前工作目录(排序靠前、标 `*`)。
    pub is_current: bool,
}

impl ScriptEntry {
    /// 选择集合的唯一键:`包路径::script`。
    pub fn key(&self) -> String {
        format!("{}::{}", self.package_path.display(), self.script)
    }
}

/// 一次发现的结果。
pub struct Discovery {
    pub cwd: PathBuf,
    pub package_manager: PackageManager,
    pub entries: Vec<ScriptEntry>,
}

/// 解析 package.json 文本;任何错误都视为「无此包」返回 None(与 TS 版 catch 一致)。
pub fn parse_package_json(raw: &str) -> Option<PackageJson> {
    serde_json::from_str(raw).ok()
}

/// 解析 `packageManager` 字段(形如 `pnpm@9.1.0`)。
pub fn parse_package_manager_field(value: Option<&str>) -> Option<PackageManager> {
    let name = value?.split('@').next()?.trim();
    match name {
        "pnpm" => Some(PackageManager::Pnpm),
        "npm" => Some(PackageManager::Npm),
        "yarn" => Some(PackageManager::Yarn),
        _ => None,
    }
}

/// 由「路径 + package.json」列表构建并排序 script 条目。
///
/// 排序:当前包优先 → 包名 → script 名。嵌套包名显示为 `祖先 -> 自身`。
pub fn build_script_entries(packages: &[(PathBuf, PackageJson)], cwd: &Path) -> Vec<ScriptEntry> {
    // 每个包路径的「基础名」(name 字段或目录名),用于拼接层级标签。
    let base_names: Vec<(PathBuf, String)> = packages
        .iter()
        .map(|(path, pkg)| {
            (
                path.clone(),
                pkg.name.clone().unwrap_or_else(|| dir_basename(path)),
            )
        })
        .collect();

    let mut entries: Vec<ScriptEntry> = Vec::new();

    for (path, pkg) in packages {
        if pkg.scripts.is_empty() {
            continue;
        }

        let package_name = hierarchical_label(path, &base_names, cwd);
        let is_current = path == cwd;

        for (script, command) in &pkg.scripts {
            entries.push(ScriptEntry {
                package_name: package_name.clone(),
                package_path: path.clone(),
                script: script.clone(),
                command: command.clone(),
                is_current,
            });
        }
    }

    entries.sort_by(|a, b| {
        b.is_current
            .cmp(&a.is_current)
            .then_with(|| a.package_name.cmp(&b.package_name))
            .then_with(|| a.script.cmp(&b.script))
    });

    entries
}

/// 大小写不敏感的子串过滤(命中包名 / script / 命令任一)。
pub fn filter_scripts(entries: &[ScriptEntry], query: &str) -> Vec<ScriptEntry> {
    let query = query.trim().to_lowercase();
    if query.is_empty() {
        return entries.to_vec();
    }

    entries
        .iter()
        .filter(|entry| {
            entry.package_name.to_lowercase().contains(&query)
                || entry.script.to_lowercase().contains(&query)
                || entry.command.to_lowercase().contains(&query)
        })
        .cloned()
        .collect()
}

/// 一个包分组:包信息 + 其下的 script 条目。
#[derive(Debug, Clone)]
pub struct PackageGroup {
    pub package_name: String,
    pub is_current: bool,
    pub scripts: Vec<ScriptEntry>,
}

/// 按包分组(保持传入 entries 的顺序,一个包路径一组)。
pub fn group_by_package(entries: &[ScriptEntry]) -> Vec<PackageGroup> {
    let mut groups: Vec<PackageGroup> = Vec::new();
    let mut index_by_path: std::collections::HashMap<PathBuf, usize> =
        std::collections::HashMap::new();

    for entry in entries {
        if let Some(&index) = index_by_path.get(&entry.package_path) {
            groups[index].scripts.push(entry.clone());
            continue;
        }
        index_by_path.insert(entry.package_path.clone(), groups.len());
        groups.push(PackageGroup {
            package_name: entry.package_name.clone(),
            is_current: entry.is_current,
            scripts: vec![entry.clone()],
        });
    }

    groups
}

/// 某个包内已勾选的 script 数。
pub fn count_selected(group: &PackageGroup, selected: &HashSet<String>) -> usize {
    group
        .scripts
        .iter()
        .filter(|entry| selected.contains(&entry.key()))
        .count()
}

/// 展示标签:`包名 · script`,包名超长截断。
pub fn format_script_label(entry: &ScriptEntry, package_max: usize) -> String {
    let name = &entry.package_name;
    let name = if name.chars().count() > package_max && package_max > 1 {
        let head: String = name.chars().take(package_max - 1).collect();
        format!("{head}")
    } else {
        name.clone()
    };
    format!("{name} · {}", entry.script)
}

/// 计算包的显示名:若嵌套在其他包(祖先)之下,拼成 `祖先 -> … -> 自身`。
///
/// 祖先按目录深度升序排列;cwd(根/当前目录包)本身不计入前缀,
/// 这样直接子包显示为一级名称,其内部的包才带层级前缀。
fn hierarchical_label(path: &Path, base_names: &[(PathBuf, String)], cwd: &Path) -> String {
    let own = base_names
        .iter()
        .find(|(p, _)| p == path)
        .map(|(_, name)| name.clone())
        .unwrap_or_else(|| dir_basename(path));

    let mut ancestors: Vec<(usize, &str)> = base_names
        .iter()
        .filter(|(p, _)| p != path && p != cwd && path.starts_with(p))
        .map(|(p, name)| (p.components().count(), name.as_str()))
        .collect();

    if ancestors.is_empty() {
        return own;
    }

    ancestors.sort_by_key(|(depth, _)| *depth);
    let mut parts: Vec<String> = ancestors
        .into_iter()
        .map(|(_, name)| name.to_string())
        .collect();
    parts.push(own);
    parts.join(" -> ")
}

/// 目录名(末段),用作缺省包名。
fn dir_basename(path: &Path) -> String {
    path.file_name()
        .map(|name| name.to_string_lossy().into_owned())
        .unwrap_or_else(|| path.display().to_string())
}

/// 需要在遍历时剪掉的目录名。
const PRUNE_DIRS: &[&str] = &[
    "node_modules",
    "dist",
    ".git",
    "coverage",
    ".worktrees",
    ".worktree",
    "target",
];

/// 遍历 cwd 及子目录收集所有 package.json(尊重 .gitignore,跳过常见产物目录)。
fn collect_packages(cwd: &Path) -> Vec<(PathBuf, PackageJson)> {
    let mut found: Vec<(PathBuf, PackageJson)> = Vec::new();
    let mut seen: HashSet<PathBuf> = HashSet::new();

    let walker = WalkBuilder::new(cwd)
        .hidden(false)
        .git_ignore(true)
        .git_global(false)
        .filter_entry(|entry| {
            // 只剪目录,保留文件判断。
            if entry.file_type().is_some_and(|ft| ft.is_dir()) {
                let name = entry.file_name().to_string_lossy();
                return !PRUNE_DIRS.contains(&name.as_ref());
            }
            true
        })
        .build();

    for result in walker {
        let Ok(entry) = result else { continue };
        if entry.file_name() != "package.json" {
            continue;
        }
        let Some(dir) = entry.path().parent() else {
            continue;
        };
        let dir = dir.to_path_buf();
        if !seen.insert(dir.clone()) {
            continue;
        }
        if let Ok(raw) = fs::read_to_string(entry.path()) {
            if let Some(pkg) = parse_package_json(&raw) {
                found.push((dir, pkg));
            }
        }
    }

    found.sort_by(|a, b| a.0.cmp(&b.0));
    found
}

/// 从 cwd 逐级向上探测包管理器:packageManager 字段优先,其次 lock 文件,默认 npm。
fn detect_package_manager(cwd: &Path) -> PackageManager {
    let mut dir = Some(cwd);
    while let Some(current) = dir {
        if let Ok(raw) = fs::read_to_string(current.join("package.json")) {
            if let Some(pkg) = parse_package_json(&raw) {
                if let Some(pm) = parse_package_manager_field(pkg.package_manager.as_deref()) {
                    return pm;
                }
            }
        }
        if current.join("pnpm-lock.yaml").exists() {
            return PackageManager::Pnpm;
        }
        if current.join("yarn.lock").exists() {
            return PackageManager::Yarn;
        }
        if current.join("package-lock.json").exists() {
            return PackageManager::Npm;
        }
        dir = current.parent();
    }
    PackageManager::Npm
}

/// 自 cwd 向上查找是否位于 git 仓库内(含 worktree:`.git` 可为文件)。
fn is_inside_git_repo(cwd: &Path) -> bool {
    let mut dir = Some(cwd);
    while let Some(current) = dir {
        if current.join(".git").exists() {
            return true;
        }
        dir = current.parent();
    }
    false
}

/// 发现当前目录(默认)下所有可运行 scripts。
///
/// 要求 cwd 位于 git 仓库内,避免在系统根目录等位置误触发全盘扫描。
pub fn discover_scripts(cwd: &Path) -> Result<Discovery> {
    let cwd = cwd.canonicalize().unwrap_or_else(|_| cwd.to_path_buf());

    if !is_inside_git_repo(&cwd) {
        return Err(anyhow!(
            "当前目录不在 git 仓库内,请先 cd 到项目目录再运行。"
        ));
    }

    let packages = collect_packages(&cwd);
    let entries = build_script_entries(&packages, &cwd);

    if entries.is_empty() {
        return Err(anyhow!("当前目录及子目录下未找到可运行的 scripts。"));
    }

    Ok(Discovery {
        package_manager: detect_package_manager(&cwd),
        cwd,
        entries,
    })
}

#[cfg(test)]
mod tests {
    use super::*;

    fn pkg(name: &str, scripts: &[(&str, &str)]) -> PackageJson {
        PackageJson {
            name: Some(name.to_string()),
            scripts: scripts
                .iter()
                .map(|(k, v)| (k.to_string(), v.to_string()))
                .collect(),
            package_manager: None,
        }
    }

    #[test]
    fn parse_reads_scripts_and_name() {
        let json = r#"{"name":"demo","scripts":{"dev":"vite","build":"tsc"}}"#;
        let parsed = parse_package_json(json).unwrap();
        assert_eq!(parsed.name.as_deref(), Some("demo"));
        assert_eq!(parsed.scripts.get("dev").map(String::as_str), Some("vite"));
    }

    #[test]
    fn parse_invalid_returns_none() {
        assert!(parse_package_json("{ not json").is_none());
    }

    #[test]
    fn parse_missing_scripts_defaults_empty() {
        let parsed = parse_package_json(r#"{"name":"x"}"#).unwrap();
        assert!(parsed.scripts.is_empty());
    }

    #[test]
    fn package_manager_field_parses() {
        assert_eq!(
            parse_package_manager_field(Some("pnpm@9.1.0")),
            Some(PackageManager::Pnpm)
        );
        assert_eq!(
            parse_package_manager_field(Some("yarn")),
            Some(PackageManager::Yarn)
        );
        assert_eq!(parse_package_manager_field(Some("bun@1")), None);
        assert_eq!(parse_package_manager_field(None), None);
    }

    #[test]
    fn build_sorts_current_first_then_name_then_script() {
        let cwd = PathBuf::from("/repo/app");
        let packages = vec![
            (
                PathBuf::from("/repo/lib"),
                pkg("lib", &[("test", "vitest")]),
            ),
            (
                PathBuf::from("/repo/app"),
                pkg("app", &[("dev", "vite"), ("build", "tsc")]),
            ),
        ];
        let entries = build_script_entries(&packages, &cwd);
        // 当前包 app 的两个 script 排前面,且 build 在 dev 之前(按名字)。
        assert_eq!(entries[0].package_name, "app");
        assert_eq!(entries[0].script, "build");
        assert_eq!(entries[1].script, "dev");
        assert!(entries[0].is_current);
        assert_eq!(entries[2].package_name, "lib");
        assert!(!entries[2].is_current);
    }

    #[test]
    fn nested_package_shows_hierarchy() {
        let cwd = PathBuf::from("/repo");
        let packages = vec![
            (PathBuf::from("/repo"), pkg("root", &[("dev", "x")])),
            (PathBuf::from("/repo/app"), pkg("app", &[("dev", "vite")])),
            (
                PathBuf::from("/repo/app/plugins/foo"),
                pkg("foo", &[("build", "tsup")]),
            ),
        ];
        let entries = build_script_entries(&packages, &cwd);
        let by_path = |p: &str| {
            entries
                .iter()
                .find(|e| e.package_path.as_path() == Path::new(p))
                .map(|e| e.package_name.clone())
                .unwrap()
        };
        // 根/当前目录包不带前缀。
        assert_eq!(by_path("/repo"), "root");
        // 直接子包显示为一级名称。
        assert_eq!(by_path("/repo/app"), "app");
        // 二级包显示为 `父 -> 子`(根不计入)。
        assert_eq!(by_path("/repo/app/plugins/foo"), "app -> foo");
    }

    #[test]
    fn deeper_nesting_chains_all_package_ancestors() {
        let cwd = PathBuf::from("/repo");
        let packages = vec![
            (PathBuf::from("/repo/a"), pkg("a", &[("dev", "x")])),
            (PathBuf::from("/repo/a/b"), pkg("b", &[("dev", "x")])),
            (PathBuf::from("/repo/a/b/c"), pkg("c", &[("dev", "x")])),
        ];
        let entries = build_script_entries(&packages, &cwd);
        let c = entries
            .iter()
            .find(|e| e.package_path.as_path() == Path::new("/repo/a/b/c"))
            .unwrap();
        assert_eq!(c.package_name, "a -> b -> c");
    }

    #[test]
    fn build_skips_packages_without_scripts() {
        let cwd = PathBuf::from("/repo");
        let packages = vec![(PathBuf::from("/repo/empty"), pkg("empty", &[]))];
        assert!(build_script_entries(&packages, &cwd).is_empty());
    }

    #[test]
    fn filter_matches_name_script_command() {
        let cwd = PathBuf::from("/repo");
        let packages = vec![(
            PathBuf::from("/repo"),
            pkg("web", &[("dev", "vite"), ("lint", "eslint .")]),
        )];
        let entries = build_script_entries(&packages, &cwd);
        assert_eq!(filter_scripts(&entries, "dev").len(), 1);
        assert_eq!(filter_scripts(&entries, "eslint").len(), 1);
        assert_eq!(filter_scripts(&entries, "web").len(), 2);
        assert_eq!(filter_scripts(&entries, "").len(), 2);
        assert_eq!(filter_scripts(&entries, "zzz").len(), 0);
    }

    #[test]
    fn label_truncates_long_package_name() {
        let entry = ScriptEntry {
            package_name: "a-very-long-package-name".to_string(),
            package_path: PathBuf::from("/x"),
            script: "dev".to_string(),
            command: "vite".to_string(),
            is_current: false,
        };
        let label = format_script_label(&entry, 8);
        assert_eq!(label, "a-very-… · dev");
    }

    #[test]
    fn group_by_package_collects_scripts() {
        let cwd = PathBuf::from("/repo/app");
        let packages = vec![
            (
                PathBuf::from("/repo/app"),
                pkg("app", &[("dev", "vite"), ("build", "tsc")]),
            ),
            (
                PathBuf::from("/repo/lib"),
                pkg("lib", &[("test", "vitest")]),
            ),
        ];
        let entries = build_script_entries(&packages, &cwd);
        let groups = group_by_package(&entries);
        assert_eq!(groups.len(), 2);
        assert_eq!(groups[0].package_name, "app");
        assert_eq!(groups[0].scripts.len(), 2);
        assert!(groups[0].is_current);
        assert_eq!(groups[1].package_name, "lib");
        assert_eq!(groups[1].scripts.len(), 1);
    }

    #[test]
    fn count_selected_counts_within_group() {
        let cwd = PathBuf::from("/repo");
        let packages = vec![(
            PathBuf::from("/repo"),
            pkg("web", &[("dev", "vite"), ("build", "tsc")]),
        )];
        let entries = build_script_entries(&packages, &cwd);
        let groups = group_by_package(&entries);
        let mut selected = HashSet::new();
        selected.insert("/repo::dev".to_string());
        assert_eq!(count_selected(&groups[0], &selected), 1);
    }

    #[test]
    fn key_is_path_and_script() {
        let entry = ScriptEntry {
            package_name: "x".to_string(),
            package_path: PathBuf::from("/repo/app"),
            script: "dev".to_string(),
            command: "vite".to_string(),
            is_current: false,
        };
        assert_eq!(entry.key(), "/repo/app::dev");
    }

    fn temp_dir(tag: &str) -> PathBuf {
        let dir = std::env::temp_dir().join(format!("vkit-run-{tag}-{}", std::process::id()));
        let _ = fs::remove_dir_all(&dir);
        fs::create_dir_all(&dir).unwrap();
        dir
    }

    #[test]
    fn is_inside_git_repo_walks_up() {
        let root = temp_dir("git-walk");
        let nested = root.join("packages").join("web");
        fs::create_dir_all(&nested).unwrap();
        assert!(!is_inside_git_repo(&nested));
        fs::create_dir(root.join(".git")).unwrap();
        assert!(is_inside_git_repo(&nested));
        assert!(is_inside_git_repo(&root));
        let _ = fs::remove_dir_all(&root);
    }

    #[test]
    fn discover_rejects_non_git_directory() {
        let dir = temp_dir("nogit");
        fs::write(
            dir.join("package.json"),
            r#"{"name":"x","scripts":{"dev":"vite"}}"#,
        )
        .unwrap();
        match discover_scripts(&dir) {
            Err(err) => assert!(err.to_string().contains("git")),
            Ok(_) => panic!("expected non-git directory to be rejected"),
        }
        let _ = fs::remove_dir_all(&dir);
    }

    #[test]
    fn discover_accepts_git_directory() {
        let dir = temp_dir("withgit");
        fs::create_dir(dir.join(".git")).unwrap();
        fs::write(
            dir.join("package.json"),
            r#"{"name":"x","scripts":{"dev":"vite"}}"#,
        )
        .unwrap();
        let discovery = discover_scripts(&dir).unwrap();
        assert_eq!(discovery.entries.len(), 1);
        assert_eq!(discovery.entries[0].script, "dev");
        let _ = fs::remove_dir_all(&dir);
    }
}