Skip to content

Commit

Permalink
Provide dedicated message for obsolete shim case
Browse files Browse the repository at this point in the history
When a shimmed command can't find usable plugin version, we used to do
several detection then output suggestion to user.

The original message assumes "preset" plugin version is not installed,
which could be false when shimmed command has old `asdf-plugin:` version
written, while not being updated when install newer plugin version.

Here add small `preset_plugin_installed` flag to detect if any
considered "missing" plugin is in fact exist. Print only simple message
for it.

Example output:

    Shimmed command 'yarn' has no matched plugin version
    Check the executable or try install yarn for your preset plugin version
  • Loading branch information
bootleq committed Oct 20, 2024
1 parent e00e4ac commit 897ea7f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 21 deletions.
33 changes: 22 additions & 11 deletions lib/utils.bash
Original file line number Diff line number Diff line change
Expand Up @@ -803,6 +803,7 @@ with_shim_executable() {
(
local preset_plugin_versions
preset_plugin_versions=()
local preset_plugin_installed=
local closest_tool_version
closest_tool_version=$(find_tool_versions)

Expand All @@ -815,22 +816,32 @@ with_shim_executable() {
IFS=' ' read -r -a shim_versions <<<"$version_string"
local usable_plugin_versions
for shim_version in "${shim_versions[@]}"; do
preset_plugin_versions+=("$shim_plugin $shim_version")
if grep -q "$shim_version" <<<"$(asdf list "$shim_plugin")"; then
preset_plugin_installed="yes"
else
preset_plugin_versions+=("$shim_plugin $shim_version")
fi
done
done

if [ -n "${preset_plugin_versions[*]}" ]; then
printf "%s %s\n" "No preset version installed for command" "$shim_name"
printf "%s\n\n" "Please install a version by running one of the following:"
for preset_plugin_version in "${preset_plugin_versions[@]}"; do
printf "%s %s\n" "asdf install" "$preset_plugin_version"
done
printf "\n%s %s\n" "or add one of the following versions in your config file at" "$closest_tool_version"
if [ -n "$preset_plugin_installed" ]; then
printf "%s '%s' %s\n" "Shimmed command" "$shim_name" "has no matched plugin version"
printf "%s %s %s\n" "Check the executable or try install" "$shim_name" "for your preset plugin version"
else
printf "%s %s\n" "No version is set for command" "$shim_name"
printf "%s %s\n" "Consider adding one of the following versions in your config file at" "$closest_tool_version"
if [ -n "${preset_plugin_versions[*]}" ]; then
printf "%s %s\n" "No preset version installed for command" "$shim_name"
printf "%s\n\n" "Please install a version by running one of the following:"
for preset_plugin_version in "${preset_plugin_versions[@]}"; do
printf "%s %s\n" "asdf install" "$preset_plugin_version"
done
printf "\n%s %s\n" "or add one of the following versions in your config file at" "$closest_tool_version"
shim_plugin_versions "${shim_name}"
else
printf "%s %s\n" "No version is set for command" "$shim_name"
printf "%s %s\n" "Consider adding one of the following versions in your config file at" "$closest_tool_version"
shim_plugin_versions "${shim_name}"
fi
fi
shim_plugin_versions "${shim_name}"
) >&2

return 126
Expand Down
13 changes: 3 additions & 10 deletions test/shim_exec.bats
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ teardown() {
echo "$output" | grep -q "dummy 1.0" 2>/dev/null
}

@test "issue #928" {
@test "shim exec should suggest to check obsolete shim" {
# Install 1.0, with fake "dummyman" command, shimmed for 1.0
run asdf install dummy 1.0
echo "echo Dummy Manager" >"$ASDF_DIR/installs/dummy/1.0/bin/dummyman"
Expand All @@ -138,25 +138,18 @@ teardown() {

# Install 1.3
run asdf install dummy 1.3

echo "dummy 1.3" >"$PROJECT_DIR/.tool-versions"

# reshim doesn't help
run asdf reshim dummy
run asdf shim-versions dummyman
[ "$status" -eq 0 ]
[ "$output" = "dummy 1.0" ]

run "$ASDF_DIR/shims/dummyman"
[ "$status" -eq 126 ]
echo ">> $output" >&3

# Below is current (misleading) message
echo "$output" | grep -q "No preset version installed for command dummyman" 2>/dev/null
echo "$output" | grep -q "Please install a version by running one of the following:" 2>/dev/null
echo "$output" | grep -q "asdf install dummy 1.3" 2>/dev/null
echo "$output" | grep -q "or add one of the following versions in your config file at $PROJECT_DIR/.tool-versions" 2>/dev/null
echo "$output" | grep -q "dummy 1.0" 2>/dev/null
echo "$output" | grep -q "Shimmed command 'dummyman' has no matched plugin version" 2>/dev/null
echo "$output" | grep -q "Check the executable or try install dummyman for your preset plugin version" 2>/dev/null
}

@test "shim exec should execute first plugin that is installed and set" {
Expand Down

0 comments on commit 897ea7f

Please sign in to comment.