Skip to content

Commit 8920db6

Browse files
jvalkealjvalkeal
committed
Update component docs
- Relates #361
1 parent 4733c3c commit 8920db6

12 files changed

+576
-0
lines changed

‎spring-shell-docs/readme.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Some info how screen recordings were made
2+
3+
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-text-input-1.cast
4+
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-path-input-1.cast
5+
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-confirmation-1.cast
6+
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-single-select-1.cast
7+
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-multi-select-1.cast
8+
9+
svg-term \
10+
--in spring-shell-docs/src/main/asciidoc/asciinema/component-text-input-1.cast \
11+
--out spring-shell-docs/src/main/asciidoc/images/component-text-input-1.svg
12+
svg-term \
13+
--in spring-shell-docs/src/main/asciidoc/asciinema/component-path-input-1.cast \
14+
--out spring-shell-docs/src/main/asciidoc/images/component-path-input-1.svg
15+
svg-term \
16+
--in spring-shell-docs/src/main/asciidoc/asciinema/component-confirmation-1.cast \
17+
--out spring-shell-docs/src/main/asciidoc/images/component-confirmation-1.svg
18+
svg-term \
19+
--in spring-shell-docs/src/main/asciidoc/asciinema/component-single-select-1.cast \
20+
--out spring-shell-docs/src/main/asciidoc/images/component-single-select-1.svg
21+
svg-term \
22+
--in spring-shell-docs/src/main/asciidoc/asciinema/component-multi-select-1.cast \
23+
--out spring-shell-docs/src/main/asciidoc/images/component-multi-select-1.svg

‎spring-shell-docs/src/main/asciidoc/asciinema/component-confirmation-1.cast

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{"version": 2, "width": 85, "height": 8, "timestamp": 1645645867, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
2+
[1.590847, "o", "java -jar spring-shell-samples/target/spring-shell-samples-2.1.0-SNAPSHOT.jar"]
3+
[2.774407, "o", "\r\n"]
4+
[4.560309, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
5+
[5.138757, "o", "\u001b[31mc\u001b[0m"]
6+
[5.267214, "o", "\u001b[31mo\u001b[0m"]
7+
[5.467126, "o", "\u001b[31mm\u001b[0m"]
8+
[5.674049, "o", "\u001b[31mp\u001b[0m"]
9+
[5.752663, "o", "\u001b[31mo\u001b[0m"]
10+
[5.917741, "o", "\u001b[31mn\u001b[0m"]
11+
[6.040844, "o", "\u001b[31me\u001b[0m"]
12+
[6.123068, "o", "\u001b[31mn\u001b[0m"]
13+
[6.277935, "o", "\u001b[31mt\u001b[0m"]
14+
[7.050283, "o", "\u001b[31m \u001b[0m"]
15+
[7.413917, "o", "\u001b[31mc\u001b[0m"]
16+
[7.568894, "o", "\u001b[31mo\u001b[0m"]
17+
[7.664856, "o", "\u001b[31mn\u001b[0m"]
18+
[7.853492, "o", "\u001b[13D\u001b[1mcomponent confirmation\u001b[0m \u001b[K"]
19+
[8.698242, "o", "\r\r\n\u001b[?1l\u001b>\u001b[?1000l\u001b[?2004l"]
20+
[8.745928, "o", "\u001b[?1h\u001b=\u001b[?25l"]
21+
[8.803411, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \u001b[2m(Y/n)\u001b[0m\r"]
22+
[13.769588, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K"]
23+
[13.779021, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \u001b[34mtrue\u001b[0m\r\n"]
24+
[13.779319, "o", "Got value true\r\n"]
25+
[13.781245, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
26+
[15.955396, "o", "\u001b[1mcomponent confirmation\u001b[0m"]
27+
[16.743244, "o", "\r\r\n\u001b[?1l\u001b>\u001b[?1000l"]
28+
[16.743555, "o", "\u001b[?2004l"]
29+
[16.748638, "o", "\u001b[?1h\u001b=\u001b[?25l"]
30+
[16.754861, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \u001b[2m(Y/n)\u001b[0m\r"]
31+
[19.347907, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K"]
32+
[19.355493, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \u001b[34mfalse\u001b[0m\r\n"]
33+
[19.356618, "o", "Got value false\r\n"]
34+
[19.3586, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
35+
[21.3586, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]

‎spring-shell-docs/src/main/asciidoc/asciinema/component-multi-select-1.cast

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{"version": 2, "width": 85, "height": 9, "timestamp": 1645645867, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
2+
[1.746447, "o", "java -jar spring-shell-samples/target/spring-shell-samples-2.1.0-SNAPSHOT.jar"]
3+
[2.881033, "o", "\r\n"]
4+
[4.603396, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
5+
[5.105471, "o", "\u001b[31mc\u001b[0m"]
6+
[5.202878, "o", "\u001b[31mo\u001b[0m"]
7+
[5.428705, "o", "\u001b[31mm\u001b[0m"]
8+
[5.630033, "o", "\u001b[31mp\u001b[0m"]
9+
[5.692044, "o", "\u001b[31mo\u001b[0m"]
10+
[5.86652, "o", "\u001b[31mn\u001b[0m"]
11+
[6.018765, "o", "\u001b[31me\u001b[0m"]
12+
[6.089776, "o", "\u001b[31mn\u001b[0m"]
13+
[6.251781, "o", "\u001b[31mt\u001b[0m"]
14+
[7.126694, "o", "\u001b[31m \u001b[0m"]
15+
[7.319912, "o", "\u001b[31mm\u001b[0m"]
16+
[7.550772, "o", "\u001b[31mu\u001b[0m"]
17+
[7.80087, "o", "\u001b[12D\u001b[1mcomponent multi\u001b[0m \u001b[K"]
18+
[8.291497, "o", "\r\r\n\u001b[?1l\u001b>\u001b[?1000l\u001b[?2004l"]
19+
[8.338879, "o", "\u001b[?1h\u001b=\u001b[?25l"]
20+
[8.398742, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mtestSimple\u001b[0m [Use arrows to move], type to filter\u001b[54C \u001b[96;1m>\u001b[0m\u001b[96;1m \u001b[39m[ ]\u001b[0m key1\u001b[93C \u001b[2m[ ]\u001b[0m \u001b[2mkey2\u001b[0m\u001b[93C \u001b[1m[ ]\u001b[0m key3\u001b[3A\r"]
21+
[12.265649, "o", "\u001b[35Cfiltering 'k'\u001b[K\r"]
22+
[12.507991, "o", "\u001b[47C\u001b[1@e\r"]
23+
[12.945812, "o", "\u001b[48C\u001b[1@y\r"]
24+
[13.35949, "o", "\u001b[49C\u001b[1@1\r\r\n\u001b[103C \u001b[K\r\r\r\n\u001b[K\r\r\n\u001b[K\u001b[3A"]
25+
[14.187299, "o", "\u001b[49C\u001b[P\r\r\n\u001b[103C \u001b[2m[ ]\u001b[0m \u001b[2mkey2\u001b[0m\u001b[93C \u001b[1m[ ]\u001b[0m key3\u001b[3A\r"]
26+
[14.356992, "o", "\u001b[48C\u001b[P\r"]
27+
[14.495579, "o", "\u001b[47C\u001b[P\r"]
28+
[14.642467, "o", "\u001b[35Ctype to filter\u001b[K\r"]
29+
[15.763904, "o", "\r\r\n\u001b[2C\u001b[32m[x]\u001b[0m\u001b[A\r"]
30+
[16.496138, "o", "\r\r\n \r\r\n\u001b[96;1m> \u001b[0m\u001b[2A\r"]
31+
[16.678991, "o", "\r\r\n\r\n \r\r\n\u001b[96;1m> \u001b[0m\u001b[3A\r"]
32+
[17.979077, "o", "\r\r\n\r\n\r\n\u001b[2C\u001b[32m[x]\u001b[0m\u001b[3A\r"]
33+
[18.809587, "o", "\r\r\n\r\n\r\n\u001b[2C\u001b[1m[ ]\u001b[0m\u001b[3A\r"]
34+
[20.452942, "o", "\r\r\n\r\n\u001b[96;1m> \u001b[0m\r\r\n \u001b[3A\r"]
35+
[21.705426, "o", "\r\r\n\r\n \r\r\n\u001b[96;1m> \u001b[0m\u001b[3A\r"]
36+
[22.207898, "o", "\r\r\n\r\n\r\n\u001b[2C\u001b[32m[x]\u001b[0m\u001b[3A\r"]
37+
[23.30633, "o", "\r\r\n\r\n\r\n\u001b[2C\u001b[1m[ ]\u001b[0m\u001b[3A\r"]
38+
[24.642701, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[3A"]
39+
[24.64692, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mtestSimple\u001b[0m \u001b[34mvalue1\u001b[0m\r\n"]
40+
[24.647546, "o", "Got value value1\r\n"]
41+
[24.649365, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
42+
[26.649365, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]

‎spring-shell-docs/src/main/asciidoc/asciinema/component-path-input-1.cast

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
{"version": 2, "width": 85, "height": 6, "timestamp": 1645645867, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
2+
[1.276071, "o", "java -jar spring-shell-samples/target/spring-shell-samples-2.1.0-SNAPSHOT.jar"]
3+
[1.975169, "o", "\r\n"]
4+
[3.730642, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
5+
[4.157171, "o", "\u001b[31mc\u001b[0m"]
6+
[4.259876, "o", "\u001b[31mo\u001b[0m"]
7+
[4.480644, "o", "\u001b[31mm\u001b[0m"]
8+
[4.675743, "o", "\u001b[31mp\u001b[0m"]
9+
[4.746389, "o", "\u001b[31mo\u001b[0m"]
10+
[4.899817, "o", "\u001b[31mn\u001b[0m"]
11+
[5.064803, "o", "\u001b[31me\u001b[0m"]
12+
[5.151957, "o", "\u001b[31mn\u001b[0m"]
13+
[5.295573, "o", "\u001b[31mt\u001b[0m"]
14+
[5.626209, "o", "\u001b[31m \u001b[0m"]
15+
[5.949778, "o", "\u001b[31mp\u001b[0m"]
16+
[6.052068, "o", "\u001b[31ma\u001b[0m"]
17+
[6.270888, "o", "\u001b[31mt\u001b[0m"]
18+
[6.342701, "o", "\u001b[13D\u001b[1mcomponent path\u001b[0m\u001b[K"]
19+
[6.866598, "o", "\r\r\n\u001b[?1l\u001b>\u001b[?1000l\u001b[?2004l"]
20+
[6.918336, "o", "\u001b[?1h\u001b=\u001b[?25l"]
21+
[6.979593, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \r"]
22+
[8.74751, "o", "\u001b[14C/\u001b[88C \u001b[31m>\u001b[0m\u001b[31m>>\u001b[0m \u001b[31mDirectory exists\u001b[0m\u001b[A\r"]
23+
[10.825765, "o", "\u001b[15Ct\r\r\n\u001b[32m>\u001b[0m \u001b[32mPath ok\u001b[0m\u001b[K\u001b[A\r"]
24+
[10.96141, "o", "\u001b[16Cm\r"]
25+
[11.050615, "o", "\u001b[17Cp\r\r\n\u001b[31m>>>\u001b[0m \u001b[31mDirectory exists\u001b[0m\u001b[K\u001b[A\r"]
26+
[11.812886, "o", "\u001b[18C/\r"]
27+
[11.930461, "o", "\u001b[19Cd\r\r\n\u001b[32m>\u001b[0m \u001b[32mPath ok\u001b[0m\u001b[K\u001b[A\r"]
28+
[12.128981, "o", "\u001b[20Ce\r"]
29+
[12.176119, "o", "\u001b[21Cm\r"]
30+
[12.28765, "o", "\u001b[22Co\r"]
31+
[13.464196, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K\r\r\n\u001b[K\u001b[A"]
32+
[13.471408, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \u001b[34m/tmp/demo\u001b[0m\r\n"]
33+
[13.471875, "o", "Got value /tmp/demo\r\n"]
34+
[13.475016, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
35+
[15.475016, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]

‎spring-shell-docs/src/main/asciidoc/asciinema/component-single-select-1.cast

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{"version": 2, "width": 85, "height": 8, "timestamp": 1645645867, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
2+
[2.193321, "o", "java -jar spring-shell-samples/target/spring-shell-samples-2.1.0-SNAPSHOT.jar"]
3+
[3.11524, "o", "\r\n"]
4+
[4.904714, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
5+
[5.372714, "o", "\u001b[31mc\u001b[0m"]
6+
[5.484943, "o", "\u001b[31mo\u001b[0m"]
7+
[5.70511, "o", "\u001b[31mm\u001b[0m"]
8+
[5.913092, "o", "\u001b[31mp\u001b[0m"]
9+
[5.992808, "o", "\u001b[31mo\u001b[0m"]
10+
[6.159092, "o", "\u001b[31mn\u001b[0m"]
11+
[6.281094, "o", "\u001b[31me\u001b[0m"]
12+
[6.353925, "o", "\u001b[31mn\u001b[0m"]
13+
[6.49373, "o", "\u001b[31mt\u001b[0m"]
14+
[6.677988, "o", "\u001b[31m \u001b[0m"]
15+
[6.825018, "o", "\u001b[31ms\u001b[0m"]
16+
[6.95602, "o", "\u001b[31mi\u001b[0m"]
17+
[7.121719, "o", "\u001b[31mn\u001b[0m"]
18+
[7.309007, "o", "\u001b[13D\u001b[1mcomponent single\u001b[0m \u001b[K"]
19+
[7.972392, "o", "\r\r\n\u001b[?1l\u001b>\u001b[?1000l\u001b[?2004l"]
20+
[8.019885, "o", "\u001b[?1h\u001b=\u001b[?25l"]
21+
[8.080156, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mtestSimple\u001b[0m [Use arrows to move], type to filter\u001b[54C \u001b[96;1m>\u001b[0m\u001b[96;1m key1\u001b[0m\u001b[97C key2\u001b[2A\r"]
22+
[9.181662, "o", "\r\r\n key1\r\r\n\u001b[96;1m> key2\u001b[0m\u001b[2A\r"]
23+
[9.701431, "o", "\r\r\n\u001b[96;1m> key1\u001b[0m\r\r\n key2\u001b[2A\r"]
24+
[10.380557, "o", "\r\r\n key1\r\r\n\u001b[96;1m> key2\u001b[0m\u001b[2A\r"]
25+
[12.157001, "o", "\u001b[35Cfiltering 'k'\u001b[K\r"]
26+
[14.605973, "o", "\u001b[47C\u001b[1@e\r\r\n\u001b[96;1m> key1\u001b[0m\r\r\n key2\u001b[2A\r"]
27+
[14.92268, "o", "\u001b[48C\u001b[1@y\r"]
28+
[15.320008, "o", "\u001b[49C\u001b[1@1\r\r\n\u001b[103C \u001b[K\r\r\r\n\u001b[K\u001b[2A"]
29+
[16.215448, "o", "\u001b[49C\u001b[P\r\r\n\u001b[103C key2\u001b[2A\r"]
30+
[16.559377, "o", "\u001b[48C\u001b[P\r"]
31+
[16.784486, "o", "\u001b[47C\u001b[P\r"]
32+
[17.004921, "o", "\u001b[35Ctype to filter\u001b[K\r"]
33+
[17.790542, "o", "\r\r\n key1\r\r\n\u001b[96;1m> key2\u001b[0m\u001b[2A\r"]
34+
[18.340142, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[2A"]
35+
[18.347511, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mtestSimple\u001b[0m \u001b[34mvalue2\u001b[0m\r\n"]
36+
[18.34852, "o", "Got value value2\r\n"]
37+
[18.35067, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
38+
[20.35067, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]

‎spring-shell-docs/src/main/asciidoc/asciinema/component-text-input-1.cast

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
{"version": 2, "width": 85, "height": 6, "timestamp": 1645645867, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
2+
[1.262977, "o", "java -jar spring-shell-samples/target/spring-shell-samples-2.1.0-SNAPSHOT.jar"]
3+
[2.045105, "o", "\r\n"]
4+
[3.846992, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
5+
[4.717927, "o", "\u001b[31mc\u001b[0m"]
6+
[4.824399, "o", "\u001b[31mo\u001b[0m"]
7+
[5.014061, "o", "\u001b[31mm\u001b[0m"]
8+
[5.703137, "o", "\u001b[31mp\u001b[0m"]
9+
[5.802386, "o", "\u001b[31mo\u001b[0m"]
10+
[6.434988, "o", "\u001b[31mn\u001b[0m"]
11+
[6.653321, "o", "\u001b[31me\u001b[0m"]
12+
[6.756821, "o", "\u001b[31mn\u001b[0m"]
13+
[7.293975, "o", "\u001b[31mt\u001b[0m"]
14+
[7.409984, "o", "\u001b[31m \u001b[0m"]
15+
[7.604973, "o", "\u001b[31ms\u001b[0m"]
16+
[7.775599, "o", "\u001b[31mt\u001b[0m"]
17+
[7.928792, "o", "\u001b[31mr\u001b[0m"]
18+
[7.979401, "o", "\u001b[31mi\u001b[0m"]
19+
[8.051232, "o", "\u001b[31mn\u001b[0m"]
20+
[8.15451, "o", "\u001b[15D\u001b[1mcomponent string\u001b[0m\u001b[K"]
21+
[8.892861, "o", "\r\r\n\u001b[?1l\u001b>\u001b[?1000l\u001b[?2004l"]
22+
[8.951185, "o", "\u001b[?1h\u001b=\u001b[?25l"]
23+
[9.013964, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \u001b[34m[Default myvalue]\u001b[0m\r"]
24+
[10.304694, "o", "\u001b[14Ch\u001b[K\r"]
25+
[10.533832, "o", "\u001b[15Ci\r"]
26+
[11.088255, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K"]
27+
[11.097044, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mEnter value\u001b[0m \u001b[34mhi\u001b[0m\r\n"]
28+
[11.097492, "o", "Got value hi\r\n"]
29+
[11.100226, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
30+
[13.100226, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]

0 commit comments

Comments
 (0)