merged in changes from help-topics

This commit is contained in:
Valerie Wolfe 2024-06-06 09:49:58 -04:00
commit f8c3ac20ac
6 changed files with 75 additions and 19 deletions

View file

@ -1,6 +1,5 @@
//! globally available tmux commands.
use std::{
env::var,
ffi::OsString,
process::exit
};
@ -12,7 +11,12 @@ use tmux_interface::{
commands
};
use crate::{ error, flag, util };
use crate::{
env::{ self, env_var },
error,
flag,
util
};
pub fn attach(pargs: &mut Arguments) {
// must be run from terminal
@ -22,7 +26,7 @@ pub fn attach(pargs: &mut Arguments) {
// consume optional flags
let read_only = pargs.contains(flag::READ_ONLY);
let detach_other = pargs.contains(flag::DETACHED);
let detach_other = pargs.contains(flag::DETACH);
let args = pargs.clone().finish();
let target: String;
@ -122,7 +126,7 @@ pub fn list() {
}
// get attached session symbol
let attach_symbol = var("REMUX_ATTACH_SYMBOL").unwrap_or("*".to_string());
let attach_symbol = env_var(env::ATTACH_SYMBOL);
// pretty print session list
println!("sessions:");
@ -149,9 +153,13 @@ pub fn new(pargs: &mut Arguments) {
// don't allow unflagged nesting
util::prevent_nest();
// get optional flag
// get optional flags
let detached = pargs.contains(flag::DETACH);
let target_dir: Result<String, Error> = pargs.value_from_str(flag::TARGET);
// get environment variables
let window_name = env_var(env::NEW_WINDOW_NAME);
// get target or fallback
let args = pargs.clone().finish();
let title: String;
@ -168,10 +176,18 @@ pub fn new(pargs: &mut Arguments) {
let mut new = commands::NewSession::new();
new = new.group_name(title);
if let Some(command) = command { new.shell_command = Some(command.to_string_lossy()); }
if detached { new.detached = true; }
if let Ok(target_dir) = target_dir { new = new.start_directory(target_dir); }
Tmux::new()
.add_command(new)
.output().ok();
let mut tmux = Tmux::new().add_command(new);
// rename window if var not empty
if !window_name.is_empty() {
let auto_name = commands::RenameWindow::new()
.new_name(window_name);
tmux = tmux.add_command(auto_name);
}
tmux.output().ok();
}

13
src/env.rs Normal file
View file

@ -0,0 +1,13 @@
use std::env::var;
pub type EnvVar = (&'static str, &'static str);
pub static ATTACH_SYMBOL: EnvVar = ("REMUX_ATTACH_SYMBOL", "*");
pub static NEW_WINDOW_NAME: EnvVar = ("REMUX_NEW_WINDOW", "");
pub fn env_var(envvar: EnvVar) -> String {
var(envvar.0).unwrap_or(envvar.1.to_string())
}
pub fn tmux() -> bool { !var("TMUX").unwrap_or("".to_string()).is_empty() }

View file

@ -1,7 +1,7 @@
type Flag = [&'static str;2];
pub static DETACHED: Flag = ["-d", "--detached"];
pub static DETACH: Flag = ["-d", "--detach"];
pub static HELP: Flag = ["-h", "--help"];
pub static NEST: Flag = ["-n", "--nest"];
pub static QUIET: Flag = ["-q", "--quiet"];

View file

@ -16,16 +16,25 @@ A command wrapper for tmux written in Rust.
usage: remux <command> [<args>]
commands:
help Show help text for remux or a specific command
help Show help text for remux, a command, or a help topic.
attach Attach to an existing tmux session
detach Detach clients from a tmux session
has Check if a tmux session exists
list Pretty-print all tmux sessions
new Create a new tmux session
Use 'remux help <command>' to see detailed help text for each command."),
root print session path (session)
switch switch to another session (session)
Some("a" | "attach")
Use 'remux help <command>' to see detailed help text for each command.
help topics:
env Environment variables"),
// COMMAND HELP
Some("a" | "attach")
=>
println!("remux attach
Attach to an existing session.
@ -114,7 +123,23 @@ args:
flags:
-r, --read-only Attach the target session as read-only."),
// not found
// TOPIC HELP
Some("env" | "vars")
=>
println!("remux environment variables
REMUX_ATTACH_SYMBOL
Changes the symbol displayed for attached sessions displayed
by the 'list' command.
Default: '*'
REMUX_NEW_WINDOW
Provides a default window name when creating a session with
the 'new' command, if not empty.
Default: ''"),
// not found
_ => error::no_help(topic.unwrap())
}
}

View file

@ -3,6 +3,7 @@ use std::env::{ set_var, var };
use pico_args::Arguments;
mod command;
mod env;
mod error;
mod flag;
mod help;

View file

@ -1,5 +1,5 @@
use std::{
env::{ current_dir, var },
env::current_dir,
io::{ stdout, IsTerminal },
path::PathBuf,
process::exit
@ -12,7 +12,10 @@ use tmux_interface::{
variables::session::SessionsCtl
};
use crate::error;
use crate::{
env,
error
};
/// return a Vec of all sessions or None
pub fn get_sessions() -> Option<Vec<Session>> {
@ -24,10 +27,9 @@ pub fn get_sessions() -> Option<Vec<Session>> {
/// show the tmux nest text if env var is not unset
pub fn prevent_nest() {
let tmux = var("TMUX").ok();
if tmux.is_some() && tmux.unwrap() != "" {
if env::tmux() {
println!("Sessions should be nested with care; unset TMUX or use the '-n' flag to allow.");
exit(1);
exit(6);
}
}
@ -44,7 +46,6 @@ pub fn session_exists<S: Into<String>>(target: S) -> bool {
let has_session = commands::HasSession::new()
.target_session(target.into());
Tmux::new().add_command(has_session)
.disable_echo()
.status()
.unwrap()
.success()