Cratification: move some str case commands to nu-cmd-extra (#9926)

I am moving the following str case commands to nu-cmd-extra (as
discussed in the core team meeting the other day)

* camel-case
* kebab-case
* pascal-case
* screaming-snake-case
* snake-case
* title-case
This commit is contained in:
Michael Angerman 2023-08-06 06:40:44 -07:00 committed by GitHub
parent 066790552a
commit 58f98a4260
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
17 changed files with 145 additions and 27 deletions

2
Cargo.lock generated
View File

@ -2606,6 +2606,7 @@ dependencies = [
name = "nu-cmd-extra" name = "nu-cmd-extra"
version = "0.83.2" version = "0.83.2"
dependencies = [ dependencies = [
"Inflector",
"ahash", "ahash",
"fancy-regex", "fancy-regex",
"htmlescape", "htmlescape",
@ -2657,7 +2658,6 @@ dependencies = [
name = "nu-command" name = "nu-command"
version = "0.83.2" version = "0.83.2"
dependencies = [ dependencies = [
"Inflector",
"alphanumeric-sort", "alphanumeric-sort",
"base64", "base64",
"bracoxide", "bracoxide",

View File

@ -20,6 +20,7 @@ nu-cmd-base = { path = "../nu-cmd-base", version = "0.83.2" }
nu-utils = { path = "../nu-utils", version = "0.83.2" } nu-utils = { path = "../nu-utils", version = "0.83.2" }
# Potential dependencies for extras # Potential dependencies for extras
Inflector = "0.11"
num-traits = "0.2" num-traits = "0.2"
ahash = "0.8.3" ahash = "0.8.3"
nu-ansi-term = "0.49.0" nu-ansi-term = "0.49.0"

View File

@ -88,7 +88,14 @@ pub fn add_extra_command_context(mut engine_state: EngineState) -> EngineState {
strings::format::FileSize, strings::format::FileSize,
strings::format::FormatDuration, strings::format::FormatDuration,
strings::encode_decode::EncodeHex, strings::encode_decode::EncodeHex,
strings::encode_decode::DecodeHex strings::encode_decode::DecodeHex,
strings::str_::case::Str,
strings::str_::case::StrCamelCase,
strings::str_::case::StrKebabCase,
strings::str_::case::StrPascalCase,
strings::str_::case::StrScreamingSnakeCase,
strings::str_::case::StrSnakeCase,
strings::str_::case::StrTitleCase
); );
bind_command!(formats::ToHtml, formats::FromUrl); bind_command!(formats::ToHtml, formats::FromUrl);

View File

@ -1,2 +1,3 @@
pub(crate) mod encode_decode; pub(crate) mod encode_decode;
pub(crate) mod format; pub(crate) mod format;
pub(crate) mod str_;

View File

@ -5,7 +5,7 @@ use nu_protocol::{
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value, Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
}; };
use crate::operate; use super::operate;
#[derive(Clone)] #[derive(Clone)]
pub struct SubCommand; pub struct SubCommand;

View File

@ -5,7 +5,7 @@ use nu_protocol::{
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value, Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
}; };
use crate::operate; use super::operate;
#[derive(Clone)] #[derive(Clone)]
pub struct SubCommand; pub struct SubCommand;

View File

@ -0,0 +1,74 @@
mod camel_case;
mod kebab_case;
mod pascal_case;
mod screaming_snake_case;
mod snake_case;
mod str_;
mod title_case;
pub use camel_case::SubCommand as StrCamelCase;
pub use kebab_case::SubCommand as StrKebabCase;
pub use pascal_case::SubCommand as StrPascalCase;
pub use screaming_snake_case::SubCommand as StrScreamingSnakeCase;
pub use snake_case::SubCommand as StrSnakeCase;
pub use str_::Str;
pub use title_case::SubCommand as StrTitleCase;
use nu_engine::CallExt;
use nu_cmd_base::input_handler::{operate as general_operate, CmdArgument};
use nu_protocol::ast::{Call, CellPath};
use nu_protocol::engine::{EngineState, Stack};
use nu_protocol::{PipelineData, ShellError, Span, Value};
struct Arguments<F: Fn(&str) -> String + Send + Sync + 'static> {
case_operation: &'static F,
cell_paths: Option<Vec<CellPath>>,
}
impl<F: Fn(&str) -> String + Send + Sync + 'static> CmdArgument for Arguments<F> {
fn take_cell_paths(&mut self) -> Option<Vec<CellPath>> {
self.cell_paths.take()
}
}
pub fn operate<F>(
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
case_operation: &'static F,
) -> Result<PipelineData, ShellError>
where
F: Fn(&str) -> String + Send + Sync + 'static,
{
let cell_paths: Vec<CellPath> = call.rest(engine_state, stack, 0)?;
let cell_paths = (!cell_paths.is_empty()).then_some(cell_paths);
let args = Arguments {
case_operation,
cell_paths,
};
general_operate(action, args, input, call.head, engine_state.ctrlc.clone())
}
fn action<F>(input: &Value, args: &Arguments<F>, head: Span) -> Value
where
F: Fn(&str) -> String + Send + Sync + 'static,
{
let case_operation = args.case_operation;
match input {
Value::String { val, .. } => Value::String {
val: case_operation(val),
span: head,
},
Value::Error { .. } => input.clone(),
_ => Value::Error {
error: Box::new(ShellError::OnlySupportsThisInputType {
exp_input_type: "string".into(),
wrong_type: input.get_type().to_string(),
dst_span: head,
src_span: input.expect_span(),
}),
},
}
}

View File

@ -5,7 +5,7 @@ use nu_protocol::{
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value, Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
}; };
use crate::operate; use super::operate;
#[derive(Clone)] #[derive(Clone)]
pub struct SubCommand; pub struct SubCommand;

View File

@ -5,7 +5,8 @@ use nu_protocol::{
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value, Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
}; };
use crate::operate; use super::operate;
#[derive(Clone)] #[derive(Clone)]
pub struct SubCommand; pub struct SubCommand;

View File

@ -5,7 +5,7 @@ use nu_protocol::{
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value, Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
}; };
use crate::operate; use super::operate;
#[derive(Clone)] #[derive(Clone)]
pub struct SubCommand; pub struct SubCommand;

View File

@ -0,0 +1,49 @@
use nu_engine::get_full_help;
use nu_protocol::{
ast::Call,
engine::{Command, EngineState, Stack},
Category, IntoPipelineData, PipelineData, ShellError, Signature, Type, Value,
};
#[derive(Clone)]
pub struct Str;
impl Command for Str {
fn name(&self) -> &str {
"str"
}
fn signature(&self) -> Signature {
Signature::build("str")
.category(Category::Strings)
.input_output_types(vec![(Type::Nothing, Type::String)])
}
fn usage(&self) -> &str {
"Various commands for working with string data."
}
fn extra_usage(&self) -> &str {
"You must use one of the following subcommands. Using this command as-is will only produce this help message."
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
_input: PipelineData,
) -> Result<PipelineData, ShellError> {
Ok(Value::String {
val: get_full_help(
&Str.signature(),
&Str.examples(),
engine_state,
stack,
self.is_parser_keyword(),
),
span: call.head,
}
.into_pipeline_data())
}
}

View File

@ -5,7 +5,7 @@ use nu_protocol::{
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value, Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
}; };
use crate::operate; use super::operate;
#[derive(Clone)] #[derive(Clone)]
pub struct SubCommand; pub struct SubCommand;

View File

@ -0,0 +1,3 @@
pub(crate) mod case;
pub use case::*;

View File

@ -28,7 +28,6 @@ nu-table = { path = "../nu-table", version = "0.83.2" }
nu-term-grid = { path = "../nu-term-grid", version = "0.83.2" } nu-term-grid = { path = "../nu-term-grid", version = "0.83.2" }
nu-utils = { path = "../nu-utils", version = "0.83.2" } nu-utils = { path = "../nu-utils", version = "0.83.2" }
Inflector = "0.11"
alphanumeric-sort = "1.5" alphanumeric-sort = "1.5"
base64 = "0.21" base64 = "0.21"
byteorder = "1.4" byteorder = "1.4"

View File

@ -177,7 +177,6 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
SplitRow, SplitRow,
SplitWords, SplitWords,
Str, Str,
StrCamelCase,
StrCapitalize, StrCapitalize,
StrContains, StrContains,
StrDistance, StrDistance,
@ -187,16 +186,11 @@ pub fn add_shell_command_context(mut engine_state: EngineState) -> EngineState {
StrJoin, StrJoin,
StrReplace, StrReplace,
StrIndexOf, StrIndexOf,
StrKebabCase,
StrLength, StrLength,
StrPascalCase,
StrReverse, StrReverse,
StrScreamingSnakeCase,
StrSnakeCase,
StrStartsWith, StrStartsWith,
StrSubstring, StrSubstring,
StrTrim, StrTrim,
StrTitleCase,
StrUpcase, StrUpcase,
FormatDate FormatDate
}; };

View File

@ -1,23 +1,11 @@
mod camel_case;
mod capitalize; mod capitalize;
mod downcase; mod downcase;
mod kebab_case;
mod pascal_case;
mod screaming_snake_case;
mod snake_case;
mod str_; mod str_;
mod title_case;
mod upcase; mod upcase;
pub use camel_case::SubCommand as StrCamelCase;
pub use capitalize::SubCommand as StrCapitalize; pub use capitalize::SubCommand as StrCapitalize;
pub use downcase::SubCommand as StrDowncase; pub use downcase::SubCommand as StrDowncase;
pub use kebab_case::SubCommand as StrKebabCase;
pub use pascal_case::SubCommand as StrPascalCase;
pub use screaming_snake_case::SubCommand as StrScreamingSnakeCase;
pub use snake_case::SubCommand as StrSnakeCase;
pub use str_::Str; pub use str_::Str;
pub use title_case::SubCommand as StrTitleCase;
pub use upcase::SubCommand as StrUpcase; pub use upcase::SubCommand as StrUpcase;
use nu_engine::CallExt; use nu_engine::CallExt;

View File

@ -97,6 +97,7 @@ fn upcases() {
} }
#[test] #[test]
#[ignore = "Playgrounds are not supported in nu-cmd-extra"]
fn camelcases() { fn camelcases() {
Playground::setup("str_test_3", |dirs, sandbox| { Playground::setup("str_test_3", |dirs, sandbox| {
sandbox.with_files(vec![FileWithContent( sandbox.with_files(vec![FileWithContent(