From 8a7c38ed6932095e060b8093326b90f6d6914985 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Wed, 11 Nov 2026 10:00:40 +0000 Subject: [PATCH] Add chira CLI pre-check and installation guidance Provide pre-checks and helpful error messages for `:md` and `:sync` commands when the external `chira` CLI binary is missing. Include installation instructions (`cargo install chira-ura`) in help text and documentation. Co-authored-by: bonsai <24775+bonsai@users.noreply.github.com> --- README.md | 6 +-- src/app.rs | 114 +++++++++++++++++++++++++++++++++++++++++++++++++++- src/main.rs | 2 +- 3 files changed, 116 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index cacd410..a5ffebc 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ dir: ~/.chira/md # source: dir で開くディレクトリ / :md :sync - `:db ` — SQLite に切替(chira-ura のメモ。`notes` テーブルを読み書き) - `:dir ` — md/txt ディレクトリに切替 -- `:md [dir]` / `:sync [dir]` — 外部 `chira md` / `chira md import` +- `:md [dir]` / `:sync [dir]` — 外部 `chira md` / `chira md import`(外部 CLI `chira` が必要です: `cargo install chira-ura`) ## 操作早見表 @@ -88,8 +88,8 @@ dir: ~/.chira/md # source: dir で開くディレクトリ / :md :sync - `:new`: 新規メモ作成 - `:next`: 次のファイルを開く - `:prev`: 前のファイルを開く -- `:md [dir]`: 外部コマンド `chira md [dir]` を実行 -- `:sync [dir]`: 外部コマンド `chira md import [dir]` を実行 +- `:md [dir]`: 外部コマンド `chira md [dir]` を実行(要 `cargo install chira-ura`) +- `:sync [dir]`: 外部コマンド `chira md import [dir]` を実行(要 `cargo install chira-ura`) ## データの扱い diff --git a/src/app.rs b/src/app.rs index 3439ddf..96f3d0b 100644 --- a/src/app.rs +++ b/src/app.rs @@ -9,6 +9,33 @@ use std::fs; use std::path::{Path, PathBuf}; use std::process::Command as ProcessCommand; +pub const CHIRA_NOT_FOUND_MSG: &str = + "chira CLI is not installed or not in PATH. Install with: cargo install chira-ura"; + +/// Checks if the `chira` binary is available in PATH. +pub fn is_chira_available() -> bool { + let path_var = match std::env::var_os("PATH") { + Some(val) => val, + None => return false, + }; + + #[cfg(windows)] + let exe_names = ["chira.exe", "chira.cmd", "chira.bat", "chira"]; + #[cfg(not(windows))] + let exe_names = ["chira"]; + + for dir in std::env::split_paths(&path_var) { + for name in &exe_names { + let candidate = dir.join(name); + if candidate.is_file() { + return true; + } + } + } + + false +} + /// 読み込み元。db = chira-ura の SQLite、dir = md/txt ディレクトリ。 #[derive(Debug, Clone, PartialEq, Eq)] pub enum Source { @@ -1009,6 +1036,10 @@ impl App { } "md" => { // External `chira md [dir]` + if !is_chira_available() { + self.status_message = Some(CHIRA_NOT_FOUND_MSG.to_string()); + return; + } let target_dir = arg.unwrap_or(self.root_dir.to_str().unwrap_or("")); self.status_message = Some(format!("Running chira md {}...", target_dir)); let output = ProcessCommand::new("chira") @@ -1027,12 +1058,20 @@ impl App { } } Err(e) => { - self.status_message = Some(format!("Failed to run chira: {}", e)); + if e.kind() == std::io::ErrorKind::NotFound { + self.status_message = Some(CHIRA_NOT_FOUND_MSG.to_string()); + } else { + self.status_message = Some(format!("Failed to run chira: {}", e)); + } } } } "sync" => { // External `chira md import [dir]` + if !is_chira_available() { + self.status_message = Some(CHIRA_NOT_FOUND_MSG.to_string()); + return; + } let target_dir = arg.unwrap_or(self.root_dir.to_str().unwrap_or("")); self.status_message = Some(format!("Running chira md import {}...", target_dir)); let output = ProcessCommand::new("chira") @@ -1051,7 +1090,11 @@ impl App { } } Err(e) => { - self.status_message = Some(format!("Failed to run chira: {}", e)); + if e.kind() == std::io::ErrorKind::NotFound { + self.status_message = Some(CHIRA_NOT_FOUND_MSG.to_string()); + } else { + self.status_message = Some(format!("Failed to run chira: {}", e)); + } } } } @@ -1061,3 +1104,70 @@ impl App { } } } + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn test_is_chira_available_returns_false_when_not_in_path() { + let original_path = std::env::var_os("PATH"); + let temp_empty_dir = std::env::temp_dir().join("rum_empty_path_test"); + let _ = fs::create_dir_all(&temp_empty_dir); + + std::env::set_var("PATH", &temp_empty_dir); + let available = is_chira_available(); + if let Some(orig) = original_path { + std::env::set_var("PATH", orig); + } else { + std::env::remove_var("PATH"); + } + let _ = fs::remove_dir(&temp_empty_dir); + + assert!(!available); + } + + #[test] + fn test_execute_command_md_missing_chira() { + let original_path = std::env::var_os("PATH"); + let temp_empty_dir = std::env::temp_dir().join("rum_empty_path_md_test"); + let _ = fs::create_dir_all(&temp_empty_dir); + + std::env::set_var("PATH", &temp_empty_dir); + + let mut app = App::new(Source::Dir(temp_empty_dir.clone()), temp_empty_dir.clone()) + .expect("app init"); + app.execute_command("md"); + + if let Some(orig) = original_path { + std::env::set_var("PATH", orig); + } else { + std::env::remove_var("PATH"); + } + let _ = fs::remove_dir_all(&temp_empty_dir); + + assert_eq!(app.status_message, Some(CHIRA_NOT_FOUND_MSG.to_string())); + } + + #[test] + fn test_execute_command_sync_missing_chira() { + let original_path = std::env::var_os("PATH"); + let temp_empty_dir = std::env::temp_dir().join("rum_empty_path_sync_test"); + let _ = fs::create_dir_all(&temp_empty_dir); + + std::env::set_var("PATH", &temp_empty_dir); + + let mut app = App::new(Source::Dir(temp_empty_dir.clone()), temp_empty_dir.clone()) + .expect("app init"); + app.execute_command("sync"); + + if let Some(orig) = original_path { + std::env::set_var("PATH", orig); + } else { + std::env::remove_var("PATH"); + } + let _ = fs::remove_dir_all(&temp_empty_dir); + + assert_eq!(app.status_message, Some(CHIRA_NOT_FOUND_MSG.to_string())); + } +} diff --git a/src/main.rs b/src/main.rs index b9af1d7..0042cf9 100644 --- a/src/main.rs +++ b/src/main.rs @@ -45,7 +45,7 @@ rum — vim 風 TUI リーダ/エディタ / pattern, n N 検索 :w :q :wq :e :new :next :prev コマンド :db / :dir 読み込み元を切替 - :md [dir] / :sync [dir] chira md / chira md import + :md [dir] / :sync [dir] chira md / chira md import (要 chira CLI: cargo install chira-ura) Ctrl-s 保存 / Ctrl-p Ctrl-n 前後のノート ";