nushell/reedline
1
1
Fork 0
mirror of https://github.com/nushell/reedline.git synced 2024-09-17 19:17:24 +03:00
Code Issues Packages Projects Releases Wiki Activity

Small fix to document need to configure completion (#325)

Browse Source 
Keybindings are currently configured to require the completion menu. To
use the completions you have to manually add it.

Undocumented: Changing the keybindings to use the old bash style
completions with `CircularCompletionHandler`

Track #307
This commit is contained in:
Stefan Holderbach 2022-02-24 20:41:45 +01:00 committed by GitHub
parent 65cfd6bcbd
commit 8a8dd44aad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -104,7 +104,7 @@ Reedline::create()?.with_highlighter(Box::new(ExampleHighlighter::new(commands))
```rust,no_run
// Create a reedline object with tab completions support
use reedline::{DefaultCompleter, Reedline};
use reedline::{DefaultCompleter, Reedline, CompletionMenu};
let commands = vec![
"test".into(),
@ -113,8 +113,10 @@ let commands = vec![
"this is the reedline crate".into(),
];
let completer = Box::new(DefaultCompleter::new_with_wordlen(commands.clone(), 2));
// Use the interactive menu to select options from the completer
let completion_menu = Box::new(CompletionMenu::default());
let mut line_editor = Reedline::create()?.with_completer(completer);
let mut line_editor = Reedline::create()?.with_completer(completer).with_menu(completion_menu);
```
### Integrate with custom Hinter

18
src/lib.rs
View File

@ -11,8 +11,8 @@
//! ```rust,no_run
//! // Create a default reedline object to handle user input
//!
//! # use std::io;
//! use reedline::{DefaultPrompt, Reedline, Signal};
//! use std::io;
//!
//! let mut line_editor = Reedline::create()?;
//! let prompt = DefaultPrompt::default();
@ -46,7 +46,7 @@
//! // [dependencies]
//! // crossterm = "*"
//!
//! use std::io;
//! # use std::io;
//! use {
//! crossterm::event::{KeyCode, KeyModifiers},
//! reedline::{default_emacs_keybindings, EditCommand, Reedline, Emacs, ReedlineEvent},
@ -69,7 +69,7 @@
//! ```rust,no_run
//! // Create a reedline object with history support, including history size limits
//!
//! use std::io;
//! # use std::io;
//! use reedline::{FileBackedHistory, Reedline};
//!
//! let history = Box::new(
@ -87,7 +87,7 @@
//! ```rust,no_run
//! // Create a reedline object with highlighter support
//!
//! use std::io;
//! # use std::io;
//! use reedline::{ExampleHighlighter, Reedline};
//!
//! let commands = vec![
@ -106,8 +106,8 @@
//! ```rust,no_run
//! // Create a reedline object with tab completions support
//!
//! use std::io;
//! use reedline::{DefaultCompleter, Reedline};
//! # use std::io;
//! use reedline::{DefaultCompleter, Reedline, CompletionMenu};
//!
//! let commands = vec![
//! "test".into(),
@ -116,8 +116,10 @@
//! "this is the reedline crate".into(),
//! ];
//! let completer = Box::new(DefaultCompleter::new_with_wordlen(commands.clone(), 2));
//! // Use the interactive menu to select options from the completer
//! let completion_menu = Box::new(CompletionMenu::default());
//!
//! let mut line_editor = Reedline::create()?.with_completer(completer);
//! let mut line_editor = Reedline::create()?.with_completer(completer).with_menu(completion_menu);
//! # Ok::<(), io::Error>(())
//! ```
//!
@ -130,7 +132,7 @@
//! // [dependencies]
//! // nu-ansi-term = "*"
//!
//! use std::io;
//! # use std::io;
//! use {
//! nu_ansi_term::{Color, Style},
//! reedline::{DefaultHinter, Reedline},