1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
use crate::prelude::*;
use nu_ansi_term::{build_all_gradient_text, gradient::TargetGround, Gradient, Rgb};
use nu_engine::WholeStreamCommand;
use nu_errors::ShellError;
use nu_protocol::ShellTypeName;
use nu_protocol::{Primitive, Signature, SyntaxShape, UntaggedValue, Value};
use nu_source::Tag;
pub struct SubCommand;
impl WholeStreamCommand for SubCommand {
fn name(&self) -> &str {
"ansi gradient"
}
fn signature(&self) -> Signature {
Signature::build("ansi gradient")
.named(
"fgstart",
SyntaxShape::String,
"foreground gradient start color in hex (0x123456)",
Some('a'),
)
.named(
"fgend",
SyntaxShape::String,
"foreground gradient end color in hex",
Some('b'),
)
.named(
"bgstart",
SyntaxShape::String,
"background gradient start color in hex",
Some('c'),
)
.named(
"bgend",
SyntaxShape::String,
"background gradient end color in hex",
Some('d'),
)
.rest(
"rest",
SyntaxShape::ColumnPath,
"optionally, draw gradients using text from column paths",
)
}
fn usage(&self) -> &str {
"draw text with a provided start and end code making a gradient"
}
fn run(&self, args: CommandArgs) -> Result<OutputStream, ShellError> {
operate(args)
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "draw text in a gradient with foreground start and end colors",
example:
"echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart 0x40c9ff --fgend 0xe81cff",
result: None,
},
Example {
description: "draw text in a gradient with foreground start and end colors and background start and end colors",
example:
"echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart 0x40c9ff --fgend 0xe81cff --bgstart 0xe81cff --bgend 0x40c9ff",
result: None,
},
Example {
description: "draw text in a gradient by specifying foreground start color - end color is assumed to be black",
example:
"echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgstart 0x40c9ff",
result: None,
},
Example {
description: "draw text in a gradient by specifying foreground end color - start color is assumed to be black",
example:
"echo 'Hello, Nushell! This is a gradient.' | ansi gradient --fgend 0xe81cff",
result: None,
},
]
}
}
fn operate(args: CommandArgs) -> Result<OutputStream, ShellError> {
let fgstart: Option<Value> = args.get_flag("fgstart")?;
let fgend: Option<Value> = args.get_flag("fgend")?;
let bgstart: Option<Value> = args.get_flag("bgstart")?;
let bgend: Option<Value> = args.get_flag("bgend")?;
let column_paths: Vec<_> = args.rest(0)?;
let fgs_hex = fgstart.map(|color| Rgb::from_hex_string(color.convert_to_string()));
let fge_hex = fgend.map(|color| Rgb::from_hex_string(color.convert_to_string()));
let bgs_hex = bgstart.map(|color| Rgb::from_hex_string(color.convert_to_string()));
let bge_hex = bgend.map(|color| Rgb::from_hex_string(color.convert_to_string()));
let result: Vec<Value> = args
.input
.map(move |v| {
if column_paths.is_empty() {
action(&v, v.tag(), fgs_hex, fge_hex, bgs_hex, bge_hex)
} else {
let mut ret = v;
for path in &column_paths {
ret = ret.swap_data_by_column_path(
path,
Box::new(move |old| {
action(old, old.tag(), fgs_hex, fge_hex, bgs_hex, bge_hex)
}),
)?;
}
Ok(ret)
}
})
.collect::<Result<Vec<Value>, _>>()?;
Ok(OutputStream::from_stream(result.into_iter()))
}
fn action(
input: &Value,
tag: impl Into<Tag>,
fg_start: Option<Rgb>,
fg_end: Option<Rgb>,
bg_start: Option<Rgb>,
bg_end: Option<Rgb>,
) -> Result<Value, ShellError> {
let tag = tag.into();
match &input.value {
UntaggedValue::Primitive(Primitive::String(astring)) => {
match (fg_start, fg_end, bg_start, bg_end) {
(None, None, None, None) => {
Err(ShellError::labeled_error(
"please supply color parameters",
"please supply foreground and/or background color parameters",
Tag::unknown(),
))
}
(None, None, None, Some(bg_end)) => {
let bg_start = Rgb::new(0, 0, 0);
let gradient = Gradient::new(bg_start, bg_end);
let gradient_string = gradient.build(astring, TargetGround::Background);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(None, None, Some(bg_start), None) => {
let bg_end = Rgb::new(0, 0, 0);
let gradient = Gradient::new(bg_start, bg_end);
let gradient_string = gradient.build(astring, TargetGround::Background);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(None, None, Some(bg_start), Some(bg_end)) => {
let gradient = Gradient::new(bg_start, bg_end);
let gradient_string = gradient.build(astring, TargetGround::Background);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(None, Some(fg_end), None, None) => {
let fg_start = Rgb::new(0, 0, 0);
let gradient = Gradient::new(fg_start, fg_end);
let gradient_string = gradient.build(astring, TargetGround::Foreground);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(None, Some(fg_end), None, Some(bg_end)) => {
let fg_start = Rgb::new(0, 0, 0);
let bg_start = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(None, Some(fg_end), Some(bg_start), None) => {
let fg_start = Rgb::new(0, 0, 0);
let bg_end = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(None, Some(fg_end), Some(bg_start), Some(bg_end)) => {
let fg_start = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), None, None, None) => {
let fg_end = Rgb::new(0, 0, 0);
let gradient = Gradient::new(fg_start, fg_end);
let gradient_string = gradient.build(astring, TargetGround::Foreground);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), None, None, Some(bg_end)) => {
let fg_end = Rgb::new(0, 0, 0);
let bg_start = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), None, Some(bg_start), None) => {
let fg_end = Rgb::new(0, 0, 0);
let bg_end = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), None, Some(bg_start), Some(bg_end)) => {
let fg_end = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), Some(fg_end), None, None) => {
let gradient = Gradient::new(fg_start, fg_end);
let gradient_string = gradient.build(astring, TargetGround::Foreground);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), Some(fg_end), None, Some(bg_end)) => {
let bg_start = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), Some(fg_end), Some(bg_start), None) => {
let bg_end = Rgb::new(0, 0, 0);
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
(Some(fg_start), Some(fg_end), Some(bg_start), Some(bg_end)) => {
let fg_gradient = Gradient::new(fg_start, fg_end);
let bg_gradient = Gradient::new(bg_start, bg_end);
let gradient_string =
build_all_gradient_text(astring, fg_gradient, bg_gradient);
Ok(UntaggedValue::string(gradient_string).into_value(tag))
}
}
}
other => {
let got = format!("got {}", other.type_name());
Err(ShellError::labeled_error(
"value is not string",
got,
tag.span,
))
}
}
}
#[cfg(test)]
mod tests {
use super::ShellError;
use super::{action, SubCommand};
use nu_ansi_term::Rgb;
use nu_protocol::UntaggedValue;
use nu_source::Tag;
#[test]
fn examples_work_as_expected() -> Result<(), ShellError> {
use crate::examples::test as test_examples;
test_examples(SubCommand {})
}
#[test]
fn test_fg_gradient() {
let input_string = UntaggedValue::string("Hello, World!").into_untagged_value();
let expected = UntaggedValue::string("\u{1b}[38;2;64;201;255mH\u{1b}[38;2;76;187;254me\u{1b}[38;2;89;174;254ml\u{1b}[38;2;102;160;254ml\u{1b}[38;2;115;147;254mo\u{1b}[38;2;128;133;254m,\u{1b}[38;2;141;120;254m \u{1b}[38;2;153;107;254mW\u{1b}[38;2;166;94;254mo\u{1b}[38;2;179;80;254mr\u{1b}[38;2;192;67;254ml\u{1b}[38;2;205;53;254md\u{1b}[38;2;218;40;254m!\u{1b}[0m").into_untagged_value();
let fg_start = Rgb::from_hex_string("0x40c9ff".to_string());
let fg_end = Rgb::from_hex_string("0xe81cff".to_string());
let actual = action(
&input_string,
Tag::unknown(),
Some(fg_start),
Some(fg_end),
None,
None,
)
.unwrap();
assert_eq!(actual, expected);
}
}