Merge pull request #1655 from axodotdev/xdg-config-home

feat: support XDG_CONFIG_HOME
axodotdev · Dec 20, 2024 · 8d4da89 · 8d4da89
2 parents aa437ee + 991430d
commit 8d4da89
Show file tree

Hide file tree

Showing 54 changed files with 262 additions and 94 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -22,7 +22,7 @@ axoproject = { version = "=0.26.1", path = "axoproject", default-features = fals
 
 # first-party deps
 axocli = { version = "0.2.0" }
-axoupdater = { version = "0.8.2" }
+axoupdater = { version = "0.9.0" }
 axotag = "0.2.0"
 axoasset = { version = "1.2.0", features = ["json-serde", "toml-serde", "toml-edit", "yaml-serde", "compression", "remote"] }
 axoprocess = { version = "0.2.0" }

diff --git a/cargo-dist/src/lib.rs b/cargo-dist/src/lib.rs
@@ -255,7 +255,7 @@ fn run_build_step(
 }
 
 const AXOUPDATER_ASSET_ROOT: &str = "https://github.com/axodotdev/axoupdater/releases";
-const AXOUPDATER_MINIMUM_VERSION: &str = "0.7.0";
+const AXOUPDATER_MINIMUM_VERSION: &str = "0.9.0";
 
 fn axoupdater_latest_asset_root() -> String {
     format!("{AXOUPDATER_ASSET_ROOT}/latest/download")

diff --git a/cargo-dist/templates/installer/installer.ps1.j2 b/cargo-dist/templates/installer/installer.ps1.j2
@@ -72,7 +72,11 @@ if ($env:INSTALLER_DOWNLOAD_URL) {
 $receipt = @"
 {{ receipt | tojson }}
 "@
-$receipt_home = "${env:LOCALAPPDATA}\{{ app_name }}"
+if ($env:XDG_CONFIG_HOME) {
+  $receipt_home = "${env:XDG_CONFIG_HOME}\{{ app_name }}"
+} else {
+  $receipt_home = "${env:LOCALAPPDATA}\{{ app_name }}"
+}
 
 if ($env:{{ env_vars.disable_update_env_var }}) {
   $install_updater = $false

diff --git a/cargo-dist/templates/installer/installer.sh.j2 b/cargo-dist/templates/installer/installer.sh.j2
@@ -54,7 +54,7 @@ fi
 read -r RECEIPT <<EORECEIPT
 {{ receipt | tojson }}
 EORECEIPT
-RECEIPT_HOME="${HOME}/.config/{{ app_name }}"
+RECEIPT_HOME="${XDG_CONFIG_HOME:-$HOME/.config}/{{ app_name }}"
 
 usage() {
     # print help (this cat/EOF stuff is a "heredoc" string)

diff --git a/cargo-dist/tests/cli-tests.rs b/cargo-dist/tests/cli-tests.rs
@@ -273,6 +273,8 @@ fn test_self_update() {
         .map(|s| s == "selfupdate" || s == "all")
         .unwrap_or(false)
     {
+        std::env::remove_var("XDG_CONFIG_HOME");
+
         let mut args = RuntestArgs {
             app_name: "cargo-dist".to_owned(),
             package: "cargo-dist".to_owned(),

diff --git a/cargo-dist/tests/gallery/dist/powershell.rs b/cargo-dist/tests/gallery/dist/powershell.rs
@@ -105,6 +105,7 @@ impl AppResult {
                     .env("LOCALAPPDATA", &appdata)
                     .env("MY_ENV_VAR", &app_home)
                     .env_remove("CARGO_HOME")
+                    .env_remove("XDG_CONFIG_HOME")
                     .env_remove("PSModulePath")
             })?;
             eprintln!(

diff --git a/cargo-dist/tests/gallery/dist/shell.rs b/cargo-dist/tests/gallery/dist/shell.rs
@@ -48,6 +48,7 @@ impl AppResult {
                     .env("ZDOTDIR", &tempdir)
                     .env("MY_ENV_VAR", &app_home)
                     .env_remove("CARGO_HOME")
+                    .env_remove("XDG_CONFIG_HOME")
             })?;
             // we could theoretically look at the above output and parse out the `source` line...
 

diff --git a/cargo-dist/tests/snapshots/akaikatana_basic.snap b/cargo-dist/tests/snapshots/akaikatana_basic.snap
diff --git a/cargo-dist/tests/snapshots/akaikatana_musl.snap b/cargo-dist/tests/snapshots/akaikatana_musl.snap
diff --git a/cargo-dist/tests/snapshots/akaikatana_one_alias_among_many_binaries.snap b/cargo-dist/tests/snapshots/akaikatana_one_alias_among_many_binaries.snap
diff --git a/cargo-dist/tests/snapshots/akaikatana_two_bin_aliases.snap b/cargo-dist/tests/snapshots/akaikatana_two_bin_aliases.snap
diff --git a/cargo-dist/tests/snapshots/akaikatana_updaters.snap b/cargo-dist/tests/snapshots/akaikatana_updaters.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_abyss.snap b/cargo-dist/tests/snapshots/axolotlsay_abyss.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_abyss_only.snap b/cargo-dist/tests/snapshots/axolotlsay_abyss_only.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_alias.snap b/cargo-dist/tests/snapshots/axolotlsay_alias.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_alias_ignores_missing_bins.snap b/cargo-dist/tests/snapshots/axolotlsay_alias_ignores_missing_bins.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_basic.snap b/cargo-dist/tests/snapshots/axolotlsay_basic.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_basic_lies.snap b/cargo-dist/tests/snapshots/axolotlsay_basic_lies.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_build_setup_steps.snap b/cargo-dist/tests/snapshots/axolotlsay_build_setup_steps.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_checksum_blake2b.snap b/cargo-dist/tests/snapshots/axolotlsay_checksum_blake2b.snap
diff --git a/cargo-dist/tests/snapshots/axolotlsay_checksum_blake2s.snap b/cargo-dist/tests/snapshots/axolotlsay_checksum_blake2s.snap