Merge pull request #4 from rage/dev

HoolaBoola · web-flow · commit 32f5b5f527d5 · 2021-05-10T22:59:09.000+03:00
Merge dev into main - adds completion script functionalities
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,6 +8,7 @@ authors = ["HoolaBoola <jaime.heikkiladias@helsinki.fi>",
 edition = "2018"
 description = "Command line interface for TMC, written in Rust."
 license = "Apache-2.0"
+build = "build.rs"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
@@ -35,3 +36,6 @@ crossterm = "0.19"
 tui = { version = "0.14", default-features = false, features = ['crossterm'] }
 termcolor = "1.1"
 terminal_size = "0.1.16"
+
+[build-dependencies]
+clap = "2.3.3"
diff --git a/README.md b/README.md
@@ -76,6 +76,10 @@ To use the software from any directory, you can add it to your environmental var
 
         echo "alias tmc='<directory>/<executable name>'" >> "$HOME/.bashrc"
 
+#### For macOS
+
+The instructions for Linux **should** work on macOS as well. This has not been tested yet, though, so your mileage may vary.
+
 #### For Windows: 
 
 After downloading the executable you can start using it from the command line by navigating to the directory it resides at. 
@@ -84,6 +88,12 @@ To be able to use it from any directory, you can add it to your environmental va
 
         set PATH=%PATH%;<directory>
 
+#### Tab-completion from commandline
+
+You can generate shell completion scripts by running `tmc generate-completions --[bash/zsh/powershell] > /path/to/your/completions/directory/filename`. For `bash`, `filename` should be `tmc.bash`. For `zsh`, `_tmc`. This has not yet been tested for Powershell, but the script *should* work if placed in the appropriate directory.
+
+Make sure to have the appropriate software configuration for completions to work. For Zsh and Powershell, completions should be supported by default, but for Bash you may need to install `bash-completion` or similar packages and follow their documentation.
+
 ## Commands
 
         tmc [FLAGS] [SUBCOMMAND]
diff --git a/build.rs b/build.rs
@@ -0,0 +1,20 @@
+use clap::Shell;
+
+include!("src/cli.rs");
+
+fn main() {
+    let outdir = match std::env::var_os("OUT_DIR") {
+        None => {
+            println!("Hellooo");
+            return;
+        }
+        Some(outdir) => outdir,
+    };
+
+    println!("{:?}", outdir);
+
+    let mut app = build_cli();
+    app.gen_completions("tmc", Shell::Bash, &outdir);
+    app.gen_completions("tmc", Shell::PowerShell, &outdir);
+    app.gen_completions("tmc", Shell::Zsh, &outdir);
+}
diff --git a/scripts/install.sh b/scripts/install.sh
@@ -1,18 +1,19 @@
 #!/bin/bash
+
 set -euo pipefail
 
 echo "~ Installing TMC-CLI ~"
 echo "(If your shell is not bash, you may have to do the installation manually.)"
 echo ""
 
-if (( $# < 2 )); then
-  echo "You need to give architecture (x86_64/i686) and OS (mac, linux) as arguments."
-  exit 1
-fi
+os="$(uname -s)"
+platform="$(uname -m)"
 
-# Get platform-string from first argument, OS from the second
-platform=$1
-os=$2
+if (( $# = 2 )); then
+  # Get platform-string from first argument, OS from the second
+  platform=$1
+  os=$2
+fi
 
 echo "Fetching latest version URL from https://download.mooc.fi"
 if ! PAGE=$(curl -s https://download.mooc.fi); then
@@ -24,7 +25,7 @@ fi
 PAGE=$(echo $PAGE | sed -r 's:</Contents><Contents>:</Contents> <Contents>:g')
 
 fileprefx=""
-if [[ "$os" == "mac" ]]; then
+if [[ "$os" == "Darwin" ]]; then
   fileprefx="tmc-cli-rust-${platform}-apple-darwin-v"
 else
   fileprefx="tmc-cli-rust-${platform}-unknown-linux-gnu-v"
@@ -94,19 +95,69 @@ elif [ "$SHELLNAME" = "csh" ] || [ "$SHELLNAME" = "tcsh" ]; then
   echo "Please add manually variables from $PROFILEFILE to your .cshrc using csh syntax."
 else
   PROFILEFILE=$HOME/.shrc
-  echo "Defaulting to .shrc for environment variables, if this is incorrect, please copy these manually to correct file."
+  echo "Defaulting to .shrc for environment variables. If this is incorrect, please copy these manually to correct file."
 fi
-# Removes old aliases
+# Removes old aliases and such
 sed -i '/alias tmc=/d' "$PROFILEFILE"
+sed -i "/export TMC_LANGS_CONFIG_DIR=/d" "$PROFILEFILE"
 
 echo $PROFILEFILE
 
+COMPLETIONS_PATH=$HOME/.local/share/tmc-autocomplete
+
+
+CMD=$PWD/$filename
+
 # Saves new alias to .bashrc
-echo "alias tmc='$PWD/$filename'" >> "$PROFILEFILE"
+echo "alias tmc='$CMD'" >> "$PROFILEFILE"
 echo "export TMC_LANGS_CONFIG_DIR='$HOME/tmc-config'" >> "$PROFILEFILE"
 
 echo ""
 
+
+
+#
+#
+# Auto-complete scripts
+# 
+#
+if [ "$SHELLNAME" = "bash" ]; then
+ 
+
+  echo "Generating auto-complete scripts to $COMPLETIONS_PATH"
+  echo ""
+  echo "" 
+
+  # removing possibly existing sourcing
+  sed -i '/source/!b;/tmc-autocomplete/d' "$PROFILEFILE"
+
+
+  # creating the completions directory, if it doesn't exist
+  eval "mkdir -p $COMPLETIONS_PATH"
+
+  # calling the generate-completions subcommand to generate the completion script
+  eval "$CMD generate-completions --bash > $COMPLETIONS_PATH/tmc.bash"
+
+  # adding the line to .bashrc so that bash knows where to look for
+  echo "source $COMPLETIONS_PATH/tmc.bash" >> "$PROFILEFILE"
+
+elif [ "$SHELLNAME" = "zsh" ]; then
+  echo "Generating auto-complete scripts to $COMPLETIONS_PATH"
+  echo ""
+  echo ""
+
+  # removing possibly existing definitions
+  sed -i "/compdef _tmc/d" "$PROFILEFILE"
+  sed -i '/fpath/!b;/tmc-autocomplete/d' "$PROFILEFILE"
+
+  eval "mkdir -p $COMPLETIONS_PATH"
+  eval "$CMD generate-completions --bash > $COMPLETIONS_PATH/_tmc"
+
+  echo "fpath=($COMPLETIONS_PATH/_tmc " '$fpath)' >> "$PROFILEFILE"
+
+  echo "compdef _tmc tmc" >> "$PROFILEFILE"
+fi
+
 echo "Installation complete. Please restart the terminal."
 echo "After opening a new terminal, you can try using TMC-CLI from the command line with:"
 echo "  'tmc login'"
diff --git a/src/cli.rs b/src/cli.rs
@@ -10,84 +10,84 @@ pub fn build_cli() -> App<'static, 'static> {
         .subcommand(SubCommand::with_name("courses").about("List the available courses"))
         .subcommand(
             SubCommand::with_name("download")
-                .about("Downloads course exercises")
-                .arg(
-                    Arg::with_name("course")
-                        .short("c")
-                        .long("course")
-                        .value_name("course name")
-                        .required(false),
+            .about("Downloads course exercises")
+            .arg(
+                Arg::with_name("course")
+                .short("c")
+                .long("course")
+                .value_name("course name")
+                .required(false),
                 )
-                .arg(
-                    Arg::with_name("currentdir")
-                        .short("d")
-                        .long("currentdir")
-                        .required(false),
+            .arg(
+                Arg::with_name("currentdir")
+                .short("d")
+                .long("currentdir")
+                .required(false),
                 ),
-        )
+                )
         .subcommand(
             SubCommand::with_name("exercises")
-                .about("List the exercises for a specific course")
-                .arg(Arg::with_name("course").value_name("course").required(true)),
-        )
+            .about("List the exercises for a specific course")
+            .arg(Arg::with_name("course").value_name("course").required(true)),
+            )
         .subcommand(
             SubCommand::with_name("login")
-                .about("Login to TMC server")
-                .arg(
-                    Arg::with_name("non-interactive")
-                        .short("n")
-                        .help("Initiates the non-interactive mode.")
-                        .long("non-interactive"),
+            .about("Login to TMC server")
+            .arg(
+                Arg::with_name("non-interactive")
+                .short("n")
+                .help("Initiates the non-interactive mode.")
+                .long("non-interactive"),
                 ),
-        )
+                )
         .subcommand(SubCommand::with_name("logout").about("Logout from TMC server"))
         .subcommand(
             SubCommand::with_name("organization")
-                .about("Change organization")
-                .arg(
-                    Arg::with_name("non-interactive")
-                        .short("n")
-                        .help("Initiates the non-interactive mode.")
-                        .long("non-interactive"),
+            .about("Change organization")
+            .arg(
+                Arg::with_name("non-interactive")
+                .short("n")
+                .help("Initiates the non-interactive mode.")
+                .long("non-interactive"),
                 ),
-        )
+                )
         .subcommand(
             SubCommand::with_name("paste")
-                .about("Submit exercise to TMC pastebin")
-                .arg(
-                    Arg::with_name("exercise")
-                        .value_name("exercise")
-                        .required(false),
+            .about("Submit exercise to TMC pastebin")
+            .arg(
+                Arg::with_name("exercise")
+                .value_name("exercise")
+                .required(false),
                 ),
-        )
+                )
         .subcommand(
             SubCommand::with_name("submit")
-                .about("Submit exercises to TMC server")
-                .arg(
-                    Arg::with_name("exercise")
-                        .value_name("exercise")
-                        .required(false),
+            .about("Submit exercises to TMC server")
+            .arg(
+                Arg::with_name("exercise")
+                .value_name("exercise")
+                .required(false),
                 ),
-        )
+                )
         .subcommand(
             SubCommand::with_name("test")
-                .about("Run local exercise tests")
-                .arg(
-                    Arg::with_name("exercise")
-                        .value_name("exercise")
-                        .required(false),
+            .about("Run local exercise tests")
+            .arg(
+                Arg::with_name("exercise")
+                .value_name("exercise")
+                .required(false),
                 ),
-        )
+                )
         .subcommand(
             SubCommand::with_name("fetchupdate")
-                .setting(AppSettings::Hidden)
-                .about("Finishes the autoupdater. Administator rights needed."),
-        )
+            .setting(AppSettings::Hidden)
+            .about("Finishes the autoupdater. Administator rights needed."),
+            )
         .subcommand(
             SubCommand::with_name("cleartemp")
-                .setting(AppSettings::Hidden)
-                .about("Removes tempfiles. Administator rights needed."),
-        )
+            .setting(AppSettings::Hidden)
+            .about("Removes tempfiles. Administator rights needed."),
+            )
         .subcommand(
             SubCommand::with_name("elevateddownload")
                 .setting(AppSettings::Hidden)
@@ -111,13 +111,33 @@ pub fn build_cli() -> App<'static, 'static> {
         .subcommand(SubCommand::with_name("update").about("Update exercises"))
         .arg(
             Arg::with_name("no-update")
-                .short("d")
-                .long("no-update")
-                .help("Disable auto update temporarily"),
-        )
+            .short("d")
+            .long("no-update")
+            .help("Disable auto update temporarily"),
+            )
         .arg(
             Arg::with_name("testmode")
-                .long("testmode")
-                .help("Only for internal testing, disables server connection"),
-        )
+            .long("testmode")
+            .help("Only for internal testing, disables server connection"),
+            )
+        .subcommand(SubCommand::with_name("generate-completions")
+                    .usage("tmc generate_completions --[your shell] > /path/to/your/completions/folder")
+                    .about("Generate completion scripts for command line usage.")
+                    .setting(AppSettings::DisableVersion)
+                    .setting(AppSettings::Hidden)
+                    .setting(AppSettings::DeriveDisplayOrder)
+                    .arg(
+                        Arg::with_name("bash")
+                        .short("b")
+                        .long("bash"))
+                    .arg(
+                        Arg::with_name("zsh")
+                        .short("z")
+                        .long("zsh")
+                        )
+                    .arg(
+                        Arg::with_name("powershell")
+                        .short("p")
+                        .long("powershell"))
+                    )
 }
diff --git a/src/main.rs b/src/main.rs
@@ -1,6 +1,10 @@
+use clap::{ArgMatches, Shell};
 use termcolor::{BufferWriter, ColorChoice};
 
-use std::io::{stdin, stdout};
+use std::{
+    io,
+    io::{stdin, stdout},
+};
 
 pub mod io_module;
 use io_module::IoProduction;
@@ -11,8 +15,12 @@ pub mod progress_reporting;
 mod updater;
 
 fn main() {
-    let matches = cli::build_cli().get_matches();
-
+    let cli = cli::build_cli();
+    let matches = cli.get_matches();
+    if matches.is_present("generate-completions") {
+        generate_completions(&matches);
+        return;
+    }
     let mut stdout = stdout();
     let mut stdin = stdin();
 
@@ -38,3 +46,18 @@ fn main() {
     }
     commands::handle(&matches, &mut io);
 }
+
+fn generate_completions(matches: &ArgMatches) {
+    let matches = matches.subcommand_matches("generate-completions").unwrap();
+    let shell = if matches.is_present("bash") {
+        Shell::Bash
+    } else if matches.is_present("zsh") {
+        Shell::Zsh
+    } else if matches.is_present("powershell") {
+        Shell::PowerShell
+    } else {
+        return;
+    };
+
+    cli::build_cli().gen_completions_to("tmc", shell, &mut io::stdout());
+}
