arf-console 0.7.0-alpha.1

A cross-platform R console written in Rust
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

//! Interactive fuzzy search for R documentation.
//!
//! This module provides a terminal-based fuzzy search interface for R help topics
//! loaded from installed packages' `Meta/Rd.rds`, `Meta/vignette.rds`, and
//! `Meta/demo.rds` independently.
//!
//! # Acknowledgment
//!
//! This implementation is inspired by the **felp** package by Atsushi Yasumoto (atusy):
//! - Repository: <https://github.com/atusy/felp>
//! - CRAN: <https://cran.r-project.org/package=felp>
//!
//! The concept of fuzzy help search was learned from felp's `fuzzyhelp()` function;
//! help indexes are read directly from installed packages here.

mod browser;
mod pages;
mod search;

pub use browser::run_help_browser;
pub(crate) use pages::display_prepared_help_request;
pub(super) use pages::{HelpPageSelectorState, help_page_title};

use arf_harp::HarpResult;

const MIN_SIZE: super::MinimumSize = super::MinimumSize { cols: 30, rows: 8 };

fn help_library_paths_after_refresh(
    refresh: HarpResult<Vec<String>>,
    cached: impl FnOnce() -> Vec<String>,
) -> HarpResult<Vec<String>> {
    match refresh {
        Ok(paths) => Ok(paths),
        Err(error) => {
            let paths = cached();
            if paths.is_empty() {
                return Err(error);
            }
            log::warn!(
                "Could not refresh R library paths for help; using the previous snapshot: {error}"
            );
            Ok(paths)
        }
    }
}