zoxide 0.10.0

A smarter cd command for your terminal
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

pub(crate) use crate::import::atuin::Atuin;
pub(crate) use crate::import::autojump::Autojump;
pub(crate) use crate::import::fasd::Fasd;
pub(crate) use crate::import::z::Z;
pub(crate) use crate::import::z_lua::ZLua;
pub(crate) use crate::import::zsh_z::ZshZ;

mod atuin;
mod autojump;
mod fasd;
mod z;
mod z_lua;
mod zsh_z;

use std::io::{self, Write};
use std::path::PathBuf;

use anyhow::Result;

use crate::config;
use crate::db::{Database, Dir};

pub(crate) trait Importer {
    /// Yields directory entries to be imported.
    ///
    /// The outer `Result` reports failure to fetch the input (e.g. missing
    /// file, subprocess errored). The per-item `Result` reports a malformed
    /// row, which doesn't necessarily abort the whole import.
    fn dirs(&self) -> Result<impl Iterator<Item = Result<Dir<'static>, ImportError>>>;
}

/// A single record that failed to import.
#[derive(Debug)]
pub(crate) struct ImportError {
    /// Path of the source file containing the offending record. `None` if the
    /// importer is not file-based (e.g. atuin streams from a subprocess).
    pub path: Option<PathBuf>,

    /// 1-indexed line number of the offending input.
    pub line_num: usize,

    /// Underlying reason the record could not be imported.
    pub source: anyhow::Error,
}

/// Drives a single importer end-to-end: writes each `Ok` dir into the
/// database and prints each `Err` to stderr in `<path>:<line>: <reason>`
/// format. Doesn't abort on per-record errors — bad rows are skipped, the
/// rest of the import continues. After the iteration completes successfully,
/// the database is deduplicated and aged.
pub(crate) fn run(importer: &impl Importer, db: &mut Database) -> Result<()> {
    let exclude_dirs = config::exclude_dirs()?;

    let stderr = io::stderr();
    let mut stderr = stderr.lock();

    for entry in importer.dirs()? {
        match entry {
            Ok(dir) => {
                if exclude_dirs.iter().any(|glob| glob.matches(&dir.path)) {
                    continue;
                }
                db.add_unchecked(dir.path, dir.rank, dir.last_accessed);
            }
            Err(e) => {
                let location = match &e.path {
                    Some(path) => format!("{}:{}", path.display(), e.line_num),
                    None => format!("line {}", e.line_num),
                };
                _ = writeln!(stderr, "{location}: {:#}", e.source);
            }
        }
    }

    if db.dirty() {
        db.dedup();
        let max_age = config::maxage()?;
        db.age(max_age);
    }

    Ok(())
}