Setup user environment

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Setup user environment (#381)
+
 ### Fixed
 
 ### Changed

Cargo.toml

@@ -43,6 +43,7 @@ openssl = { version = "0.10.57", features = ["vendored"] }
 
 [target.'cfg(windows)'.dependencies]
 winreg = "0.51.0"
+winapi =  { version = "0.3.9", features = ["winuser"] }
 
 [dev-dependencies]
 assert_cmd = "2.0.12"

README.md

@@ -117,6 +117,11 @@ Options:
 
 ### Install Subcommand
 
+> **Warning**
+>
+> #### Environment modification
+>  Installation will, by default, modify your environment. If you dont want `espup` to modify your environment, please use the `--no-modify-env` argument.
+
 > **Note**
 >
 > #### Xtensa Rust destination path
@@ -125,7 +130,7 @@ Options:
 > **Note**
 >
 > #### GitHub API
->  During the installation process, several GitHub queries are made, [which are subject to certain limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting). Our number of queries should not hit the limits unless you are running `espup install` command numerous times in a short span of time. We recommend setting the [`GITHUB_TOKEN` environment variable](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) when using `espup` in CI, if you want to use `espup` on CI, recommend using it via the [`xtensa-toolchain` action](https://github.com/esp-rs/xtensa-toolchain/), and making sure `GITHUB_TOKEN` is not set when using it on a host machine. See https://github.com/esp-rs/xtensa-toolchain/issues/15 for more details on this.
+>  During the installation process, several GitHub queries are made, [which are subject to certain limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting). Our number of queries should not hit the limit unless you are running `espup install` command numerous times in a short span of time. We recommend setting the [`GITHUB_TOKEN` environment variable](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) when using `espup` in CI, if you want to use `espup` on CI, recommend using it via the [`xtensa-toolchain` action](https://github.com/esp-rs/xtensa-toolchain/), and making sure `GITHUB_TOKEN` is not set when using it on a host machine. See https://github.com/esp-rs/xtensa-toolchain/issues/15 for more details on this.
 
 ```
 Usage: espup install [OPTIONS]
@@ -136,9 +141,6 @@ Options:
 
           [possible values: x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu, x86_64-pc-windows-msvc, x86_64-pc-windows-gnu, x86_64-apple-darwin, aarch64-apple-darwin]
 
-  -f, --export-file <EXPORT_FILE>
-          Relative or full path for the export file that will be generated. If no path is provided, the file will be generated under home directory (https://docs.rs/dirs/latest/dirs/fn.home_dir.html)
-
   -e, --extended-llvm
           Extends the LLVM installation.
 
@@ -160,6 +162,9 @@ Options:
 
           [default: nightly]
 
+  -o, --no-modify-env
+          Don't configure environment variables
+
   -k, --skip-version-parse
           Skips parsing Xtensa Rust version
 
@@ -202,9 +207,6 @@ Options:
 
           [possible values: x86_64-unknown-linux-gnu, aarch64-unknown-linux-gnu, x86_64-pc-windows-msvc, x86_64-pc-windows-gnu, x86_64-apple-darwin, aarch64-apple-darwin]
 
-  -f, --export-file <EXPORT_FILE>
-          Relative or full path for the export file that will be generated. If no path is provided, the file will be generated under home directory (https://docs.rs/dirs/latest/dirs/fn.home_dir.html)
-
   -e, --extended-llvm
           Extends the LLVM installation.
 
@@ -226,6 +228,9 @@ Options:
 
           [default: nightly]
 
+  -o, --no-modify-env
+          Don't configure environment variables
+
   -k, --skip-version-parse
           Skips parsing Xtensa Rust version
 

src/cli.rs

@@ -1,7 +1,9 @@
+//! Command line interface.
+
 use crate::targets::{parse_targets, Target};
 use clap::Parser;
 use clap_complete::Shell;
-use std::{collections::HashSet, path::PathBuf};
+use std::collections::HashSet;
 
 #[derive(Debug, Parser)]
 pub struct CompletionsOpts {
@@ -17,9 +19,6 @@ pub struct InstallOpts {
     /// Target triple of the host.
     #[arg(short = 'd', long, value_parser = ["x86_64-unknown-linux-gnu", "aarch64-unknown-linux-gnu", "x86_64-pc-windows-msvc", "x86_64-pc-windows-gnu" , "x86_64-apple-darwin" , "aarch64-apple-darwin"])]
     pub default_host: Option<String>,
-    /// Relative or full path for the export file that will be generated. If no path is provided, the file will be generated under home directory (https://docs.rs/dirs/latest/dirs/fn.home_dir.html).
-    #[arg(short = 'f', long)]
-    pub export_file: Option<PathBuf>,
     /// Extends the LLVM installation.
     ///
     /// This will install the whole LLVM instead of only installing the libs.
@@ -34,6 +33,9 @@ pub struct InstallOpts {
     /// Nightly Rust toolchain version.
     #[arg(short = 'n', long, default_value = "nightly")]
     pub nightly_version: String,
+    /// Don't configure environment variables
+    #[arg(short = 'o', long)]
+    pub no_modify_env: bool,
     /// Skips parsing Xtensa Rust version.
     #[arg(short = 'k', long)]
     pub skip_version_parse: bool,

src/env/env.bat

@@ -0,0 +1,32 @@
+@echo off
+rem espup CMD setup
+
+set XTENSA_GCC={xtensa_gcc}
+if not "%XTENSA_GCC%" == "" (
+    echo %PATH% | findstr /C:"%XTENSA_GCC%" 1>nul
+    if errorlevel 1 (
+        rem Prepending path
+        set PATH=%XTENSA_GCC%;%PATH%
+    )
+)
+
+set RISCV_GCC={riscv_gcc}
+if not "%RISCV_GCC%" == "" (
+    echo %PATH% | findstr /C:"%RISCV_GCC%" 1>nul
+    if errorlevel 1 (
+        rem Prepending path
+        set PATH=%RISCV_GCC%;%PATH%
+    )
+)
+
+set LIBCLANG_PATH={libclang_path}
+set LIBCLANG_BIN_PATH={libclang_bin_path}
+if not "%LIBCLANG_BIN_PATH%" == "" (
+    echo %PATH% | findstr /C:"%LIBCLANG_BIN_PATH%" 1>nul
+    if errorlevel 1 (
+        rem Prepending path
+        set PATH=%LIBCLANG_BIN_PATH%;%PATH%
+    )
+)
+
+set CLANG_PATH={clang_path}

src/env/env.fish

@@ -0,0 +1,19 @@
+# espup shell setup
+set XTENSA_GCC "{xtensa_gcc}"
+if test -n "$XTENSA_GCC"
+    if not contains "{xtensa_gcc}" $PATH
+        # Prepending path
+        set -x PATH "{xtensa_gcc}" $PATH
+    end
+end
+
+set RISCV_GCC "{riscv_gcc}"
+if test -n "$RISCV_GCC"
+    if not contains "{riscv_gcc}" $PATH
+        # Prepending path
+        set -x PATH "{riscv_gcc}" $PATH
+    end
+end
+
+set -x LIBCLANG_PATH "{libclang_path}"
+set -x CLANG_PATH "{clang_path}"

src/env/env.ps1

@@ -0,0 +1,28 @@
+# espup PowerShell setup
+# affix semicolons on either side of $Env:PATH to simplify matching
+$XTENSA_GCC = "{xtensa_gcc}"
+if ($XTENSA_GCC -ne "") {
+    if (-not ($Env:PATH -like "*;$XTENSA_GCC;*")) {
+        # Prepending path
+        $Env:PATH = "$XTENSA_GCC;$Env:PATH"
+    }
+}
+
+$RISCV_GCC = "{riscv_gcc}"
+if ($RISCV_GCC -ne "") {
+    if (-not ($Env:PATH -like "*;$RISCV_GCC;*")) {
+        # Prepending path
+        $Env:PATH = "$RISCV_GCC;$Env:PATH"
+    }
+}
+
+$Env:LIBCLANG_PATH = "{libclang_path}"
+$LIBCLANG_BIN_PATH = "{libclang_bin_path}"
+if ($LIBCLANG_BIN_PATH -ne "") {
+    if (-not ($Env:PATH -like "*;$LIBCLANG_BIN_PATH;*")) {
+        # Prepending path
+        $Env:PATH = "$LIBCLANG_BIN_PATH;$Env:PATH"
+    }
+}
+
+$Env:CLANG_PATH = "{clang_path}"

src/env/env.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+# espup shell setup
+# affix colons on either side of $PATH to simplify matching
+XTENSA_GCC="{xtensa_gcc}"
+if [[ -n "${XTENSA_GCC}" ]]; then
+    case ":${PATH}:" in
+    *:"{xtensa_gcc}":*) ;;
+    *)
+        # Prepending path
+        export PATH="{xtensa_gcc}:$PATH"
+        ;;
+    esac
+fi
+RISCV_GCC="{riscv_gcc}"
+if [[ -n "${RISCV_GCC}" ]]; then
+    case ":${PATH}:" in
+    *:"{riscv_gcc}":*) ;;
+    *)
+        # Prepending path
+        export PATH="{riscv_gcc}:$PATH"
+        ;;
+    esac
+fi
+export LIBCLANG_PATH="{libclang_path}"
+export CLANG_PATH="{clang_path}"