This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new f471aaf275 feat(datafusion-cli): enhance CLI helper with default hint
(#20310)
f471aaf275 is described below
commit f471aaf27539c58b4b3558354af1244089557e57
Author: dario curreri <[email protected]>
AuthorDate: Sat Feb 14 11:30:50 2026 +0100
feat(datafusion-cli): enhance CLI helper with default hint (#20310)
# Pull Request Description
## Which issue does this PR close?
<!--
We generally require a GitHub issue to be filed for all bug fixes and
enhancements and this helps us generate change logs for our releases.
You can link an issue to this PR using the GitHub syntax. For example
`Closes #123` indicates that this PR will close issue #123.
-->
- Closes #.
## Rationale for this change
<!--
Why are you proposing this change? If this is already explained clearly
in the issue then this section is not needed.
Explaining clearly why changes are proposed helps reviewers understand
your changes and offer better suggestions for fixes.
-->
When the CLI prompt is empty, users have no indication of how to get
help or exit. Showing a subtle gray hint (e.g. `\? for help, \q to
quit`) on an empty line improves discoverability without changing any
existing behavior.
## What changes are included in this PR?
<!--
There is no need to duplicate the description in the issue here but it
is sometimes worth providing a summary of the individual changes in this
PR.
-->
- Implement `Hinter::hint` on `CliHelper` so that when the current line
is empty, a default hint is shown (e.g. `\? for help, \q to quit`) in
gray.
- Add a `DEFAULT_HINT_SUGGESTION` constant and use it for the hint text.
- Expose the highlighter’s `Color` type and its methods as `pub(crate)`
and add `Color::gray()` for styling the hint.
## Are these changes tested?
<!--
We typically require tests for all PRs in order to:
1. Prevent the code from being accidentally broken by subsequent changes
2. Serve as another way to document the expected behavior of the code
If tests are not included in your PR, please explain why (for example,
are they covered by existing tests)?
-->
No new tests were added; the change is a small UI hint.
Manual testing: start the CLI and confirm the hint appears on an empty
line and disappears when typing. Happy to add tests if the project
expects them for this behavior.
## Are there any user-facing changes?
<!--
If there are user-facing changes then we may require documentation to be
updated before approving the PR.
-->
Yes. When the input line is empty, users now see a gray hint: `\? for
help, \q to quit`. No API or CLI flag changes. Documentation could
optionally mention this hint in the CLI docs if the project documents
REPL UX.
<!--
If there are any breaking changes to public APIs, please add the `api
change` label.
-->
---
datafusion-cli/src/helper.rs | 14 +++++++++++++-
datafusion-cli/src/highlighter.rs | 10 +++++++---
2 files changed, 20 insertions(+), 4 deletions(-)
diff --git a/datafusion-cli/src/helper.rs b/datafusion-cli/src/helper.rs
index df7afc1404..c53272ee19 100644
--- a/datafusion-cli/src/helper.rs
+++ b/datafusion-cli/src/helper.rs
@@ -20,7 +20,7 @@
use std::borrow::Cow;
-use crate::highlighter::{NoSyntaxHighlighter, SyntaxHighlighter};
+use crate::highlighter::{Color, NoSyntaxHighlighter, SyntaxHighlighter};
use datafusion::sql::parser::{DFParser, Statement};
use datafusion::sql::sqlparser::dialect::dialect_from_str;
@@ -33,6 +33,9 @@ use rustyline::hint::Hinter;
use rustyline::validate::{ValidationContext, ValidationResult, Validator};
use rustyline::{Context, Helper, Result};
+/// Default suggestion shown when the input line is empty.
+const DEFAULT_HINT_SUGGESTION: &str = " \\? for help, \\q to quit";
+
pub struct CliHelper {
completer: FilenameCompleter,
dialect: Dialect,
@@ -114,6 +117,15 @@ impl Highlighter for CliHelper {
impl Hinter for CliHelper {
type Hint = String;
+
+ fn hint(&self, line: &str, _pos: usize, _ctx: &Context<'_>) ->
Option<String> {
+ if line.trim().is_empty() {
+ let suggestion = Color::gray(DEFAULT_HINT_SUGGESTION);
+ Some(suggestion)
+ } else {
+ None
+ }
+ }
}
/// returns true if the current position is after the open quote for
diff --git a/datafusion-cli/src/highlighter.rs
b/datafusion-cli/src/highlighter.rs
index 912a13916a..0a2a2e6c14 100644
--- a/datafusion-cli/src/highlighter.rs
+++ b/datafusion-cli/src/highlighter.rs
@@ -80,16 +80,20 @@ impl Highlighter for SyntaxHighlighter {
}
/// Convenient utility to return strings with [ANSI
color](https://gist.github.com/JBlond/2fea43a3049b38287e5e9cefc87b2124).
-struct Color {}
+pub(crate) struct Color {}
impl Color {
- fn green(s: impl Display) -> String {
+ pub(crate) fn green(s: impl Display) -> String {
format!("\x1b[92m{s}\x1b[0m")
}
- fn red(s: impl Display) -> String {
+ pub(crate) fn red(s: impl Display) -> String {
format!("\x1b[91m{s}\x1b[0m")
}
+
+ pub(crate) fn gray(s: impl Display) -> String {
+ format!("\x1b[90m{s}\x1b[0m")
+ }
}
#[cfg(test)]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
