Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-09-20 06:31:57 +00:00
Code Issues Projects Releases Packages Wiki Activity

Allow input to take a specified number of characters (#9242)

Browse source 
# Description
Title; fixes #9208.


# User-Facing Changes
`input` now can specify a certain number of characters to read.

# Tests + Formatting
No CI tests; can't find a way to implement.
```
~/CodingProjects/nushell> let user_input = (input --numchar 2)                                           
~/CodingProjects/nushell> echo $user_input                                                        
te
```

# After Submitting
<!-- If your PR had any user-facing changes, update [the
documentation](https://github.com/nushell/nushell.github.io) after the
PR is merged, if necessary. This will help us keep the docs up to date.
-->
This commit is contained in:
pwygab 2023-05-20 04:28:35 +08:00 committed by GitHub
parent 55bb501c71
commit 01a00641f9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
crates/nu-command/src/platform/input/input_.rs
View file

@ -3,8 +3,8 @@ use nu_engine::CallExt;
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, SyntaxShape, Type,
Value,
Category, Example, IntoPipelineData, PipelineData, ShellError, Signature, Spanned, SyntaxShape,
Type, Value,
};
use std::io::{Read, Write};
@ -38,6 +38,12 @@ impl Command for Input {
"read bytes (not text) until a stop byte",
Some('u'),
)
.named(
"numchar",
SyntaxShape::Int,
"number of characters to read; suppresses output",
Some('n'),
)
.switch("suppress-output", "don't print keystroke values", Some('s'))
.category(Category::Platform)
}
@ -52,6 +58,21 @@ impl Command for Input {
let prompt: Option<String> = call.opt(engine_state, stack, 0)?;
let bytes_until: Option<String> = call.get_flag(engine_state, stack, "bytes-until")?;
let suppress_output = call.has_flag("suppress-output");
let numchar: Option<Spanned<i64>> = call.get_flag(engine_state, stack, "numchar")?;
let numchar_exists = numchar.is_some();
let numchar: Spanned<i64> = numchar.unwrap_or(Spanned {
item: i64::MAX,
span: call.head,
});
if numchar.item < 1 {
return Err(ShellError::UnsupportedInput(
"Number of characters to read has to be positive".to_string(),
"value originated from here".to_string(),
call.head,
numchar.span,
));
}
if let Some(bytes_until) = bytes_until {
let _ = crossterm::terminal::enable_raw_mode();
@ -73,6 +94,11 @@ impl Command for Input {
}
buffer.push(buf[0]);
if i64::try_from(buffer.len()).unwrap_or(0) >= numchar.item {
let _ = crossterm::terminal::disable_raw_mode();
break;
}
// 03 symbolizes SIGINT/Ctrl+C
if buf.contains(&3) {
let _ = crossterm::terminal::disable_raw_mode();
@ -104,9 +130,13 @@ impl Command for Input {
let mut buf = String::new();
if suppress_output {
if suppress_output || numchar_exists {
crossterm::terminal::enable_raw_mode()?;
loop {
if i64::try_from(buf.len()).unwrap_or(0) >= numchar.item {
let _ = crossterm::terminal::disable_raw_mode();
break;
}
match crossterm::event::read() {
Ok(Event::Key(k)) => match k.code {
// TODO: maintain keycode parity with existing command
@ -165,11 +195,18 @@ impl Command for Input {
}
fn examples(&self) -> Vec<Example> {
vec![Example {
description: "Get input from the user, and assign to a variable",
example: "let user_input = (input)",
result: None,
}]
vec![
Example {
description: "Get input from the user, and assign to a variable",
example: "let user_input = (input)",
result: None,
},
Example {
description: "Get two characters from the user, and assign to a variable",
example: "let user_input = (input --numchar 2)",
result: None,
},
]
}
}