Merge pull request #36 from PicoJr/dev

v1.5.0

Author: PicoJr

CHANGELOG.md

@@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.5.0](https://crates.io/crates/rtw/1.5.0) Jun 21, 2020 
+
+* add `completion <shell>` command.
+
+`rtw completion <shell>` generates completion file for `<shell>`
+
 ## [1.4.1](https://crates.io/crates/rtw/1.4.1) Jun 19, 2020 
 
 * Fix timeline crash when activity spans over several days (#33)

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rtw"
-version = "1.4.1"
+version = "1.5.0"
 authors = ["PicoJr <picojr_dev@gmx.com>"]
 edition = "2018"
 repository = "https://github.com/PicoJr/rtw"
@@ -9,7 +9,7 @@ license = "MIT OR Apache-2.0"
 readme = "README.md"
 keywords = ["time", "tracker", "cli", "tool"]
 categories = ["command-line-utilities"]
-include = ["src/**/*", "/LICENSE", "/README.md", "/CHANGELOG.md", "/commands.md", "/img/*"]
+include = ["src/**/*", "/LICENSE", "/README.md", "/CHANGELOG.md", "/commands.md", "/shell-completion.md", "/img/*"]
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 

README.md

@@ -55,6 +55,10 @@ cargo build --release
 
 Download the corresponding archive from the [Release page](https://github.com/picojr/rtw/releases).
 
+### Shell Completion (Bash, Zsh, Fish, Powershell, Elvish)
+
+Please see [shell completion](shell-completion.md).
+
 ## Changelog
 
 Please see the [CHANGELOG](CHANGELOG.md) for a release history.

release.bash

@@ -6,4 +6,4 @@ rustfmt --check src/**/*.rs &&
     cargo test &&
     cargo build --release &&
     mkdir -p ${RELEASE_DIR} &&
-    cp -r CHANGELOG.md commands.md example/ img/ README.md LICENSE target/release/rtw ${RELEASE_DIR}
+    cp -r ./CHANGELOG.md ./commands.md ./shell-completion.md example/ img/ ./README.md ./LICENSE target/release/rtw ${RELEASE_DIR}

shell-completion.md

@@ -0,0 +1,33 @@
+# RTW Shell Completion
+
+supported shells: bash, zsh, fish, powershell, elvish
+
+Write completion file for `<shell>` to stdout:
+
+```
+rtw completion <shell>
+```
+
+## oh-my-zsh
+
+```
+.oh-my-zsh/custom/plugins/rtw
+├── _rtw
+└── rtw.plugin.zsh
+```
+
+```
+mkdir -p ~/.oh-my-zsh/custom/plugins/rtw
+rtw completion zsh > ~/.oh-my-zsh/custom/plugins/rtw/_rtw
+echo "#rtw completion plugin" > ~/.oh-my-zsh/custom/plugins/rtw/rtw.plugin.zsh
+```
+
+Add `rtw` to `plugins` in `.zshrc`:
+
+```
+# Which plugins would you like to load? (plugins can be found in ~/.oh-my-zsh/plugins/*)
+# Custom plugins may be added to ~/.oh-my-zsh/custom/plugins/
+# Example format: plugins=(rails git textmate ruby lighthouse)
+# Add wisely, as too many plugins slow down shell startup.
+plugins=(git rtw)
+```

src/cli_helper.rs

@@ -71,7 +71,7 @@ fn split_time_range(tokens: &[String], clock: &dyn Clock) -> anyhow::Result<(Tim
 }
 
 pub fn get_app() -> App<'static, 'static> {
-    App::new("RTW")
+    App::new(crate_name!())
         .version(crate_version!())
         .author("PicoJr")
         .about("rust time tracking CLI")
@@ -224,6 +224,16 @@ pub fn get_app() -> App<'static, 'static> {
                 .arg(Arg::with_name("id").required(true).help("activity id")),
         )
         .subcommand(SubCommand::with_name("cancel").about("cancel current activity"))
+        .subcommand(
+            SubCommand::with_name("completion")
+                .about("generate completion file")
+                .arg(
+                    Arg::with_name("shell")
+                        .possible_values(&["bash", "zsh", "fish", "powershell", "elvish"])
+                        .takes_value(true)
+                        .required(true),
+                ),
+        )
 }
 
 pub fn parse_start_args(start_m: &ArgMatches, clock: &dyn Clock) -> anyhow::Result<(Time, Tags)> {
@@ -327,6 +337,19 @@ pub fn parse_delete_args(delete_m: &ArgMatches) -> anyhow::Result<ActivityId> {
     }
 }
 
+pub fn parse_completion_args(completion_m: &ArgMatches) -> anyhow::Result<clap::Shell> {
+    let shell_maybe = completion_m.value_of("shell");
+    match shell_maybe {
+        Some("bash") => Ok(clap::Shell::Bash),
+        Some("zsh") => Ok(clap::Shell::Zsh),
+        Some("fish") => Ok(clap::Shell::Fish),
+        Some("powershell") => Ok(clap::Shell::PowerShell),
+        Some("elvish") => Ok(clap::Shell::Elvish),
+        None => Err(anyhow::anyhow!("missing shell")), // should never happen thanks to clap check
+        _ => Err(anyhow::anyhow!("invalid shell")),    // should never happen thanks to clap check
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use crate::chrono_clock::ChronoClock;

src/rtw_cli.rs

@@ -29,6 +29,7 @@ pub enum RTWAction {
     Delete(ActivityId),
     DisplayCurrent,
     Timeline((DateTimeW, DateTimeW)),
+    Completion(clap::Shell),
 }
 
 pub enum RTWMutation {
@@ -93,6 +94,10 @@ where
                 cli_helper::parse_summary_args(sub_m, clock)?;
             Ok(RTWAction::DumpICal((range_start, range_end)))
         }
+        ("completion", Some(sub_m)) => {
+            let shell = cli_helper::parse_completion_args(sub_m)?;
+            Ok(RTWAction::Completion(shell))
+        }
         // default case: display current activity
         _ => Ok(RTWAction::DisplayCurrent),
     }
@@ -262,6 +267,11 @@ where
             println!("{}", calendar);
             Ok(RTWMutation::Pure)
         }
+        RTWAction::Completion(shell) => {
+            let mut app = cli_helper::get_app();
+            app.gen_completions_to(crate_name!(), shell, &mut std::io::stdout());
+            Ok(RTWMutation::Pure)
+        }
     }
 }