Skip to content

feat(cli): implement dynamic runtime completions for plugins #3876

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
ItsLemmy merged 2 commits into from
Aug 15, 2026
+113 −28
Merged

feat(cli): implement dynamic runtime completions for plugins #3876

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b755721
feat(cli): implement dynamic runtime completions for plugins
oldirtty Aug 11, 2026
6931bef
fix(cli): resolve completion trailing space and clang-tidy errors
oldirtty Aug 15, 2026
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
127 changes: 104 additions & 23 deletions src/cli/completions.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#include "cli/parse.h"
#include "cli/schema_root.h"

#include <algorithm>
#include <print>
#include <span>
#include <string_view>
Expand Down Expand Up @@ -203,20 +204,34 @@ namespace noctalia::cli {

std::string generateBash(const Command& root) {
const auto states = collectStates(root);
std::string output = "# bash completion for noctalia; generated from the live CLI schema\n"
"_noctalia_complete_words() {\n"
" local words=\"$1\"\n"
" local IFS=$'\\n'\n"
" COMPREPLY=( $(compgen -W \"$words\" -- \"$cur\") )\n"
"}\n\n"
"_noctalia_completions() {\n"
" local cur=\"${COMP_WORDS[COMP_CWORD]}\"\n"
" local path=noctalia\n"
" local depth=1\n"
" local i token\n"
" for ((i=1; i<COMP_CWORD; ++i)); do\n"
" token=\"${COMP_WORDS[i]}\"\n"
" case \"$path:$token\" in\n";
std::string output =
"# bash completion for noctalia; generated from the live CLI schema\n"
"_noctalia_complete_words() {\n"
" local words=\"$1\"\n"
" local IFS=$'\\n'\n"
" COMPREPLY=( $(compgen -W \"$words\" -- \"$cur\") )\n"
"}\n\n"
"_noctalia_plugins_enabled() {\n"
" local words=\"$(noctalia msg plugins list 2>/dev/null | awk '$4 == \"enabled\" {print $1}')\"\n"
" COMPREPLY=( $(compgen -W \"$words\" -- \"$cur\") )\n"
"}\n\n"
"_noctalia_plugins_disabled() {\n"
" local words=\"$(noctalia msg plugins list 2>/dev/null | awk '$4 == \"disabled\" {print $1}')\"\n"
" COMPREPLY=( $(compgen -W \"$words\" -- \"$cur\") )\n"
"}\n\n"
"_noctalia_plugin_prefix() {\n"
" local words=\"$(noctalia msg plugins list 2>/dev/null | awk '$4 == \"enabled\" {print $1\":\"}')\"\n"
" compopt -o nospace 2>/dev/null\n"
" COMPREPLY=( $(compgen -W \"$words\" -- \"$cur\") )\n"
"}\n\n"
"_noctalia_completions() {\n"
" local cur=\"${COMP_WORDS[COMP_CWORD]}\"\n"
" local path=noctalia\n"
" local depth=1\n"
" local i token\n"
" for ((i=1; i<COMP_CWORD; ++i)); do\n"
" token=\"${COMP_WORDS[i]}\"\n"
" case \"$path:$token\" in\n";

for (const CommandState& state : states) {
for (const Command& child : state.command->subcommands) {
Expand Down Expand Up @@ -309,21 +324,33 @@ namespace noctalia::cli {
output.append(" ");
output.append(std::to_string(i));
output.append(")\n");
if (positional.choices.empty())
if (!positional.runtimeProvider.empty()) {
output.append(10, ' ');
output.append("_noctalia_");
output.append(positional.runtimeProvider);
output.append("\n");
} else if (positional.choices.empty()) {
appendBashFiles(output, 10);
else
} else {
appendBashCompletion(output, positional.choices, 10);
}
output.append(" ;;\n");
if (positional.variadic)
break;
}
output.append(" *)\n");
if (!command.positionals.empty() && command.positionals.back().variadic) {
const Positional& positional = command.positionals.back();
if (positional.choices.empty())
if (!positional.runtimeProvider.empty()) {
output.append(10, ' ');
output.append("_noctalia_");
output.append(positional.runtimeProvider);
output.append("\n");
} else if (positional.choices.empty()) {
appendBashFiles(output, 10);
else
} else {
appendBashCompletion(output, positional.choices, 10);
}
}
output.append(" ;;\n esac\n ;;\n");
}
Expand All @@ -333,7 +360,35 @@ namespace noctalia::cli {

std::string generateZsh(const Command& root) {
const auto states = collectStates(root);
std::string output = "#compdef noctalia\n# generated from the live CLI schema\n\n";
std::string output =
"#compdef noctalia\n# generated from the live CLI schema\n\n"
"_noctalia_plugins_enabled() {\n"
" local -a plugins\n"
" plugins=(${(f)\"$(noctalia msg plugins list 2>/dev/null | awk '$4 == \"enabled\" {print $1}')\"})\n"
" if [[ ${#plugins[@]} -gt 0 ]]; then\n"
" _values 'enabled plugin' $plugins\n"
" else\n"
" _message 'no enabled plugins found'\n"
" fi\n"
"}\n\n"
"_noctalia_plugins_disabled() {\n"
" local -a plugins\n"
" plugins=(${(f)\"$(noctalia msg plugins list 2>/dev/null | awk '$4 == \"disabled\" {print $1}')\"})\n"
" if [[ ${#plugins[@]} -gt 0 ]]; then\n"
" _values 'disabled plugin' $plugins\n"
" else\n"
" _message 'no disabled plugins found'\n"
" fi\n"
"}\n\n"
"_noctalia_plugin_prefix() {\n"
" local -a plugins\n"
" plugins=(${(f)\"$(noctalia msg plugins list 2>/dev/null | awk '$4 == \"enabled\" {print $1\":\"}')\"})\n"
" if [[ ${#plugins[@]} -gt 0 ]]; then\n"
" compadd -S '' -a plugins\n"
" else\n"
" _message 'no enabled plugins found'\n"
" fi\n"
"}\n\n";

for (const CommandState& state : states) {
const Command& command = *state.command;
Expand Down Expand Up @@ -378,9 +433,18 @@ namespace noctalia::cli {
const Positional& positional = command.positionals[i];
std::string spec = positional.variadic ? "*" : std::to_string(i + 1);
spec.push_back(':');
spec.append(positional.name);
std::string safeName{positional.name};
std::ranges::replace(safeName, ':', '-');
spec.append(safeName);
spec.push_back(':');
spec.append(positional.choices.empty() ? "_files" : zshChoiceList(positional.choices));

if (!positional.runtimeProvider.empty())
spec.append("_noctalia_").append(positional.runtimeProvider);
else if (positional.choices.empty())
spec.append("_files");
else
spec.append(zshChoiceList(positional.choices));

output.append(" ");
output.append(shellSingleQuote(spec));
output.append(i + 1 == command.positionals.size() ? "\n" : " \\\n");
Expand Down Expand Up @@ -449,6 +513,15 @@ namespace noctalia::cli {
" end\n"
" end\n"
" test $seen -eq $wanted\n"
"end\n\n"
"function __noctalia_plugins_enabled\n"
" noctalia msg plugins list 2>/dev/null | awk '$4 == \"enabled\" {print $1}'\n"
"end\n\n"
"function __noctalia_plugins_disabled\n"
" noctalia msg plugins list 2>/dev/null | awk '$4 == \"disabled\" {print $1}'\n"
"end\n\n"
"function __noctalia_plugin_prefix\n"
" noctalia msg plugins list 2>/dev/null | awk '$4 == \"enabled\" {print $1\":\"}'\n"
"end\n\n";

for (const CommandState& state : states) {
Expand Down Expand Up @@ -503,8 +576,9 @@ namespace noctalia::cli {

for (std::size_t i = 0; i < command.positionals.size(); ++i) {
const Positional& positional = command.positionals[i];
if (positional.choices.empty())
if (positional.choices.empty() && positional.runtimeProvider.empty())
continue;

std::string condition = "__noctalia_at_pos " + std::to_string(i);
if (!path.empty()) {
condition.push_back(' ');
Expand All @@ -513,7 +587,14 @@ namespace noctalia::cli {
output.append("complete -c noctalia -n ");
output.append(shellSingleQuote(condition));
output.append(" -f -a ");
output.append(shellSingleQuote(fishChoiceList(positional.choices)));

if (!positional.runtimeProvider.empty()) {
std::string call = "(__noctalia_" + std::string(positional.runtimeProvider) + ")";
output.append(shellSingleQuote(call));
} else {
output.append(shellSingleQuote(fishChoiceList(positional.choices)));
}

if (!positional.description.empty()) {
output.append(" -d ");
output.append(shellSingleQuote(positional.description));
Expand Down
1 change: 1 addition & 0 deletions src/cli/schema.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ namespace noctalia::cli {
bool required = false;
bool variadic = false;
bool joinRemaining = false;
std::string_view runtimeProvider;
};

struct Command {
Expand Down
13 changes: 8 additions & 5 deletions src/cli/schema_msg.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@ namespace noctalia::cli {
Command{"custom", "Use a custom palette", {}, {}, {}, kMsgColorSchemeSetCustomPositionals, {}, false},
};

inline constexpr std::array kMsgPluginsPluginPositionals{
Positional{"author/plugin", {}, {}, true, false, false},
inline constexpr std::array kMsgPluginsEnablePositionals{
Positional{"author/plugin", {}, {}, true, false, false, "plugins_disabled"},
};
inline constexpr std::array kMsgPluginsDisablePositionals{
Positional{"author/plugin", {}, {}, true, false, false, "plugins_enabled"},
};
inline constexpr std::array kMsgPluginsUpdatePositionals{
Positional{"source-name", {}, {}, true, false, false},
Expand All @@ -55,8 +58,8 @@ namespace noctalia::cli {
};
inline constexpr std::array kMsgPluginsSubcommands{
Command{"list", "List installed plugins", {}, {}, {}, {}, {}, false},
Command{"enable", "Enable a plugin", {}, {}, {}, kMsgPluginsPluginPositionals, {}, false},
Command{"disable", "Disable a plugin", {}, {}, {}, kMsgPluginsPluginPositionals, {}, false},
Command{"enable", "Enable a plugin", {}, {}, {}, kMsgPluginsEnablePositionals, {}, false},
Command{"disable", "Disable a plugin", {}, {}, {}, kMsgPluginsDisablePositionals, {}, false},
Command{"update", "Update a plugin source", {}, {}, {}, kMsgPluginsUpdatePositionals, {}, false},
Command{"source", "Manage plugin sources", {}, {}, {}, {}, kMsgPluginsSourceSubcommands, false},
};
Expand Down Expand Up @@ -170,7 +173,7 @@ namespace noctalia::cli {
Positional{"context", {}, {}, false, false, false},
};
inline constexpr std::array kMsgPluginPositionals{
Positional{"author/plugin:entry", {}, {}, true, false, false},
Positional{"author/plugin:entry", {}, {}, true, false, false, "plugin_prefix"},
Positional{"target[:bar-name]", {}, {}, true, false, false},
Positional{"event", {}, {}, true, false, false},
Positional{"payload", {}, {}, false, false, false},
Expand Down
Loading