Revert "feat: immediately execute command (#882)" (#924)

132ikl · web-flow · commit cf2887af24a8 · 2025-06-16T12:32:38.000-04:00
This reverts commit f716256.
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ let mut line_editor = Reedline::create();
 let prompt = DefaultPrompt::default();
 
 loop {
-    let sig = line_editor.read_line(&prompt, false);
+    let sig = line_editor.read_line(&prompt);
     match sig {
         Ok(Signal::Success(buffer)) => {
             println!("We processed: {}", buffer);
diff --git a/examples/basic.rs b/examples/basic.rs
@@ -12,7 +12,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/completions.rs b/examples/completions.rs
@@ -81,7 +81,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/custom_prompt.rs b/examples/custom_prompt.rs
@@ -61,7 +61,7 @@ fn main() -> io::Result<()> {
     let prompt = CustomPrompt(Cell::new(0), "Custom Prompt");
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/cwd_aware_hinter.rs b/examples/cwd_aware_hinter.rs
@@ -71,7 +71,7 @@ fn main() -> io::Result<()> {
         } else {
             std::env::set_current_dir(&home_dir).unwrap();
         }
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/demo.rs b/examples/demo.rs
@@ -134,7 +134,7 @@ fn main() -> reedline::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false);
+        let sig = line_editor.read_line(&prompt);
 
         match sig {
             Ok(Signal::CtrlD) => {
diff --git a/examples/external_printer.rs b/examples/external_printer.rs
@@ -42,7 +42,7 @@ fn main() {
     let prompt = DefaultPrompt::default();
 
     loop {
-        if let Ok(sig) = line_editor.read_line(&prompt, false) {
+        if let Ok(sig) = line_editor.read_line(&prompt) {
             match sig {
                 Signal::Success(buffer) => {
                     println!("We processed: {buffer}");
diff --git a/examples/highlighter.rs b/examples/highlighter.rs
@@ -17,7 +17,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/hinter.rs b/examples/hinter.rs
@@ -17,7 +17,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/history.rs b/examples/history.rs
@@ -19,7 +19,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/ide_completions.rs b/examples/ide_completions.rs
@@ -117,7 +117,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/transient_prompt.rs b/examples/transient_prompt.rs
@@ -118,7 +118,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/examples/validator.rs b/examples/validator.rs
@@ -27,7 +27,7 @@ fn main() -> io::Result<()> {
     let prompt = DefaultPrompt::default();
 
     loop {
-        let sig = line_editor.read_line(&prompt, false)?;
+        let sig = line_editor.read_line(&prompt)?;
         match sig {
             Signal::Success(buffer) => {
                 println!("We processed: {buffer}");
diff --git a/src/engine.rs b/src/engine.rs
@@ -88,7 +88,7 @@ enum InputMode {
 /// let mut line_editor = Reedline::create();
 /// let prompt = DefaultPrompt::default();
 ///
-/// let out = line_editor.read_line(&prompt, false).unwrap();
+/// let out = line_editor.read_line(&prompt).unwrap();
 /// match out {
 ///    Signal::Success(content) => {
 ///        // process content
@@ -642,12 +642,12 @@ impl Reedline {
     ///
     /// Returns a [`std::io::Result`] in which the `Err` type is [`std::io::Result`]
     /// and the `Ok` variant wraps a [`Signal`] which handles user inputs.
-    pub fn read_line(&mut self, prompt: &dyn Prompt, immediately_execute: bool) -> Result<Signal> {
+    pub fn read_line(&mut self, prompt: &dyn Prompt) -> Result<Signal> {
         terminal::enable_raw_mode()?;
         self.bracketed_paste.enter();
         self.kitty_protocol.enter();
 
-        let result = self.read_line_helper(prompt, immediately_execute);
+        let result = self.read_line_helper(prompt);
 
         self.bracketed_paste.exit();
         self.kitty_protocol.exit();
@@ -687,11 +687,7 @@ impl Reedline {
 
     /// Helper implementing the logic for [`Reedline::read_line()`] to be wrapped
     /// in a `raw_mode` context.
-    fn read_line_helper(
-        &mut self,
-        prompt: &dyn Prompt,
-        immediately_execute: bool,
-    ) -> Result<Signal> {
+    fn read_line_helper(&mut self, prompt: &dyn Prompt) -> Result<Signal> {
         self.painter
             .initialize_prompt_position(self.suspended_state.as_ref())?;
         if self.suspended_state.is_some() {
@@ -738,31 +734,29 @@ impl Reedline {
 
             let mut events: Vec<Event> = vec![];
 
-            if !immediately_execute {
-                // If the `external_printer` feature is enabled, we need to
-                // periodically yield so that external printers get a chance to
-                // print. Otherwise, we can just block until we receive an event.
-                #[cfg(feature = "external_printer")]
-                if event::poll(EXTERNAL_PRINTER_WAIT)? {
-                    events.push(crossterm::event::read()?);
-                }
-                #[cfg(not(feature = "external_printer"))]
+            // If the `external_printer` feature is enabled, we need to
+            // periodically yield so that external printers get a chance to
+            // print. Otherwise, we can just block until we receive an event.
+            #[cfg(feature = "external_printer")]
+            if event::poll(EXTERNAL_PRINTER_WAIT)? {
                 events.push(crossterm::event::read()?);
+            }
+            #[cfg(not(feature = "external_printer"))]
+            events.push(crossterm::event::read()?);
 
-                // a line of input is completed.
-                // Receive all events in the queue without blocking. Will stop when
-                while !completed(&events) && event::poll(Duration::from_millis(0))? {
-                    events.push(crossterm::event::read()?);
-                }
+            // Receive all events in the queue without blocking. Will stop when
+            // a line of input is completed.
+            while !completed(&events) && event::poll(Duration::from_millis(0))? {
+                events.push(crossterm::event::read()?);
+            }
 
-                // If we believe there's text pasting or resizing going on, batch
-                // more events at the cost of a slight delay.
-                if events.len() > EVENTS_THRESHOLD
-                    || events.iter().any(|e| matches!(e, Event::Resize(_, _)))
-                {
-                    while !completed(&events) && event::poll(POLL_WAIT)? {
-                        events.push(crossterm::event::read()?);
-                    }
+            // If we believe there's text pasting or resizing going on, batch
+            // more events at the cost of a slight delay.
+            if events.len() > EVENTS_THRESHOLD
+                || events.iter().any(|e| matches!(e, Event::Resize(_, _)))
+            {
+                while !completed(&events) && event::poll(POLL_WAIT)? {
+                    events.push(crossterm::event::read()?);
                 }
             }
 
@@ -793,9 +787,6 @@ impl Reedline {
             if let Some((x, y)) = resize {
                 reedline_events.push(ReedlineEvent::Resize(x, y));
             }
-            if immediately_execute {
-                reedline_events.push(ReedlineEvent::Submit);
-            }
 
             // Handle reedline events.
             let mut need_repaint = false;
diff --git a/src/lib.rs b/src/lib.rs
@@ -19,7 +19,7 @@
 //! let prompt = DefaultPrompt::default();
 //!
 //! loop {
-//!     let sig = line_editor.read_line(&prompt, false);
+//!     let sig = line_editor.read_line(&prompt);
 //!     match sig {
 //!         Ok(Signal::Success(buffer)) => {
 //!             println!("We processed: {}", buffer);

Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ fn main() -> io::Result<()> {`
`71`	`71`	`} else {`
`72`	`72`	`std::env::set_current_dir(&home_dir).unwrap();`
`73`	`73`	`}`
`74`		`- let sig = line_editor.read_line(&prompt, false)?;`
	`74`	`+ let sig = line_editor.read_line(&prompt)?;`
`75`	`75`	`match sig {`
`76`	`76`	`Signal::Success(buffer) => {`
`77`	`77`	`println!("We processed: {buffer}");`