Allow `~/.config/sdkman/config` to override `~/.sdkman/etc/config` #1069

felipecrs · 2022-03-14T18:23:49Z

Because the current approach is very dotfiles unfriendly.

Fixes #941

felipecrs · 2022-03-14T18:27:26Z

I may need to add tests and fix the CI. I would just like to receive a greenlight from the maintainers before I spend time on it.

marc0der

I'd really prefer to keep the base SDKMAN directory free from configuration. That is explicitly what the etc directory is for. Also, you will see no other files, just directories, in the base dir.

However, I would consider an override if you wanted an .sdkmanrc file in your home directory. That makes more sense and is more in line with what you would expect on a Unix system.

Another thing also not considered is the sdk config command for editing the configuration. Which of these files should it be responsible for editing?

felipecrs · 2022-03-14T23:12:46Z

However, I would consider an override if you wanted an .sdkmanrc file in your home directory. That makes more sense and is more in line with what you would expect on a Unix system.

That's what I'm proposing, ~/.sdkmanrc as an override option only. I have no intention to change anything in ~/.sdkman/etc/config or how it works.

Another thing also not considered is the sdk config command for editing the configuration. Which of these files should it be responsible for editing?

Actually, I considered and changed sdk config to edit ~/.sdkmanrc instead of ~/.sdkman/etc/config. But I'm okay to change it back to etc/config if you do not agree.

helpermethod · 2022-03-15T05:32:41Z

In any case please don't name it .sdkmanrc 😂. We already use .sdkmanrc files for storing per-project candidate versions.

An .sdkmanrc file in the $HOME directory looks like a similar file but per-user.

A lot of popular tools use that convention, e.g. NPM and direnv

https://docs.npmjs.com/cli/v8/configuring-npm/npmrc
https://direnv.net/#how-it-works

src/main/bash/sdkman-config.sh

src/main/bash/sdkman-init.sh

src/main/bash/sdkman-main.sh

felipecrs · 2022-03-15T12:13:53Z

How about ~/.sdkmanconfig (like ~/.gitconfig)?

tripleo1 · 2022-03-20T00:57:09Z

I would prefer not to have another file in my home directory.

Use .config or something. (see #941)

Just my 2 cents.

felipecrs · 2022-03-20T17:06:54Z

Yeah, I also agree.

I would prefer not to have another file in my home directory.

PS: sdkman won't create this file automatically.

felipecrs · 2022-03-20T17:11:11Z

Changed.

marc0der · 2022-03-20T18:29:03Z

I'll be very honest, but I'm leaning towards not having this capability at all. I honestly don't think that our users want this feature since it has never been asked for before.

Another point is that modern Linux systems do not store configuration directly in the home directory. Instead, the ~/.config directory is used to contain all config files. And again different rules apply on Mac.

Besides that, I think that this has many undesired side effects and consequences that simply haven't been thought through.

felipecrs · 2022-03-20T18:57:32Z

@marc0der I changed already to ~/.config.

felipecrs · 2023-06-19T17:14:35Z

I honestly don't think that our users want this feature since it has never been asked for before.

@marc0der it seems that I'm no longer alone: #1160

If you want, I can rebase this PR.

untainsYD · 2023-10-19T16:51:09Z

Are there any updates on this issue? It is quite annoying that sdk-cli pollutes my home directory instead of creating .sdkmanrc file in ~/.config/sdkman/...

felipecrs · 2023-10-19T17:49:03Z

I will wait for maintainers to comment before I rebase this PR.

sdavids · 2023-11-03T18:14:41Z

src/main/bash/sdkman-init.sh

@@ -34,6 +34,11 @@ if [ -f "${SDKMAN_DIR}/etc/config" ]; then
 	source "${SDKMAN_DIR}/etc/config"
 fi

+# Load the sdkman user config if it exists.
+if [ -f "${HOME}/.config/sdkman/config" ]; then


"${XDG_CONFIG_HOME}/sdkman/config"

if XDG_CONFIG_HOME is not set then "${HOME}/.config/sdkman/config"

https://wiki.archlinux.org/title/XDG_Base_Directory#User_directories

sdavids · 2023-11-03T18:14:52Z

src/main/bash/sdkman-main.sh

@@ -95,6 +95,11 @@ function sdk() {
 		source "${SDKMAN_DIR}/etc/config"
 	fi

+	# Load the sdkman user config if it exists.
+	if [ -f "${HOME}/.config/sdkman/config" ]; then


sdavids · 2023-11-03T18:26:35Z

Are there any updates on this issue? It is quite annoying that sdk-cli pollutes my home directory instead of creating .sdkmanrc file in ~/.config/sdkman/...

$ export SDKMAN_DIR="${XDG_DATA_HOME}/sdkman" && \
  curl -s "https://get.sdkman.io/" | bash

~/.zshrc

### sdkman - https://sdkman.io/

readonly sdkman_home="${XDG_DATA_HOME}/sdkman"

if [ -d "${sdkman_home}" ]; then
  export SDKMAN_DIR="${sdkman_home}"

  if [ -s "${sdkman_home}/bin/sdkman-init.sh" ]; then
    . "${sdkman_home}/bin/sdkman-init.sh"
  fi
fi

It would be nice if there were a SDKMAN_CONFIG_DIR:

$ export SDKMAN_DIR="${XDG_DATA_HOME}/sdkman" && \
  export SDKMAN_CONFIG_DIR="${XDG_CONFIG_HOME}/sdkman" && \
  curl -s "https://get.sdkman.io/" | bash

felipecrs · 2023-12-22T17:53:01Z

@sdavids thanks for your suggestions, but I'll wait to have a go ahead from some maintainer before spending more time in this PR.

Allow ~/.sdkmanrc to overwrite ~/.sdkman/etc/config

ea21d5d

marc0der reviewed Mar 14, 2022

View reviewed changes

felipecrs changed the title ~~Allow ~/.sdkmanrc to overwrite ~/.sdkman/etc/config~~ Allow ~/.sdkmanrc to override ~/.sdkman/etc/config Mar 14, 2022

marc0der reviewed Mar 15, 2022

View reviewed changes

src/main/bash/sdkman-config.sh Outdated Show resolved Hide resolved

marc0der reviewed Mar 15, 2022

View reviewed changes

src/main/bash/sdkman-init.sh Outdated Show resolved Hide resolved

marc0der reviewed Mar 15, 2022

View reviewed changes

src/main/bash/sdkman-main.sh Outdated Show resolved Hide resolved

Change to .sdkmanconfig

0c20697

github-actions bot requested review from helpermethod and marc0der March 15, 2022 17:09

github-actions bot assigned felipecrs Mar 15, 2022

felipecrs changed the title ~~Allow ~/.sdkmanrc to override ~/.sdkman/etc/config~~ Allow ~/.sdkmanconfig to override ~/.sdkman/etc/config Mar 15, 2022

felipecrs mentioned this pull request Mar 19, 2022

Add Homebrew support #1042

Merged

7 tasks

Use XDG spec instead

a25768c

felipecrs changed the title ~~Allow ~/.sdkmanconfig to override ~/.sdkman/etc/config~~ Allow ~/.config/sdkman/config to override ~/.sdkman/etc/config Mar 20, 2022

patrikcoch123 approved these changes May 24, 2022

View reviewed changes

Li-Gru approved these changes Nov 9, 2022

View reviewed changes

gavvvr mentioned this pull request Dec 22, 2022

"You already have SDKMAN installed" after deploying dotfiles with sdkman config #1160

Open

sdavids reviewed Nov 3, 2023

View reviewed changes

sdavids mentioned this pull request Nov 3, 2023

Feature: stop mixing the default config with user config in a single file #941

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow `~/.config/sdkman/config` to override `~/.sdkman/etc/config` #1069

Allow `~/.config/sdkman/config` to override `~/.sdkman/etc/config` #1069

felipecrs commented Mar 14, 2022

felipecrs commented Mar 14, 2022

marc0der left a comment

felipecrs commented Mar 14, 2022

helpermethod commented Mar 15, 2022

felipecrs commented Mar 15, 2022

tripleo1 commented Mar 20, 2022 •

edited

felipecrs commented Mar 20, 2022 •

edited

felipecrs commented Mar 20, 2022

marc0der commented Mar 20, 2022 •

edited

felipecrs commented Mar 20, 2022

felipecrs commented Jun 19, 2023

untainsYD commented Oct 19, 2023

felipecrs commented Oct 19, 2023

sdavids Nov 3, 2023

sdavids Nov 3, 2023

sdavids commented Nov 3, 2023

felipecrs commented Dec 22, 2023

Allow ~/.config/sdkman/config to override ~/.sdkman/etc/config #1069

Are you sure you want to change the base?

Allow ~/.config/sdkman/config to override ~/.sdkman/etc/config #1069

Conversation

felipecrs commented Mar 14, 2022

felipecrs commented Mar 14, 2022

marc0der left a comment

Choose a reason for hiding this comment

felipecrs commented Mar 14, 2022

helpermethod commented Mar 15, 2022

felipecrs commented Mar 15, 2022

tripleo1 commented Mar 20, 2022 • edited

felipecrs commented Mar 20, 2022 • edited

felipecrs commented Mar 20, 2022

marc0der commented Mar 20, 2022 • edited

felipecrs commented Mar 20, 2022

felipecrs commented Jun 19, 2023

untainsYD commented Oct 19, 2023

felipecrs commented Oct 19, 2023

sdavids Nov 3, 2023

Choose a reason for hiding this comment

sdavids Nov 3, 2023

Choose a reason for hiding this comment

sdavids commented Nov 3, 2023

felipecrs commented Dec 22, 2023

Allow `~/.config/sdkman/config` to override `~/.sdkman/etc/config` #1069

Allow `~/.config/sdkman/config` to override `~/.sdkman/etc/config` #1069

tripleo1 commented Mar 20, 2022 •

edited

felipecrs commented Mar 20, 2022 •

edited

marc0der commented Mar 20, 2022 •

edited