Skip to content

Add completion spec: SDKMAN! (sdk) #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lucieleblanc merged 1 commit into from
Apr 1, 2026
+329 −0
Merged

Add completion spec: SDKMAN! (sdk) #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
231 changes: 231 additions & 0 deletions command-signatures/json/sdk.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,231 @@
{
"name": "sdk",
"description": "SDKMAN! - The Software Development Kit Manager",
"subcommands": [
{
"name": [
"install",
"i"
],
"description": "Install a candidate version",
"args": [
{
"name": "candidate",
"generatorName": "candidates"
},
{
"name": "version",
"isOptional": true,
"generatorName": "available_versions"
},
{
"name": "path",
"isOptional": true,
"template": "folders"
}
]
},
{
"name": [
"uninstall",
"rm"
],
"description": "Uninstall a candidate version",
"args": [
{
"name": "candidate",
"generatorName": "candidates"
},
{
"name": "version",
"generatorName": "installed_versions"
}
]
},
{
"name": [
"list",
"ls"
],
"description": "List available candidates or candidate versions",
"args": {
"name": "candidate",
"isOptional": true,
"generatorName": "candidates"
}
},
{
"name": [
"use",
"u"
],
"description": "Use a specific version in the current shell",
"args": [
{
"name": "candidate",
"generatorName": "candidates"
},
{
"name": "version",
"generatorName": "installed_versions"
}
]
},
{
"name": [
"default",
"d"
],
"description": "Set the default candidate version for all shells",
"args": [
{
"name": "candidate",
"generatorName": "candidates"
},
{
"name": "version",
"isOptional": true,
"generatorName": "installed_versions"
}
]
},
{
"name": "home",
"description": "Output the path of a specific candidate version",
"args": [
{
"name": "candidate",
"generatorName": "candidates"
},
{
"name": "version",
"generatorName": "installed_versions"
}
]
},
{
"name": [
"current",
"c"
],
"description": "Display the current default installed versions",
"args": {
"name": "candidate",
"isOptional": true,
"generatorName": "candidates"
}
},
{
"name": [
"upgrade",
"ug"
],
"description": "Upgrade installed candidate versions",
"args": {
"name": "candidate",
"isOptional": true,
"generatorName": "candidates"
}
},
{
"name": "env",
"description": "Manage project-specific SDK versions via .sdkmanrc",
"args": {
"name": "command",
"isOptional": true,
"suggestions": [
{
"name": "init",
"description": "Create a default .sdkmanrc file"
},
{
"name": "install",
"description": "Install and switch to versions in .sdkmanrc"
},
{
"name": "clear",
"description": "Reset all SDK versions to their defaults"
}
]
}
},
{
"name": [
"version",
"v"
],
"description": "Display the current version of SDKMAN!"
},
{
"name": "selfupdate",
"description": "Update SDKMAN! itself",
"args": {
"name": "qualifier",
"isOptional": true,
"suggestions": [
{
"name": "force",
"description": "Force a reinstallation of SDKMAN!"
}
]
}
},
{
"name": "update",
"description": "Refresh the candidate metadata cache"
},
{
"name": "flush",
"description": "Flush SDKMAN! local state",
"args": {
"name": "target",
"isOptional": true,
"suggestions": [
{
"name": "tmp",
"description": "Clean pre/post hooks and residual archives"
},
{
"name": "metadata",
"description": "Remove header metadata"
},
{
"name": "version",
"description": "Flush version files"
}
]
}
},
{
"name": "config",
"description": "Open the SDKMAN! configuration file"
},
{
"name": [
"help",
"h"
],
"description": "Display help information",
"args": {
"name": "subcommand",
"isOptional": true,
"suggestions": [
"install",
"uninstall",
"list",
"use",
"default",
"home",
"env",
"current",
"upgrade",
"version",
"selfupdate",
"update",
"flush",
"config"
]
}
}
]
}
2 changes: 2 additions & 0 deletions command-signatures/src/generators/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ mod powershell;
mod pyenv;
mod react_native;
mod screen;
mod sdk;
mod ssh;
mod systemctl;
mod tar;
Expand Down Expand Up @@ -98,6 +99,7 @@ pub fn dynamic_command_signature_data() -> HashMap<String, DynamicCompletionData
tmux::generator(),
node::generator(),
screen::generator(),
sdk::generator(),
powershell::get_help_generator(),
powershell::get_process_generator(),
powershell::debug_process_generator(),
Expand Down
96 changes: 96 additions & 0 deletions command-signatures/src/generators/sdk.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
use warp_completion_metadata::{
CommandBuilder, CommandSignatureGenerators, Generator, GeneratorResultsCollector, Suggestion,
};

/// Returns the SDKMAN directory reference using the SDKMAN_DIR env var with a fallback.
fn sdkman_dir() -> &'static str {
"${SDKMAN_DIR:-$HOME/.sdkman}"
}

/// Extracts the candidate name from tokens.
///
/// When `has_trailing_whitespace` is true, the candidate is the last token
/// (the user just finished typing the candidate and pressed space).
/// Otherwise, the candidate is the second-to-last token (the user is typing
/// the version prefix).
fn candidate_from_tokens<'a>(tokens: &'a [&str], has_trailing_whitespace: bool) -> Option<&'a str> {
if has_trailing_whitespace {
tokens.last().copied()
} else {
tokens.get(tokens.len().saturating_sub(2)).copied()
}
}

pub fn generator() -> CommandSignatureGenerators {
CommandSignatureGenerators::new("sdk")
.add_generator(
"candidates",
Generator::script(
CommandBuilder::single_command(format!(
"cat {}/var/candidates | tr ',' '\\n'",
sdkman_dir()
)),
|output| {
output
.trim()
.lines()
.filter(|line| !line.is_empty())
.map(|line| Suggestion::with_description(line.trim(), "SDK candidate"))
.collect_unordered_results()
},
),
)
.add_generator(
"installed_versions",
Generator::command_from_tokens(
|tokens, has_trailing_whitespace, _| {
match candidate_from_tokens(tokens, has_trailing_whitespace) {
Some(candidate) => CommandBuilder::pipe(
CommandBuilder::single_command(format!(
"ls {}/candidates/{}/",
sdkman_dir(),
candidate
)),
CommandBuilder::single_command("grep -v current"),
),
None => CommandBuilder::single_command(""),
}
},
|output| {
output
.trim()
.lines()
.filter(|line| !line.is_empty())
.map(|line| {
Suggestion::with_description(line.trim(), "Installed version")
})
.collect_unordered_results()
},
),
)
.add_generator(
"available_versions",
Generator::command_from_tokens(
|tokens, has_trailing_whitespace, _| {
match candidate_from_tokens(tokens, has_trailing_whitespace) {
Some(candidate) => CommandBuilder::single_command(format!(
"curl -s https://api.sdkman.io/2/candidates/{}/$(cat {}/var/platform)/versions/all | tr ',' '\\n'",
candidate,
sdkman_dir()
)),
None => CommandBuilder::single_command(""),
}
},
|output| {
output
.trim()
.lines()
.filter(|line| !line.is_empty())
.map(|line| {
Suggestion::with_description(line.trim(), "Available version")
})
.collect_unordered_results()
},
),
)
}
Loading