Skip to content

Commit 4da8016

Browse files
author
Nicola Di Falco
committed
feat: adding documentation
1 parent 255ff77 commit 4da8016

File tree

11 files changed

+198
-51
lines changed

11 files changed

+198
-51
lines changed

‎spring-shell-docs/readme.txt

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
Some info how screen recordings were made
22

33
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-number-input-1.cast
45
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-path-input-1.cast
56
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-confirmation-1.cast
67
asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-single-select-1.cast
@@ -11,6 +12,9 @@ asciinema rec spring-shell-docs/src/main/asciidoc/asciinema/component-flow-condi
1112
svg-term \
1213
--in spring-shell-docs/src/main/asciidoc/asciinema/component-text-input-1.cast \
1314
--out spring-shell-docs/src/main/asciidoc/images/component-text-input-1.svg
15+
svg-term \
16+
--in spring-shell-docs/src/main/asciidoc/asciinema/component-number-input-1.cast \
17+
--out spring-shell-docs/src/main/asciidoc/images/component-number-input-1.svg
1418
svg-term \
1519
--in spring-shell-docs/src/main/asciidoc/asciinema/component-path-input-1.cast \
1620
--out spring-shell-docs/src/main/asciidoc/images/component-path-input-1.svg

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

+68-42
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,68 @@
1-
{"version": 2, "width": 85, "height": 15, "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-
[5.968022, "o", "\r\n"]
4-
[8.099727, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
5-
[11.261894, "o", "\u001b[1mflow showcase\u001b[0m"]
6-
[12.6451, "o", "\r\r\n\u001b[?1l\u001b>\u001b[?1000l\u001b[?2004l"]
7-
[12.721206, "o", "\u001b[?1h\u001b=\u001b[?25l"]
8-
[12.780227, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mField1\u001b[0m \u001b[34m[Default defaultField1Value]\u001b[0m\r"]
9-
[14.703281, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K"]
10-
[14.711232, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mField1\u001b[0m \u001b[34mdefaultField1Value\u001b[0m\r\n"]
11-
[14.713588, "o", "\u001b[?1h\u001b=\u001b[?25l"]
12-
[14.720745, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mField2\u001b[0m \r"]
13-
[16.084492, "o", "\u001b[9Ch\r"]
14-
[16.176942, "o", "\u001b[10Ci\r"]
15-
[16.620009, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K"]
16-
[16.625711, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mField2\u001b[0m \u001b[34mhi\u001b[0m\r\n"]
17-
[16.628041, "o", "\u001b[?1h\u001b=\u001b[?25l"]
18-
[16.633919, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mConfirmation1\u001b[0m \u001b[2m(Y/n)\u001b[0m\r"]
19-
[20.090558, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K"]
20-
[20.098654, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mConfirmation1\u001b[0m \u001b[34mtrue\u001b[0m\r\n"]
21-
[20.101548, "o", "\u001b[?1h\u001b=\u001b[?25l"]
22-
[20.105099, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mPath1\u001b[0m \r"]
23-
[21.53213, "o", "\u001b[8Cp\u001b[134C \u001b[32m>\u001b[0m \u001b[32mPath ok\u001b[0m\u001b[A\r"]
24-
[21.626297, "o", "\u001b[9Ca\r"]
25-
[21.896442, "o", "\u001b[10Ct\r"]
26-
[21.941151, "o", "\u001b[11Ch\r"]
27-
[23.041717, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K\r\r\n\u001b[K\u001b[A"]
28-
[23.044506, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mPath1\u001b[0m \u001b[34mpath\u001b[0m\r\n"]
29-
[23.049225, "o", "\u001b[?1h\u001b=\u001b[?25l"]
30-
[23.05459, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mSingle1\u001b[0m [Use arrows to move], type to filter\u001b[97C \u001b[96;1m>\u001b[0m\u001b[96;1m key1\u001b[0m\u001b[137C key2\u001b[2A\r"]
31-
[24.520415, "o", "\r\r\n key1\r\r\n\u001b[96;1m> key2\u001b[0m\u001b[2A\r"]
32-
[25.431855, "o", "\u001b[?1l\u001b>\u001b[?12;25h\u001b[K\r\r\n\u001b[K\r\r\n\u001b[K\u001b[2A"]
33-
[25.438619, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mSingle1\u001b[0m \u001b[34mvalue2\u001b[0m\r\n"]
34-
[25.441975, "o", "\u001b[?1h\u001b=\u001b[?25l"]
35-
[25.446547, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mMulti1\u001b[0m [Use arrows to move], type to filter\u001b[98C \u001b[96;1m>\u001b[0m\u001b[96;1m \u001b[39m[ ]\u001b[0m key1\u001b[133C \u001b[1m[ ]\u001b[0m key2\u001b[133C \u001b[1m[ ]\u001b[0m key3\u001b[3A\r"]
36-
[26.698294, "o", "\r\r\n\u001b[2C\u001b[32m[x]\u001b[0m\u001b[A\r"]
37-
[28.022787, "o", "\r\r\n \r\r\n\u001b[96;1m> \u001b[0m\u001b[2A\r"]
38-
[28.110824, "o", "\r\r\n\r\n\u001b[2C\u001b[32m[x]\u001b[0m\u001b[2A\r"]
39-
[29.250629, "o", "\r\r\n\r\n\u001b[2C\u001b[1m[ ]\u001b[0m\u001b[2A\r"]
40-
[30.360368, "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"]
41-
[30.368273, "o", "\u001b[32;1m?\u001b[0m \u001b[97;1mMulti1\u001b[0m \u001b[34mvalue1\u001b[0m\r\n"]
42-
[30.370638, "o", "\u001b[?1h\u001b=\u001b[?2004h\u001b[33mmy-shell:>\u001b[0m"]
1+
{"version":2,"width":85,"height":13,"timestamp":1691402365,"env":{"TERM":"ms-terminal","SHELL":"powershell.exe"}}
2+
[1.1047019958496094,"o","\u001b[25l\u001b[m\u001b[93m\u001b[jjava\u001b[m \u001b[90m-jar\u001b[m spring-shell-samples/target/spring-shell-samples-2.1.13-SNAPSHOT.jar\u001b[?25h"]
3+
[1.5809330940246582,"o","\r\n"]
4+
[4.359606981277466,"o","\u001b[?2004h\u001b[33mmy-shell:>"]
5+
[4.368336200714111,"o","\u001b[m"]
6+
[5.008507013320923,"o","\u001b[31mf"]
7+
[5.020178556442261,"o","\u001b[m"]
8+
[5.110008478164673,"o","\u001b[31ml"]
9+
[5.128786325454712,"o","\u001b[m"]
10+
[5.294262886047363,"o","\u001b[31mo"]
11+
[5.316054582595825,"o","\u001b[m"]
12+
[5.717259883880615,"o","\u001b[31mw"]
13+
[5.738360643386841,"o","\u001b[m"]
14+
[5.893903732299805,"o","\u001b[31m "]
15+
[5.909526586532593,"o","\u001b[m"]
16+
[6.101584434509277,"o","\u001b[31ms"]
17+
[6.112699270248413,"o","\u001b[m"]
18+
[6.213729619979858,"o","\u001b[31mh"]
19+
[6.2375335693359375,"o","\u001b[m"]
20+
[6.30126953125,"o","\u001b[31mo"]
21+
[6.313809156417847,"o","\u001b[m"]
22+
[6.7899205684661865,"o","\u001b[31mw"]
23+
[6.8119776248931885,"o","\u001b[m"]
24+
[7.117271423339844,"o","\u001b[31mc"]
25+
[7.125688552856445,"o","\u001b[m"]
26+
[7.317806005477905,"o","\u001b[31ma"]
27+
[7.330649375915527,"o","\u001b[m"]
28+
[7.413134574890137,"o","\u001b[31ms"]
29+
[7.423953533172607,"o","\u001b[m"]
30+
[7.597413063049316,"o","\u001b[31me"]
31+
[7.613054275512695,"o","\u001b[m"]
32+
[7.966388940811157,"o","\u001b[25l\u001b[2;11H\u001b[?25h"]
33+
[7.975397825241089,"o","\u001b[1m\u001b[97mflow showcase1\u001b[m\u001b[K"]
34+
[8.303815603256226,"o","\r"]
35+
[8.32024359703064,"o","\u001b[?2004l\r\n"]
36+
[8.385269403457642,"o","\u001b[?25l"]
37+
[8.439088344573975,"o","\u001b[1m\u001b[92m?\u001b[m \u001b[1m\u001b[97mField1\u001b[m \u001b[34m[Default defaultField1Value]"]
38+
[8.460672616958618,"o","\u001b[m"]
39+
[9.442008256912231,"o","\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mField1\u001b[m \u001b[34mdefaultField1Value\u001b[m\u001b[K\u001b[1m\u001b[92m\r\n?\u001b[m \u001b[1m\u001b[97mField2\u001b[m \u001b[K\u001b[200C"]
40+
[10.610269784927368,"o","\u001b[4;10Hh"]
41+
[10.767188787460327,"o","i"]
42+
[11.911431312561035,"o","\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mField2\u001b[m \u001b[34mhi\u001b[m\u001b[K\u001b[1m\u001b[92m\r\n?\u001b[m \u001b[1m\u001b[97mNumber1\u001b[m \u001b[34m[Number Type: Integer]\u001b[m\u001b[K\u001b[177C"]
43+
[13.872986078262329,"o","\u001b[5;11H5\u001b[176X\u001b[176C\u001b[K\u001b[22C"]
44+
[14.3775053024292,"o","\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mNumber1\u001b[m 5.\u001b[176X\u001b[176C\u001b[K\u001b[31m\r\n✖\u001b[m \u001b[31mSorry, your input is invalid: '5.', try again\u001b[m\u001b[K\u001b[162C"]
45+
[15.164267301559448,"o","\u001b[5;13H5\u001b[176X\u001b[176C\u001b[K\u001b[31m\u001b[6;13Hr input is invalid: '5.5', try again\u001b[m\u001b[K\u001b[161C"]
46+
[16.089154958724976,"o","\u001b[5;13H\u001b[176X\u001b[176C\u001b[K\u001b[31m\u001b[6;13Hr input is invalid: '5.', try again\u001b[m\u001b[K\u001b[162C"]
47+
[16.401957750320435,"o","\u001b[1m\u001b[92m\u001b[5;1H?\u001b[m \u001b[1m\u001b[97mNumber1\u001b[m 5\u001b[176X\u001b[176C\u001b[K\r\n\u001b[K\u001b[209C"]
48+
[17.43408179283142,"o","\u001b[1m\u001b[92m\u001b[5;1H?\u001b[m \u001b[1m\u001b[97mNumber1\u001b[m \u001b[34m5\u001b[m\u001b[K\u001b[1m\u001b[92m\r\n?\u001b[m \u001b[1m\u001b[97mNumber2\u001b[m \u001b[34m[Number Type: Double][Default \u001b[m20.5\u001b[34m]\u001b[m\u001b[K\u001b[164C"]
49+
[19.153944492340088,"o","\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mNumber2\u001b[m \u001b[34m20.5\u001b[m\u001b[K\u001b[1m\u001b[92m\r\n?\u001b[m \u001b[1m\u001b[97mConfirmation1\u001b[m (Y/n) \u001b[K\u001b[187C"]
50+
[21.184024572372437,"o","\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mConfirmation1\u001b[m \u001b[34mtrue\u001b[m\u001b[K\u001b[1m\u001b[92m\r\n?\u001b[m \u001b[1m\u001b[97mPath1\u001b[m \u001b[K\u001b[201C"]
51+
[22.48876166343689,"o","\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mPath1\u001b[m p\u001b[K\u001b[32m\r\nℹ\u001b[m \u001b[32mPath ok\u001b[m\u001b[K\u001b[200C"]
52+
[22.628902673721313,"o","\u001b[8;10Ha\u001b[K\u001b[199C"]
53+
[22.83142924308777,"o","\u001b[8;11Ht\u001b[K\u001b[198C"]
54+
[22.9888756275177,"o","\u001b[8;12Hh\u001b[K\u001b[197C"]
55+
[24.351086616516113,"o","\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mPath1\u001b[m \u001b[34mpath\u001b[m\u001b[K\u001b[1m\u001b[92m\r\n?\u001b[m \u001b[1m\u001b[97mSingle1\u001b[m [Use arrows to move], type to filter\u001b[K\u001b[1m\u001b[96m\r\n❯ key1\u001b[m\u001b[K\r\n key2\u001b[K\u001b[203C"]
56+
[25.801196813583374,"o","\u001b[10;1H key1\u001b[1m\u001b[96m\r\n❯ key2"]
57+
[27.1348237991333,"o","\u001b[m"]
58+
[27.156653881072998,"o","\u001b[1m\u001b[92m\u001b[9;1H?\u001b[m \u001b[1m\u001b[97mSingle1\u001b[m \u001b[34mvalue2\u001b[m\u001b[K\u001b[1m\u001b[92m\r\n?\u001b[m \u001b[1m\u001b[97mMulti1\u001b[m [Use arrows to move], type to filter\u001b[K\u001b[1m\u001b[96m\r\n❯ \u001b[97m☐ \u001b[m key1\u001b[K\r\n \u001b[1m\u001b[97m☐ \u001b[m key2\u001b[K\r\n \u001b[1m\u001b[97m☐ \u001b[m key3\u001b[K\u001b[200C"]
59+
[28.298755884170532,"o","\u001b[32m\u001b[11;3H☒ "]
60+
[28.935486793518066,"o","\u001b[m"]
61+
[28.9540057182312,"o","\r \u001b[1m\u001b[96m\r\n❯ "]
62+
[29.616623163223267,"o","\u001b[m"]
63+
[29.6264967918396,"o","\u001b[32m☒ "]
64+
[30.775631189346313,"o","\u001b[m"]
65+
[30.79448390007019,"o","\u001b[1m\u001b[97m\u001b[12;3H☐ "]
66+
[31.608378648757935,"o","\u001b[m"]
67+
[31.622425317764282,"o","\u001b[?2004h\u001b[1m\u001b[92m\u001b[10;1H?\u001b[m \u001b[1m\u001b[97mMulti1\u001b[m \u001b[34mvalue1\u001b[m\u001b[K\u001b[33m\r\nmy-shell:>\u001b[m\u001b[K\r\n\u001b[K\r\n\u001b[K\u001b[11;11H\u001b[?25h"]
68+
[33.2701370716095,"o","\u001b[31m"]

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

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{"version":2,"width":120,"height":9,"timestamp":1691400709,"env":{"TERM":"ms-terminal","SHELL":"powershell.exe"}}
2+
[1.1047019958496094,"o","\u001b[25l\u001b[m\u001b[93m\u001b[jjava\u001b[m \u001b[90m-jar\u001b[m spring-shell-samples/target/spring-shell-samples-2.1.13-SNAPSHOT.jar\u001b[?25h"]
3+
[1.7505860328674316,"o","\r\n"]
4+
[4.510409593582153,"o","\u001b[?2004h\u001b[33mmy-shell:>"]
5+
[4.519921541213989,"o","\u001b[m"]
6+
[5.577335357666016,"o","\u001b[31mc"]
7+
[5.591983318328857,"o","\u001b[m"]
8+
[5.846746921539307,"o","\u001b[31mo"]
9+
[5.857876777648926,"o","\u001b[m"]
10+
[5.96783971786499,"o","\u001b[31mm"]
11+
[5.98032808303833,"o","\u001b[m"]
12+
[6.270904302597046,"o","\u001b[31mp"]
13+
[6.293165922164917,"o","\u001b[m"]
14+
[6.335582733154297,"o","\u001b[31mo"]
15+
[6.355441093444824,"o","\u001b[m"]
16+
[6.671180009841919,"o","\u001b[31mn"]
17+
[6.684344053268433,"o","\u001b[m"]
18+
[6.855102300643921,"o","\u001b[31me"]
19+
[6.872071743011475,"o","\u001b[m"]
20+
[6.998976230621338,"o","\u001b[31mn"]
21+
[7.0131447315216064,"o","\u001b[m"]
22+
[7.159230947494507,"o","\u001b[31mt"]
23+
[7.1707377433776855,"o","\u001b[m"]
24+
[7.230209112167358,"o","\u001b[31m "]
25+
[7.248788356781006,"o","\u001b[m"]
26+
[7.406573534011841,"o","\u001b[31mn"]
27+
[7.420743227005005,"o","\u001b[m"]
28+
[7.679130554199219,"o","\u001b[31mu"]
29+
[7.699283123016357,"o","\u001b[m"]
30+
[8.135498523712158,"o","\u001b[31mm"]
31+
[8.153958559036255,"o","\u001b[m"]
32+
[8.374905347824097,"o","\u001b[31mb"]
33+
[8.38698434829712,"o","\u001b[m"]
34+
[8.527199268341064,"o","\u001b[31me"]
35+
[8.543792724609375,"o","\u001b[m"]
36+
[8.719360589981079,"o","\u001b[25l\u001b[2;11H\u001b[?25h"]
37+
[8.731481313705444,"o","\u001b[1m\u001b[97mcomponent number\u001b[m\u001b[K"]
38+
[8.814936637878418,"o"," "]
39+
[8.982696294784546,"o","d"]
40+
[9.087361097335815,"o","o"]
41+
[9.151376247406006,"o","u"]
42+
[9.383987665176392,"o","b"]
43+
[9.574780225753784,"o","l"]
44+
[9.70450234413147,"o","\u001b[25l\u001b[2;27H\u001b[?25h"]
45+
[9.718122243881226,"o","\u001b[1m\u001b[97m double\u001b[m\u001b[K"]
46+
[9.928346157073975,"o","\r"]
47+
[9.95093560218811,"o","\u001b[?2004l\r\n"]
48+
[10.007387638092041,"o","\u001b[?25l"]
49+
[10.075207471847534,"o","\u001b[1m\u001b[92m?\u001b[m \u001b[1m\u001b[97mEnter value\u001b[m \u001b[34m[Number Type: Double][Default \u001b[m99.9\u001b[34m]"]
50+
[10.091434478759766,"o","\u001b[m"]
51+
[12.732241153717041,"o","\u001b[3;15H5\u001b[70X\u001b[70C\u001b[K\u001b[35C"]
52+
[13.092545509338379,"o","\u001b[3;16H.\u001b[70X\u001b[70C\u001b[K\u001b[34C"]
53+
[13.577228307723999,"o","\u001b[3;17H5\u001b[70X\u001b[70C\u001b[K\u001b[33C"]
54+
[14.40083646774292,"o","\u001b[?2004h\u001b[1m\u001b[92m\r?\u001b[m \u001b[1m\u001b[97mEnter value\u001b[m \u001b[34m5.5\u001b[m\u001b[K\r\nGot value 5.5\u001b[K\u001b[33m\r\nmy-shell:>\u001b[m\u001b[K\u001b[?25h"]
55+
[15.966568946838379,"o","\u001b[31m"]

‎spring-shell-docs/src/main/asciidoc/images/component-flow-showcase-1.svg

+1-1
Loading

0 commit comments

Comments
 (0)