Compare commits
1555 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1688c4f9b0 | ||
|
|
9a7b9b8a10 | ||
|
|
2b5f53b83f | ||
|
|
d65c795ccb | ||
|
|
3918148378 | ||
|
|
f5694dd4d7 | ||
|
|
5fc0909ce7 | ||
| 230c684725 | |||
| 081aafa8c6 | |||
| 25eb9bbb86 | |||
| 5d4fe2fa2f | |||
| 956c92ee79 | |||
|
|
c6ea409bd8 | ||
|
|
deaacedb96 | ||
|
|
ecdc8f4a2a | ||
|
|
df4baa55a7 | ||
|
|
f96626739f | ||
|
|
635d20e013 | ||
|
|
f789564f51 | ||
| 25fbc61f49 | |||
| 319bfc3bc6 | |||
|
|
c56b142fd1 | ||
|
|
11a7f6238e | ||
|
|
07cc9060d1 | ||
|
|
8afb055f0b | ||
| f34ca98623 | |||
| aa992cef7d | |||
| bcfc525bee | |||
| bd50ace19e | |||
| 3465e36de5 | |||
| b154a91867 | |||
| cf304e004e | |||
| a056c830d2 | |||
| 73ff7e5534 | |||
| d6979d7167 | |||
| 7143b465ad | |||
| c270d5d741 | |||
| 10d1dc943c | |||
|
|
75b07aec93 | ||
|
|
6f6224f21b | ||
|
|
c28df7b33e | ||
|
|
a97d6f1ea3 | ||
|
|
302519d876 | ||
|
|
ca95464115 | ||
| 44c12281d3 | |||
| b36bb87513 | |||
| 58d3d9daa0 | |||
| 4cf3aa6d5c | |||
| 299bfe4644 | |||
|
|
785a2108e6 | ||
|
|
e2e011d7e6 | ||
| 90aac7db6e | |||
| cba62d33ba | |||
|
|
4260715945 | ||
|
|
a65cbd606b | ||
|
|
de8f390f4b | ||
|
|
80206c942d | ||
|
|
5f61744eed | ||
|
|
d976ce0652 | ||
|
|
9a1a5a1276 | ||
|
|
8f2d187b17 | ||
|
|
87a0526922 | ||
|
|
cf774a9269 | ||
|
|
bbae80c1bb | ||
|
|
1b6f7a2a84 | ||
|
|
4733a986f2 | ||
|
|
68186944c8 | ||
|
|
dcf8ece59a | ||
|
|
d3fd0ef950 | ||
|
|
1a46cc5e1e | ||
|
|
eff373fb71 | ||
|
|
801c4abb43 | ||
|
|
e4bd82da22 | ||
|
|
0d1749abcf | ||
|
|
c29678b303 | ||
|
|
479068587d | ||
|
|
fc1b12516f | ||
|
|
78cdca3e02 | ||
|
|
d819040d83 | ||
|
|
2b2945e6f1 | ||
|
|
0566d10a69 | ||
|
|
b63efd2247 | ||
|
|
3bed628174 | ||
|
|
90d72e91c5 | ||
|
|
cb2fcd85c0 | ||
|
|
be18d30de3 | ||
|
|
aa29384611 | ||
|
|
8801df1672 | ||
|
|
672e438593 | ||
|
|
383dfda990 | ||
|
|
5299aa8a11 | ||
|
|
bd921770fd | ||
|
|
c26ba98884 | ||
|
|
1361b2c5a9 | ||
|
|
6c39682fd2 | ||
|
|
7f0608fadc | ||
|
|
363c42ec4a | ||
|
|
26123964df | ||
|
|
f0efca563e | ||
|
|
61487902d6 | ||
| 097bfecfe6 | |||
| 45d1d60166 | |||
| daa204555d | |||
| 2bea94eb89 | |||
| ba1ca13066 | |||
| 1664c830c9 | |||
| de1ac8e010 | |||
| 4662ce3c02 | |||
| 5fc7823f4b | |||
| 048a0cf893 | |||
| 901e908342 | |||
| 78f7d3a8c4 | |||
| f6ef711c72 | |||
| ba75cc39a0 | |||
| ab1d8b1157 | |||
| 1101107b9b | |||
| 3fee5134b4 | |||
| 7d49f552e4 | |||
|
|
28d17db663 | ||
|
|
860ebdae15 | ||
| aec8908205 | |||
| 2bc9c0b4e0 | |||
| 57f3e47bb6 | |||
|
|
78fce909a8 | ||
|
|
6800631ead | ||
|
|
ee3362d512 | ||
|
|
44ec137db5 | ||
|
|
ba48ae255b | ||
|
|
bb0b9d2ad9 | ||
|
|
255b8da0e7 | ||
| 62ccf42a4b | |||
| 940ad5bb71 | |||
| 6f723a7d77 | |||
| ffe476684f | |||
| 85c108a8d2 | |||
| e386ae4f49 | |||
| bcd8552f41 | |||
| 31d8e1a21d | |||
| b0f8fe20d8 | |||
| 9cf7cf711a | |||
| 1fe699f20c | |||
| bfafc06140 | |||
| b66020cf64 | |||
| e79164d8dc | |||
| dd7946c20c | |||
| 1709618f2c | |||
| fbe2e5b345 | |||
|
|
f54c57847a | ||
|
|
b83aa75e9d | ||
|
|
e59ff8b63f | ||
| d9b75ef4ae | |||
| 413a9be24f | |||
| 2a9ddd0484 | |||
| 88d55ed401 | |||
| 86b2d60e5f | |||
| c589da3511 | |||
| b7f7e8cf6c | |||
| 6d41fa326b | |||
| 7ed8b41b88 | |||
| 01a54cff67 | |||
| 906b703a80 | |||
| 3ab0152b7f | |||
| d4f9798ec3 | |||
| 2eacd5f98d | |||
| f1294b26cb | |||
| 62a64e9fd0 | |||
| 54077e1f33 | |||
| ba190c20cd | |||
| 6be418f8cb | |||
| 9011f5b4c8 | |||
| 9643dcf53b | |||
|
|
5eedae9717 | ||
|
|
386fae3421 | ||
| ccc8009d1f | |||
| 7d5754d6eb | |||
| f2f639a6c2 | |||
| 3ea062a8d8 | |||
| c9d0bf428b | |||
| b9e82fe302 | |||
| ade9cfb2a5 | |||
| af64993c7e | |||
|
|
380a8dea1b | ||
|
|
e4101351aa | ||
| 6b4f015ac0 | |||
| 05c9a05d39 | |||
| c13274c381 | |||
| dfa68f6893 | |||
|
|
844e3d5214 | ||
| a65c0c9cf1 | |||
| 029936e9ba | |||
| 0d0e756125 | |||
| 56db4a17ab | |||
| d94d226ca5 | |||
| dec5a4fcf8 | |||
| 4cdb9edaaa | |||
| 4bef194924 | |||
| a11650fd64 | |||
| 48857379fb | |||
| b3a72d3222 | |||
| 63782e673a | |||
| c49ce44481 | |||
| 59cf09f73a | |||
| 48607d710e | |||
| 304cdb5918 | |||
| 5d4974e38a | |||
| ee11b07ffb | |||
| a44c9330c6 | |||
| fdc47f1415 | |||
|
|
8576e8421b | ||
|
|
7d176ed74d | ||
|
|
4778bb3fb3 | ||
|
|
af1d6a7485 | ||
| 825a644ce9 | |||
| 5215843308 | |||
|
|
3669edf24e | ||
| 64c7efca5e | |||
|
|
e9e11ee407 | ||
| a763a03884 | |||
| 27a536ab9a | |||
|
|
f9fa1df7cc | ||
|
|
e58db411f2 | ||
|
|
eeac447644 | ||
|
|
e2a894de29 | ||
|
|
ff16a9bc07 | ||
|
|
23f7e05931 | ||
|
|
6d67dbe2d7 | ||
|
|
10ce2ca1cd | ||
| 9a41f9e732 | |||
| ab1044079e | |||
| 554478ffe7 | |||
| 43ae67a070 | |||
| 006dab5905 | |||
| bea94be43c | |||
| df0a1a59e5 | |||
| 4e9cf01b02 | |||
| 4d30086ee0 | |||
| 5a85a4ca4a | |||
| 95e7020c00 | |||
| 9fdb74b5fb | |||
| 0696fc6fdd | |||
| e5f142bfbd | |||
| 1f5c75dcd5 | |||
| 07ca315299 | |||
| 5a7a6f832d | |||
| b47c9d1761 | |||
| 697a7443d5 | |||
| 94976866be | |||
| d0c3b38289 | |||
| 1c8da11df7 | |||
| f7215d75e1 | |||
| 09dd31b473 | |||
| 0eaf56be91 | |||
| 6a02a45474 | |||
| 95507002c9 | |||
| 8ee76ac2b4 | |||
| 5155ab16af | |||
|
|
ad906b5894 | ||
| 12a00dbc78 | |||
|
|
92c8a3b955 | ||
|
|
0ef28b6cfe | ||
| 84bbcd3a06 | |||
| cde04c9917 | |||
| 397b544ab2 | |||
| 494b69e2b7 | |||
| 0c2d805fa0 | |||
| 0cbf0758f9 | |||
| 3f90e5bc15 | |||
| 9c895533b6 | |||
| f49b5245d0 | |||
| a7cc5142ac | |||
| b918079117 | |||
|
|
54192a06d5 | ||
|
|
2f2edc86ad | ||
|
|
e924645ac2 | ||
| af5e58199d | |||
| d2e817c25f | |||
|
|
42cf8949f7 | ||
|
|
f061c0285a | ||
| 2f1d5e6173 | |||
| 9ed01e86ba | |||
|
|
4e52882d22 | ||
|
|
201d922fd2 | ||
|
|
8a24f12624 | ||
|
|
a208ee91a2 | ||
|
|
b90a118e4e | ||
| 5b58fa9f8b | |||
|
|
5914ee766f | ||
| fee1b585b5 | |||
| 22a8309296 | |||
| f783182648 | |||
| af78e5375a | |||
| e39ad90ae5 | |||
| 8ee4a78d67 | |||
| 28839cf646 | |||
| eef9f39b58 | |||
| 803ad57012 | |||
| 07f5b8d363 | |||
| 820ef4bc49 | |||
| aa38f44258 | |||
| 22c238fbf8 | |||
| 200e200a75 | |||
| f0859afe27 | |||
| d5f6feba43 | |||
| 445001529a | |||
| 291ee62db5 | |||
| d90cac4c89 | |||
| f539c10c02 | |||
| a6bba54b5f | |||
| 801826c9ba | |||
| 0b7a6f0ef4 | |||
| 3441156169 | |||
| 11fd479650 | |||
| 95c85d0a70 | |||
| 164748601e | |||
| aa44716264 | |||
|
|
6c971ca689 | ||
|
|
2ddec79102 | ||
|
|
7635732952 | ||
|
|
6c9f4b54e0 | ||
|
|
8b218cce03 | ||
| ae2c856e7c | |||
| 74a23105da | |||
| 50bad9bb7a | |||
| 6cf8cf5657 | |||
|
|
cd0cec3619 | ||
|
|
a20a69f7d8 | ||
|
|
e856d30874 | ||
|
|
cefbcb6caa | ||
|
|
263febb080 | ||
|
|
9cc411eb4a | ||
|
|
41c8f7cf6d | ||
|
|
196bcebb27 | ||
|
|
ef211882af | ||
|
|
7001e8a2a6 | ||
|
|
16c01b2e0f | ||
|
|
a74129ff90 | ||
|
|
9123c2bcb8 | ||
| 145c6d8714 | |||
| cb125e8114 | |||
| 53552b03c2 | |||
| 12316e57bb | |||
| 984013f774 | |||
| ff0d04f3b6 | |||
| 1abeb6f982 | |||
| 5eb74431c1 | |||
| c9124654f1 | |||
| 35fe19f27a | |||
| 2e57704884 | |||
| b1bc3e1dc4 | |||
| 36b4d04288 | |||
| 7f52368a2d | |||
| 66dbcae195 | |||
| a247ad2065 | |||
| 139f46b6c3 | |||
| 9f424d9d33 | |||
| 154a5139d9 | |||
| eb81e69bf4 | |||
| 4b41bdc588 | |||
| 9eb89e0411 | |||
| 5fcdadcabd | |||
| d542d080fa | |||
| f6557335ee | |||
| bbac841427 | |||
| 746d9d16c7 | |||
| 075b6bd124 | |||
| 9174e60d78 | |||
| 85b17eeb05 | |||
|
|
8d03eb822d | ||
|
|
0ee57a8075 | ||
|
|
dd400ba6fa | ||
|
|
4a82bde192 | ||
|
|
08bcd3bc56 | ||
|
|
49bf9dbf80 | ||
|
|
2b39801164 | ||
|
|
5bfaec3cb3 | ||
|
|
99427fcbef | ||
|
|
1bd91cd51a | ||
|
|
03935c3637 | ||
|
|
b84e9a046c | ||
|
|
b3fe4dd2cd | ||
|
|
49f15d46bb | ||
|
|
cf8e69041d | ||
|
|
89ef8442a3 | ||
|
|
9bbe8abd6b | ||
| de763f14f6 | |||
| d5f06ef971 | |||
| 357a9e58ba | |||
| 635950f33a | |||
| ad71b6943e | |||
| 9beb763c93 | |||
| 40455a8c2e | |||
| 418a38527a | |||
| 3af0aef6c1 | |||
| c9dc8fb44b | |||
| 18f4471d3f | |||
| b0f82ac834 | |||
| ff1b343a95 | |||
|
|
5255006b92 | ||
|
|
38dd076cb9 | ||
|
|
52a1d2f80d | ||
| 6fbca85d0c | |||
| 8ee02d175e | |||
|
|
4746337b24 | ||
|
|
46a3bcb840 | ||
|
|
dde5f2f7e6 | ||
|
|
c7724f0779 | ||
| c702354260 | |||
|
|
4afedc6541 | ||
|
|
97760cfe87 | ||
|
|
b957394d2a | ||
|
|
7d28129f06 | ||
|
|
ab80ba8628 | ||
| cb43ec7f1a | |||
| 9657e9aa97 | |||
| a25a12d4c9 | |||
| 738bb16084 | |||
| f9717f8f5d | |||
|
|
4b0b5a26f8 | ||
|
|
0e8fdb0149 | ||
| 2c7eaa4f5d | |||
| 58aee3916c | |||
| 79d2bb49f9 | |||
| 6daffaeb94 | |||
| 6edbfef12a | |||
| b7b89eece7 | |||
| 90a3ce1181 | |||
|
|
c813546085 | ||
|
|
b0b1fbf2c2 | ||
|
|
3d86ec7cf5 | ||
| ce6cf3aa9c | |||
| 03bb86bd72 | |||
| b146261432 | |||
| b29468c0c2 | |||
| 8d1656c679 | |||
| 0f6d6f731a | |||
| 0f2d9f0aba | |||
| 0221c0a28c | |||
| 03961b291b | |||
| e89bd8ce24 | |||
| 66d2ef2d97 | |||
| 0a02ea353a | |||
| 03c296ec2f | |||
| a96bebfd65 | |||
| fac9276479 | |||
| 8440b18e2f | |||
| e340ad01ea | |||
| ae1f9d4477 | |||
| 7b8ca007b7 | |||
| fb87adf87d | |||
| d52aa5dbd4 | |||
| 0bf586f748 | |||
| a4472f095e | |||
| f5ca193fb4 | |||
| 3f9844fd93 | |||
| 76efe0438a | |||
| 12c197207c | |||
| 60fd795b1f | |||
|
|
ccfe02b1ee | ||
|
|
b6324849a4 | ||
| c10a7f2e7b | |||
| 049f2316bd | |||
| 4af635c4d1 | |||
| d1ec4ff568 | |||
|
|
13223dc03d | ||
|
|
9d79b6f2e2 | ||
| db9d2b5a0a | |||
| 791988c420 | |||
|
|
566d871399 | ||
| cbc6a9df2d | |||
| cace08d36c | |||
| a1fcdc1005 | |||
| c4d4dd5560 | |||
|
|
1228441fd6 | ||
|
|
ae5ab3133f | ||
|
|
b4c0d33b81 | ||
| 24ec468d37 | |||
|
|
582184f51e | ||
| f30d1fd503 | |||
|
|
e341f83f0f | ||
|
|
ab6808c5f9 | ||
|
|
289bfb3a98 | ||
|
|
32e7a6df4f | ||
| 50545ef5c1 | |||
| 621faa73a5 | |||
| ffa5447e6f | |||
|
|
a62147d7cc | ||
|
|
dcb9714599 | ||
| a99af1dfdd | |||
| bf999d8fcb | |||
|
|
750e34cbe4 | ||
|
|
25f4e4f03e | ||
|
|
0bc6150986 | ||
| 4c1ed80b85 | |||
| 85eaee4c0a | |||
| 161f6786bd | |||
| 692838566a | |||
| 856a5add22 | |||
| 5f75c542df | |||
| 43e7c087db | |||
| e0a81f9525 | |||
| 80741a3500 | |||
| c6d703b860 | |||
| 836c87fbec | |||
| 5f683ec4a8 | |||
| 77d9b5c869 | |||
| 607b2b0881 | |||
| 01163ef534 | |||
|
|
a37dbd2438 | ||
|
|
9945cfb52c | ||
|
|
25327053b9 | ||
|
|
426a53a50d | ||
|
|
b26893bf45 | ||
| 4e20df3eb8 | |||
| a2a9b07238 | |||
| 8532373e7e | |||
| c7b2ea9e2a | |||
| 698724f810 | |||
| 4f54551f14 | |||
|
|
117c9ac67c | ||
| e47d311c99 | |||
| 6de2153f11 | |||
|
|
0e7344ae4a | ||
| 810cbda176 | |||
| d07aec8434 | |||
| 4ab65ac61b | |||
| 1dd8c29735 | |||
| e7a36f47e8 | |||
|
|
7fe03b5a5d | ||
| 9f39481cb4 | |||
| 2253ef71e6 | |||
|
|
cd512813e3 | ||
|
|
d6ea18e6db | ||
|
|
cc93081b15 | ||
|
|
6098f166bb | ||
|
|
3050433cfd | ||
|
|
de9e310867 | ||
| 9398d653d3 | |||
| 66240aa9f2 | |||
|
|
03de3a6aee | ||
|
|
cf187d46b3 | ||
|
|
066f339b78 | ||
|
|
68dd957421 | ||
| b168d647da | |||
| 3f46a35f7b | |||
| e6021c0bde | |||
| 9af7a62381 | |||
| 245d45bb6b | |||
| 238c35d45b | |||
| df3817120f | |||
| 2a38221d7f | |||
| 40b3911781 | |||
| febe87c55e | |||
| e8d6193d06 | |||
| 1d98724c02 | |||
| 26731c38b5 | |||
| a484da769c | |||
| cbccce3413 | |||
|
|
27c8c06cdb | ||
|
|
35eee2dcad | ||
| cba4a6d7c1 | |||
| 1217d7b10d | |||
|
|
cfd5711c86 | ||
| 9642922445 | |||
| 9b2b7283c0 | |||
| 9658f1af8d | |||
| 13bed3d48a | |||
| e620dfc6e3 | |||
| 1171b7b6d6 | |||
| 3029bf661a | |||
|
|
26c945ed08 | ||
| 1b90ce41e6 | |||
| e0a8bc32e7 | |||
|
|
f5d9c6019b | ||
|
|
27f48de1f1 | ||
| add4fb5c48 | |||
| 17cdfd8a0d | |||
|
|
854eb9972b | ||
| c0339a0922 | |||
| 601e5db76a | |||
| b109299210 | |||
| 082dbed910 | |||
| 6e32a01faa | |||
| d73fe6eb25 | |||
| 4a0fd8edde | |||
| 34202de296 | |||
| 3988548fe9 | |||
| 3bcb6bee80 | |||
| 7e33acb425 | |||
| 75d20fd8e1 | |||
|
|
c38fdd86ac | ||
|
|
9069816db1 | ||
| 1903ebe045 | |||
| 3dee0d7eef | |||
| ba85e91c58 | |||
|
|
1ed08b3ca4 | ||
|
|
bcee46fa15 | ||
| f3449d6812 | |||
|
|
3c5e0a053e | ||
|
|
f6c077c6b5 | ||
| df5d91e7b6 | |||
| 25e01e308c | |||
| 7204aff27e | |||
| cd91734a84 | |||
| 6306883463 | |||
| 42bfecffb6 | |||
| f7d5415484 | |||
| 5825640c2c | |||
| de60c5f78e | |||
| be19609855 | |||
| 27bc172257 | |||
| 6732928156 | |||
| 3bd1117210 | |||
| 1cd8e8c299 | |||
| 97d506ecbf | |||
| 43ffedfad8 | |||
| 71298a9704 | |||
| e76f558f97 | |||
| e030309b7f | |||
| e77f923cd2 | |||
| bd86f2c4f7 | |||
|
|
2d00d6cf9f | ||
|
|
a58d72615d | ||
|
|
14771ed944 | ||
|
|
a6d4a23172 | ||
|
|
5c77c6bd8d | ||
| b0ff9e3fbf | |||
|
|
3f82240564 | ||
| 06a89aead9 | |||
| 23a723e17f | |||
| 1501a09e62 | |||
|
|
1f9b8c1e76 | ||
|
|
f7ed2ea31e | ||
| 15aeb136b2 | |||
| 50f33e9303 | |||
| f026565f77 | |||
| 0845feffac | |||
| 55f0621983 | |||
| 75363d7aeb | |||
| 1f9bc11a2e | |||
| aab018925d | |||
| 5fa361256a | |||
| 42fe7b0a0d | |||
| 011e5b039e | |||
|
|
e9bcf6ef69 | ||
| f885563982 | |||
| ffff44f347 | |||
|
|
0e1450b5db | ||
| f8734a7e9f | |||
| c05ec6be7f | |||
| 8677d177cb | |||
| dd37eeaa29 | |||
| d5753ee794 | |||
| 6b46b3dbaa | |||
| 4cd5b51085 | |||
| 0a7851b920 | |||
| a0fdaf395e | |||
| 2c5a2ace17 | |||
| 965a2bebb7 | |||
| 2c08ee8687 | |||
| e105dd73b5 | |||
| f5dfe8c0af | |||
| ac97e9e7bc | |||
|
|
beae2cef82 | ||
| 2b23771056 | |||
| 19632b4b4b | |||
| 31c033300a | |||
| ca4127319d | |||
|
|
d3d8f0d0f1 | ||
|
|
2968e4dddc | ||
|
|
30c7951058 | ||
|
|
af63e266d8 | ||
|
|
5d1e3d416e | ||
|
|
dd9dc59485 | ||
| b473630ceb | |||
| a34b8b70ba | |||
| fd195f0824 | |||
| a727d19281 | |||
| 52c88bccb5 | |||
| 85cb868bff | |||
| 4339220b42 | |||
| 2eb62063f2 | |||
| eaccbe610f | |||
| 53e685241a | |||
| 9d87fc62f3 | |||
| 682abdbda9 | |||
| 6308d232aa | |||
| 56d6a05ced | |||
| 0c93a5abe8 | |||
| 2726ecbe2e | |||
| aa26ae60e2 | |||
|
|
edefab866f | ||
|
|
b01e6a5a4c | ||
|
|
843b20804b | ||
| daf6ce5126 | |||
| 52214f79d6 | |||
|
|
6ae6cc35ee | ||
|
|
82a46e8149 | ||
| 93953ed570 | |||
| 2667856633 | |||
| 3bca5f661e | |||
| d4df226381 | |||
| d56a04e3ea | |||
| e4c204376e | |||
| 04403b62a4 | |||
|
|
3b0232ebe3 | ||
|
|
29e0efa3d6 | ||
|
|
c81af5e235 | ||
|
|
b15c4cd15a | ||
|
|
65d75a8148 | ||
|
|
b04e1d7f99 | ||
|
|
a848eaa18b | ||
|
|
ccf2d4a3a5 | ||
|
|
59acea177d | ||
| 5cb52ba6b1 | |||
| 6a2ea52e48 | |||
| c853f3b0ce | |||
| 07bd258e54 | |||
| 52f7a7a2b8 | |||
| cf4d9e86c8 | |||
|
|
44effe9a4b | ||
|
|
2502f0a655 | ||
|
|
d747977185 | ||
| 4b900e383a | |||
| 8ae0d6e401 | |||
|
|
198a394be8 | ||
|
|
697c500e35 | ||
|
|
e6c1d84836 | ||
| e837912363 | |||
| 50a76dd096 | |||
| a7f6548bea | |||
| 34da4f06e1 | |||
| 932b6508c9 | |||
| bfaa2446cd | |||
| bfe3110894 | |||
| 59386bb1c2 | |||
| b99f5ae6e9 | |||
| 4472dc7d04 | |||
| d3d7eccf3d | |||
| 7e250d1224 | |||
| 14d8d5af8d | |||
| 1cb6c486df | |||
| bc163eb61d | |||
| 802f6e074d | |||
| 4bf4294c42 | |||
| cb13febd78 | |||
| 685a58aa14 | |||
| 2bc2c07114 | |||
| 66757c52d7 | |||
| 9fd551e0f7 | |||
| 705f2d640e | |||
| 0eb4dd38f8 | |||
| 6233961371 | |||
| ddfb48f7ab | |||
| 800133ab89 | |||
|
|
2319912f8f | ||
| 0363e5e661 | |||
| d2bf58f514 | |||
| bc92114918 | |||
| f143e3cf48 | |||
| f20f5efcb6 | |||
| 1d383faa62 | |||
| 46e425cbc5 | |||
| 44d3edca55 | |||
|
|
a44072bd4d | ||
|
|
957d977147 | ||
| c038334e67 | |||
| 2f450f7b9b | |||
|
|
a840d1211a | ||
|
|
f8dc42499b | ||
|
|
78c5a7a3c6 | ||
|
|
983908e531 | ||
|
|
a76dfc3a28 | ||
|
|
914cba5388 | ||
| 4c7654fb3c | |||
| 5b48304fac | |||
|
|
6357ae43db | ||
| ab5430ddc7 | |||
| 6877de4626 | |||
| 181a81a84a | |||
| f2079c7c3d | |||
| 9b86f76eaa | |||
|
|
5cee9a4d5a | ||
| 835556b223 | |||
| 0ebc06589e | |||
| 2a23458b57 | |||
|
|
c27862262f | ||
|
|
5592d13d66 | ||
| 63fd9d1660 | |||
| d59c9a06fd | |||
| 21e43c69a8 | |||
| b560288962 | |||
| 57dfa87a9e | |||
| 4fb7996f99 | |||
| bd9cc74c60 | |||
| ff79c952f2 | |||
| 6c3032e65f | |||
| 740b243356 | |||
| bb3dd2dbf9 | |||
| 02c4229116 | |||
| 55794a208c | |||
| c81e342037 | |||
| 1fe0f04226 | |||
| bf01a35686 | |||
| 1ea0978776 | |||
| 8d7c8e8933 | |||
| 5cc32b3e9c | |||
| 0b8cba068e | |||
| 8282bdf6d5 | |||
| b8759d29fb | |||
| 1944d58c9f | |||
| 959c1319e7 | |||
| a538b2af90 | |||
| 0ec8fd58d2 | |||
| bd120180ea | |||
| 2127fb2ec0 | |||
| ddf5fcbbcc | |||
| 62932976dd | |||
| 63217506dd | |||
| fdd619df85 | |||
| 90fc08a816 | |||
| 874ad25fe1 | |||
| 35c3dd7955 | |||
| b6935cf673 | |||
| cbde29a8b4 | |||
| 8e47487a23 | |||
| 32fcda82e7 | |||
| 721352489d | |||
| 6092143ed8 | |||
| d469869b14 | |||
| 391283159d | |||
| 802dcdb8ac | |||
| a5146e4a27 | |||
| 2c8daf11d8 | |||
| e798187b89 | |||
| b9eb75d13e | |||
| d32f0f4245 | |||
| e8d4d0afe6 | |||
| 555272eeb3 | |||
| f53a1c3349 | |||
| 02ffc71aea | |||
| f092095e7b | |||
| 45c64b8184 | |||
| 1fdd30c147 | |||
| 8354ba4c8c | |||
| d9f1c93a01 | |||
| 0e7ea1a6f0 | |||
| 9ca0728929 | |||
| 7ea0a43b0c | |||
| c3b517c4f3 | |||
| 09dedf9669 | |||
| 1b03a9ef6d | |||
| 6ba074b29c | |||
| 731c4a801a | |||
| 0662b37915 | |||
| 545fd75d71 | |||
| ca6fc6f7a5 | |||
| 49bd1b84ff | |||
|
|
6a22412a72 | ||
|
|
35ae33f32a | ||
|
|
e2aa9e7c46 | ||
|
|
dbf18c7a34 | ||
|
|
8902d92534 | ||
|
|
483b6e3de3 | ||
| f769c34466 | |||
|
|
c0242a0729 | ||
|
|
df452ce258 | ||
| 7de290ae55 | |||
| fe161c5bea | |||
|
|
fca7c7364a | ||
|
|
ef705d1be0 | ||
|
|
3154733be1 | ||
| b285e85eb5 | |||
| 89b7f0d465 | |||
|
|
256d4e9bca | ||
|
|
54f4e83627 | ||
|
|
f7a770989b | ||
|
|
c5759ea30e | ||
|
|
aef9c84eb5 | ||
| d0baac83a9 | |||
| b6a2671665 | |||
| a96ae1252c | |||
| ac4db0f789 | |||
| 37f9ab78ec | |||
|
|
9b3ac150bd | ||
|
|
dd577d51b9 | ||
| 92f9714229 | |||
|
|
632a1c11c2 | ||
|
|
63d41352bc | ||
|
|
da8eef3711 | ||
|
|
f0a4732206 | ||
|
|
1f053edefc | ||
|
|
f93db1d23c | ||
|
|
105611bbfb | ||
|
|
4977c6de30 | ||
|
|
eb956bca3d | ||
|
|
5e511367c3 | ||
|
|
484bfe393e | ||
| a1404584d6 | |||
| 3ef1698c2c | |||
| a7fb704627 | |||
| 91ba6001cb | |||
| 345a79d8ff | |||
| 15d886e5e9 | |||
| d6224d1e60 | |||
| 83fb647ac3 | |||
| b410544ee1 | |||
| 2d5d1befae | |||
| fd8b8c8f42 | |||
| 8ffb8c8caf | |||
| b8b339b85c | |||
| 0789a38ea9 | |||
| 995d3c3f6d | |||
|
|
822b179ef4 | ||
| 4691971bd0 | |||
| 9226e8b490 | |||
| b7fc7734b6 | |||
| 8749e3a8cb | |||
| 61f9f2868a | |||
| 97dfcbeb51 | |||
| 238fabbcb2 | |||
| 49542b4bff | |||
| 46898112f5 | |||
| f9bdb22c67 | |||
| cb664b2115 | |||
|
|
761b9e031e | ||
|
|
0d8d11fe26 | ||
|
|
2d5fbd3337 | ||
| cd3c98280e | |||
| 39c6c37dee | |||
| 3438f74e60 | |||
| 4f79712570 | |||
| 8e85ce0678 | |||
| ff09e7bf1b | |||
| 46e1c6706c | |||
| d8a59d0726 | |||
| 108d2019cd | |||
| 3682ef2420 | |||
| a066db6624 | |||
| 7458d64c05 | |||
| 2a1787f28f | |||
| de78c229ce | |||
|
|
f386c67acf | ||
|
|
75f98bf349 | ||
|
|
9870fcbc5d | ||
|
|
d2b8379505 | ||
|
|
2dcb97255c | ||
|
|
f7dd227cd0 | ||
| e2c18c3a24 | |||
| 1bc6c6eab8 | |||
|
|
4b39b137de | ||
| e5de293919 | |||
| 8a10374570 | |||
| ad37a041ab | |||
| 44daea4447 | |||
| 6989a4da13 | |||
| de4583691c | |||
| d8c9b07a51 | |||
| 54d31f40b2 | |||
| ec73b5ff34 | |||
| 9fcdcc3aff | |||
| 05ab2b68f4 | |||
| 79330ef8f5 | |||
| 45ed369a78 | |||
| 37c17fc7da | |||
| 23640d2647 | |||
| be54ec8302 | |||
| 638f81a781 | |||
| e00306b6f8 | |||
| 3fec1c38a1 | |||
| edc9e3c150 | |||
| a155122898 | |||
| f0552f38a0 | |||
|
|
f99419371a | ||
|
|
86d47c218b | ||
|
|
bd5cafbad7 | ||
|
|
b71362eb9a | ||
|
|
673d982360 | ||
|
|
712b46864a | ||
|
|
186c3aae59 | ||
|
|
0794fe948b | ||
|
|
ba2d6e4310 | ||
|
|
b9e5d14b48 | ||
|
|
bf26b0af1d | ||
|
|
8e82b2865b | ||
|
|
367340d69d | ||
|
|
0b77c73809 | ||
|
|
51b432d911 | ||
|
|
f7a679b2a3 | ||
|
|
15c9d60760 | ||
|
|
c69b53fd4e | ||
|
|
9cdab1f392 | ||
|
|
34656cf1f9 | ||
|
|
cf98822749 | ||
|
|
2335d14623 | ||
| 4a72698402 | |||
| fcb857f756 | |||
|
|
ba07f85fd8 | ||
|
|
7b621243d0 | ||
| 598b312140 | |||
| 0df10f5cb3 | |||
| 2c748a9fc8 | |||
| a2e1b4fb27 | |||
| 9b0da9f245 | |||
| 5b9426ba11 | |||
| 8b6ad4d076 | |||
|
|
7d4565e56f | ||
|
|
92cceeb64b | ||
|
|
3d90e39781 | ||
|
|
efbf00830a | ||
|
|
b9969c69fd | ||
|
|
15d998bf76 | ||
|
|
8c966ae853 | ||
|
|
3e10db326f | ||
|
|
dc6f1bdf52 | ||
|
|
429f3b1fea | ||
|
|
70009f1846 | ||
|
|
5f9024c7bf | ||
|
|
f2138f104f | ||
|
|
04ee73e8dd | ||
|
|
bd83ad37bf | ||
|
|
7b175c8804 | ||
|
|
22cbc806dc | ||
|
|
02e0a073aa | ||
|
|
b2e5a84ff9 | ||
|
|
abd694015b | ||
|
|
57d30eab2d | ||
| b27f0a5017 | |||
|
|
c47002430e | ||
|
|
bd3abade55 | ||
|
|
ea0637423e | ||
|
|
a6756bfe5a | ||
|
|
4cdbc51343 | ||
|
|
2e5210a0b7 | ||
|
|
e8574383ee | ||
|
|
21da15da0a | ||
|
|
dca1d877ac | ||
|
|
007f65c27e | ||
|
|
ef572f402d | ||
|
|
133e7c9809 | ||
| 0d38c1b471 | |||
| cf7bfb7650 | |||
|
|
228abe36a3 | ||
| b48abc474c | |||
|
|
c3fe788a5b | ||
|
|
025e8fba69 | ||
| 672904d914 | |||
| fac783c58d | |||
| 6e7843f368 | |||
| 6a555a5fe3 | |||
| 4796e4fe82 | |||
| 3b1068a3a8 | |||
| 392f764acc | |||
| 122cba9f6b | |||
|
|
dc178f68c7 | ||
|
|
59a0519b4e | ||
|
|
dfcaeec85f | ||
|
|
ef922d162e | ||
|
|
02e4ea180d | ||
|
|
8b9b0678b8 | ||
|
|
475e812ba3 | ||
|
|
0a953f2c09 | ||
|
|
1e26162e00 | ||
|
|
dd68bf950c | ||
|
|
e374520654 | ||
|
|
47c95f76e9 | ||
|
|
918cfd83ec | ||
|
|
83387c47ec | ||
|
|
f6c22c733b | ||
|
|
269d0474c5 | ||
|
|
28359984ff | ||
|
|
c09e424890 | ||
| a55af220bf | |||
| 9c09af83a2 | |||
| e69d67d238 | |||
| 01c6ea66ac | |||
| f9ea731a6e | |||
|
|
a974091442 | ||
|
|
413b805823 | ||
|
|
46069ba924 | ||
|
|
f3e7b979a5 | ||
|
|
f6733a67af | ||
|
|
4988b241ef | ||
|
|
7807a8e736 | ||
| 5ba11aab46 | |||
|
|
4abb46b4bf | ||
|
|
a7976c45f9 | ||
|
|
5194fabe62 | ||
|
|
ff430c2e4d | ||
| 1581628ea3 | |||
| 237f9bd742 | |||
|
|
cf27e7880e | ||
|
|
ad300c068f | ||
|
|
1a02dcaf0f | ||
|
|
9ecc2444aa | ||
|
|
0e1836c5d0 | ||
|
|
7965883744 | ||
|
|
b006bb1e41 | ||
|
|
27c9018c48 | ||
|
|
f1991d89b3 | ||
| 9448ae85cf | |||
|
|
a64e964d83 | ||
|
|
5e321b6b0f | ||
| b1453e3580 | |||
| 3da895083b | |||
| ac583741a4 | |||
| 4358ba6471 | |||
| 46afb63f31 | |||
| f773ce168e | |||
| aa79df1fcd | |||
| 420c9cb9e5 | |||
| 83d935930f | |||
| 2e2c94e897 | |||
| a96903da0e | |||
| 3dbcf00e9f | |||
| 708147435e | |||
| 26289bb00f | |||
| 1489b9f44f | |||
| e4045ef179 | |||
| 13f482fa12 | |||
| 3e2013576f | |||
| e5aa8bca09 | |||
| 4dd3908ff7 | |||
| 09f388e2ff | |||
| baecb9bbe4 | |||
| 2c5986295e | |||
| 126f23dfa2 | |||
|
|
407f3f85bc | ||
|
|
94da4fff5e | ||
|
|
0fa54f1354 | ||
|
|
80677f7177 | ||
|
|
01cac0f741 | ||
|
|
30546a34f9 | ||
|
|
0ccf317564 | ||
|
|
0c49e83a68 | ||
| 51db8257f5 | |||
| ecc2977581 | |||
| ffafef0c88 | |||
| ca3bac1d76 | |||
| 43f7bc7943 | |||
| b3555aa54e | |||
|
|
54dc3d3f1f | ||
|
|
afad769066 | ||
|
|
2da37ee4a5 | ||
|
|
90c81a1234 | ||
|
|
34ea12ca23 | ||
|
|
d2c1be5396 | ||
|
|
fe934bba36 | ||
|
|
b01e40da40 | ||
|
|
ae7e7ecb84 | ||
|
|
fdf540cbd0 | ||
|
|
7cb26e5569 | ||
|
|
913b0cb790 | ||
|
|
485b47d145 | ||
| fb9c9b8070 | |||
|
|
5b69f935a5 | ||
|
|
9dbc36d634 | ||
|
|
42b0c4d48f | ||
|
|
5343d9bff6 | ||
|
|
eb47c8490d | ||
|
|
1de9be2a8a | ||
|
|
d852ecc5b1 | ||
|
|
368edcd93a | ||
|
|
71906fd891 | ||
|
|
dbd187a017 | ||
|
|
52a3546325 | ||
|
|
a23eb0ff0b | ||
|
|
b40c366335 | ||
|
|
d2ad18e8ec | ||
|
|
9b737c9280 | ||
| 834c413cfc | |||
| da9965bdc6 | |||
| 6bbaa0d1f7 | |||
| 834f612bfe | |||
|
|
171e54a68c | ||
|
|
a690f98cc1 | ||
|
|
400ea6e80e | ||
|
|
84c19ca9a4 | ||
|
|
3b7ec028f9 | ||
| 83f7bf41e3 | |||
| 634b8c5bad | |||
| 4aabc8d1b0 | |||
| 75255d8cd0 | |||
|
|
a0b53126ca | ||
|
|
38cd933d41 | ||
|
|
2da014c407 | ||
|
|
9d1752f4ed | ||
|
|
d06a806184 | ||
|
|
fe1becabaf | ||
| 2d0d196cd3 | |||
| 37573b0b59 | |||
| 35dace9155 | |||
| 69e7c1cce9 | |||
| d21e71e615 | |||
|
|
972bb9f755 | ||
|
|
a798b2347f | ||
|
|
17979b4fde | ||
|
|
68d25d3622 | ||
|
|
f38d4249ef | ||
| ded4a0b102 | |||
| 6184441706 | |||
| 293dc3f1ac | |||
| 6492e42358 | |||
| 4aaf1bd6db | |||
| a56a251d7f | |||
| f306ff728f | |||
| a10a6d6507 | |||
|
|
59efa18bce | ||
|
|
4ed80481aa | ||
| fff14183a4 | |||
|
|
1f58676278 | ||
|
|
b67db23e07 | ||
|
|
4fe1e70881 | ||
|
|
988602f90f | ||
| 6a2e143b98 | |||
|
|
306de32de8 | ||
|
|
c0b57e2a01 | ||
|
|
aeeacc877b | ||
| 6820a7e9c8 | |||
| 1c7621f20a | |||
| 5263798b11 | |||
|
|
0d96c5fc65 | ||
|
|
6b0cf48292 | ||
|
|
9160e95e4a | ||
|
|
296cb9adf5 | ||
|
|
88fe8f503f | ||
|
|
a26bb56b15 | ||
|
|
2f54f05cfd | ||
|
|
f61d6808e8 | ||
|
|
4719876feb | ||
|
|
975cca77b1 | ||
|
|
eb80294b0a | ||
|
|
0704c9421d | ||
|
|
f08af0e2c5 | ||
| 29c2fccbe5 | |||
| 975c07fc2e | |||
|
|
814b61f25e | ||
|
|
1c264815c3 | ||
|
|
33150846cc | ||
| ff45beac09 | |||
| 24eb709293 | |||
| 49e2146152 | |||
| cdaf64b3cf | |||
| 49af31776e | |||
| 0880823576 | |||
| 1fa1ecb8ec | |||
| d6108c9836 | |||
|
|
2e7efdf229 | ||
|
|
f47703f599 | ||
|
|
383fc9fade | ||
|
|
cc344fa60e | ||
|
|
4691046d5f | ||
|
|
7b453962ca | ||
|
|
528d594056 | ||
|
|
6305cf159e | ||
|
|
5e468359a1 | ||
|
|
2317dd2d4c | ||
|
|
b92647c52e | ||
|
|
906f13b562 | ||
|
|
84142b60a7 | ||
|
|
54024ee222 | ||
|
|
66f29fcb02 | ||
|
|
73c3c3bdb5 | ||
|
|
fa677c01b2 | ||
| 60d6474a42 | |||
| 8c52326550 | |||
| 52aba347a8 | |||
|
|
acd1a4a61d | ||
|
|
ee1ac54dde | ||
|
|
2599fa6859 | ||
|
|
61a0fd2aa6 | ||
|
|
d604d739e3 | ||
|
|
a57f53fdb4 | ||
|
|
f276cdf697 | ||
|
|
7fb46a4c0b | ||
|
|
fc993a95d7 | ||
| c6ff7e7ba5 | |||
| 3f9a3fb1cd | |||
| 7ae4f7dbd0 | |||
| dbb44ec30a | |||
| 7f4fc42a7a | |||
| 01db4540b1 | |||
| 5c0c096a79 | |||
| c1719a057a | |||
| e969eacd06 | |||
| 8ed3439cdc | |||
|
|
5241dfddd4 | ||
|
|
6e0572b48a | ||
|
|
9a4a39b19a | ||
|
|
8abf113715 | ||
|
|
0fb8901ab5 | ||
|
|
6753b87873 | ||
|
|
715f481364 | ||
|
|
776942cd8b | ||
|
|
f0c23eb4ae | ||
| 25c997fec5 | |||
|
|
1546bf7f87 | ||
|
|
02d4adcff0 | ||
|
|
147c889b53 | ||
|
|
f6e7644284 | ||
|
|
582da6d7f0 | ||
|
|
3a337b7b0a | ||
|
|
2953dd0172 | ||
|
|
08f0620305 | ||
|
|
ec22a8e0ec | ||
|
|
6644d3b11c | ||
|
|
13471d4ca5 | ||
|
|
80254739b0 | ||
|
|
be4d2547e4 | ||
|
|
a7f8893399 | ||
|
|
d0b52f40b7 | ||
| 30cb80efcd | |||
| 3117d288b1 | |||
|
|
6ecd190de8 | ||
|
|
dacd6d5afb | ||
| 299f6dea06 | |||
| ed025f9acb | |||
|
|
de0e66a94a | ||
|
|
e86504ecd5 | ||
|
|
1b192328b2 | ||
|
|
77a77ff87e | ||
|
|
439dff4a64 | ||
|
|
f8cb6f25f7 | ||
| 5a8daa3feb | |||
|
|
c408934efd | ||
| abe81190e6 | |||
| c4ea066927 | |||
| e997946c56 | |||
| 5f9c6ff2bb | |||
|
|
dd4bb73a78 | ||
| 8965f7ae89 | |||
|
|
c157c86600 | ||
| 9a931b65e2 | |||
| 2c149507f6 | |||
|
|
34dea39c52 | ||
|
|
f1a4547961 | ||
|
|
8ae56a8df6 | ||
| cb0110ed20 | |||
| 2bbf814003 | |||
|
86e3fdb910
|
|||
| b731c4c388 | |||
| e929ce029d | |||
| 5160096a1a | |||
| f219a4041a | |||
| 674eae1c11 | |||
| f62369bd01 | |||
| 7a6660ebd8 | |||
| e20d1bdcc5 | |||
| 3e309b6379 | |||
| ae4e92e090 | |||
| 7b69719f0e | |||
| 1d631fec21 | |||
|
|
1005576814 | ||
| 690b1b68c3 | |||
| 6e619622d2 | |||
| eb38bc5e60 | |||
| b0da6d1bd2 | |||
| 1377953dcf | |||
|
|
963b31b087 | ||
|
|
2aafab50ad | ||
| aa85172700 | |||
| eff269e911 | |||
| 65ec6ee1a3 | |||
| a86b23b2e9 | |||
| bcccd5f247 | |||
| cb8c550ed1 | |||
| 5fc7019dcc | |||
| 8c9248fd94 | |||
| d1a5f1c268 | |||
| 96bc5c9e5d | |||
| 20927485d9 | |||
| a034708f21 | |||
| 19a2577564 | |||
| e34d804dda | |||
| cd6c899661 | |||
| 4b2f83ceaf | |||
| 69b0944fdd | |||
| e99f484249 | |||
| ebdd7060b0 | |||
| 6f78151f7e | |||
| 133a8c7441 | |||
| 393dc98c73 | |||
| 105d4dd054 | |||
| 4a738b966e | |||
| 4fd3095a75 | |||
| 737457dbad | |||
| fb05951c5b | |||
| 094c915a20 | |||
| c6e83252cf | |||
| 0a757e8634 | |||
| 21a7d7506a | |||
| 6bae1a98ea | |||
| 3d76bc9c04 | |||
| 4495df4d2e | |||
| 99d3e6c00c | |||
| 8a005a2fd2 | |||
| f37999c10c | |||
| 5842fb9f26 | |||
| df5aa1f1a3 | |||
| f079122be5 | |||
| a3daefa7ce | |||
| e5a3c2cae1 | |||
| 313e241a72 | |||
| a66ef2e8b3 | |||
|
4a2753d32c
|
|||
| f4f5eb06a4 | |||
| c93fe755fd | |||
| 6bdc4a5b8f | |||
| 048c72b294 | |||
| 5ad2062e5c | |||
|
babbb610d9
|
|||
| 5bbb99c3f9 | |||
| 6eec7dbda2 | |||
| be9f37a459 | |||
| 757358fded | |||
| 430586cc89 | |||
| 69b405ba65 | |||
| c2eef5a6ab | |||
|
b89a9e87c8
|
|||
| 01991027cc | |||
| 9b81061e22 | |||
|
1c0535a8b4
|
|||
|
|
2d30e6f9cf | ||
|
62f64862be
|
|||
| ee205c4b07 | |||
|
|
10c15f6f8e | ||
|
|
af2f33d4f6 | ||
|
a0c253fa05
|
|||
| 9aee672450 | |||
| 2d17938c75 | |||
| 67562cacc2 | |||
| c8d715126f | |||
| 1d6af5204b | |||
| a5398094da | |||
|
17a67870ef
|
|||
| 0fd5062408 | |||
|
54cfd4c353
|
|||
| 717eb1e7d8 | |||
|
|
c886f85d21 | ||
|
749fa94312
|
|||
|
c27fcc6983
|
|||
|
|
7bd997e368 | ||
|
|
d803a49a85 | ||
| cfa9f877b3 | |||
| e4f883d35a | |||
| 0ad1d27327 | |||
| 3bf2473c3a | |||
|
|
1db2c3ee54 | ||
|
|
7e8a4c5c45 | ||
|
|
f6fe3d4fda | ||
|
|
eeb2602bcf | ||
|
|
565eec0292 | ||
|
|
a98fad32d3 | ||
|
|
10f0c0bd31 | ||
| 84c2b43595 | |||
| 1135b8cee5 | |||
| 8322280066 | |||
| 99ecf1b0d8 | |||
| bb69ee0be9 | |||
| fb0754b3b2 | |||
| d6a13f81e0 | |||
| 6e1f23b702 | |||
| 74ab68d05f | |||
| 27cb6cb0c6 | |||
| 5670efc4cb | |||
| 5a8ad0a47b | |||
|
45098785e9
|
|||
|
|
01552145a8 | ||
|
|
09ed341b97 | ||
|
|
5cb30e6783 | ||
| 6a8bd5c205 | |||
|
|
2e5f618d0b | ||
| 112f5eecb2 | |||
| 8cf611ca51 | |||
| 0f095a691d | |||
| 8b0f692673 | |||
| 03f5885980 | |||
| 04d891a0b8 | |||
|
f8d675dcaf
|
|||
|
9f6e49963e
|
|||
| 0ae8e227fc | |||
| 623f1a289e | |||
|
|
85ac9e5104 | ||
|
|
266205363d | ||
|
|
b9ad95a99d | ||
| ca8799af39 | |||
| 1cd176a626 | |||
|
|
22918434c3 | ||
|
|
23410e6109 | ||
|
|
77809423fd | ||
|
|
ee8fbbca09 | ||
|
|
b9b21ac44b | ||
|
34b1aad175
|
|||
| d4d3713cad | |||
|
01fff39e41
|
|||
| 12968cb580 | |||
| 888aac4867 | |||
| 6637756088 | |||
|
|
70856f7348 | ||
|
|
ac19671469 | ||
| f2b9b73528 | |||
| d1c907fc3a | |||
| df0c4ca857 | |||
|
|
02128e69ba | ||
|
|
885c4d9b32 | ||
|
|
12db34ddb0 | ||
|
|
c7d7e8b954 | ||
|
|
a95ce8abb2 | ||
|
|
cab7a47050 | ||
|
|
dce0b71530 | ||
|
|
915951d84f | ||
|
|
b3509611a2 | ||
|
|
e82e367e95 | ||
|
|
6f9d570a93 | ||
|
|
7486d561ec | ||
|
|
50116651de | ||
|
|
3fe350abe9 | ||
|
|
9e51604286 | ||
|
|
309496ef5d | ||
|
|
d403f84b6c | ||
|
|
dfeeb8cd4c | ||
|
|
135866e5b0 | ||
|
|
eef88b5375 | ||
|
|
8b9717bb74 | ||
|
4422d67701
|
|||
|
|
d54a1e5a34 | ||
|
|
0d2307acc8 | ||
|
|
de45ed3a07 | ||
| 480894372c | |||
|
|
9a7a66192b | ||
|
|
df950143b4 | ||
|
|
038c563843 | ||
|
|
4733e05c58 | ||
|
|
c9496f0973 | ||
|
|
31dffa14ce | ||
|
|
7459501c8f | ||
|
|
bc9fd08f7e | ||
|
|
be1cee5d6a | ||
|
|
c91f9ba43c | ||
|
|
357000ef13 | ||
|
|
6ba89a8b9c | ||
|
|
d5af1d19b8 | ||
|
|
ce1ce722d5 | ||
|
|
fa192e10b8 | ||
|
|
7ae3296ef5 | ||
|
|
a6ba22b0b1 | ||
|
|
d49e94e412 | ||
|
|
ff8ee3693c | ||
|
|
d43d4d8a9f | ||
|
|
6f814b5d09 | ||
|
|
5d3df608e1 | ||
|
|
86af42bf4a | ||
|
|
5869998f6e | ||
|
|
cbdc0fd313 | ||
|
|
bada9508ef | ||
|
|
7bc4da97ab |
19
.github/workflows/documentation.yml
vendored
19
.github/workflows/documentation.yml
vendored
@@ -2,9 +2,9 @@ name: Deploy Documentation to Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: ["main"]
|
||||
branches: ["development"]
|
||||
workflow_dispatch:
|
||||
branches: ["main"]
|
||||
branches: ["development"]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
@@ -17,34 +17,31 @@ concurrency:
|
||||
|
||||
jobs:
|
||||
deploy-documentation:
|
||||
#if: startsWith(github.ref, 'refs/tags/')
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Install Vlang dependencies
|
||||
run: sudo apt update && sudo apt install -y libgc-dev
|
||||
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v3
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Vlang
|
||||
run: ./install_v.sh
|
||||
|
||||
- name: Generate documentation
|
||||
run: |
|
||||
./doc.vsh
|
||||
# ls /home/runner/work/herolib/docs
|
||||
./doc.vsh
|
||||
find .
|
||||
|
||||
- name: Setup Pages
|
||||
uses: actions/configure-pages@v3
|
||||
uses: actions/configure-pages@v4
|
||||
|
||||
- name: Upload artifact
|
||||
uses: actions/upload-pages-artifact@v1
|
||||
uses: actions/upload-pages-artifact@v3
|
||||
with:
|
||||
path: "/home/runner/work/herolib/herolib/docs"
|
||||
|
||||
- name: Deploy to GitHub Pages
|
||||
id: deployment
|
||||
uses: actions/deploy-pages@v1
|
||||
uses: actions/deploy-pages@v4
|
||||
|
||||
142
.github/workflows/hero_build.yml
vendored
Normal file
142
.github/workflows/hero_build.yml
vendored
Normal file
@@ -0,0 +1,142 @@
|
||||
name: Release Hero
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- "*"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
timeout-minutes: 60
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- target: x86_64-linux
|
||||
os: ubuntu-latest
|
||||
- target: aarch64-linux
|
||||
os: ubuntu-24.04-arm
|
||||
- target: aarch64-apple-darwin
|
||||
os: macos-latest
|
||||
# - target: x86_64-apple-darwin
|
||||
# os: macos-13
|
||||
runs-on: ${{ matrix.os }}
|
||||
container: ${{ matrix.container }}
|
||||
|
||||
steps:
|
||||
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||
- run: echo "🔎 The name of your branch is ${{ github.ref_name }} and your repository is ${{ github.repository }}."
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# We do the workaround as described here https://github.com/Incubaid/herolib?tab=readme-ov-file#tcc-compiler-error-on-macos
|
||||
# gcc and clang also don't work on macOS due to https://github.com/vlang/v/issues/25467
|
||||
# We can change the compiler or remove this when one is fixed
|
||||
- name: Setup V & Herolib
|
||||
id: setup
|
||||
shell: bash
|
||||
run: |
|
||||
git clone https://github.com/vlang/v
|
||||
cd v
|
||||
make
|
||||
./v symlink
|
||||
if [ "${{ runner.os }}" = "macOS" ]; then
|
||||
sudo sed -i '' '618,631d' /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/math.h
|
||||
fi
|
||||
cd -
|
||||
|
||||
mkdir -p ~/.vmodules/incubaid
|
||||
ln -s $(pwd)/lib ~/.vmodules/incubaid/herolib
|
||||
echo "Herolib symlink created to $(pwd)/lib"
|
||||
timeout-minutes: 10
|
||||
|
||||
# We can't make static builds for Linux easily, since we link to libql
|
||||
# (Postgres) and this has no static version available in the Alpine
|
||||
# repos. Therefore we build dynamic binaries for both glibc and musl.
|
||||
#
|
||||
# Again we work around a bug limiting our choice of C compiler tcc won't
|
||||
# work on Alpine due to https://github.com/vlang/v/issues/24866
|
||||
# So always use gcc for Linux
|
||||
#
|
||||
# For macOS, we can only use tcc (see above), but then we hit issues using
|
||||
# the garbage collector, so disable that
|
||||
- name: Build Hero
|
||||
timeout-minutes: 15
|
||||
run: |
|
||||
set -e
|
||||
if [ "${{ runner.os }}" = "Linux" ]; then
|
||||
sudo apt-get install libpq-dev
|
||||
# Build for glibc
|
||||
v -w -d use_openssl -enable-globals -cc gcc cli/hero.v -o cli/hero-${{ matrix.target }}
|
||||
|
||||
# Build for musl using Alpine in Docker
|
||||
docker run --rm \
|
||||
-v ${{ github.workspace }}/lib:/root/.vmodules/incubaid/herolib \
|
||||
-v ${{ github.workspace }}:/herolib \
|
||||
-w /herolib \
|
||||
alpine \
|
||||
sh -c '
|
||||
apk add --no-cache bash git build-base openssl-dev libpq-dev
|
||||
cd v
|
||||
make clean
|
||||
make
|
||||
./v symlink
|
||||
cd ..
|
||||
v -w -d use_openssl -enable-globals -cc gcc cli/hero.v -o cli/hero-${{ matrix.target }}-musl
|
||||
'
|
||||
|
||||
else
|
||||
v -w -d use_openssl -enable-globals -gc none -cc tcc cli/hero.v -o cli/hero-${{ matrix.target }}
|
||||
fi
|
||||
|
||||
- name: Upload glibc binary
|
||||
if: runner.os == 'Linux'
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: hero-${{ matrix.target }}
|
||||
path: cli/hero-${{ matrix.target }}
|
||||
|
||||
- name: Upload musl binary
|
||||
if: runner.os == 'Linux'
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: hero-${{ matrix.target }}-musl
|
||||
path: cli/hero-${{ matrix.target }}-musl
|
||||
|
||||
- name: Upload
|
||||
if: runner.os != 'Linux'
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: hero-${{ matrix.target }}
|
||||
path: cli/hero-${{ matrix.target }}
|
||||
|
||||
release_hero:
|
||||
needs: build
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Download Artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: cli/bins
|
||||
merge-multiple: true
|
||||
|
||||
- name: Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
tag_name: ${{ github.ref_name }}
|
||||
name: Release ${{ github.ref_name }}
|
||||
draft: false
|
||||
fail_on_unmatched_files: true
|
||||
generate_release_notes: true
|
||||
files: cli/bins/*
|
||||
93
.github/workflows/hero_build_linux.yml
vendored
93
.github/workflows/hero_build_linux.yml
vendored
@@ -1,93 +0,0 @@
|
||||
name: Build Hero on Linux & Run tests
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
on:
|
||||
push:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
- target: x86_64-unknown-linux-musl
|
||||
os: ubuntu-latest
|
||||
short-name: linux-i64
|
||||
# - target: aarch64-unknown-linux-musl
|
||||
# os: ubuntu-latest
|
||||
# short-name: linux-arm64
|
||||
# - target: aarch64-apple-darwin
|
||||
# os: macos-latest
|
||||
# short-name: macos-arm64
|
||||
# - target: x86_64-apple-darwin
|
||||
# os: macos-13
|
||||
# short-name: macos-i64
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||
- run: echo "🔎 The name of your branch is ${{ github.ref_name }} and your repository is ${{ github.repository }}."
|
||||
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Vlang
|
||||
run: |
|
||||
git clone --depth=1 https://github.com/vlang/v
|
||||
cd v
|
||||
make
|
||||
sudo ./v symlink
|
||||
cd ..
|
||||
|
||||
- name: Setup Herolib
|
||||
run: |
|
||||
mkdir -p ~/.vmodules/freeflowuniverse
|
||||
ln -s $GITHUB_WORKSPACE/lib ~/.vmodules/freeflowuniverse/herolib
|
||||
|
||||
echo "Installing secp256k1..."
|
||||
# Install build dependencies
|
||||
sudo apt-get install -y build-essential wget autoconf libtool
|
||||
|
||||
# Download and extract secp256k1
|
||||
cd /tmp
|
||||
wget https://github.com/bitcoin-core/secp256k1/archive/refs/tags/v0.3.2.tar.gz
|
||||
tar -xvf v0.3.2.tar.gz
|
||||
|
||||
# Build and install
|
||||
cd secp256k1-0.3.2/
|
||||
./autogen.sh
|
||||
./configure
|
||||
make -j 5
|
||||
sudo make install
|
||||
|
||||
# Cleanup
|
||||
rm -rf secp256k1-0.3.2 v0.3.2.tar.gz
|
||||
|
||||
echo "secp256k1 installation complete!"
|
||||
|
||||
- name: Install and Start Redis
|
||||
run: |
|
||||
# Import Redis GPG key
|
||||
curl -fsSL https://packages.redis.io/gpg | sudo gpg --dearmor -o /usr/share/keyrings/redis-archive-keyring.gpg
|
||||
# Add Redis repository
|
||||
echo "deb [signed-by=/usr/share/keyrings/redis-archive-keyring.gpg] https://packages.redis.io/deb $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/redis.list
|
||||
# Install Redis
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y redis
|
||||
|
||||
# Start Redis
|
||||
redis-server --daemonize yes
|
||||
|
||||
# Print versions
|
||||
redis-cli --version
|
||||
redis-server --version
|
||||
|
||||
- name: Build Hero
|
||||
run: |
|
||||
v -cg -enable-globals -w -n cli/hero.v
|
||||
|
||||
- name: Do all the basic tests
|
||||
run: |
|
||||
./test_basic.vsh
|
||||
66
.github/workflows/hero_build_macos.yml
vendored
66
.github/workflows/hero_build_macos.yml
vendored
@@ -1,66 +0,0 @@
|
||||
name: Build Hero on Macos & Run tests
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
on:
|
||||
push:
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
- target: aarch64-apple-darwin
|
||||
os: macos-latest
|
||||
short-name: macos-arm64
|
||||
- target: x86_64-apple-darwin
|
||||
os: macos-13
|
||||
short-name: macos-i64
|
||||
runs-on: ${{ matrix.os }}
|
||||
steps:
|
||||
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||
- run: echo "🔎 The name of your branch is ${{ github.ref_name }} and your repository is ${{ github.repository }}."
|
||||
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v3
|
||||
|
||||
- name: Setup Vlang
|
||||
run: |
|
||||
git clone --depth=1 https://github.com/vlang/v
|
||||
cd v
|
||||
make
|
||||
sudo ./v symlink
|
||||
cd ..
|
||||
|
||||
- name: Setup Herolib
|
||||
run: |
|
||||
mkdir -p ~/.vmodules/freeflowuniverse
|
||||
ln -s $GITHUB_WORKSPACE/lib ~/.vmodules/freeflowuniverse/herolib
|
||||
|
||||
echo "Installing secp256k1..."
|
||||
brew install secp256k1
|
||||
|
||||
echo "secp256k1 installation complete!"
|
||||
|
||||
- name: Install and Start Redis
|
||||
run: |
|
||||
brew update
|
||||
brew install redis
|
||||
|
||||
# Start Redis
|
||||
redis-server --daemonize yes
|
||||
|
||||
# Print versions
|
||||
redis-cli --version
|
||||
redis-server --version
|
||||
|
||||
- name: Build Hero
|
||||
run: |
|
||||
v -w -cg -gc none -no-retry-compilation -d use_openssl -enable-globals cli/hero.v
|
||||
|
||||
- name: Do all the basic tests
|
||||
run: |
|
||||
./test_basic.vsh
|
||||
132
.github/workflows/release.yml
vendored
132
.github/workflows/release.yml
vendored
@@ -1,132 +0,0 @@
|
||||
name: Release
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- v*
|
||||
|
||||
jobs:
|
||||
upload:
|
||||
strategy:
|
||||
matrix:
|
||||
include:
|
||||
- target: aarch64-apple-darwin
|
||||
os: macos-latest
|
||||
short-name: macos-arm64
|
||||
- target: x86_64-apple-darwin
|
||||
os: macos-13
|
||||
short-name: macos-i64
|
||||
- target: x86_64-unknown-linux-musl
|
||||
os: ubuntu-latest
|
||||
short-name: linux-i64
|
||||
|
||||
runs-on: ${{ matrix.os }}
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Vlang
|
||||
run: |
|
||||
git clone --depth=1 https://github.com/vlang/v
|
||||
cd v
|
||||
make
|
||||
sudo ./v symlink
|
||||
cd ..
|
||||
|
||||
- name: Setup Herolib
|
||||
run: |
|
||||
mkdir -p ~/.vmodules/freeflowuniverse
|
||||
ln -s $GITHUB_WORKSPACE/lib ~/.vmodules/freeflowuniverse/herolib
|
||||
|
||||
echo "Installing secp256k1..."
|
||||
if [[ ${{ matrix.os }} == 'macos-latest' || ${{ matrix.os }} == 'macos-13' ]]; then
|
||||
brew install secp256k1
|
||||
|
||||
elif [[ ${{ matrix.os }} == 'ubuntu-latest' ]]; then
|
||||
# Install build dependencies
|
||||
sudo apt-get install -y build-essential wget autoconf libtool
|
||||
|
||||
# Download and extract secp256k1
|
||||
cd /tmp
|
||||
wget https://github.com/bitcoin-core/secp256k1/archive/refs/tags/v0.3.2.tar.gz
|
||||
tar -xvf v0.3.2.tar.gz
|
||||
|
||||
# Build and install
|
||||
cd secp256k1-0.3.2/
|
||||
./autogen.sh
|
||||
./configure
|
||||
make -j 5
|
||||
sudo make install
|
||||
|
||||
else
|
||||
echo "Unsupported OS: ${{ matrix.os }}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "secp256k1 installation complete!"
|
||||
|
||||
- name: Build Hero
|
||||
run: |
|
||||
v -w -cg -gc none -no-retry-compilation -d use_openssl -enable-globals cli/hero.v -o cli/hero-${{ matrix.target }}
|
||||
|
||||
- name: Upload
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: hero-${{ matrix.target }}
|
||||
path: cli/hero-${{ matrix.target }}
|
||||
|
||||
release_hero:
|
||||
needs: upload
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
steps:
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
# TODO: this adds commits that don't belong to this branhc, check another action
|
||||
# - name: Generate changelog
|
||||
# id: changelog
|
||||
# uses: heinrichreimer/github-changelog-generator-action@v2.3
|
||||
# with:
|
||||
# token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# headerLabel: "# 📑 Changelog"
|
||||
# breakingLabel: "### 💥 Breaking"
|
||||
# enhancementLabel: "### 🚀 Enhancements"
|
||||
# bugsLabel: "### 🐛 Bug fixes"
|
||||
# securityLabel: "### 🛡️ Security"
|
||||
# issuesLabel: "### 📁 Other issues"
|
||||
# prLabel: "### 📁 Other pull requests"
|
||||
# addSections: '{"documentation":{"prefix":"### 📖 Documentation","labels":["documentation"]},"tests":{"prefix":"### ✅ Testing","labels":["tests"]}}'
|
||||
# onlyLastTag: true
|
||||
# issues: false
|
||||
# issuesWoLabels: false
|
||||
# pullRequests: true
|
||||
# prWoLabels: true
|
||||
# author: true
|
||||
# unreleased: true
|
||||
# compareLink: true
|
||||
# stripGeneratorNotice: true
|
||||
# verbose: true
|
||||
|
||||
- name: Download Artifacts
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
path: cli/bins
|
||||
merge-multiple: true
|
||||
|
||||
- name: Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
with:
|
||||
tag_name: ${{ github.ref }}
|
||||
name: Release ${{ github.ref_name }}
|
||||
draft: false
|
||||
fail_on_unmatched_files: true
|
||||
# body: ${{ steps.changelog.outputs.changelog }}
|
||||
files: cli/bins/*
|
||||
38
.github/workflows/test.yml
vendored
Normal file
38
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
name: Build on Linux & Run tests
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- "**"
|
||||
workflow_dispatch:
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
|
||||
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
|
||||
- run: echo "🔎 The name of your branch is ${{ github.ref_name }} and your repository is ${{ github.repository }}."
|
||||
|
||||
- name: Check out repository code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup V
|
||||
run: |
|
||||
# Updating man-db takes a long time on every run. We don't need it
|
||||
sudo apt-get remove -y --purge man-db
|
||||
./install_v.sh
|
||||
|
||||
- name: Setup Herolib from current branch
|
||||
run: |
|
||||
# Create necessary directories
|
||||
mkdir -p ~/.vmodules/incubaid
|
||||
# Create symlink to current code
|
||||
ln -s $(pwd)/lib ~/.vmodules/incubaid/herolib
|
||||
echo "Herolib symlink created to $(pwd)/lib"
|
||||
|
||||
- name: Do all the basic tests
|
||||
run: ./test_basic.vsh
|
||||
35
.gitignore
vendored
35
.gitignore
vendored
@@ -1,12 +1,23 @@
|
||||
|
||||
# Additional ignore files and directories
|
||||
Thumbs.db
|
||||
# Logs
|
||||
logs/
|
||||
*.log
|
||||
*.out
|
||||
# Compiled Python files
|
||||
*.pyc
|
||||
*.pyo
|
||||
__pycache__/
|
||||
*dSYM/
|
||||
.vmodules/
|
||||
.vscode
|
||||
.dylib
|
||||
_docs/
|
||||
vls.*
|
||||
vls.log
|
||||
node_modules/
|
||||
docs/
|
||||
vdocs/
|
||||
photonwrapper.so
|
||||
x
|
||||
.env
|
||||
@@ -25,7 +36,25 @@ dump.rdb
|
||||
output/
|
||||
*.db
|
||||
.stellar
|
||||
vdocs/
|
||||
data.ms/
|
||||
test_basic
|
||||
cli/hero
|
||||
cli/hero
|
||||
.aider*
|
||||
storage/
|
||||
.qdrant-initialized
|
||||
.compile_cache
|
||||
compile_results.log
|
||||
tmp
|
||||
compile_summary.log
|
||||
.summary_lock
|
||||
.aider*
|
||||
*.dylib
|
||||
HTTP_REST_MCP_DEMO.md
|
||||
MCP_HTTP_REST_IMPLEMENTATION_PLAN.md
|
||||
.roo
|
||||
.kilocode
|
||||
.continue
|
||||
tmux_logger
|
||||
release
|
||||
install_herolib
|
||||
doc
|
||||
5
.goosehints
Normal file
5
.goosehints
Normal file
@@ -0,0 +1,5 @@
|
||||
|
||||
when fixing or creating code, refer to the following hints:
|
||||
@aiprompts/vlang_herolib_core.md
|
||||
|
||||
|
||||
2
.qwen/QWEN.md
Normal file
2
.qwen/QWEN.md
Normal file
@@ -0,0 +1,2 @@
|
||||
|
||||
@../aiprompts/vlang_herolib_core.md
|
||||
52
.qwen/agents/compiler.md
Normal file
52
.qwen/agents/compiler.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
name: compiler
|
||||
description: Use this agent when you need to verify V code compilation using vrun, locate files, handle compilation errors, and assist with basic code fixes within the same directory.
|
||||
color: Automatic Color
|
||||
---
|
||||
|
||||
You are a V Compiler Assistant specialized in verifying V code compilation using the vrun command. Your responsibilities include:
|
||||
|
||||
1. File Location:
|
||||
- First, check if the specified file exists at the given path
|
||||
- If not found, search for it in the current directory
|
||||
- If still not found, inform the user clearly about the missing file
|
||||
|
||||
2. Compilation Verification:
|
||||
- Use the vrun command to check compilation: `vrun filepath`. DONT USE v run .. or any other, its vrun ...
|
||||
- This will compile the file and report any issues without executing it
|
||||
|
||||
3. Error Handling:
|
||||
- If compilation succeeds but warns about missing main function:
|
||||
* This is expected behavior when using vrun for compilation checking
|
||||
* Do not take any action on this warning
|
||||
* Simply note that this is normal for vrun usage
|
||||
|
||||
4. Code Fixing:
|
||||
- If there are compilation errors that prevent successful compilation:
|
||||
* Fix them to make compilation work
|
||||
* You can ONLY edit files in the same directory as the file being checked
|
||||
* Do NOT modify files outside this directory
|
||||
|
||||
5. Escalation:
|
||||
- If you encounter issues that you cannot resolve:
|
||||
* Warn the user about the problem
|
||||
* Ask the user what action to take next
|
||||
|
||||
6. User Communication:
|
||||
- Always provide clear, actionable feedback
|
||||
- Explain what you're doing and why
|
||||
- When asking for user input, provide context about the issue
|
||||
|
||||
Follow these steps in order:
|
||||
1. Locate the specified file
|
||||
2. Run vrun on the file
|
||||
3. Analyze the output
|
||||
4. Fix compilation errors if possible (within directory constraints)
|
||||
5. Report results to the user
|
||||
6. Escalate complex issues to the user
|
||||
|
||||
Remember:
|
||||
- vrun is used for compilation checking only, not execution
|
||||
- Missing main function warnings are normal and expected
|
||||
- You can only modify files in the directory of the target file
|
||||
- Always ask the user before taking action on complex issues
|
||||
67
.qwen/agents/struct-validator.md
Normal file
67
.qwen/agents/struct-validator.md
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
name: struct-validator
|
||||
description: Use this agent when you need to validate struct definitions in V files for proper serialization (dump/load) of all properties and subproperties, ensure consistency, and generate or fix tests if changes are made. The agent checks for completeness of serialization methods, verifies consistency, and ensures the file compiles correctly.
|
||||
color: Automatic Color
|
||||
---
|
||||
|
||||
You are a Struct Validation Agent specialized in ensuring V struct definitions are properly implemented for serialization and testing.
|
||||
|
||||
## Core Responsibilities
|
||||
|
||||
1. **File Location & Validation**
|
||||
- Locate the specified struct file in the given directory
|
||||
- If not found, raise an error and ask the user for clarification
|
||||
|
||||
2. **Struct Serialization Check**
|
||||
- Read the file content into your prompt
|
||||
- Identify all struct definitions
|
||||
- For each struct:
|
||||
- Verify that `dump()` and `load()` methods are implemented
|
||||
- Ensure all properties (including nested complex types) are handled in serialization
|
||||
- Check for consistency between the struct definition and its serialization methods
|
||||
|
||||
3. **Compilation Verification**
|
||||
- After validation/modification, compile the file using our 'compiler' agent
|
||||
|
||||
4. **Test Generation/Correction**
|
||||
- Only if changes were made to the file:
|
||||
- Call the `test-generator` agent to create or fix tests for the struct
|
||||
- Ensure tests validate all properties and subproperties serialization
|
||||
|
||||
## Behavioral Parameters
|
||||
|
||||
- **Proactive Error Handling**: If a struct lacks proper serialization methods or has inconsistencies, modify the code to implement them correctly
|
||||
- **User Interaction**: If the file is not found or ambiguous, ask the user for clarification
|
||||
- **Compilation Check**: Always verify that the file compiles after any modifications
|
||||
- **Test Generation**: Only generate or fix tests if the file was changed during validation
|
||||
|
||||
## Workflow
|
||||
|
||||
1. **Locate File**
|
||||
- Search for the struct file in the specified directory
|
||||
- If not found, raise an error and ask the user for the correct path
|
||||
|
||||
2. **Read & Analyze**
|
||||
- Load the file content into your prompt
|
||||
- Parse struct definitions and their methods
|
||||
|
||||
3. **Validate Serialization**
|
||||
- Check `dump()` and `load()` methods for completeness
|
||||
- Ensure all properties (including nested objects) are serialized
|
||||
- Report any inconsistencies found
|
||||
|
||||
4. **Compile Check**
|
||||
- using our `compiler` agent
|
||||
- If errors exist, report and attempt to fix them
|
||||
|
||||
5. **Test Generation (Conditional)**
|
||||
- If changes were made:
|
||||
- Call the `test-generator` agent to create or fix tests
|
||||
- Ensure tests cover all serialization aspects
|
||||
|
||||
## Output Format
|
||||
|
||||
- Clearly indicate whether the file was found
|
||||
- List any serialization issues and how they were fixed
|
||||
- Report compilation status
|
||||
- Mention if tests were generated or modified
|
||||
52
.qwen/agents/tester.md
Normal file
52
.qwen/agents/tester.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
name: tester
|
||||
description: Use this agent when you need to execute a V test file ending with _test.v within the current directory. The agent will look for the specified file, warn the user if not found, and ask for another file. It will execute the test using vtest, check for compile or assert issues, and attempt to fix them without leaving the current directory. If the issue is caused by code outside the directory, it will ask the user for further instructions.
|
||||
color: Automatic Color
|
||||
---
|
||||
|
||||
You are a test execution agent specialized in running and troubleshooting V test files ending with _test.v within a confined directory scope.
|
||||
|
||||
## Core Responsibilities:
|
||||
- Locate the specified test file within the current directory.
|
||||
- Execute the test file using the `vtest` command.
|
||||
- Analyze the output for compile errors or assertion failures.
|
||||
- Attempt to fix issues originating within the current directory.
|
||||
- Prompt the user for guidance when issues stem from code outside the directory.
|
||||
|
||||
## Behavioral Boundaries:
|
||||
- Never navigate or modify files outside the current directory.
|
||||
- Always verify the file ends with _test.v before execution.
|
||||
- If the file is not found, warn the user and request an alternative file.
|
||||
- Do not attempt fixes for external dependencies or code.
|
||||
|
||||
## Operational Workflow:
|
||||
1. **File Search**: Look for the specified file in the current directory.
|
||||
- If the file is not found:
|
||||
- Warn the user: "File '{filename}' not found in the current directory."
|
||||
- Ask: "Please provide another file name to test."
|
||||
|
||||
2. **Test Execution**: Run the test using `vtest`.
|
||||
```bash
|
||||
vtest {filename}
|
||||
```
|
||||
|
||||
3. **Output Analysis**:
|
||||
- **Compile Issues**:
|
||||
- Identify the source of the error.
|
||||
- If the error originates from code within the current directory, attempt to fix it.
|
||||
- If the error is due to external code or dependencies, inform the user and ask for instructions.
|
||||
- **Assertion Failures**:
|
||||
- Locate the failing assertion.
|
||||
- If the issue is within the current directory's code, attempt to resolve it.
|
||||
- If the issue involves external code, inform the user and seek guidance.
|
||||
|
||||
4. **Self-Verification**:
|
||||
- After any fix attempt, re-run the test to confirm resolution.
|
||||
- Report the final outcome clearly to the user.
|
||||
|
||||
## Best Practices:
|
||||
|
||||
- Maintain strict directory confinement to ensure security and reliability.
|
||||
- Prioritize user feedback when external dependencies are involved.
|
||||
- Use precise error reporting to aid in troubleshooting.
|
||||
- Ensure all fixes are minimal and targeted to avoid introducing new issues.
|
||||
71
.qwen/agents/testgenerator.md
Normal file
71
.qwen/agents/testgenerator.md
Normal file
@@ -0,0 +1,71 @@
|
||||
---
|
||||
name: testgenerator
|
||||
description: Use this agent when you need to analyze a given source file, generate or update its corresponding test file, and ensure the test file executes correctly by leveraging the testexecutor subagent.
|
||||
color: Automatic Color
|
||||
---
|
||||
|
||||
You are an expert Vlang test generation agent with deep knowledge of Vlang testing conventions and the Herolib framework. Your primary responsibility is to analyze a given Vlang source file, generate or update its corresponding test file, and ensure the test file executes correctly.
|
||||
|
||||
## Core Responsibilities
|
||||
|
||||
1. **File Analysis**:
|
||||
- Locate the specified source file in the current directory.
|
||||
- If the file is not found, prompt the user with a clear error message.
|
||||
- Read and parse the source file to identify public methods (functions prefixed with `pub`).
|
||||
|
||||
2. **Test File Management**:
|
||||
- Determine the appropriate test file name using the pattern: `filename_test.v`, where `filename` is the base name of the source file.
|
||||
- If the test file does not exist, generate a new one.
|
||||
- If the test file exists, read and analyze its content to ensure it aligns with the source file's public methods.
|
||||
- Do not look for test files outside of this dir.
|
||||
|
||||
3. **Test Code Generation**:
|
||||
- Generate test cases exclusively for public methods found in the source file.
|
||||
- Ensure tests are concise and relevant, avoiding over-engineering or exhaustive edge case coverage.
|
||||
- Write the test code to the corresponding test file.
|
||||
|
||||
4. **Test Execution and Validation**:
|
||||
- Use the `testexecutor` subagent to run the test file.
|
||||
- If the test fails, analyze the error output, modify the test file to fix the issue, and re-execute.
|
||||
- Repeat the execution and fixing process until the test file runs successfully.
|
||||
|
||||
## Behavioral Boundaries
|
||||
|
||||
- **Focus Scope**: Only test public methods. Do not test private functions or generate excessive test cases.
|
||||
- **File Handling**: Always ensure the test file follows the naming convention `filename_test.v`.
|
||||
- **Error Handling**: If the source file is not found, clearly inform the user. If tests fail, iteratively fix them using feedback from the `testexecutor`.
|
||||
- **Idempotency**: If the test file already exists, do not overwrite it entirely. Only update or add missing test cases.
|
||||
- **Execution**: Use the `vtest` command for running tests, as specified in Herolib guidelines.
|
||||
|
||||
## Workflow Steps
|
||||
|
||||
1. **Receive Input**: Accept the source file name as an argument.
|
||||
2. **Locate File**: Check if the file exists in the current directory. If not, notify the user.
|
||||
3. **Parse Source**: Read the file and extract all public methods.
|
||||
4. **Check Test File**:
|
||||
- Derive the test file name: `filename_test.v`.
|
||||
- If it does not exist, create it with basic test scaffolding.
|
||||
- If it exists, read its content to understand current test coverage.
|
||||
5. **Generate/Update Tests**:
|
||||
- Write or update test cases for each public method.
|
||||
- Ensure tests are minimal and focused.
|
||||
6. **Execute Tests**:
|
||||
- Use the `testexecutor` agent to run the test file.
|
||||
- If execution fails, analyze the output, fix the test file, and re-execute.
|
||||
- Continue until tests pass or a critical error is encountered.
|
||||
7. **Report Status**: Once tests pass, report success. If issues persist, provide a detailed error summary.
|
||||
|
||||
## Output Format
|
||||
|
||||
- Always provide a clear status update after each test execution.
|
||||
- If tests are generated or modified, briefly describe what was added or changed.
|
||||
- If errors occur, explain the issue and the steps taken to resolve it.
|
||||
- If the source file is not found, provide a user-friendly error message.
|
||||
|
||||
## Example Usage
|
||||
|
||||
- **Context**: User wants to generate tests for `calculator.v`.
|
||||
- **Action**: Check if `calculator.v` exists.
|
||||
- **Action**: Create or update `calculator_test.v` with tests for public methods.
|
||||
- **Action**: Use `testexecutor` to run `calculator_test.v`.
|
||||
- **Action**: If tests fail, fix them iteratively until they pass.
|
||||
6
.zed/keymap.json
Normal file
6
.zed/keymap.json
Normal file
@@ -0,0 +1,6 @@
|
||||
{
|
||||
"context": "Workspace",
|
||||
"bindings": {
|
||||
"cmd-r": ["task::Spawn", { "task_name": "ET", "reveal_target": "center" }]
|
||||
}
|
||||
}
|
||||
47
.zed/tasks.json
Normal file
47
.zed/tasks.json
Normal file
@@ -0,0 +1,47 @@
|
||||
[
|
||||
{
|
||||
"label": "ET",
|
||||
"command": "for i in {1..5}; do echo \"Hello $i/5\"; sleep 1; done",
|
||||
//"args": [],
|
||||
// Env overrides for the command, will be appended to the terminal's environment from the settings.
|
||||
"env": { "foo": "bar" },
|
||||
// Current working directory to spawn the command into, defaults to current project root.
|
||||
//"cwd": "/path/to/working/directory",
|
||||
// Whether to use a new terminal tab or reuse the existing one to spawn the process, defaults to `false`.
|
||||
"use_new_terminal": true,
|
||||
// Whether to allow multiple instances of the same task to be run, or rather wait for the existing ones to finish, defaults to `false`.
|
||||
"allow_concurrent_runs": false,
|
||||
// What to do with the terminal pane and tab, after the command was started:
|
||||
// * `always` — always show the task's pane, and focus the corresponding tab in it (default)
|
||||
// * `no_focus` — always show the task's pane, add the task's tab in it, but don't focus it
|
||||
// * `never` — do not alter focus, but still add/reuse the task's tab in its pane
|
||||
"reveal": "always",
|
||||
// What to do with the terminal pane and tab, after the command has finished:
|
||||
// * `never` — Do nothing when the command finishes (default)
|
||||
// * `always` — always hide the terminal tab, hide the pane also if it was the last tab in it
|
||||
// * `on_success` — hide the terminal tab on task success only, otherwise behaves similar to `always`
|
||||
"hide": "never",
|
||||
// Which shell to use when running a task inside the terminal.
|
||||
// May take 3 values:
|
||||
// 1. (default) Use the system's default terminal configuration in /etc/passwd
|
||||
// "shell": "system"
|
||||
// 2. A program:
|
||||
// "shell": {
|
||||
// "program": "sh"
|
||||
// }
|
||||
// 3. A program with arguments:
|
||||
// "shell": {
|
||||
// "with_arguments": {
|
||||
// "program": "/bin/bash",
|
||||
// "args": ["--login"]
|
||||
// }
|
||||
// }
|
||||
"shell": "system",
|
||||
// Whether to show the task line in the output of the spawned task, defaults to `true`.
|
||||
"show_summary": true,
|
||||
// Whether to show the command line in the output of the spawned task, defaults to `true`.
|
||||
// "show_output": true,
|
||||
// Represents the tags for inline runnable indicators, or spawning multiple tasks at once.
|
||||
"tags": ["DODO"]
|
||||
}
|
||||
]
|
||||
190
CONTRIBUTING.md
Normal file
190
CONTRIBUTING.md
Normal file
@@ -0,0 +1,190 @@
|
||||
# Contributing to Herolib
|
||||
|
||||
Thank you for your interest in contributing to Herolib! This document provides guidelines and instructions for contributing to the project.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Getting Started](#getting-started)
|
||||
- [Setting Up Development Environment](#setting-up-development-environment)
|
||||
- [Repository Structure](#repository-structure)
|
||||
- [Development Workflow](#development-workflow)
|
||||
- [Branching Strategy](#branching-strategy)
|
||||
- [Making Changes](#making-changes)
|
||||
- [Testing](#testing)
|
||||
- [Pull Requests](#pull-requests)
|
||||
- [Code Guidelines](#code-guidelines)
|
||||
- [CI/CD Process](#cicd-process)
|
||||
- [Documentation](#documentation)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Setting Up Development Environment
|
||||
|
||||
For developers, you can use the automated installation script:
|
||||
|
||||
```bash
|
||||
curl 'https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/install_v.sh' > /tmp/install_v.sh
|
||||
bash /tmp/install_v.sh --analyzer --herolib
|
||||
# IMPORTANT: Start a new shell after installation for paths to be set correctly
|
||||
```
|
||||
|
||||
Alternatively, you can manually set up the environment:
|
||||
|
||||
```bash
|
||||
mkdir -p ~/code/github/incubaid
|
||||
cd ~/code/github/incubaid
|
||||
git clone git@github.com:incubaid/herolib.git
|
||||
cd herolib
|
||||
# checkout development branch for most recent changes
|
||||
git checkout development
|
||||
bash install.sh
|
||||
```
|
||||
|
||||
### Repository Structure
|
||||
|
||||
Herolib is an opinionated library primarily used by ThreeFold to automate cloud environments. The repository is organized into several key directories:
|
||||
|
||||
- `/lib`: Core library code
|
||||
- `/cli`: Command-line interface tools, including the Hero tool
|
||||
- `/cookbook`: Examples and guides for using Herolib
|
||||
- `/scripts`: Installation and utility scripts
|
||||
- `/docs`: Generated documentation
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Branching Strategy
|
||||
|
||||
- `development`: Main development branch where all features and fixes are merged
|
||||
- `main`: Stable release branch
|
||||
|
||||
For new features or bug fixes, create a branch from `development` with a descriptive name.
|
||||
|
||||
### Making Changes
|
||||
|
||||
1. Create a new branch from `development`:
|
||||
|
||||
```bash
|
||||
git checkout development
|
||||
git pull
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
|
||||
2. Make your changes, following the code guidelines.
|
||||
|
||||
3. Run tests to ensure your changes don't break existing functionality:
|
||||
|
||||
```bash
|
||||
./test_basic.vsh
|
||||
```
|
||||
|
||||
4. Commit your changes with clear, descriptive commit messages.
|
||||
|
||||
### Testing
|
||||
|
||||
Before submitting a pull request, ensure all tests pass:
|
||||
|
||||
```bash
|
||||
# Run all basic tests
|
||||
./test_basic.vsh
|
||||
|
||||
# Run tests for a specific module
|
||||
vtest ~/code/github/incubaid/herolib/lib/osal/package_test.v
|
||||
|
||||
# Run tests for an entire directory
|
||||
vtest ~/code/github/incubaid/herolib/lib/osal
|
||||
```
|
||||
|
||||
The test script (`test_basic.vsh`) manages test execution and caching to optimize performance. It automatically skips tests listed in the ignore or error sections of the script.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
1. Push your branch to the repository:
|
||||
|
||||
```bash
|
||||
git push origin feature/your-feature-name
|
||||
```
|
||||
|
||||
2. Create a pull request against the `development` branch.
|
||||
|
||||
3. Ensure your PR includes:
|
||||
- A clear description of the changes
|
||||
- Any related issue numbers
|
||||
- Documentation updates if applicable
|
||||
|
||||
4. Wait for CI checks to pass and address any feedback from reviewers.
|
||||
|
||||
## Code Guidelines
|
||||
|
||||
- Follow the existing code style and patterns in the repository
|
||||
- Write clear, concise code with appropriate comments
|
||||
- Keep modules separate and focused on specific functionality
|
||||
- Maintain separation between the jsonschema and jsonrpc modules rather than merging them
|
||||
|
||||
## CI/CD Process
|
||||
|
||||
The repository uses GitHub Actions for continuous integration and deployment:
|
||||
|
||||
### 1. Testing Workflow (`test.yml`)
|
||||
|
||||
This workflow runs on every push and pull request to ensure code quality:
|
||||
|
||||
- Sets up V and Herolib
|
||||
- Runs all basic tests using `test_basic.vsh`
|
||||
|
||||
All tests must pass before a PR can be merged to the `development` branch.
|
||||
|
||||
### 2. Hero Build Workflow (`hero_build.yml`)
|
||||
|
||||
This workflow builds the Hero tool for multiple platforms when a new tag is created:
|
||||
|
||||
- Builds for Linux (x86_64, aarch64) and macOS (x86_64, aarch64)
|
||||
- Runs all basic tests
|
||||
- Creates GitHub releases with the built binaries
|
||||
|
||||
### 3. Documentation Workflow (`documentation.yml`)
|
||||
|
||||
This workflow automatically updates the documentation on GitHub Pages when changes are pushed to the `development` branch:
|
||||
|
||||
- Generates documentation using `doc.vsh`
|
||||
- Deploys the documentation to GitHub Pages
|
||||
|
||||
## Documentation
|
||||
|
||||
To generate documentation locally:
|
||||
|
||||
```bash
|
||||
cd ~/code/github/incubaid/herolib
|
||||
bash doc.sh
|
||||
```
|
||||
|
||||
The documentation is automatically published to [https://incubaid.github.io/herolib/](https://incubaid.github.io/herolib/) when changes are pushed to the `development` branch.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### TCC Compiler Error on macOS
|
||||
|
||||
If you encounter the following error when using TCC compiler on macOS:
|
||||
|
||||
```
|
||||
In file included from /Users/timurgordon/code/github/vlang/v/thirdparty/cJSON/cJSON.c:42:
|
||||
/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/math.h:614: error: ';' expected (got "__fabsf16")
|
||||
```
|
||||
|
||||
This is caused by incompatibility between TCC and the half precision math functions in the macOS SDK. To fix this issue:
|
||||
|
||||
1. Open the math.h file:
|
||||
|
||||
```bash
|
||||
sudo nano /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/math.h
|
||||
```
|
||||
|
||||
2. Comment out the half precision math functions (around line 612-626).
|
||||
|
||||
For more details, see the [README.md](README.md) troubleshooting section.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Herolib Documentation](https://incubaid.github.io/herolib/)
|
||||
- [Cookbook Examples](https://github.com/incubaid/herolib/tree/development/cookbook)
|
||||
- [AI Prompts](aiprompts/starter/0_start_here.md)
|
||||
179
README.md
179
README.md
@@ -1,26 +1,57 @@
|
||||
# herolib
|
||||
# Herolib
|
||||
|
||||
a smaller version of herolib with only the items we need for hero
|
||||
Herolib is an opinionated library primarily used by ThreeFold to automate cloud environments. It provides a comprehensive set of tools and utilities for cloud automation, git operations, documentation building, and more.
|
||||
|
||||
> [documentation here](https://freeflowuniverse.github.io/herolib/)
|
||||
[](https://github.com/incubaid/herolib/actions/workflows/test.yml)
|
||||
[](https://github.com/incubaid/herolib/actions/workflows/documentation.yml)
|
||||
|
||||
## automated install
|
||||
> [Complete Documentation](https://incubaid.github.io/herolib/)
|
||||
|
||||
## Installation
|
||||
|
||||
### For Users
|
||||
|
||||
The Hero tool can be installed with a single command:
|
||||
|
||||
```bash
|
||||
curl 'https://raw.githubusercontent.com/freeflowuniverse/herolib/refs/heads/main/install_v.sh' > /tmp/install_v.sh
|
||||
bash /tmp/install_v.sh --analyzer --herolib
|
||||
#DONT FORGET TO START A NEW SHELL (otherwise the paths will not be set)
|
||||
curl https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/install_hero.sh | bash
|
||||
```
|
||||
|
||||
### details
|
||||
Hero will be installed in:
|
||||
|
||||
- `/usr/local/bin` for Linux
|
||||
- `~/hero/bin` for macOS
|
||||
|
||||
After installation on macOS, you may need to do source see below or restart your terminal to ensure the `hero` command is available:
|
||||
|
||||
```bash
|
||||
source ~/.zprofile
|
||||
```
|
||||
|
||||
#~/code/github/freeflowuniverse/herolib/install_v.sh --help
|
||||
The Hero tool can be used to work with git, build documentation, interact with Hero AI, and more.
|
||||
|
||||
### For Developers
|
||||
|
||||
For development purposes, use the automated installation script:
|
||||
|
||||
```bash
|
||||
curl 'https://raw.githubusercontent.com/incubaid/herolib/refs/heads/development/install_v.sh' > /tmp/install_v.sh
|
||||
bash /tmp/install_v.sh --analyzer --herolib
|
||||
|
||||
#do not forget to do the following this makes sure vtest and vrun exists
|
||||
cd ~/code/github/incubaid/herolib
|
||||
v install_herolib.vsh
|
||||
|
||||
# IMPORTANT: Start a new shell after installation for paths to be set correctly
|
||||
|
||||
```
|
||||
|
||||
#### Installation Options
|
||||
|
||||
```
|
||||
V & HeroLib Installer Script
|
||||
|
||||
Usage: ~/code/github/freeflowuniverse/herolib/install_v.sh [options]
|
||||
Usage: ~/code/github/incubaid/herolib/install_v.sh [options]
|
||||
|
||||
Options:
|
||||
-h, --help Show this help message
|
||||
@@ -30,35 +61,121 @@ Options:
|
||||
--herolib Install our herolib
|
||||
|
||||
Examples:
|
||||
~/code/github/freeflowuniverse/herolib/install_v.sh
|
||||
~/code/github/freeflowuniverse/herolib/install_v.sh --reset
|
||||
~/code/github/freeflowuniverse/herolib/install_v.sh --remove
|
||||
~/code/github/freeflowuniverse/herolib/install_v.sh --analyzer
|
||||
~/code/github/freeflowuniverse/herolib/install_v.sh --herolib
|
||||
~/code/github/freeflowuniverse/herolib/install_v.sh --reset --analyzer # Fresh install of both
|
||||
|
||||
~/code/github/incubaid/herolib/install_v.sh
|
||||
~/code/github/incubaid/herolib/install_v.sh --reset
|
||||
~/code/github/incubaid/herolib/install_v.sh --remove
|
||||
~/code/github/incubaid/herolib/install_v.sh --analyzer
|
||||
~/code/github/incubaid/herolib/install_v.sh --herolib
|
||||
~/code/github/incubaid/herolib/install_v.sh --reset --analyzer # Fresh install of both
|
||||
```
|
||||
|
||||
### to test
|
||||
## Features
|
||||
|
||||
to run the basic tests, important !!!
|
||||
Herolib provides a wide range of functionality:
|
||||
|
||||
- Cloud automation tools
|
||||
- Git operations and management
|
||||
|
||||
### Offline Mode for Git Operations
|
||||
|
||||
Herolib now supports an `offline` mode for Git operations, which prevents automatic fetching from remote repositories. This can be useful in environments with limited or no internet connectivity, or when you want to avoid network calls during development or testing.
|
||||
|
||||
To enable offline mode:
|
||||
|
||||
- **Via `GitStructureConfig`**: Set the `offline` field to `true` in the `GitStructureConfig` struct.
|
||||
- **Via `GitStructureArgsNew`**: When creating a new `GitStructure` instance using `gittools.new()`, set the `offline` parameter to `true`.
|
||||
- **Via Environment Variable**: Set the `OFFLINE` environment variable to any value (e.g., `export OFFLINE=true`).
|
||||
|
||||
When offline mode is active, `git fetch --all` operations will be skipped, and a debug message "fetch skipped (offline)" will be printed.
|
||||
- Documentation building
|
||||
- Hero AI integration
|
||||
- System management utilities
|
||||
- And much more
|
||||
|
||||
Check the [cookbook](https://github.com/incubaid/herolib/tree/development/cookbook) for examples and use cases.
|
||||
|
||||
## Testing
|
||||
|
||||
Running tests is an essential part of development. To run the basic tests:
|
||||
|
||||
```bash
|
||||
~/code/github/freeflowuniverse/herolib/test_basic.vsh
|
||||
# Run all basic tests
|
||||
~/code/github/incubaid/herolib/test_basic.vsh
|
||||
|
||||
# Run tests for a specific module
|
||||
vtest ~/code/github/incubaid/herolib/lib/osal/package_test.v
|
||||
|
||||
# Run tests for an entire directory
|
||||
vtest ~/code/github/incubaid/herolib/lib/osal
|
||||
```
|
||||
|
||||
The `vtest` command is an alias for testing functionality.
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions to Herolib! Please see our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed information on:
|
||||
|
||||
- Setting up your development environment
|
||||
- Understanding the repository structure
|
||||
- Following our development workflow
|
||||
- Making pull requests
|
||||
- CI/CD processes
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### TCC Compiler Error on macOS
|
||||
|
||||
If you encounter the following error when using TCC compiler on macOS:
|
||||
|
||||
```
|
||||
In file included from /Users/timurgordon/code/github/vlang/v/thirdparty/cJSON/cJSON.c:42:
|
||||
/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/math.h:614: error: ';' expected (got "__fabsf16")
|
||||
```
|
||||
|
||||
This is caused by incompatibility between TCC and the half precision math functions in the macOS SDK. To fix this issue:
|
||||
|
||||
1. Open the math.h file:
|
||||
|
||||
```bash
|
||||
sudo nano /Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/usr/include/math.h
|
||||
```
|
||||
|
||||
2. Comment out the following lines (around line 612-626):
|
||||
|
||||
```c
|
||||
/* half precision math functions */
|
||||
// extern _Float16 __fabsf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __hypotf16(_Float16, _Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __sqrtf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __ceilf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __floorf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __rintf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __roundf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __truncf16(_Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __copysignf16(_Float16, _Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __nextafterf16(_Float16, _Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __fmaxf16(_Float16, _Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __fminf16(_Float16, _Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
// extern _Float16 __fmaf16(_Float16, _Float16, _Float16) __API_AVAILABLE(macos(15.0), ios(18.0), watchos(11.0), tvos(18.0));
|
||||
```
|
||||
|
||||
3. Save the file and try compiling again.
|
||||
|
||||
## Additional Resources
|
||||
|
||||
- [Complete Documentation](https://incubaid.github.io/herolib/)
|
||||
- [Cookbook Examples](https://github.com/incubaid/herolib/tree/development/cookbook)
|
||||
- [AI Prompts](aiprompts/starter/0_start_here.md)
|
||||
|
||||
## Generating Documentation
|
||||
|
||||
To generate documentation locally:
|
||||
|
||||
```bash
|
||||
vtest ~/code/github/freeflowuniverse/herolib/lib/osal/package_test.v
|
||||
#for a full dir
|
||||
vtest ~/code/github/freeflowuniverse/herolib/lib/osal
|
||||
|
||||
#to do al basic tests
|
||||
~/code/github/freeflowuniverse/herolib/test_basic.vsh
|
||||
|
||||
cd ~/code/github/incubaid/herolib
|
||||
bash doc.sh
|
||||
```
|
||||
vtest is an alias to test functionality
|
||||
|
||||
<!-- Security scan triggered at 2025-09-02 01:58:41 -->
|
||||
|
||||
## important to read
|
||||
|
||||
- [aiprompts/starter/0_start_here.md](aiprompts/starter/0_start_here.md)
|
||||
<!-- Security scan triggered at 2025-09-09 05:33:18 -->
|
||||
16
WARP.md
Normal file
16
WARP.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# WARP.md
|
||||
|
||||
This file provides guidance to WARP (warp.dev) when working with code in this repository.
|
||||
|
||||
## Commands to Use
|
||||
|
||||
### Testing
|
||||
- **Run Tests**: Utilize `vtest ~/code/github/incubaid/herolib/lib/osal/package_test.v` to run specific tests.
|
||||
|
||||
## High-Level Architecture
|
||||
- **Project Structure**: The project is organized into multiple modules located in `lib` and `src` directories. Prioritized compilation and caching strategies are utilized across modules.
|
||||
- **Script Handling**: Vlang scripts are crucial and should follow instructions from `aiprompts/vlang_herolib_core.md`.
|
||||
|
||||
## Special Instructions
|
||||
- **Documentation Reference**: Always refer to `aiprompts/vlang_herolib_core.md` for essential instructions regarding Vlang and Heroscript code generation and execution.
|
||||
- **Environment Specifics**: Ensure Redis and other dependencies are configured as per scripts provided in the codebase.
|
||||
19
aiprompts/.openhands/setup.sh
Normal file
19
aiprompts/.openhands/setup.sh
Normal file
@@ -0,0 +1,19 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Herolib Web Server Installation Script
|
||||
# This script sets up the necessary environment for the Flask web server.
|
||||
|
||||
set -e # Exit on any error
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
BLUE='\033[0;34m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
# Script directory
|
||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||
cd "$SCRIPT_DIR"
|
||||
|
||||
/workspace/herolib/install_v.sh
|
||||
@@ -1,204 +0,0 @@
|
||||
# instructions how to work with heroscript in vlang
|
||||
|
||||
## heroscript
|
||||
|
||||
Heroscript is our small scripting language which has following structure
|
||||
|
||||
an example of a heroscript is
|
||||
|
||||
```heroscript
|
||||
|
||||
!!mailclient.configure
|
||||
name: 'myname'
|
||||
host: 'localhost'
|
||||
port: 25
|
||||
secure: 1
|
||||
reset: 1
|
||||
description: '
|
||||
a description can be multiline
|
||||
|
||||
like this
|
||||
'
|
||||
|
||||
```
|
||||
|
||||
Notice how:
|
||||
- every action starts with !!
|
||||
- the first part is the actor, mailclient in this case
|
||||
- the 2e part is the action name, configure in this case
|
||||
- multilines are supported see the description field
|
||||
|
||||
## how to process heroscript in Vlang
|
||||
|
||||
- heroscript can be converted to a struct,
|
||||
- the methods available to get the params are in 'params' section further in this doc
|
||||
|
||||
|
||||
```vlang
|
||||
//the object which will be configured
|
||||
pub struct mailclient {
|
||||
pub mut:
|
||||
name string
|
||||
host string
|
||||
port int
|
||||
secure bool
|
||||
description string
|
||||
}
|
||||
|
||||
mut plbook := playbook.new(text: $the_heroscript_from_above)!
|
||||
play_mailclient(mut plbook)! //see below in vlang block there it all happens
|
||||
|
||||
pub fn play_mailclient(mut plbook playbook.PlayBook) ! {
|
||||
|
||||
//find all actions are !!$actor.$actionname. in this case above the actor is !!mailclient, we check with the fitler if it exists, if not we return
|
||||
mailclient_actions := plbook.find(filter: 'mailclient.')!
|
||||
for action in mailclient_actions {
|
||||
if action.name == "configure"{
|
||||
mut p := action.params
|
||||
mut obj := mailclientScript{
|
||||
//INFO: all details about the get methods can be found in 'params get methods' section
|
||||
name : p.get('name')! //will give error if not exist
|
||||
homedir : p.get('homedir')!
|
||||
title : p.get_default('title', 'My Hero DAG')! //uses a default if not set
|
||||
reset : p.get_default_false('reset')
|
||||
start : p.get_default_true('start')
|
||||
colors : p.get_list('colors')
|
||||
description : p.get_default('description','')!
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
## params get methods (param getters)
|
||||
|
||||
above in the p.get...
|
||||
|
||||
below you can find the methods which can be used on the params
|
||||
|
||||
```vlang
|
||||
|
||||
exists(key_ string) bool
|
||||
|
||||
//check if arg exist (arg is just a value in the string e.g. red, not value:something)
|
||||
exists_arg(key_ string) bool
|
||||
|
||||
//see if the kwarg with the key exists if yes return as string trimmed
|
||||
get(key_ string) !string
|
||||
|
||||
//return the arg with nr, 0 is the first
|
||||
get_arg(nr int) !string
|
||||
|
||||
//return arg, if the nr is larger than amount of args, will return the defval
|
||||
get_arg_default(nr int, defval string) !string
|
||||
|
||||
get_default(key string, defval string) !string
|
||||
|
||||
get_default_false(key string) bool
|
||||
|
||||
get_default_true(key string) bool
|
||||
|
||||
get_float(key string) !f64
|
||||
|
||||
get_float_default(key string, defval f64) !f64
|
||||
|
||||
get_from_hashmap(key_ string, defval string, hashmap map[string]string) !string
|
||||
|
||||
get_int(key string) !int
|
||||
|
||||
get_int_default(key string, defval int) !int
|
||||
|
||||
//Looks for a list of strings in the parameters. ',' are used as deliminator to list
|
||||
get_list(key string) ![]string
|
||||
|
||||
get_list_default(key string, def []string) ![]string
|
||||
|
||||
get_list_f32(key string) ![]f32
|
||||
|
||||
get_list_f32_default(key string, def []f32) []f32
|
||||
|
||||
get_list_f64(key string) ![]f64
|
||||
|
||||
get_list_f64_default(key string, def []f64) []f64
|
||||
|
||||
get_list_i16(key string) ![]i16
|
||||
|
||||
get_list_i16_default(key string, def []i16) []i16
|
||||
|
||||
get_list_i64(key string) ![]i64
|
||||
|
||||
get_list_i64_default(key string, def []i64) []i64
|
||||
|
||||
get_list_i8(key string) ![]i8
|
||||
|
||||
get_list_i8_default(key string, def []i8) []i8
|
||||
|
||||
get_list_int(key string) ![]int
|
||||
|
||||
get_list_int_default(key string, def []int) []int
|
||||
|
||||
get_list_namefix(key string) ![]string
|
||||
|
||||
get_list_namefix_default(key string, def []string) ![]string
|
||||
|
||||
get_list_u16(key string) ![]u16
|
||||
|
||||
get_list_u16_default(key string, def []u16) []u16
|
||||
|
||||
get_list_u32(key string) ![]u32
|
||||
|
||||
get_list_u32_default(key string, def []u32) []u32
|
||||
|
||||
get_list_u64(key string) ![]u64
|
||||
|
||||
get_list_u64_default(key string, def []u64) []u64
|
||||
|
||||
get_list_u8(key string) ![]u8
|
||||
|
||||
get_list_u8_default(key string, def []u8) []u8
|
||||
|
||||
get_map() map[string]string
|
||||
|
||||
get_path(key string) !string
|
||||
|
||||
get_path_create(key string) !string
|
||||
|
||||
get_percentage(key string) !f64
|
||||
|
||||
get_percentage_default(key string, defval string) !f64
|
||||
|
||||
//convert GB, MB, KB to bytes e.g. 10 GB becomes bytes in u64
|
||||
get_storagecapacity_in_bytes(key string) !u64
|
||||
|
||||
get_storagecapacity_in_bytes_default(key string, defval u64) !u64
|
||||
|
||||
get_storagecapacity_in_gigabytes(key string) !u64
|
||||
|
||||
//Get Expiration object from time string input input can be either relative or absolute## Relative time
|
||||
get_time(key string) !ourtime.OurTime
|
||||
|
||||
get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime
|
||||
|
||||
get_time_interval(key string) !Duration
|
||||
|
||||
get_timestamp(key string) !Duration
|
||||
|
||||
get_timestamp_default(key string, defval Duration) !Duration
|
||||
|
||||
get_u32(key string) !u32
|
||||
|
||||
get_u32_default(key string, defval u32) !u32
|
||||
|
||||
get_u64(key string) !u64
|
||||
|
||||
get_u64_default(key string, defval u64) !u64
|
||||
|
||||
get_u8(key string) !u8
|
||||
|
||||
get_u8_default(key string, defval u8) !u8
|
||||
|
||||
```
|
||||
@@ -1,142 +0,0 @@
|
||||
# how to use params
|
||||
|
||||
works very well in combination with heroscript
|
||||
|
||||
## How to get the paramsparser
|
||||
|
||||
```v
|
||||
import freeflowuniverse.herolib.data.paramsparser
|
||||
|
||||
// Create new params from text
|
||||
params := paramsparser.new("color:red size:'large' priority:1 enable:true")!
|
||||
|
||||
// Or create empty params and add later
|
||||
mut params := paramsparser.new_params()
|
||||
params.set("color", "red")
|
||||
```
|
||||
|
||||
## Parameter Format
|
||||
|
||||
The parser supports several formats:
|
||||
|
||||
1. Key-value pairs: `key:value`
|
||||
2. Quoted values: `key:'value with spaces'`
|
||||
3. Arguments without keys: `arg1 arg2`
|
||||
4. Comments: `// this is a comment`
|
||||
|
||||
Example:
|
||||
|
||||
```v
|
||||
text := "name:'John Doe' age:30 active:true // user details"
|
||||
params := paramsparser.new(text)!
|
||||
```
|
||||
|
||||
## Getting Values
|
||||
|
||||
The module provides various methods to retrieve values:
|
||||
|
||||
```v
|
||||
// Get string value
|
||||
name := params.get("name")! // returns "John Doe"
|
||||
|
||||
// Get with default value
|
||||
color := params.get_default("color", "blue")! // returns "blue" if color not set
|
||||
|
||||
// Get as integer
|
||||
age := params.get_int("age")! // returns 30
|
||||
|
||||
// Get as boolean (true if value is "1", "true", "y", "yes")
|
||||
is_active := params.get_default_true("active")
|
||||
|
||||
// Get as float
|
||||
score := params.get_float("score")!
|
||||
|
||||
// Get as percentage (converts "80%" to 0.8)
|
||||
progress := params.get_percentage("progress")!
|
||||
```
|
||||
|
||||
## Type Conversion Methods
|
||||
|
||||
The module supports various type conversions:
|
||||
|
||||
### Basic Types
|
||||
|
||||
- `get_int()`: Convert to int32
|
||||
- `get_u32()`: Convert to unsigned 32-bit integer
|
||||
- `get_u64()`: Convert to unsigned 64-bit integer
|
||||
- `get_u8()`: Convert to unsigned 8-bit integer
|
||||
- `get_float()`: Convert to 64-bit float
|
||||
- `get_percentage()`: Convert percentage string to float (e.g., "80%" → 0.8)
|
||||
|
||||
### Boolean Values
|
||||
|
||||
- `get_default_true()`: Returns true if value is empty, "1", "true", "y", or "yes"
|
||||
- `get_default_false()`: Returns false if value is empty, "0", "false", "n", or "no"
|
||||
|
||||
### Lists
|
||||
|
||||
The module provides robust support for parsing and converting lists:
|
||||
|
||||
```v
|
||||
// Basic list parsing
|
||||
names := params.get_list("users")! // parses ["user1", "user2", "user3"]
|
||||
|
||||
// With default value
|
||||
tags := params.get_list_default("tags", ["default"])!
|
||||
|
||||
// Lists with type conversion
|
||||
numbers := params.get_list_int("ids")! // converts each item to int
|
||||
amounts := params.get_list_f64("prices")! // converts each item to f64
|
||||
|
||||
// Name-fixed lists (normalizes each item)
|
||||
clean_names := params.get_list_namefix("categories")!
|
||||
```
|
||||
|
||||
Supported list types:
|
||||
|
||||
- `get_list()`: String list
|
||||
- `get_list_u8()`, `get_list_u16()`, `get_list_u32()`, `get_list_u64()`: Unsigned integers
|
||||
- `get_list_i8()`, `get_list_i16()`, `get_list_int()`, `get_list_i64()`: Signed integers
|
||||
- `get_list_f32()`, `get_list_f64()`: Floating point numbers
|
||||
|
||||
Each list method has a corresponding `_default` version that accepts a default value.
|
||||
|
||||
Valid list formats:
|
||||
|
||||
```v
|
||||
users: "john, jane,bob"
|
||||
ids: "1,2,3,4,5"
|
||||
```
|
||||
|
||||
### Advanced
|
||||
|
||||
```v
|
||||
get_map() map[string]string
|
||||
|
||||
get_path(key string) !string
|
||||
|
||||
get_path_create(key string) !string //will create path if it doesnt exist yet
|
||||
|
||||
get_percentage(key string) !f64
|
||||
|
||||
get_percentage_default(key string, defval string) !f64
|
||||
|
||||
//convert GB, MB, KB to bytes e.g. 10 GB becomes bytes in u64
|
||||
get_storagecapacity_in_bytes(key string) !u64
|
||||
|
||||
get_storagecapacity_in_bytes_default(key string, defval u64) !u64
|
||||
|
||||
get_storagecapacity_in_gigabytes(key string) !u64
|
||||
|
||||
//Get Expiration object from time string input input can be either relative or absolute## Relative time
|
||||
get_time(key string) !ourtime.OurTime
|
||||
|
||||
get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime
|
||||
|
||||
get_time_interval(key string) !Duration
|
||||
|
||||
get_timestamp(key string) !Duration
|
||||
|
||||
get_timestamp_default(key string, defval Duration) !Duration
|
||||
|
||||
```
|
||||
@@ -1,309 +0,0 @@
|
||||
# how to work with heroscript in vlang
|
||||
|
||||
## heroscript
|
||||
|
||||
Heroscript is our small scripting language which has following structure
|
||||
|
||||
an example of a heroscript is
|
||||
|
||||
```heroscript
|
||||
|
||||
!!dagu.script_define
|
||||
name: 'test_dag'
|
||||
homedir:''
|
||||
title:'a title'
|
||||
reset:1
|
||||
start:true //trie or 1 is same
|
||||
colors: 'green,red,purple' //lists are comma separated
|
||||
description: '
|
||||
a description can be multiline
|
||||
|
||||
like this
|
||||
'
|
||||
|
||||
|
||||
!!dagu.add_step
|
||||
dag: 'test_dag'
|
||||
name: 'hello_world'
|
||||
command: 'echo hello world'
|
||||
|
||||
!!dagu.add_step
|
||||
dag: 'test_dag'
|
||||
name: 'last_step'
|
||||
command: 'echo last step'
|
||||
|
||||
|
||||
```
|
||||
|
||||
Notice how:
|
||||
- every action starts with !!
|
||||
- the first part is the actor e.g. dagu in this case
|
||||
- the 2e part is the action name
|
||||
- multilines are supported see the description field
|
||||
|
||||
## how to process heroscript in Vlang
|
||||
|
||||
- heroscript can be converted to a struct,
|
||||
- the methods available to get the params are in 'params' section further in this doc
|
||||
|
||||
|
||||
```vlang
|
||||
|
||||
fn test_play_dagu() ! {
|
||||
mut plbook := playbook.new(text: thetext_from_above)!
|
||||
play_dagu(mut plbook)! //see below in vlang block there it all happens
|
||||
}
|
||||
|
||||
|
||||
pub fn play_dagu(mut plbook playbook.PlayBook) ! {
|
||||
|
||||
//find all actions are !!$actor.$actionname. in this case above the actor is !!dagu, we check with the fitler if it exists, if not we return
|
||||
dagu_actions := plbook.find(filter: 'dagu.')!
|
||||
if dagu_actions.len == 0 {
|
||||
return
|
||||
}
|
||||
play_dagu_basic(mut plbook)!
|
||||
}
|
||||
|
||||
pub struct DaguScript {
|
||||
pub mut:
|
||||
name string
|
||||
homedir string
|
||||
title string
|
||||
reset bool
|
||||
start bool
|
||||
colors []string
|
||||
}
|
||||
|
||||
// play_dagu plays the dagu play commands
|
||||
pub fn play_dagu_basic(mut plbook playbook.PlayBook) ! {
|
||||
|
||||
//now find the specific ones for dagu.script_define
|
||||
mut actions := plbook.find(filter: 'dagu.script_define')!
|
||||
|
||||
if actions.len > 0 {
|
||||
for myaction in actions {
|
||||
mut p := myaction.params //get the params object from the action object, this can then be processed using the param getters
|
||||
mut obj := DaguScript{
|
||||
//INFO: all details about the get methods can be found in 'params get methods' section
|
||||
name : p.get('name')! //will give error if not exist
|
||||
homedir : p.get('homedir')!
|
||||
title : p.get_default('title', 'My Hero DAG')! //uses a default if not set
|
||||
reset : p.get_default_false('reset')
|
||||
start : p.get_default_true('start')
|
||||
colors : p.get_list('colors')
|
||||
description : p.get_default('description','')!
|
||||
}
|
||||
...
|
||||
}
|
||||
}
|
||||
|
||||
//there can be more actions which will have other filter
|
||||
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## params get methods (param getters)
|
||||
|
||||
```vlang
|
||||
|
||||
fn (params &Params) exists(key_ string) bool
|
||||
|
||||
//check if arg exist (arg is just a value in the string e.g. red, not value:something)
|
||||
fn (params &Params) exists_arg(key_ string) bool
|
||||
|
||||
//see if the kwarg with the key exists if yes return as string trimmed
|
||||
fn (params &Params) get(key_ string) !string
|
||||
|
||||
//return the arg with nr, 0 is the first
|
||||
fn (params &Params) get_arg(nr int) !string
|
||||
|
||||
//return arg, if the nr is larger than amount of args, will return the defval
|
||||
fn (params &Params) get_arg_default(nr int, defval string) !string
|
||||
|
||||
fn (params &Params) get_default(key string, defval string) !string
|
||||
|
||||
fn (params &Params) get_default_false(key string) bool
|
||||
|
||||
fn (params &Params) get_default_true(key string) bool
|
||||
|
||||
fn (params &Params) get_float(key string) !f64
|
||||
|
||||
fn (params &Params) get_float_default(key string, defval f64) !f64
|
||||
|
||||
fn (params &Params) get_from_hashmap(key_ string, defval string, hashmap map[string]string) !string
|
||||
|
||||
fn (params &Params) get_int(key string) !int
|
||||
|
||||
fn (params &Params) get_int_default(key string, defval int) !int
|
||||
|
||||
//Looks for a list of strings in the parameters. ',' are used as deliminator to list
|
||||
fn (params &Params) get_list(key string) ![]string
|
||||
|
||||
fn (params &Params) get_list_default(key string, def []string) ![]string
|
||||
|
||||
fn (params &Params) get_list_f32(key string) ![]f32
|
||||
|
||||
fn (params &Params) get_list_f32_default(key string, def []f32) []f32
|
||||
|
||||
fn (params &Params) get_list_f64(key string) ![]f64
|
||||
|
||||
fn (params &Params) get_list_f64_default(key string, def []f64) []f64
|
||||
|
||||
fn (params &Params) get_list_i16(key string) ![]i16
|
||||
|
||||
fn (params &Params) get_list_i16_default(key string, def []i16) []i16
|
||||
|
||||
fn (params &Params) get_list_i64(key string) ![]i64
|
||||
|
||||
fn (params &Params) get_list_i64_default(key string, def []i64) []i64
|
||||
|
||||
fn (params &Params) get_list_i8(key string) ![]i8
|
||||
|
||||
fn (params &Params) get_list_i8_default(key string, def []i8) []i8
|
||||
|
||||
fn (params &Params) get_list_int(key string) ![]int
|
||||
|
||||
fn (params &Params) get_list_int_default(key string, def []int) []int
|
||||
|
||||
fn (params &Params) get_list_namefix(key string) ![]string
|
||||
|
||||
fn (params &Params) get_list_namefix_default(key string, def []string) ![]string
|
||||
|
||||
fn (params &Params) get_list_u16(key string) ![]u16
|
||||
|
||||
fn (params &Params) get_list_u16_default(key string, def []u16) []u16
|
||||
|
||||
fn (params &Params) get_list_u32(key string) ![]u32
|
||||
|
||||
fn (params &Params) get_list_u32_default(key string, def []u32) []u32
|
||||
|
||||
fn (params &Params) get_list_u64(key string) ![]u64
|
||||
|
||||
fn (params &Params) get_list_u64_default(key string, def []u64) []u64
|
||||
|
||||
fn (params &Params) get_list_u8(key string) ![]u8
|
||||
|
||||
fn (params &Params) get_list_u8_default(key string, def []u8) []u8
|
||||
|
||||
fn (params &Params) get_map() map[string]string
|
||||
|
||||
fn (params &Params) get_path(key string) !string
|
||||
|
||||
fn (params &Params) get_path_create(key string) !string
|
||||
|
||||
fn (params &Params) get_percentage(key string) !f64
|
||||
|
||||
fn (params &Params) get_percentage_default(key string, defval string) !f64
|
||||
|
||||
//convert GB, MB, KB to bytes e.g. 10 GB becomes bytes in u64
|
||||
fn (params &Params) get_storagecapacity_in_bytes(key string) !u64
|
||||
|
||||
fn (params &Params) get_storagecapacity_in_bytes_default(key string, defval u64) !u64
|
||||
|
||||
fn (params &Params) get_storagecapacity_in_gigabytes(key string) !u64
|
||||
|
||||
//Get Expiration object from time string input input can be either relative or absolute## Relative time
|
||||
fn (params &Params) get_time(key string) !ourtime.OurTime
|
||||
|
||||
fn (params &Params) get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime
|
||||
|
||||
fn (params &Params) get_time_interval(key string) !Duration
|
||||
|
||||
fn (params &Params) get_timestamp(key string) !Duration
|
||||
|
||||
fn (params &Params) get_timestamp_default(key string, defval Duration) !Duration
|
||||
|
||||
fn (params &Params) get_u32(key string) !u32
|
||||
|
||||
fn (params &Params) get_u32_default(key string, defval u32) !u32
|
||||
|
||||
fn (params &Params) get_u64(key string) !u64
|
||||
|
||||
fn (params &Params) get_u64_default(key string, defval u64) !u64
|
||||
|
||||
fn (params &Params) get_u8(key string) !u8
|
||||
|
||||
fn (params &Params) get_u8_default(key string, defval u8) !u8
|
||||
|
||||
```
|
||||
|
||||
## how internally a heroscript gets parsed for params
|
||||
|
||||
- example to show how a heroscript gets parsed in action with params
|
||||
- params are part of action object
|
||||
|
||||
```heroscript
|
||||
example text to parse (heroscript)
|
||||
|
||||
id:a1 name6:aaaaa
|
||||
name:'need to do something 1'
|
||||
description:
|
||||
'
|
||||
## markdown works in it
|
||||
description can be multiline
|
||||
lets see what happens
|
||||
|
||||
- a
|
||||
- something else
|
||||
|
||||
### subtitle
|
||||
'
|
||||
|
||||
name2: test
|
||||
name3: hi
|
||||
name10:'this is with space' name11:aaa11
|
||||
|
||||
name4: 'aaa'
|
||||
|
||||
//somecomment
|
||||
name5: 'aab'
|
||||
```
|
||||
|
||||
the params are part of the action and are represented as follow for the above:
|
||||
|
||||
```vlang
|
||||
Params{
|
||||
params: [Param{
|
||||
key: 'id'
|
||||
value: 'a1'
|
||||
}, Param{
|
||||
key: 'name6'
|
||||
value: 'aaaaa'
|
||||
}, Param{
|
||||
key: 'name'
|
||||
value: 'need to do something 1'
|
||||
}, Param{
|
||||
key: 'description'
|
||||
value: '## markdown works in it
|
||||
|
||||
description can be multiline
|
||||
lets see what happens
|
||||
|
||||
- a
|
||||
- something else
|
||||
|
||||
### subtitle
|
||||
'
|
||||
}, Param{
|
||||
key: 'name2'
|
||||
value: 'test'
|
||||
}, Param{
|
||||
key: 'name3'
|
||||
value: 'hi'
|
||||
}, Param{
|
||||
key: 'name10'
|
||||
value: 'this is with space'
|
||||
}, Param{
|
||||
key: 'name11'
|
||||
value: 'aaa11'
|
||||
}, Param{
|
||||
key: 'name4'
|
||||
value: 'aaa'
|
||||
}, Param{
|
||||
key: 'name5'
|
||||
value: 'aab'
|
||||
}]
|
||||
}
|
||||
```
|
||||
@@ -1,441 +0,0 @@
|
||||
# module osal
|
||||
|
||||
import as
|
||||
|
||||
```vlang
|
||||
import freeflowuniverse.herolib.osal
|
||||
|
||||
osal.ping...
|
||||
|
||||
```
|
||||
|
||||
## ping
|
||||
|
||||
```go
|
||||
assert ping(address:"338.8.8.8")==.unknownhost
|
||||
assert ping(address:"8.8.8.8")==.ok
|
||||
assert ping(address:"18.8.8.8")==.timeout
|
||||
```
|
||||
|
||||
will do a panic if its not one of them, an unknown error
|
||||
|
||||
## platform
|
||||
|
||||
```go
|
||||
if platform()==.osx{
|
||||
//do something
|
||||
}
|
||||
|
||||
pub enum PlatformType {
|
||||
unknown
|
||||
osx
|
||||
ubuntu
|
||||
alpine
|
||||
}
|
||||
|
||||
pub enum CPUType {
|
||||
unknown
|
||||
intel
|
||||
arm
|
||||
intel32
|
||||
arm32
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## process
|
||||
|
||||
### execute jobs
|
||||
|
||||
```v
|
||||
mut job2:=osal.exec(cmd:"ls /")?
|
||||
println(job2)
|
||||
|
||||
//wont die, the result can be found in /tmp/execscripts
|
||||
mut job:=osal.exec(cmd:"ls dsds",ignore_error:true)?
|
||||
//this one has an error
|
||||
println(job)
|
||||
```
|
||||
|
||||
All scripts are executed from a file from /tmp/execscripts
|
||||
|
||||
If the script executes well then its removed, so no leftovers, if it fails the script stays in the dir
|
||||
|
||||
### check process logs
|
||||
|
||||
```
|
||||
mut pm:=process.processmap_get()?
|
||||
```
|
||||
|
||||
info returns like:
|
||||
|
||||
```json
|
||||
}, freeflowuniverse.herolib.process.ProcessInfo{
|
||||
cpu_perc: 0
|
||||
mem_perc: 0
|
||||
cmd: 'mc'
|
||||
pid: 84455
|
||||
ppid: 84467
|
||||
rss: 3168
|
||||
}, freeflowuniverse.herolib.process.ProcessInfo{
|
||||
cpu_perc: 0
|
||||
mem_perc: 0
|
||||
cmd: 'zsh -Z -g'
|
||||
pid: 84467
|
||||
ppid: 84469
|
||||
rss: 1360
|
||||
}]
|
||||
```
|
||||
|
||||
## other commands
|
||||
|
||||
fn bin*path() !string
|
||||
fn cmd_add(args* CmdAddArgs) !
|
||||
copy a binary to the right location on the local computer . e.g. is /usr/local/bin on linux . e.g. is ~/hero/bin on osx . will also add the bin location to the path of .zprofile and .zshrc (different per platform)
|
||||
fn cmd*exists(cmd string) bool
|
||||
fn cmd_exists_profile(cmd string) bool
|
||||
fn cmd_path(cmd string) !string
|
||||
is same as executing which in OS returns path or error
|
||||
fn cmd_to_script_path(cmd Command) !string
|
||||
will return temporary path which then can be executed, is a helper function for making script out of command
|
||||
fn cputype() CPUType
|
||||
fn cputype_enum_from_string(cpytype string) CPUType
|
||||
Returns the enum value that matches the provided string for CPUType
|
||||
fn dir_delete(path string) !
|
||||
remove all if it exists
|
||||
fn dir_ensure(path string) !
|
||||
remove all if it exists
|
||||
fn dir_reset(path string) !
|
||||
remove all if it exists and then (re-)create
|
||||
fn done_delete(key string) !
|
||||
fn done_exists(key string) bool
|
||||
fn done_get(key string) ?string
|
||||
fn done_get_int(key string) int
|
||||
fn done_get_str(key string) string
|
||||
fn done_print() !
|
||||
fn done_reset() !
|
||||
fn done_set(key string, val string) !
|
||||
fn download(args* DownloadArgs) !pathlib.Path
|
||||
if name is not specified, then will be the filename part if the last ends in an extension like .md .txt .log .text ... the file will be downloaded
|
||||
fn env_get(key string) !string
|
||||
Returns the requested environment variable if it exists or throws an error if it does not
|
||||
fn env_get_all() map[string]string
|
||||
Returns all existing environment variables
|
||||
fn env_get_default(key string, def string) string
|
||||
Returns the requested environment variable if it exists or returns the provided default value if it does not
|
||||
fn env_set(args EnvSet)
|
||||
Sets an environment if it was not set before, it overwrites the enviroment variable if it exists and if overwrite was set to true (default)
|
||||
fn env_set_all(args EnvSetAll)
|
||||
Allows to set multiple enviroment variables in one go, if clear_before_set is true all existing environment variables will be unset before the operation, if overwrite_if_exists is set to true it will overwrite all existing enviromnent variables
|
||||
fn env_unset(key string)
|
||||
Unsets an environment variable
|
||||
fn env_unset_all()
|
||||
Unsets all environment variables
|
||||
fn exec(cmd Command) !Job
|
||||
cmd is the cmd to execute can use ' ' and spaces . if \n in cmd it will write it to ext and then execute with bash . if die==false then will just return returncode,out but not return error . if stdout will show stderr and stdout . . if cmd starts with find or ls, will give to bash -c so it can execute . if cmd has no path, path will be found . . Command argument: .
|
||||
|
||||
````
|
||||
name string // to give a name to your command, good to see logs...
|
||||
cmd string
|
||||
description string
|
||||
timeout int = 3600 // timeout in sec
|
||||
stdout bool = true
|
||||
stdout_log bool = true
|
||||
raise_error bool = true // if false, will not raise an error but still error report
|
||||
ignore_error bool // means if error will just exit and not raise, there will be no error reporting
|
||||
work_folder string // location where cmd will be executed
|
||||
environment map[string]string // env variables
|
||||
ignore_error_codes []int
|
||||
scriptpath string // is the path where the script will be put which is executed
|
||||
scriptkeep bool // means we don't remove the script
|
||||
debug bool // if debug will put +ex in the script which is being executed and will make sure script stays
|
||||
shell bool // means we will execute it in a shell interactive
|
||||
retry int
|
||||
interactive bool = true // make sure we run on non interactive way
|
||||
async bool
|
||||
runtime RunTime (.bash, .python)
|
||||
|
||||
returns Job:
|
||||
start time.Time
|
||||
end time.Time
|
||||
cmd Command
|
||||
output []string
|
||||
error []string
|
||||
exit_code int
|
||||
status JobStatus
|
||||
process os.Process
|
||||
```
|
||||
return Job .
|
||||
|
||||
fn exec_string(cmd Command) !string
|
||||
cmd is the cmd to execute can use ' ' and spaces if \n in cmd it will write it to ext and then execute with bash if die==false then will just return returncode,out but not return error if stdout will show stderr and stdout
|
||||
|
||||
if cmd starts with find or ls, will give to bash -c so it can execute if cmd has no path, path will be found $... are remplaced by environment arguments TODO:implement
|
||||
|
||||
Command argument: cmd string timeout int = 600 stdout bool = true die bool = true debug bool
|
||||
|
||||
return what needs to be executed can give it to bash -c ...
|
||||
|
||||
fn execute*debug(cmd string) !string
|
||||
fn execute_interactive(cmd string) !
|
||||
shortcut to execute a job interactive means in shell
|
||||
fn execute_ok(cmd string) bool
|
||||
executes a cmd, if not error return true
|
||||
fn execute_silent(cmd string) !string
|
||||
shortcut to execute a job silent
|
||||
fn execute_stdout(cmd string) !string
|
||||
shortcut to execute a job to stdout
|
||||
fn file_read(path string) !string
|
||||
fn file_write(path string, text string) !
|
||||
fn get_logger() log.Logger
|
||||
Returns a logger object and allows you to specify via environment argument OSAL_LOG_LEVEL the debug level
|
||||
fn hero_path() !string
|
||||
fn hostname() !string
|
||||
fn initname() !string
|
||||
e.g. systemd, bash, zinit
|
||||
fn ipaddr_pub_get() !string
|
||||
Returns the ipaddress as known on the public side is using resolver4.opendns.com
|
||||
fn is_linux() bool
|
||||
fn is_linux_arm()! bool
|
||||
fn is_linux_intel() bool
|
||||
fn is_osx() bool
|
||||
fn is_osx_arm() bool
|
||||
fn is_osx_intel() bool
|
||||
fn is_ubuntu() bool
|
||||
fn load_env_file(file_path string) !
|
||||
fn memdb_exists(key string) bool
|
||||
fn memdb_get(key string) string
|
||||
fn memdb_set(key string, val string)
|
||||
fn package_install(name* string) !
|
||||
install a package will use right commands per platform
|
||||
fn package_refresh() !
|
||||
update the package list
|
||||
fn ping(args PingArgs) PingResult
|
||||
if reached in timout result will be True address is e.g. 8.8.8.8 ping means we check if the destination responds
|
||||
fn platform() PlatformType
|
||||
fn platform_enum_from_string(platform string) PlatformType
|
||||
fn process_exists(pid int) bool
|
||||
fn process_exists_byname(name string) !bool
|
||||
fn process_kill_recursive(args ProcessKillArgs) !
|
||||
kill process and all the ones underneith
|
||||
fn processinfo_children(pid int) !ProcessMap
|
||||
get all children of 1 process
|
||||
fn processinfo_get(pid int) !ProcessInfo
|
||||
get process info from 1 specific process returns
|
||||
` pub struct ProcessInfo {
|
||||
pub mut:
|
||||
cpu_perc f32
|
||||
mem_perc f32
|
||||
cmd string
|
||||
pid int
|
||||
ppid int
|
||||
//resident memory
|
||||
rss int
|
||||
}
|
||||
`
|
||||
fn processinfo_get_byname(name string) ![]ProcessInfo
|
||||
fn processinfo_with_children(pid int) !ProcessMap
|
||||
return the process and its children
|
||||
fn processmap_get() !ProcessMap
|
||||
make sure to use new first, so that the connection has been initted then you can get it everywhere
|
||||
fn profile_path() string
|
||||
fn profile_path_add(args ProfilePathAddArgs) !
|
||||
add the following path to a profile
|
||||
fn profile_path_add_hero() !string
|
||||
fn profile_path_source() string
|
||||
return the source statement if the profile exists
|
||||
fn profile_path_source_and() string
|
||||
return source $path && . or empty if it doesn't exist
|
||||
fn sleep(duration int)
|
||||
sleep in seconds
|
||||
fn tcp_port_test(args TcpPortTestArgs) bool
|
||||
test if a tcp port answers
|
||||
` address string //192.168.8.8
|
||||
port int = 22
|
||||
timeout u16 = 2000 // total time in milliseconds to keep on trying
|
||||
`
|
||||
fn user_add(args UserArgs) !int
|
||||
add's a user if the user does not exist yet
|
||||
fn user_exists(username string) bool
|
||||
fn user_id_get(username string) !int
|
||||
fn usr_local_path() !string
|
||||
/usr/local on linux, ${os.home_dir()}/hero on osx
|
||||
fn whoami() !string
|
||||
fn write_flags[T](options T) string
|
||||
enum CPUType {
|
||||
unknown
|
||||
intel
|
||||
arm
|
||||
intel32
|
||||
arm32
|
||||
}
|
||||
enum ErrorType {
|
||||
exec
|
||||
timeout
|
||||
args
|
||||
}
|
||||
enum JobStatus {
|
||||
init
|
||||
running
|
||||
error_exec
|
||||
error_timeout
|
||||
error_args
|
||||
done
|
||||
}
|
||||
enum PMState {
|
||||
init
|
||||
ok
|
||||
old
|
||||
}
|
||||
enum PingResult {
|
||||
ok
|
||||
timeout // timeout from ping
|
||||
unknownhost // means we don't know the hostname its a dns issue
|
||||
}
|
||||
enum PlatformType {
|
||||
unknown
|
||||
osx
|
||||
ubuntu
|
||||
alpine
|
||||
arch
|
||||
suse
|
||||
}
|
||||
enum RunTime {
|
||||
bash
|
||||
python
|
||||
heroscript
|
||||
herocmd
|
||||
v
|
||||
}
|
||||
struct CmdAddArgs {
|
||||
pub mut:
|
||||
cmdname string
|
||||
source string @[required] // path where the binary is
|
||||
symlink bool // if rather than copy do a symlink
|
||||
reset bool // if existing cmd will delete
|
||||
// bin_repo_url string = 'https://github.com/freeflowuniverse/freeflow_binary' // binary where we put the results
|
||||
}
|
||||
struct Command {
|
||||
pub mut:
|
||||
name string // to give a name to your command, good to see logs...
|
||||
cmd string
|
||||
description string
|
||||
timeout int = 3600 // timeout in sec
|
||||
stdout bool = true
|
||||
stdout_log bool = true
|
||||
raise_error bool = true // if false, will not raise an error but still error report
|
||||
ignore_error bool // means if error will just exit and not raise, there will be no error reporting
|
||||
work_folder string // location where cmd will be executed
|
||||
environment map[string]string // env variables
|
||||
ignore_error_codes []int
|
||||
scriptpath string // is the path where the script will be put which is executed
|
||||
scriptkeep bool // means we don't remove the script
|
||||
debug bool // if debug will put +ex in the script which is being executed and will make sure script stays
|
||||
shell bool // means we will execute it in a shell interactive
|
||||
retry int
|
||||
interactive bool = true
|
||||
async bool
|
||||
runtime RunTime
|
||||
}
|
||||
struct DownloadArgs {
|
||||
pub mut:
|
||||
name string // optional (otherwise derived out of filename)
|
||||
url string
|
||||
reset bool // will remove
|
||||
hash string // if hash is known, will verify what hash is
|
||||
dest string // if specified will copy to that destination
|
||||
timeout int = 180
|
||||
retry int = 3
|
||||
minsize_kb u32 = 10 // is always in kb
|
||||
maxsize_kb u32
|
||||
expand_dir string
|
||||
expand_file string
|
||||
}
|
||||
struct EnvSet {
|
||||
pub mut:
|
||||
key string @[required]
|
||||
value string @[required]
|
||||
overwrite bool = true
|
||||
}
|
||||
struct EnvSetAll {
|
||||
pub mut:
|
||||
env map[string]string
|
||||
clear_before_set bool
|
||||
overwrite_if_exists bool = true
|
||||
}
|
||||
struct Job {
|
||||
pub mut:
|
||||
start time.Time
|
||||
end time.Time
|
||||
cmd Command
|
||||
output string
|
||||
error string
|
||||
exit_code int
|
||||
status JobStatus
|
||||
process ?&os.Process @[skip; str: skip]
|
||||
runnr int // nr of time it runs, is for retry
|
||||
}
|
||||
fn (mut job Job) execute_retry() !
|
||||
execute the job and wait on result will retry as specified
|
||||
fn (mut job Job) execute() !
|
||||
execute the job, start process, process will not be closed . important you need to close the process later by job.close()! otherwise we get zombie processes
|
||||
fn (mut job Job) wait() !
|
||||
wait till the job finishes or goes in error
|
||||
fn (mut job Job) process() !
|
||||
process (read std.err and std.out of process)
|
||||
fn (mut job Job) close() !
|
||||
will wait & close
|
||||
struct JobError {
|
||||
Error
|
||||
pub mut:
|
||||
job Job
|
||||
error_type ErrorType
|
||||
}
|
||||
struct PingArgs {
|
||||
pub mut:
|
||||
address string @[required]
|
||||
count u8 = 1 // the ping is successful if it got count amount of replies from the other side
|
||||
timeout u16 = 1 // the time in which the other side should respond in seconds
|
||||
retry u8
|
||||
}
|
||||
struct ProcessInfo {
|
||||
pub mut:
|
||||
cpu_perc f32
|
||||
mem_perc f32
|
||||
cmd string
|
||||
pid int
|
||||
ppid int // parentpid
|
||||
// resident memory
|
||||
rss int
|
||||
}
|
||||
fn (mut p ProcessInfo) str() string
|
||||
struct ProcessKillArgs {
|
||||
pub mut:
|
||||
name string
|
||||
pid int
|
||||
}
|
||||
struct ProcessMap {
|
||||
pub mut:
|
||||
processes []ProcessInfo
|
||||
lastscan time.Time
|
||||
state PMState
|
||||
pids []int
|
||||
}
|
||||
struct ProfilePathAddArgs {
|
||||
pub mut:
|
||||
path string @[required]
|
||||
todelete string // see which one to remove
|
||||
}
|
||||
struct TcpPortTestArgs {
|
||||
pub mut:
|
||||
address string @[required] // 192.168.8.8
|
||||
port int = 22
|
||||
timeout u16 = 2000 // total time in milliseconds to keep on trying
|
||||
}
|
||||
struct UserArgs {
|
||||
pub mut:
|
||||
name string @[required]
|
||||
}
|
||||
|
||||
-
|
||||
````
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1 +0,0 @@
|
||||
../lib/data/encoder/readme.md
|
||||
51
aiprompts/bizmodel/bizmodel_cost.md
Normal file
51
aiprompts/bizmodel/bizmodel_cost.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# Cost Module Documentation
|
||||
|
||||
This module provides functionalities related to managing various costs within the business model.
|
||||
|
||||
## Actions
|
||||
|
||||
### `!!bizmodel.cost_define`
|
||||
|
||||
Defines a cost item and its associated properties.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
* `bizname` (string, required): The name of the business model instance to which this cost belongs.
|
||||
* `descr` (string, required): Description of the cost item. If `name` is not provided, it will be derived from this.
|
||||
* `name` (string, optional): Unique name for the cost item. If not provided, it will be generated from `descr`.
|
||||
* `cost` (string, required): The cost value. Can be a fixed value (e.g., '1000USD') or a growth rate (e.g., '0:1000,59:2000'). If `indexation` is used, this should not contain a colon. This value is extrapolated.
|
||||
* `indexation` (percentage, optional, default: '0%'): Annual indexation rate for the cost. Applied over 6 years if specified.
|
||||
* `costcenter` (string, optional): The costcenter associated with this cost.
|
||||
* `cost_percent_revenue` (percentage, optional, default: '0%'): Ensures the cost is at least this percentage of the total revenue.
|
||||
* `extrapolate`: If you want to extrapolate revenue or cogs do extrapolate:1, default is 0.
|
||||
|
||||
### `!!bizmodel.costcenter_define`
|
||||
|
||||
Defines a cost center.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
* `bizname` (string, required): The name of the business model instance to which this cost belongs.
|
||||
* `descr` (string, required): Description of the cost center. If `name` is not provided, it will be derived from this.
|
||||
* `name` (string, optional): Unique name for the cost center. If not provided, it will be generated from `descr`.
|
||||
* `department` (string, optional): The department associated with this cost center.
|
||||
|
||||
|
||||
## **Example:**
|
||||
|
||||
```js
|
||||
!!bizmodel.costcenter_define bizname:'test'
|
||||
descr:'Marketing Cost Center'
|
||||
name:'marketing_cc'
|
||||
department:'marketing'
|
||||
|
||||
|
||||
!!bizmodel.cost_define bizname:'test'
|
||||
descr:'Office Rent'
|
||||
cost:'5000USD'
|
||||
indexation:'3%'
|
||||
costcenter:'marketing_cc'
|
||||
cost_percent_revenue:'1%'
|
||||
|
||||
```
|
||||
|
||||
35
aiprompts/bizmodel/bizmodel_funding.md
Normal file
35
aiprompts/bizmodel/bizmodel_funding.md
Normal file
@@ -0,0 +1,35 @@
|
||||
# Funding Module Documentation
|
||||
|
||||
This module provides functionalities related to managing various funding sources within the business model.
|
||||
|
||||
## Actions
|
||||
|
||||
### `!!bizmodel.funding_define`
|
||||
|
||||
Defines a funding entity and its associated properties.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
* `bizname` (string, required): The name of the business model instance to which this funding belongs.
|
||||
* `name` (string, required): Identifier for the funding entity.
|
||||
* `descr` (string, optional): Human-readable description. If not provided, it will be derived from `description`.
|
||||
* `investment` (string, required): Format `month:amount`, e.g., '0:10000,12:5000'. This value is extrapolated.
|
||||
* `type` (string, optional, default: 'capital'): The type of funding. Allowed values: 'loan' or 'capital'.
|
||||
* `extrapolate`: If you want to extrapolate revenue or cogs do extrapolate:1, default is 0.
|
||||
|
||||
### `funding_total`
|
||||
|
||||
Calculates the total funding.
|
||||
|
||||
## **Example:**
|
||||
|
||||
```js
|
||||
!!bizmodel.funding_define bizname:'test' name:'seed_capital'
|
||||
descr:'Initial Seed Capital Investment'
|
||||
investment:'0:500000,12:200000'
|
||||
type:'capital'
|
||||
|
||||
!!bizmodel.funding_define bizname:'test' name:'bank_loan'
|
||||
descr:'Bank Loan for Expansion'
|
||||
investment:'6:100000,18:50000'
|
||||
type:'loan'
|
||||
24
aiprompts/bizmodel/bizmodel_generation_prompt.md
Normal file
24
aiprompts/bizmodel/bizmodel_generation_prompt.md
Normal file
@@ -0,0 +1,24 @@
|
||||
create a bizmodel for a startup called threefold
|
||||
|
||||
it has 4 departments
|
||||
- engineering
|
||||
- operations
|
||||
- sales
|
||||
- admin
|
||||
|
||||
I need modest engineering 10, 5 people, team nr of people grows 10% per year, with max of 20 people
|
||||
I need operational team of 2 people and 4% of revenue
|
||||
|
||||
I am selling services on a cloud, it starts at 10k USD a month after 10 months, then growing to 1 million a month after 3 years, then 5% up per year
|
||||
|
||||
we have 3 offices
|
||||
|
||||
we have 5m funding day 1
|
||||
|
||||
travelcost is 3% of revenue
|
||||
|
||||
create me the full heroscript which gives me this biz model
|
||||
|
||||
create bizmodel.heroscript in ~/code/github/incubaid/herolib/examples/biztools/generated_ai
|
||||
|
||||
as well as a do.vsh file which executes the heroscript and does a pprint, in do.vsh , call play with heroscript_path arg
|
||||
69
aiprompts/bizmodel/bizmodel_hr.md
Normal file
69
aiprompts/bizmodel/bizmodel_hr.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# HR Module Documentation
|
||||
|
||||
This module provides functionalities related to Human Resources within the business model.
|
||||
|
||||
## Actions
|
||||
|
||||
All actions in the `bizmodel` module accept a `bizname` parameter (string, required) which specifies the business model instance to which the action applies.
|
||||
|
||||
### `bizmodel.employee_define`
|
||||
|
||||
Defines an employee and their associated costs within the business model.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
* `bizname` (string, required): The name of the business model instance to which this cost belongs.
|
||||
* `descr` (string, required): Description of the employee (e.g., 'Junior Engineer'). If `name` is not provided, it will be derived from this.
|
||||
* `name` (string, optional): Unique name for the employee. If not provided, it will be generated from `descr`.
|
||||
* `cost` (string, required): The cost associated with the employee. Can be a fixed value (e.g., '4000USD') or a growth rate (e.g., '1:5,60:30'). If `indexation` is used, this should not contain a colon.
|
||||
* `nrpeople` (string, optional, default: '1'): The number of people for this employee definition. Can be a fixed number or a growth rate (e.g., '1:5,60:30').
|
||||
* `indexation` (percentage, optional, default: '0%'): Annual indexation rate for the cost. Applied over 6 years if specified.
|
||||
* `department` (string, optional): The department the employee belongs to.
|
||||
* `cost_percent_revenue` (percentage, optional, default: '0%'): Ensures the employee cost is at least this percentage of the total revenue.
|
||||
* `costcenter` (string, optional, default: 'default_costcenter'): The cost center for the employee.
|
||||
* `page` (string, optional): A reference to a page or document related to this employee.
|
||||
* `fulltime` (percentage, optional, default: '100%'): The full-time percentage of the employee.
|
||||
|
||||
|
||||
### `bizmodel.department_define`
|
||||
|
||||
Defines a department within the business model.
|
||||
|
||||
**Parameters:**
|
||||
|
||||
* `bizname` (string, required): The name of the business model instance to which this cost belongs.
|
||||
* `name` (string, required): Unique name for the department.
|
||||
* `descr` (string, optional): Description of the department. If not provided, `description` will be used.
|
||||
* `description` (string, optional): Description of the department. Used if `descr` is not provided.
|
||||
* `title` (string, optional): A title for the department.
|
||||
* `page` (string, optional): A reference to a page or document related to this department.
|
||||
|
||||
## **Example:**
|
||||
|
||||
```js
|
||||
|
||||
!!bizmodel.department_define bizname:'test'
|
||||
name:'engineering'
|
||||
descr:'Software Development Department'
|
||||
title:'Engineering Division'
|
||||
//optional, if set overrules the hr_params
|
||||
//avg_monthly_cost:'6000USD' avg_indexation:'5%'
|
||||
|
||||
!!bizmodel.employee_define bizname:'test'
|
||||
name:'ourclo'
|
||||
descr:'CLO'
|
||||
cost:'10000EUR'
|
||||
indexation:'5%'
|
||||
|
||||
!!bizmodel.employee_define bizname:'test'
|
||||
name:'junior_engineer'
|
||||
descr:'Junior Engineer'
|
||||
nrpeople:'1:5,60:30'
|
||||
cost:'4000USD'
|
||||
indexation:'5%'
|
||||
department:'engineering'
|
||||
cost_percent_revenue:'4%'
|
||||
|
||||
|
||||
```
|
||||
|
||||
90
aiprompts/bizmodel/bizmodel_revenue.md
Normal file
90
aiprompts/bizmodel/bizmodel_revenue.md
Normal file
@@ -0,0 +1,90 @@
|
||||
# Revenue
|
||||
|
||||
```
|
||||
!!bizmodel.revenue_define bizname:'test' name:'oem1' ...
|
||||
```
|
||||
|
||||
## Params
|
||||
|
||||
- bizname, is the name of the biz model we are populating
|
||||
- name, name of product, project
|
||||
- descr, description of the revenue line item
|
||||
- nr_months_recurring: e.g. 60 is 5 years
|
||||
|
||||
## discrete revenue/cogs (not per item)
|
||||
|
||||
cogs stands for cost of goods
|
||||
|
||||
- revenue: one of revenue, can be extrapolated if specified
|
||||
- cogs: cost of goods, this is the cost of the revenue, can be extrapolated if specified
|
||||
- cogs_percent: percent of revenue
|
||||
- cogs_delay: delay in months between cogs and revenue
|
||||
- extrapolate: if you want to extrapolate revenue or cogs do extrapolate:1, default is 0
|
||||
|
||||
### results in
|
||||
|
||||
follow rows in sheets
|
||||
|
||||
- {name}_ + all the arg names as mentioned above...
|
||||
- {name}_revenue_total
|
||||
- {name}_cogs_total
|
||||
|
||||
## grouped per items sold
|
||||
|
||||
- nr_sold: how many do we sell per month (is in growth format e.g. 10:100,20:200, default is 1)
|
||||
- revenue_item_setup, revenue for 1 item '1000usd'
|
||||
- revenue_item_setup_delay, delay between sell and recognition of sale in months e.g. 1
|
||||
- revenue_item_monthly, revenue per month for 1 item
|
||||
- revenue_item_monthly_delay, how many months before monthly revenue starts
|
||||
- revenue_item_monthly_perc, how much percent of revenue_item_setup will come back over months e.g. 20%
|
||||
- cogs_item_setup, cost of good for 1 item at setup
|
||||
- cogs_item_setup_rev_perc: what is percentage of the revenue which is cogs, e.g. 2%
|
||||
- cogs_item_monthly, cost of goods for the monthly per 1 item
|
||||
- cogs_item_monthly_rev_perc: what is percentage of the monthly revenue which is cogs, e.g. 10%
|
||||
- cogs_item_delay, how many months before cogs starts after sales
|
||||
|
||||
### results in
|
||||
|
||||
follow rows in sheets
|
||||
|
||||
- {name}_ + all the arg names as mentioned above...
|
||||
- {name}_revenue_item_setup_total
|
||||
- {name}_revenue_item_monthly_total
|
||||
- {name}_revenue_item_total
|
||||
|
||||
- {name}_cogs_item_total
|
||||
|
||||
## to use
|
||||
|
||||
### basic example
|
||||
|
||||
```v
|
||||
|
||||
import incubaid.herolib.biz.bizmodel
|
||||
import os
|
||||
|
||||
heroscript:="
|
||||
|
||||
Next will define an OEM product in month 10, 1 Million EUR, ... cogs is a percent which is 20% at start but goes to 10% after 20 months.
|
||||
|
||||
!!bizmodel.revenue_define bizname:'test' name:'oem1'
|
||||
descr:'OEM Deals'
|
||||
revenue:'10:1000000EUR,15:3333,20:1200000'
|
||||
cogs_percent: '1:20%,20:10%'
|
||||
|
||||
|
||||
This time we have the cogs defined in fixed manner, the default currency is USD doesn't have to be mentioned.
|
||||
|
||||
!!bizmodel.revenue_define bizname:'test' name:'oem2'
|
||||
descr:'OEM Deals'
|
||||
revenue:'10:1000000EUR,15:3333,20:1200000'
|
||||
cogs: '10:100000,15:1000,20:120000'
|
||||
"
|
||||
|
||||
bizmodel.play(heroscript:heroscript)!
|
||||
|
||||
mut bm:=bizmodel.get("test")!
|
||||
|
||||
bm.sheet.pprint()!
|
||||
|
||||
```
|
||||
38
aiprompts/bizmodel/costs.heroscript
Normal file
38
aiprompts/bizmodel/costs.heroscript
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
//need to define some revenue because otherwise can't see how HR relates to it
|
||||
!!bizmodel.revenue_define bizname:'test' name:'oem1' extrapolate:1
|
||||
descr:'OEM Deals' revenue:'0:1000000,60:10000000'
|
||||
cogs_percent: '0:20%'
|
||||
|
||||
!!bizmodel.department_define bizname:'test' name:'marketing'
|
||||
descr:'Marketing Department'
|
||||
|
||||
!!bizmodel.department_define bizname:'test' name:'engineering'
|
||||
descr:'Engineering Department'
|
||||
|
||||
!!bizmodel.costcenter_define bizname:'test' name:'marketing_cc'
|
||||
descr:'Marketing Cost Center'
|
||||
department:'marketing'
|
||||
|
||||
!!bizmodel.cost_define bizname:'test' name:'office_rent'
|
||||
descr:'Office Rent'
|
||||
cost:'8000USD'
|
||||
indexation:'3%'
|
||||
costcenter:'marketing_cc'
|
||||
cost_percent_revenue:'0.5%'
|
||||
|
||||
!!bizmodel.cost_define bizname:'test' name:'travel'
|
||||
descr:'Office Rent'
|
||||
cost:'2:5000USD' //start month 3
|
||||
costcenter:'marketing_cc'
|
||||
|
||||
!!bizmodel.cost_define bizname:'test' name:'triptomoon'
|
||||
descr:'Office Rent'
|
||||
cost:'10:500000USD' extrapolate:0 //this means we do a one off cost in this case month 11
|
||||
costcenter:'marketing_cc'
|
||||
|
||||
|
||||
// !!bizmodel.cost_define bizname:'test' name:'software_licenses'
|
||||
// descr:'Annual Software Licenses'
|
||||
// cost:'0:10000 10:EUR:20kCHF,12:5000USD'
|
||||
// department:'engineering'
|
||||
@@ -1 +0,0 @@
|
||||
../lib/data/currency/readme.md
|
||||
@@ -1,340 +0,0 @@
|
||||
module datatypes
|
||||
|
||||
# datatypes
|
||||
|
||||
This module provides implementations of less frequently used, but still common data types.
|
||||
|
||||
V's `builtin` module is imported implicitly, and has implementations for arrays, maps and strings. These are good for many applications, but there are a plethora of other useful data structures/containers, like linked lists, priority queues, trees, etc, that allow for algorithms with different time complexities, which may be more suitable for your specific application.
|
||||
|
||||
It is implemented using generics, that you have to specialise for the type of your actual elements. For example:
|
||||
```v
|
||||
import datatypes
|
||||
|
||||
mut stack := datatypes.Stack[int]{}
|
||||
stack.push(1)
|
||||
println(stack)
|
||||
```
|
||||
|
||||
## Currently Implemented Datatypes:
|
||||
|
||||
- [x] Linked list
|
||||
- [x] Doubly linked list
|
||||
- [x] Stack (LIFO)
|
||||
- [x] Queue (FIFO)
|
||||
- [x] Min heap (priority queue)
|
||||
- [x] Set
|
||||
- [x] Quadtree
|
||||
- [x] Bloom filter
|
||||
- [ ] ...
|
||||
|
||||
|
||||
fn new_bloom_filter[T](hash_func fn (T) u32, table_size int, num_functions int) !&BloomFilter[T]
|
||||
new_bloom_filter creates a new bloom_filter. `table_size` should be greater than 0, and `num_functions` should be 1~16.
|
||||
fn new_bloom_filter_fast[T](hash_func fn (T) u32) &BloomFilter[T]
|
||||
new_bloom_filter_fast creates a new bloom_filter. `table_size` is 16384, and `num_functions` is 4.
|
||||
fn new_ringbuffer[T](s int) RingBuffer[T]
|
||||
new_ringbuffer creates an empty ring buffer of size `s`.
|
||||
fn (mut bst BSTree[T]) insert(value T) bool
|
||||
insert give the possibility to insert an element in the BST.
|
||||
fn (bst &BSTree[T]) contains(value T) bool
|
||||
contains checks if an element with a given `value` is inside the BST.
|
||||
fn (mut bst BSTree[T]) remove(value T) bool
|
||||
remove removes an element with `value` from the BST.
|
||||
fn (bst &BSTree[T]) is_empty() bool
|
||||
is_empty checks if the BST is empty
|
||||
fn (bst &BSTree[T]) in_order_traversal() []T
|
||||
in_order_traversal traverses the BST in order, and returns the result as an array.
|
||||
fn (bst &BSTree[T]) post_order_traversal() []T
|
||||
post_order_traversal traverses the BST in post order, and returns the result in an array.
|
||||
fn (bst &BSTree[T]) pre_order_traversal() []T
|
||||
pre_order_traversal traverses the BST in pre order, and returns the result as an array.
|
||||
fn (bst &BSTree[T]) to_left(value T) !T
|
||||
to_left returns the value of the node to the left of the node with `value` specified if it exists, otherwise the a false value is returned.
|
||||
|
||||
An example of usage can be the following one
|
||||
```v
|
||||
left_value, exist := bst.to_left(10)
|
||||
```
|
||||
fn (bst &BSTree[T]) to_right(value T) !T
|
||||
to_right return the value of the element to the right of the node with `value` specified, if exist otherwise, the boolean value is false An example of usage can be the following one
|
||||
|
||||
```v
|
||||
left_value, exist := bst.to_right(10)
|
||||
```
|
||||
fn (bst &BSTree[T]) max() !T
|
||||
max return the max element inside the BST. Time complexity O(N) if the BST is not balanced
|
||||
fn (bst &BSTree[T]) min() !T
|
||||
min return the minimum element in the BST. Time complexity O(N) if the BST is not balanced.
|
||||
fn (mut b BloomFilter[T]) add(element T)
|
||||
adds the element to bloom filter.
|
||||
fn (b &BloomFilter[T]) exists(element T) bool
|
||||
checks the element is exists.
|
||||
fn (l &BloomFilter[T]) @union(r &BloomFilter[T]) !&BloomFilter[T]
|
||||
@union returns the union of the two bloom filters.
|
||||
fn (l &BloomFilter[T]) intersection(r &BloomFilter[T]) !&BloomFilter[T]
|
||||
intersection returns the intersection of bloom filters.
|
||||
fn (list DoublyLinkedList[T]) is_empty() bool
|
||||
is_empty checks if the linked list is empty
|
||||
fn (list DoublyLinkedList[T]) len() int
|
||||
len returns the length of the linked list
|
||||
fn (list DoublyLinkedList[T]) first() !T
|
||||
first returns the first element of the linked list
|
||||
fn (list DoublyLinkedList[T]) last() !T
|
||||
last returns the last element of the linked list
|
||||
fn (mut list DoublyLinkedList[T]) push_back(item T)
|
||||
push_back adds an element to the end of the linked list
|
||||
fn (mut list DoublyLinkedList[T]) push_front(item T)
|
||||
push_front adds an element to the beginning of the linked list
|
||||
fn (mut list DoublyLinkedList[T]) push_many(elements []T, direction Direction)
|
||||
push_many adds array of elements to the beginning of the linked list
|
||||
fn (mut list DoublyLinkedList[T]) pop_back() !T
|
||||
pop_back removes the last element of the linked list
|
||||
fn (mut list DoublyLinkedList[T]) pop_front() !T
|
||||
pop_front removes the last element of the linked list
|
||||
fn (mut list DoublyLinkedList[T]) insert(idx int, item T) !
|
||||
insert adds an element to the linked list at the given index
|
||||
fn (list &DoublyLinkedList[T]) index(item T) !int
|
||||
index searches the linked list for item and returns the forward index or none if not found.
|
||||
fn (mut list DoublyLinkedList[T]) delete(idx int)
|
||||
delete removes index idx from the linked list and is safe to call for any idx.
|
||||
fn (list DoublyLinkedList[T]) str() string
|
||||
str returns a string representation of the linked list
|
||||
fn (list DoublyLinkedList[T]) array() []T
|
||||
array returns a array representation of the linked list
|
||||
fn (mut list DoublyLinkedList[T]) next() ?T
|
||||
next implements the iter interface to use DoublyLinkedList with V's `for x in list {` loop syntax.
|
||||
fn (mut list DoublyLinkedList[T]) iterator() DoublyListIter[T]
|
||||
iterator returns a new iterator instance for the `list`.
|
||||
fn (mut list DoublyLinkedList[T]) back_iterator() DoublyListIterBack[T]
|
||||
back_iterator returns a new backwards iterator instance for the `list`.
|
||||
fn (mut iter DoublyListIterBack[T]) next() ?T
|
||||
next returns *the previous* element of the list, or `none` when the start of the list is reached. It is called by V's `for x in iter{` on each iteration.
|
||||
fn (mut iter DoublyListIter[T]) next() ?T
|
||||
next returns *the next* element of the list, or `none` when the end of the list is reached. It is called by V's `for x in iter{` on each iteration.
|
||||
fn (list LinkedList[T]) is_empty() bool
|
||||
is_empty checks if the linked list is empty
|
||||
fn (list LinkedList[T]) len() int
|
||||
len returns the length of the linked list
|
||||
fn (list LinkedList[T]) first() !T
|
||||
first returns the first element of the linked list
|
||||
fn (list LinkedList[T]) last() !T
|
||||
last returns the last element of the linked list
|
||||
fn (list LinkedList[T]) index(idx int) !T
|
||||
index returns the element at the given index of the linked list
|
||||
fn (mut list LinkedList[T]) push(item T)
|
||||
push adds an element to the end of the linked list
|
||||
fn (mut list LinkedList[T]) push_many(elements []T)
|
||||
push adds an array of elements to the end of the linked list
|
||||
fn (mut list LinkedList[T]) pop() !T
|
||||
pop removes the last element of the linked list
|
||||
fn (mut list LinkedList[T]) shift() !T
|
||||
shift removes the first element of the linked list
|
||||
fn (mut list LinkedList[T]) insert(idx int, item T) !
|
||||
insert adds an element to the linked list at the given index
|
||||
fn (mut list LinkedList[T]) prepend(item T)
|
||||
prepend adds an element to the beginning of the linked list (equivalent to insert(0, item))
|
||||
fn (list LinkedList[T]) str() string
|
||||
str returns a string representation of the linked list
|
||||
fn (list LinkedList[T]) array() []T
|
||||
array returns a array representation of the linked list
|
||||
fn (mut list LinkedList[T]) next() ?T
|
||||
next implements the iteration interface to use LinkedList with V's `for` loop syntax.
|
||||
fn (mut list LinkedList[T]) iterator() ListIter[T]
|
||||
iterator returns a new iterator instance for the `list`.
|
||||
fn (mut iter ListIter[T]) next() ?T
|
||||
next returns the next element of the list, or `none` when the end of the list is reached. It is called by V's `for x in iter{` on each iteration.
|
||||
fn (mut heap MinHeap[T]) insert(item T)
|
||||
insert adds an element to the heap.
|
||||
fn (mut heap MinHeap[T]) insert_many(elements []T)
|
||||
insert array of elements to the heap.
|
||||
fn (mut heap MinHeap[T]) pop() !T
|
||||
pop removes the top-most element from the heap.
|
||||
fn (heap MinHeap[T]) peek() !T
|
||||
peek gets the top-most element from the heap without removing it.
|
||||
fn (heap MinHeap[T]) len() int
|
||||
len returns the number of elements in the heap.
|
||||
fn (queue Queue[T]) is_empty() bool
|
||||
is_empty checks if the queue is empty
|
||||
fn (queue Queue[T]) len() int
|
||||
len returns the length of the queue
|
||||
fn (queue Queue[T]) peek() !T
|
||||
peek returns the head of the queue (first element added)
|
||||
fn (queue Queue[T]) last() !T
|
||||
last returns the tail of the queue (last element added)
|
||||
fn (queue Queue[T]) index(idx int) !T
|
||||
index returns the element at the given index of the queue
|
||||
fn (mut queue Queue[T]) push(item T)
|
||||
push adds an element to the tail of the queue
|
||||
fn (mut queue Queue[T]) pop() !T
|
||||
pop removes the element at the head of the queue and returns it
|
||||
fn (queue Queue[T]) str() string
|
||||
str returns a string representation of the queue
|
||||
fn (queue Queue[T]) array() []T
|
||||
array returns a array representation of the queue
|
||||
fn (mut rb RingBuffer[T]) push(element T) !
|
||||
push adds an element to the ring buffer.
|
||||
fn (mut rb RingBuffer[T]) pop() !T
|
||||
pop returns the oldest element in the buffer.
|
||||
fn (mut rb RingBuffer[T]) push_many(elements []T) !
|
||||
push_many pushes an array to the buffer.
|
||||
fn (mut rb RingBuffer[T]) pop_many(n u64) ![]T
|
||||
pop_many returns `n` elements of the buffer starting with the oldest one.
|
||||
fn (rb RingBuffer[T]) is_empty() bool
|
||||
is_empty returns `true` if the ring buffer is empty, `false` otherwise.
|
||||
fn (rb RingBuffer[T]) is_full() bool
|
||||
is_full returns `true` if the ring buffer is full, `false` otherwise.
|
||||
fn (rb RingBuffer[T]) capacity() int
|
||||
capacity returns the capacity of the ring buffer.
|
||||
fn (mut rb RingBuffer[T]) clear()
|
||||
clear empties the ring buffer and all pushed elements.
|
||||
fn (rb RingBuffer[T]) occupied() int
|
||||
occupied returns the occupied capacity of the buffer.
|
||||
fn (rb RingBuffer[T]) remaining() int
|
||||
remaining returns the remaining capacity of the buffer.
|
||||
fn (set Set[T]) exists(element T) bool
|
||||
checks the element is exists.
|
||||
fn (mut set Set[T]) add(element T)
|
||||
adds the element to set, if it is not present already.
|
||||
fn (mut set Set[T]) remove(element T)
|
||||
removes the element from set.
|
||||
fn (set Set[T]) pick() !T
|
||||
pick returns an arbitrary element of set, if set is not empty.
|
||||
fn (mut set Set[T]) rest() ![]T
|
||||
rest returns the set consisting of all elements except for the arbitrary element.
|
||||
fn (mut set Set[T]) pop() !T
|
||||
pop returns an arbitrary element and deleting it from set.
|
||||
fn (mut set Set[T]) clear()
|
||||
delete all elements of set.
|
||||
fn (l Set[T]) == (r Set[T]) bool
|
||||
== checks whether the two given sets are equal (i.e. contain all and only the same elements).
|
||||
fn (set Set[T]) is_empty() bool
|
||||
is_empty checks whether the set is empty or not.
|
||||
fn (set Set[T]) size() int
|
||||
size returns the number of elements in the set.
|
||||
fn (set Set[T]) copy() Set[T]
|
||||
copy returns a copy of all the elements in the set.
|
||||
fn (mut set Set[T]) add_all(elements []T)
|
||||
add_all adds the whole `elements` array to the set
|
||||
fn (l Set[T]) @union(r Set[T]) Set[T]
|
||||
@union returns the union of the two sets.
|
||||
fn (l Set[T]) intersection(r Set[T]) Set[T]
|
||||
intersection returns the intersection of sets.
|
||||
fn (l Set[T]) - (r Set[T]) Set[T]
|
||||
- returns the difference of sets.
|
||||
fn (l Set[T]) subset(r Set[T]) bool
|
||||
subset returns true if the set `r` is a subset of the set `l`.
|
||||
fn (stack Stack[T]) is_empty() bool
|
||||
is_empty checks if the stack is empty
|
||||
fn (stack Stack[T]) len() int
|
||||
len returns the length of the stack
|
||||
fn (stack Stack[T]) peek() !T
|
||||
peek returns the top of the stack
|
||||
fn (mut stack Stack[T]) push(item T)
|
||||
push adds an element to the top of the stack
|
||||
fn (mut stack Stack[T]) pop() !T
|
||||
pop removes the element at the top of the stack and returns it
|
||||
fn (stack Stack[T]) str() string
|
||||
str returns a string representation of the stack
|
||||
fn (stack Stack[T]) array() []T
|
||||
array returns a array representation of the stack
|
||||
enum Direction {
|
||||
front
|
||||
back
|
||||
}
|
||||
struct AABB {
|
||||
pub mut:
|
||||
x f64
|
||||
y f64
|
||||
width f64
|
||||
height f64
|
||||
}
|
||||
struct BSTree[T] {
|
||||
mut:
|
||||
root &BSTreeNode[T] = unsafe { 0 }
|
||||
}
|
||||
Pure Binary Seach Tree implementation
|
||||
|
||||
Pure V implementation of the Binary Search Tree Time complexity of main operation O(log N) Space complexity O(N)
|
||||
struct DoublyLinkedList[T] {
|
||||
mut:
|
||||
head &DoublyListNode[T] = unsafe { 0 }
|
||||
tail &DoublyListNode[T] = unsafe { 0 }
|
||||
// Internal iter pointer for allowing safe modification
|
||||
// of the list while iterating. TODO: use an option
|
||||
// instead of a pointer to determine it is initialized.
|
||||
iter &DoublyListIter[T] = unsafe { 0 }
|
||||
len int
|
||||
}
|
||||
DoublyLinkedList[T] represents a generic doubly linked list of elements, each of type T.
|
||||
struct DoublyListIter[T] {
|
||||
mut:
|
||||
node &DoublyListNode[T] = unsafe { 0 }
|
||||
}
|
||||
DoublyListIter[T] is an iterator for DoublyLinkedList. It starts from *the start* and moves forwards to *the end* of the list. It can be used with V's `for x in iter {` construct. One list can have multiple independent iterators, pointing to different positions/places in the list. A DoublyListIter iterator instance always traverses the list from *start to finish*.
|
||||
struct DoublyListIterBack[T] {
|
||||
mut:
|
||||
node &DoublyListNode[T] = unsafe { 0 }
|
||||
}
|
||||
DoublyListIterBack[T] is an iterator for DoublyLinkedList. It starts from *the end* and moves backwards to *the start* of the list. It can be used with V's `for x in iter {` construct. One list can have multiple independent iterators, pointing to different positions/places in the list. A DoublyListIterBack iterator instance always traverses the list from *finish to start*.
|
||||
struct LinkedList[T] {
|
||||
mut:
|
||||
head &ListNode[T] = unsafe { 0 }
|
||||
len int
|
||||
// Internal iter pointer for allowing safe modification
|
||||
// of the list while iterating. TODO: use an option
|
||||
// instead of a pointer to determine if it is initialized.
|
||||
iter &ListIter[T] = unsafe { 0 }
|
||||
}
|
||||
struct ListIter[T] {
|
||||
mut:
|
||||
node &ListNode[T] = unsafe { 0 }
|
||||
}
|
||||
ListIter[T] is an iterator for LinkedList. It can be used with V's `for x in iter {` construct. One list can have multiple independent iterators, pointing to different positions/places in the list. An iterator instance always traverses the list from start to finish.
|
||||
struct ListNode[T] {
|
||||
mut:
|
||||
data T
|
||||
next &ListNode[T] = unsafe { 0 }
|
||||
}
|
||||
struct MinHeap[T] {
|
||||
mut:
|
||||
data []T
|
||||
}
|
||||
MinHeap is a binary minimum heap data structure.
|
||||
struct Quadtree {
|
||||
pub mut:
|
||||
perimeter AABB
|
||||
capacity int
|
||||
depth int
|
||||
level int
|
||||
particles []AABB
|
||||
nodes []Quadtree
|
||||
}
|
||||
fn (mut q Quadtree) create(x f64, y f64, width f64, height f64, capacity int, depth int, level int) Quadtree
|
||||
create returns a new configurable root node for the tree.
|
||||
fn (mut q Quadtree) insert(p AABB)
|
||||
insert recursively adds a particle in the correct index of the tree.
|
||||
fn (mut q Quadtree) retrieve(p AABB) []AABB
|
||||
retrieve recursively checks if a particle is in a specific index of the tree.
|
||||
fn (mut q Quadtree) clear()
|
||||
clear flushes out nodes and particles from the tree.
|
||||
fn (q Quadtree) get_nodes() []Quadtree
|
||||
get_nodes recursively returns the subdivisions the tree has.
|
||||
struct Queue[T] {
|
||||
mut:
|
||||
elements LinkedList[T]
|
||||
}
|
||||
struct RingBuffer[T] {
|
||||
mut:
|
||||
reader int // index of the tail where data is going to be read
|
||||
writer int // index of the head where data is going to be written
|
||||
content []T
|
||||
}
|
||||
RingBuffer represents a ring buffer also known as a circular buffer.
|
||||
struct Set[T] {
|
||||
mut:
|
||||
elements map[T]u8
|
||||
}
|
||||
struct Stack[T] {
|
||||
mut:
|
||||
elements []T
|
||||
}
|
||||
@@ -1,79 +0,0 @@
|
||||
|
||||
## how internally a heroscript gets parsed for params
|
||||
|
||||
- example to show how a heroscript gets parsed in action with params
|
||||
- params are part of action object
|
||||
|
||||
```heroscript
|
||||
example text to parse (heroscript)
|
||||
|
||||
id:a1 name6:aaaaa
|
||||
name:'need to do something 1'
|
||||
description:
|
||||
'
|
||||
## markdown works in it
|
||||
description can be multiline
|
||||
lets see what happens
|
||||
|
||||
- a
|
||||
- something else
|
||||
|
||||
### subtitle
|
||||
'
|
||||
|
||||
name2: test
|
||||
name3: hi
|
||||
name10:'this is with space' name11:aaa11
|
||||
|
||||
name4: 'aaa'
|
||||
|
||||
//somecomment
|
||||
name5: 'aab'
|
||||
```
|
||||
|
||||
the params are part of the action and are represented as follow for the above:
|
||||
|
||||
```vlang
|
||||
Params{
|
||||
params: [Param{
|
||||
key: 'id'
|
||||
value: 'a1'
|
||||
}, Param{
|
||||
key: 'name6'
|
||||
value: 'aaaaa'
|
||||
}, Param{
|
||||
key: 'name'
|
||||
value: 'need to do something 1'
|
||||
}, Param{
|
||||
key: 'description'
|
||||
value: '## markdown works in it
|
||||
|
||||
description can be multiline
|
||||
lets see what happens
|
||||
|
||||
- a
|
||||
- something else
|
||||
|
||||
### subtitle
|
||||
'
|
||||
}, Param{
|
||||
key: 'name2'
|
||||
value: 'test'
|
||||
}, Param{
|
||||
key: 'name3'
|
||||
value: 'hi'
|
||||
}, Param{
|
||||
key: 'name10'
|
||||
value: 'this is with space'
|
||||
}, Param{
|
||||
key: 'name11'
|
||||
value: 'aaa11'
|
||||
}, Param{
|
||||
key: 'name4'
|
||||
value: 'aaa'
|
||||
}, Param{
|
||||
key: 'name5'
|
||||
value: 'aab'
|
||||
}]
|
||||
}
|
||||
```
|
||||
@@ -1 +0,0 @@
|
||||
../crystallib/virt/docker/readme.md
|
||||
345
aiprompts/docusaurus/docusaurus_ebook_manual.md
Normal file
345
aiprompts/docusaurus/docusaurus_ebook_manual.md
Normal file
@@ -0,0 +1,345 @@
|
||||
# HeroLib Docusaurus Ebook Manual for AI Prompts
|
||||
|
||||
This manual provides a comprehensive guide on how to leverage HeroLib's Docusaurus integration, Doctree, and HeroScript to create and manage technical ebooks, optimized for AI-driven content generation and project management.
|
||||
|
||||
## 1. Core Concepts
|
||||
|
||||
To effectively create ebooks with HeroLib, it's crucial to understand the interplay of three core components:
|
||||
|
||||
* **HeroScript**: A concise scripting language used to define the structure, configuration, and content flow of your Docusaurus site. It acts as the declarative interface for the entire process.
|
||||
* **Docusaurus**: A popular open-source static site generator. HeroLib uses Docusaurus as the underlying framework to render your ebook content into a navigable website.
|
||||
* **Doctree**: HeroLib's content management system. Doctree organizes your markdown files into "collections" and "pages," allowing for structured content retrieval and reuse across multiple projects.
|
||||
|
||||
## 2. Setting Up a Docusaurus Project with HeroLib
|
||||
|
||||
The `docusaurus` module in HeroLib provides the primary interface for managing your ebook projects.
|
||||
|
||||
### 2.1. Defining the Docusaurus Factory (`docusaurus.define`)
|
||||
|
||||
The `docusaurus.define` HeroScript directive configures the global settings for your Docusaurus build environment. This is typically used once at the beginning of your main HeroScript configuration.
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
!!docusaurus.define
|
||||
path_build: "/tmp/my_ebook_build"
|
||||
path_publish: "/tmp/my_ebook_publish"
|
||||
production: true
|
||||
update: true
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `path_build` (string, optional): The local path where the Docusaurus site will be built. Defaults to `~/hero/var/docusaurus/build`.
|
||||
* `path_publish` (string, optional): The local path where the final Docusaurus site will be published (e.g., for deployment). Defaults to `~/hero/var/docusaurus/publish`.
|
||||
* `production` (boolean, optional): If `true`, the site will be built for production (optimized). Default is `false`.
|
||||
* `update` (boolean, optional): If `true`, the Docusaurus template and dependencies will be updated. Default is `false`.
|
||||
|
||||
### 2.2. Adding a Docusaurus Site (`docusaurus.add`)
|
||||
|
||||
The `docusaurus.add` directive defines an individual Docusaurus site (your ebook). You can specify the source of your documentation content, whether it's a local path or a Git repository.
|
||||
|
||||
**HeroScript Example (Local Content):**
|
||||
|
||||
```heroscript
|
||||
!!docusaurus.add
|
||||
name:"my_local_ebook"
|
||||
path:"./my_ebook_content" // Path to your local docs directory
|
||||
open:true // Open in browser after generation
|
||||
```
|
||||
|
||||
**HeroScript Example (Git Repository Content):**
|
||||
|
||||
```heroscript
|
||||
!!docusaurus.add
|
||||
name:"tfgrid_tech_ebook"
|
||||
git_url:"https://git.threefold.info/tfgrid/docs_tfgrid4/src/branch/main/ebooks/tech"
|
||||
git_reset:true // Reset Git repository before pulling
|
||||
git_pull:true // Pull latest changes
|
||||
git_root:"/tmp/git_clones" // Optional: specify a root directory for git clones
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `name` (string, optional): A unique name for your Docusaurus site/ebook. Defaults to "main".
|
||||
* `path` (string, optional): The local file system path to the root of your documentation content (e.g., where your `docs` and `cfg` directories are).
|
||||
* `git_url` (string, optional): A Git URL to a repository containing your documentation content. HeroLib will clone/pull this repository.
|
||||
* `git_reset` (boolean, optional): If `true`, the Git repository will be reset to a clean state before pulling. Default is `false`.
|
||||
* `git_pull` (boolean, optional): If `true`, the Git repository will be pulled to get the latest changes. Default is `false`.
|
||||
* `git_root` (string, optional): An optional root directory where Git repositories will be cloned.
|
||||
* `nameshort` (string, optional): A shorter name for the Docusaurus site. Defaults to the value of `name`.
|
||||
* `path_publish` (string, optional): Overrides the factory's `path_publish` for this specific site.
|
||||
* `production` (boolean, optional): Overrides the factory's `production` setting for this specific site.
|
||||
* `watch_changes` (boolean, optional): If `true`, HeroLib will watch for changes in your source `docs` directory and trigger rebuilds. Default is `true`.
|
||||
* `update` (boolean, optional): If `true`, this specific documentation will be updated. Default is `false`.
|
||||
* `open` (boolean, optional): If `true`, the Docusaurus site will be opened in your default browser after generation/development server start. Default is `false`.
|
||||
* `init` (boolean, optional): If `true`, the Docusaurus site will be initialized (e.g., creating missing `docs` directories). Default is `false`.
|
||||
|
||||
## 3. Structuring Content with HeroScript and Doctree
|
||||
|
||||
The actual content and structure of your ebook are defined using HeroScript directives within your site's configuration files (e.g., in a `cfg` directory within your `path` or `git_url` source).
|
||||
|
||||
### 3.1. Site Configuration (`site.config`, `site.config_meta`)
|
||||
|
||||
These directives define the fundamental properties and metadata of your Docusaurus site.
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
!!site.config
|
||||
name:"my_awesome_ebook"
|
||||
title:"My Awesome Ebook Title"
|
||||
tagline:"A comprehensive guide to everything."
|
||||
url:"https://my-ebook.example.com"
|
||||
url_home:"docs/"
|
||||
base_url:"/my-ebook/"
|
||||
favicon:"img/favicon.png"
|
||||
copyright:"© 2024 My Organization"
|
||||
|
||||
!!site.config_meta
|
||||
description:"This ebook covers advanced topics in AI and software engineering."
|
||||
image:"https://my-ebook.example.com/img/social_share.png"
|
||||
title:"Advanced AI & Software Engineering Ebook"
|
||||
keywords:"AI, software, engineering, manual, guide"
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.config`**:
|
||||
* `name` (string, required): Unique identifier for the site.
|
||||
* `title` (string, optional): Main title of the site. Defaults to "My Documentation Site".
|
||||
* `description` (string, optional): General site description.
|
||||
* `tagline` (string, optional): Short tagline for the site.
|
||||
* `favicon` (string, optional): Path to the favicon. Defaults to "img/favicon.png".
|
||||
* `image` (string, optional): General site image (e.g., for social media previews). Defaults to "img/tf_graph.png".
|
||||
* `copyright` (string, optional): Copyright notice. Defaults to "© [Current Year] Example Organization".
|
||||
* `url` (string, optional): The main URL where the site will be hosted.
|
||||
* `base_url` (string, optional): The base URL for Docusaurus (e.g., `/` or `/my-ebook/`).
|
||||
* `url_home` (string, optional): The path to the home page relative to `base_url`.
|
||||
* **`site.config_meta`**: Overrides for specific SEO metadata.
|
||||
* `title` (string, optional): Specific title for SEO (e.g., `<meta property="og:title">`).
|
||||
* `image` (string, optional): Specific image for SEO (e.g., `<meta property="og:image">`).
|
||||
* `description` (string, optional): Specific description for SEO.
|
||||
* `keywords` (string, optional): Comma-separated keywords for SEO.
|
||||
|
||||
### 3.2. Navigation Bar (`site.navbar`, `site.navbar_item`)
|
||||
|
||||
Define the main navigation menu of your Docusaurus site.
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
!!site.navbar
|
||||
title:"Ebook Navigation"
|
||||
logo_alt:"Ebook Logo"
|
||||
logo_src:"img/logo.svg"
|
||||
logo_src_dark:"img/logo_dark.svg"
|
||||
|
||||
!!site.navbar_item
|
||||
label:"Introduction"
|
||||
to:"/docs/intro" // Internal Docusaurus path
|
||||
position:"left"
|
||||
|
||||
!!site.navbar_item
|
||||
label:"External Link"
|
||||
href:"https://example.com/external" // External URL
|
||||
position:"right"
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.navbar`**:
|
||||
* `title` (string, optional): Title displayed in the navbar. Defaults to `site.config.title`.
|
||||
* `logo_alt` (string, optional): Alt text for the logo.
|
||||
* `logo_src` (string, optional): Path to the light mode logo.
|
||||
* `logo_src_dark` (string, optional): Path to the dark mode logo.
|
||||
* **`site.navbar_item`**:
|
||||
* `label` (string, required): Text displayed for the menu item.
|
||||
* `href` (string, optional): External URL for the link.
|
||||
* `to` (string, optional): Internal Docusaurus path (e.g., `/docs/my-page`).
|
||||
* `position` (string, optional): "left" or "right" for placement in the navbar. Defaults to "right".
|
||||
|
||||
### 3.3. Footer (`site.footer`, `site.footer_item`)
|
||||
|
||||
Configure the footer section of your Docusaurus site.
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
!!site.footer
|
||||
style:"dark" // "dark" or "light"
|
||||
|
||||
!!site.footer_item
|
||||
title:"Resources" // Grouping title for footer links
|
||||
label:"API Documentation"
|
||||
href:"https://api.example.com/docs"
|
||||
|
||||
!!site.footer_item
|
||||
title:"Community"
|
||||
label:"GitHub"
|
||||
href:"https://github.com/my-org"
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.footer`**:
|
||||
* `style` (string, optional): "dark" or "light" style for the footer. Defaults to "dark".
|
||||
* **`site.footer_item`**:
|
||||
* `title` (string, required): The title under which this item will be grouped in the footer.
|
||||
* `label` (string, required): Text displayed for the footer link.
|
||||
* `href` (string, optional): External URL for the link.
|
||||
* `to` (string, optional): Internal Docusaurus path.
|
||||
|
||||
### 3.4. Build Destinations (`site.build_dest`, `site.build_dest_dev`)
|
||||
|
||||
Specify where the built Docusaurus site should be deployed. This typically involves an SSH connection defined elsewhere (e.g., `!!site.ssh_connection`).
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
!!site.build_dest
|
||||
ssh_name:"production_server" // Name of a pre-defined SSH connection
|
||||
path:"/var/www/my-ebook" // Remote path on the server
|
||||
|
||||
!!site.build_dest_dev
|
||||
ssh_name:"dev_server"
|
||||
path:"/tmp/dev-ebook"
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `ssh_name` (string, required): The name of the SSH connection to use for deployment.
|
||||
* `path` (string, required): The destination path on the remote server.
|
||||
|
||||
### 3.5. Importing External Content (`site.import`)
|
||||
|
||||
This powerful feature allows you to pull markdown content and assets from other Git repositories directly into your Docusaurus site's `docs` directory, with optional text replacement. This is ideal for integrating shared documentation or specifications.
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
!!site.import
|
||||
url:'https://git.threefold.info/tfgrid/docs_tfgrid4/src/branch/main/collections/cloud_reinvented'
|
||||
dest:'cloud_reinvented' // Destination subdirectory within your Docusaurus docs folder
|
||||
replace:'NAME:MyName, URGENCY:red' // Optional: comma-separated key:value pairs for text replacement
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* `url` (string, required): The Git URL of the repository or specific path within a repository to import.
|
||||
* `dest` (string, required): The subdirectory within your Docusaurus `docs` folder where the imported content will be placed.
|
||||
* `replace` (string, optional): A comma-separated string of `KEY:VALUE` pairs. During import, all occurrences of `${KEY}` in the imported content will be replaced with `VALUE`.
|
||||
|
||||
### 3.6. Defining Pages and Categories (`site.page_category`, `site.page`)
|
||||
|
||||
This is where you define the actual content pages and how they are organized into categories within your Docusaurus sidebar.
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
```heroscript
|
||||
// Define a category
|
||||
!!site.page_category path:'introduction' label:"Introduction to Ebook" position:10
|
||||
|
||||
// Define a page within that category, linking to Doctree content
|
||||
!!site.page path:'introduction' src:"my_doctree_collection:chapter_1_overview"
|
||||
title:"Chapter 1: Overview"
|
||||
description:"A brief introduction to the ebook's content."
|
||||
position:1 // Order within the category
|
||||
hide_title:true // Hide the title on the page itself
|
||||
```
|
||||
|
||||
**Arguments:**
|
||||
|
||||
* **`site.page_category`**:
|
||||
* `path` (string, required): The path to the category directory within your Docusaurus `docs` folder (e.g., `introduction` will create `docs/introduction/_category_.json`).
|
||||
* `label` (string, required): The display name for the category in the sidebar.
|
||||
* `position` (int, optional): The order of the category in the sidebar.
|
||||
* `sitename` (string, optional): If you have multiple Docusaurus sites defined, specify which site this category belongs to. Defaults to the current site's name.
|
||||
* **`site.page`**:
|
||||
* `src` (string, required): **Crucial for Doctree integration.** This specifies the source of the page content in the format `collection_name:page_name`. HeroLib will fetch the markdown content from the specified Doctree collection and page.
|
||||
* `path` (string, required): The relative path and filename for the generated markdown file within your Docusaurus `docs` folder (e.g., `introduction/chapter_1.md`). If only a directory is provided (e.g., `introduction/`), the `page_name` from `src` will be used as the filename.
|
||||
* `title` (string, optional): The title of the page. If not provided, HeroLib will attempt to extract it from the markdown content or use the `page_name`.
|
||||
* `description` (string, optional): A short description for the page, used in frontmatter.
|
||||
* `position` (int, optional): The order of the page within its category.
|
||||
* `hide_title` (boolean, optional): If `true`, the title will not be displayed on the page itself.
|
||||
* `draft` (boolean, optional): If `true`, the page will be marked as a draft and not included in production builds.
|
||||
* `title_nr` (int, optional): If set, HeroLib will re-number the markdown headings (e.g., `title_nr:3` will make `# Heading` become `### Heading`). Useful for consistent heading levels across imported content.
|
||||
|
||||
### 3.7. Doctree Integration Details
|
||||
|
||||
The `site.page` directive's `src` parameter (`collection_name:page_name`) is the bridge to your Doctree content.
|
||||
|
||||
**How Doctree Works:**
|
||||
|
||||
1. **Collections**: Doctree organizes markdown files into logical groups called "collections." A collection is typically a directory containing markdown files and an empty `.collection` file.
|
||||
2. **Scanning**: You define which collections Doctree should scan using `!!doctree.scan` in a HeroScript file (e.g., `doctree.heroscript`).
|
||||
**Example `doctree.heroscript`:**
|
||||
|
||||
```heroscript
|
||||
!!doctree.scan git_url:"https://git.threefold.info/tfgrid/docs_tfgrid4/src/branch/main/collections"
|
||||
```
|
||||
|
||||
This will pull the `collections` directory from the specified Git URL and make its contents available to Doctree.
|
||||
3. **Page Retrieval**: When `site.page` references `src:"my_collection:my_page"`, HeroLib's `doctreeclient` fetches the content of `my_page.md` from the `my_collection` collection that Doctree has scanned.
|
||||
|
||||
## 4. Building and Developing Your Ebook
|
||||
|
||||
Once your HeroScript configuration is set up, HeroLib provides commands to build and serve your Docusaurus ebook.
|
||||
|
||||
### 4.1. Generating Site Files (`site.generate()`)
|
||||
|
||||
The `site.generate()` function (called internally by `build`, `dev`, etc.) performs the core file generation:
|
||||
|
||||
* Copies Docusaurus template files.
|
||||
* Copies your site's `src` and `static` assets.
|
||||
* Generates Docusaurus configuration JSON files (`main.json`, `navbar.json`, `footer.json`) from your HeroScript `site.config`, `site.navbar`, and `site.footer` directives.
|
||||
* Copies your source `docs` directory.
|
||||
* Processes `site.page` and `site.page_category` directives using the `sitegen` module to create the final markdown files and `_category_.json` files in the Docusaurus `docs` directory, fetching content from Doctree.
|
||||
* Handles `site.import` directives, pulling external content and performing replacements.
|
||||
|
||||
### 4.2. Local Development
|
||||
|
||||
HeroLib integrates with Docusaurus's development server for live preview.
|
||||
|
||||
**HeroScript Example:**
|
||||
|
||||
can be stored as example_docusaurus.vsh and then used to generate and develop an ebook
|
||||
|
||||
```v
|
||||
#!/usr/bin/env -S v -n -w -gc none -cg -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.web.docusaurus
|
||||
import os
|
||||
|
||||
const cfgpath = os.dir(@FILE)
|
||||
|
||||
docusaurus.new(
|
||||
heroscript: '
|
||||
|
||||
// !!docusaurus.define
|
||||
// path_build: "/tmp/docusaurus_build"
|
||||
// path_publish: "/tmp/docusaurus_publish"
|
||||
|
||||
!!docusaurus.add name:"tfgrid_docs"
|
||||
path:"${cfgpath}"
|
||||
|
||||
!!docusaurus.dev
|
||||
|
||||
'
|
||||
)!
|
||||
|
||||
```
|
||||
|
||||
the following script suggest to call it do.vsh and put in directory of where the ebook is
|
||||
|
||||
```v
|
||||
#!/usr/bin/env -S v -n -w -gc none -cg -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib.web.docusaurus
|
||||
|
||||
const cfgpath = os.dir(@FILE) + '/cfg'
|
||||
|
||||
docusaurus.new(heroscript_path:cfgpath)!
|
||||
```
|
||||
|
||||
by just called do.vsh we can execute on the ebook
|
||||
@@ -1 +0,0 @@
|
||||
../lib/develop/gittools/README.md
|
||||
141
aiprompts/herolib_advanced/advanced_paths.md
Normal file
141
aiprompts/herolib_advanced/advanced_paths.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# Pathlib Module: Advanced Listing and Filtering
|
||||
|
||||
The `pathlib` module provides powerful capabilities for listing and filtering files and directories, especially through its `list` method. This document explains how to leverage advanced features like regular expressions and various filtering options.
|
||||
|
||||
## Advanced File Listing with `path.list()`
|
||||
|
||||
The `path.list()` method allows you to retrieve a `PathList` object containing `Path` objects that match specified criteria.
|
||||
|
||||
### `ListArgs` Parameters
|
||||
|
||||
The `list` method accepts a `ListArgs` struct to control its behavior:
|
||||
|
||||
```v
|
||||
pub struct ListArgs {
|
||||
pub mut:
|
||||
regex []string // A slice of regular expressions to filter files.
|
||||
recursive bool = true // Whether to list files recursively (default true).
|
||||
ignore_default bool = true // Whether to ignore files starting with . and _ (default true).
|
||||
include_links bool // Whether to include symbolic links in the list.
|
||||
dirs_only bool // Whether to include only directories in the list.
|
||||
files_only bool // Whether to include only files in the list.
|
||||
}
|
||||
```
|
||||
|
||||
### Usage Examples
|
||||
|
||||
Here are examples demonstrating how to use these advanced filtering options:
|
||||
|
||||
#### 1. Listing Files by Regex Pattern
|
||||
|
||||
You can use regular expressions to filter files based on their names or extensions. The `regex` parameter accepts a slice of strings, where each string is a regex pattern.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
// Get a directory path
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
// List only Vlang files (ending with .v)
|
||||
mut vlang_files := dir.list(
|
||||
regex: [r'.*\.v$']
|
||||
)!
|
||||
|
||||
// List only image files (png, jpg, svg, jpeg)
|
||||
mut image_files := dir.list(
|
||||
regex: [r'.*\.png$', r'.*\.jpg$', r'.*\.svg$', r'.*\.jpeg$']
|
||||
)!
|
||||
|
||||
// List files containing "test" in their name (case-insensitive)
|
||||
mut test_files := dir.list(
|
||||
regex: [r'(?i).*test.*'] // (?i) makes the regex case-insensitive
|
||||
)!
|
||||
|
||||
for path_obj in vlang_files.paths {
|
||||
println(path_obj.path)
|
||||
}
|
||||
```
|
||||
|
||||
#### 2. Controlling Recursion
|
||||
|
||||
By default, `list()` is recursive. You can disable recursion to list only items in the current directory.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
// List only top-level files and directories (non-recursive)
|
||||
mut top_level_items := dir.list(
|
||||
recursive: false
|
||||
)!
|
||||
|
||||
for path_obj in top_level_items.paths {
|
||||
println(path_obj.path)
|
||||
}
|
||||
```
|
||||
|
||||
#### 3. Including or Excluding Hidden Files
|
||||
|
||||
The `ignore_default` parameter controls whether files and directories starting with `.` or `_` are ignored.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
// List all files and directories, including hidden ones
|
||||
mut all_items := dir.list(
|
||||
ignore_default: false
|
||||
)!
|
||||
|
||||
for path_obj in all_items.paths {
|
||||
println(path_obj.path)
|
||||
}
|
||||
```
|
||||
|
||||
#### 4. Including Symbolic Links
|
||||
|
||||
By default, symbolic links are ignored when walking the directory structure. Set `include_links` to `true` to include them.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
// List files and directories, including symbolic links
|
||||
mut items_with_links := dir.list(
|
||||
include_links: true
|
||||
)!
|
||||
|
||||
for path_obj in items_with_links.paths {
|
||||
println(path_obj.path)
|
||||
}
|
||||
```
|
||||
|
||||
#### 5. Listing Only Directories or Only Files
|
||||
|
||||
Use `dirs_only` or `files_only` to restrict the results to only directories or only files.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.pathlib
|
||||
|
||||
mut dir := pathlib.get('/some/directory')!
|
||||
|
||||
// List only directories (recursive)
|
||||
mut only_dirs := dir.list(
|
||||
dirs_only: true
|
||||
)!
|
||||
|
||||
// List only files (non-recursive)
|
||||
mut only_files := dir.list(
|
||||
files_only: true,
|
||||
recursive: false
|
||||
)!
|
||||
|
||||
for path_obj in only_dirs.paths {
|
||||
println(path_obj.path)
|
||||
}
|
||||
```
|
||||
|
||||
By combining these parameters, you can create highly specific and powerful file system listing operations tailored to your needs.
|
||||
323
aiprompts/herolib_advanced/builder.md
Normal file
323
aiprompts/herolib_advanced/builder.md
Normal file
@@ -0,0 +1,323 @@
|
||||
# Builder Module: System Automation and Remote Execution
|
||||
|
||||
The `builder` module in Herolib provides a powerful framework for automating system tasks and executing commands on both local and remote machines. It offers a unified interface to manage nodes, execute commands, perform file operations, and maintain persistent state.
|
||||
|
||||
## Key Components
|
||||
|
||||
- **`BuilderFactory`**: Responsible for creating and managing `Node` instances.
|
||||
- **`Node`**: Represents a target system (local or remote). It encapsulates system properties (platform, CPU type, environment variables) and provides methods for interaction.
|
||||
- **`Executor`**: An interface (implemented by `ExecutorLocal` and `ExecutorSSH`) that handles the actual command execution and file operations on the target system.
|
||||
- **NodeDB (via `Node.done` map)**: A key-value store within each `Node` for persistent state, caching, and tracking execution history.
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Initializing a Builder and Node
|
||||
|
||||
First, import the `builder` module and create a new `BuilderFactory` instance. Then, create a `Node` object, which can represent either the local machine or a remote server.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder
|
||||
|
||||
// Create a new builder factory
|
||||
mut b := builder.new()!
|
||||
|
||||
// Create a node for the local machine
|
||||
mut local_node := b.node_local()!
|
||||
|
||||
// Create a node for a remote server via SSH
|
||||
// Format: "user@ip_address:port" or "ip_address:port" or "ip_address"
|
||||
mut remote_node := b.node_new(ipaddr: "root@195.192.213.2:2222")!
|
||||
|
||||
// Node with custom name and debug enabled
|
||||
mut named_debug_node := b.node_new(
|
||||
name: "my_remote_server",
|
||||
ipaddr: "user@server.example.com:22",
|
||||
debug: true
|
||||
)!
|
||||
```
|
||||
|
||||
### `Node` Properties
|
||||
|
||||
A `Node` object automatically detects and caches system information. You can access these properties:
|
||||
|
||||
```v
|
||||
// Get platform type (e.g., .osx, .ubuntu, .alpine, .arch)
|
||||
println(node.platform)
|
||||
|
||||
// Get CPU architecture (e.g., .intel, .arm)
|
||||
println(node.cputype)
|
||||
|
||||
// Get hostname
|
||||
println(node.hostname)
|
||||
|
||||
// Get environment variables
|
||||
env_vars := node.environ_get()!
|
||||
println(env_vars['HOME'])
|
||||
|
||||
// Get node information (category, sshkey, user, ipaddress, port)
|
||||
info := node.info()
|
||||
println(info['category'])
|
||||
```
|
||||
|
||||
## Command Execution
|
||||
|
||||
The `Node` object provides methods to execute commands on the target system.
|
||||
|
||||
### `node.exec(args ExecArgs) !string`
|
||||
|
||||
Executes a command and returns its standard output.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder { ExecArgs }
|
||||
|
||||
// Execute a command with stdout
|
||||
result := node.exec(cmd: "ls -la /tmp", stdout: true)!
|
||||
println(result)
|
||||
|
||||
// Execute silently (no stdout)
|
||||
node.exec(cmd: "mkdir -p /tmp/my_dir", stdout: false)!
|
||||
```
|
||||
|
||||
### `node.exec_silent(cmd string) !string`
|
||||
|
||||
Executes a command silently (no stdout) and returns its output.
|
||||
|
||||
```v
|
||||
output := node.exec_silent("echo 'Hello from remote!'")!
|
||||
println(output)
|
||||
```
|
||||
|
||||
### `node.exec_interactive(cmd string) !`
|
||||
|
||||
Executes a command in an interactive shell.
|
||||
|
||||
```v
|
||||
// This will open an interactive shell session
|
||||
node.exec_interactive("bash")!
|
||||
```
|
||||
|
||||
### `node.exec_cmd(args NodeExecCmd) !string`
|
||||
|
||||
A more advanced command execution method that supports caching, periodic execution, and temporary script handling.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder { NodeExecCmd }
|
||||
|
||||
// Execute a command, cache its result for 24 hours (48*3600 seconds)
|
||||
// and provide a description for logging.
|
||||
result := node.exec_cmd(
|
||||
cmd: "apt-get update",
|
||||
period: 48 * 3600,
|
||||
description: "Update system packages"
|
||||
)!
|
||||
println(result)
|
||||
|
||||
// Execute a multi-line script
|
||||
script_output := node.exec_cmd(
|
||||
cmd: "
|
||||
echo 'Starting script...'
|
||||
ls -la /
|
||||
echo 'Script finished.'
|
||||
",
|
||||
name: "my_custom_script",
|
||||
stdout: true
|
||||
)!
|
||||
println(script_output)
|
||||
```
|
||||
|
||||
### `node.exec_retry(args ExecRetryArgs) !string`
|
||||
|
||||
Executes a command with retries until it succeeds or a timeout is reached.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder { ExecRetryArgs }
|
||||
|
||||
// Try to connect to a service, retrying every 100ms for up to 10 seconds
|
||||
result := node.exec_retry(
|
||||
cmd: "curl --fail http://localhost:8080/health",
|
||||
retrymax: 100, // 100 retries
|
||||
period_milli: 100, // 100ms sleep between retries
|
||||
timeout: 10 // 10 seconds total timeout
|
||||
)!
|
||||
println("Service is up: ${result}")
|
||||
```
|
||||
|
||||
### `node.cmd_exists(cmd string) bool`
|
||||
|
||||
Checks if a command exists on the target system.
|
||||
|
||||
```v
|
||||
if node.cmd_exists("docker") {
|
||||
println("Docker is installed.")
|
||||
} else {
|
||||
println("Docker is not installed.")
|
||||
}
|
||||
```
|
||||
|
||||
## File System Operations
|
||||
|
||||
The `Node` object provides comprehensive file and directory management capabilities.
|
||||
|
||||
### `node.file_write(path string, text string) !`
|
||||
|
||||
Writes content to a file on the target system.
|
||||
|
||||
```v
|
||||
node.file_write("/tmp/my_file.txt", "This is some content.")!
|
||||
```
|
||||
|
||||
### `node.file_read(path string) !string`
|
||||
|
||||
Reads content from a file on the target system.
|
||||
|
||||
```v
|
||||
content := node.file_read("/tmp/my_file.txt")!
|
||||
println(content)
|
||||
```
|
||||
|
||||
### `node.file_exists(path string) bool`
|
||||
|
||||
Checks if a file or directory exists on the target system.
|
||||
|
||||
```v
|
||||
if node.file_exists("/tmp/my_file.txt") {
|
||||
println("File exists.")
|
||||
}
|
||||
```
|
||||
|
||||
### `node.delete(path string) !`
|
||||
|
||||
Deletes a file or directory (recursively for directories) on the target system.
|
||||
|
||||
```v
|
||||
node.delete("/tmp/my_dir")!
|
||||
```
|
||||
|
||||
### `node.list(path string) ![]string`
|
||||
|
||||
Lists the contents of a directory on the target system.
|
||||
|
||||
```v
|
||||
files := node.list("/home/user")!
|
||||
for file in files {
|
||||
println(file)
|
||||
}
|
||||
```
|
||||
|
||||
### `node.dir_exists(path string) bool`
|
||||
|
||||
Checks if a directory exists on the target system.
|
||||
|
||||
```v
|
||||
if node.dir_exists("/var/log") {
|
||||
println("Log directory exists.")
|
||||
}
|
||||
```
|
||||
|
||||
### File Transfers (`node.upload` and `node.download`)
|
||||
|
||||
Transfer files between the local machine and the target node using `rsync` or `scp`.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder { SyncArgs }
|
||||
|
||||
// Upload a local file to the remote node
|
||||
node.upload(
|
||||
source: "/local/path/to/my_script.sh",
|
||||
dest: "/tmp/remote_script.sh",
|
||||
stdout: true // Show rsync/scp output
|
||||
)!
|
||||
|
||||
// Download a file from the remote node to the local machine
|
||||
node.download(
|
||||
source: "/var/log/syslog",
|
||||
dest: "/tmp/local_syslog.log",
|
||||
stdout: false
|
||||
)!
|
||||
|
||||
// Upload a directory, ignoring .git and examples folders, and deleting extra files on destination
|
||||
node.upload(
|
||||
source: "/local/repo/",
|
||||
dest: "~/code/my_project/",
|
||||
ignore: [".git/*", "examples/"],
|
||||
delete: true,
|
||||
fast_rsync: true
|
||||
)!
|
||||
```
|
||||
|
||||
## Node Database (`node.done`)
|
||||
|
||||
The `node.done` map provides a simple key-value store for persistent data on the node. This data is cached in Redis.
|
||||
|
||||
```v
|
||||
// Store a value
|
||||
node.done_set("setup_complete", "true")!
|
||||
|
||||
// Retrieve a value
|
||||
status := node.done_get("setup_complete") or { "false" }
|
||||
println("Setup complete: ${status}")
|
||||
|
||||
// Check if a key exists
|
||||
if node.done_exists("initial_config") {
|
||||
println("Initial configuration done.")
|
||||
}
|
||||
|
||||
// Print all stored 'done' items
|
||||
node.done_print()
|
||||
|
||||
// Reset all stored 'done' items
|
||||
node.done_reset()!
|
||||
```
|
||||
|
||||
## Bootstrapping and Updates
|
||||
|
||||
The `bootstrapper` module provides functions for installing and updating Herolib components on nodes.
|
||||
|
||||
### `node.hero_install() !`
|
||||
|
||||
Installs the Herolib environment on the node.
|
||||
|
||||
```v
|
||||
node.hero_install()!
|
||||
```
|
||||
|
||||
### `node.hero_update(args HeroUpdateArgs) !`
|
||||
|
||||
Updates the Herolib code on the node, with options for syncing from local, git reset, or git pull.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder { HeroUpdateArgs }
|
||||
|
||||
// Sync local Herolib code to the remote node (full sync)
|
||||
node.hero_update(sync_from_local: true, sync_full: true)!
|
||||
|
||||
// Reset git repository on the remote node and pull latest from 'dev' branch
|
||||
node.hero_update(git_reset: true, branch: "dev")!
|
||||
```
|
||||
|
||||
### `node.vscript(args VScriptArgs) !`
|
||||
|
||||
Uploads and executes a Vlang script (`.vsh` or `.v`) on the remote node.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder { VScriptArgs }
|
||||
|
||||
// Upload and execute a local V script on the remote node
|
||||
node.vscript(path: "/local/path/to/my_script.vsh", sync_from_local: true)!
|
||||
```
|
||||
|
||||
## Port Forwarding
|
||||
|
||||
The `portforward_to_local` function allows forwarding a remote port on an SSH host to a local port.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.builder { portforward_to_local, ForwardArgsToLocal }
|
||||
|
||||
// Forward remote port 8080 on 192.168.1.100 to local port 9000
|
||||
portforward_to_local(
|
||||
name: "my_app_forward",
|
||||
address: "192.168.1.100",
|
||||
remote_port: 8080,
|
||||
local_port: 9000
|
||||
)!
|
||||
```
|
||||
@@ -0,0 +1,24 @@
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import os
|
||||
import flag
|
||||
|
||||
mut fp := flag.new_flag_parser(os.args)
|
||||
fp.application('compile.vsh')
|
||||
fp.version('v0.1.0')
|
||||
fp.description('Compile hero binary in debug or production mode')
|
||||
fp.skip_executable()
|
||||
|
||||
prod_mode := fp.bool('prod', `p`, false, 'Build production version (optimized)')
|
||||
help_requested := fp.bool('help', `h`, false, 'Show help message')
|
||||
|
||||
if help_requested {
|
||||
println(fp.usage())
|
||||
exit(0)
|
||||
}
|
||||
|
||||
additional_args := fp.finalize() or {
|
||||
eprintln(err)
|
||||
println(fp.usage())
|
||||
exit(1)
|
||||
}
|
||||
78
aiprompts/herolib_advanced/openrpcexample.json
Normal file
78
aiprompts/herolib_advanced/openrpcexample.json
Normal file
@@ -0,0 +1,78 @@
|
||||
{
|
||||
"openrpc": "1.0.0-rc1",
|
||||
"info": {
|
||||
"title": "Simple RPC overview",
|
||||
"version": "2.0.0"
|
||||
},
|
||||
"methods": [
|
||||
{
|
||||
"name": "get_versions",
|
||||
"summary": "List API versions",
|
||||
"params": [],
|
||||
"result": {
|
||||
"name": "get_version_result",
|
||||
"schema": {
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"examples": [
|
||||
{
|
||||
"name": "v2",
|
||||
"summary": "its a v2 example pairing!",
|
||||
"description": "aight so this is how it works. You foo the bar then you baz the razmataz",
|
||||
"params": [],
|
||||
"result": {
|
||||
"name": "versionsExample",
|
||||
"value": {
|
||||
"versions": [
|
||||
{
|
||||
"status": "CURRENT",
|
||||
"updated": "2011-01-21T11:33:21Z",
|
||||
"id": "v2.0",
|
||||
"urls": [
|
||||
{
|
||||
"href": "http://127.0.0.1:8774/v2/",
|
||||
"rel": "self"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"status": "EXPERIMENTAL",
|
||||
"updated": "2013-07-23T11:33:21Z",
|
||||
"id": "v3.0",
|
||||
"urls": [
|
||||
{
|
||||
"href": "http://127.0.0.1:8774/v3/",
|
||||
"rel": "self"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "get_version_details",
|
||||
"summary": "Show API version details",
|
||||
"params": [],
|
||||
"result": {
|
||||
"name": "foo",
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"examples": [
|
||||
{
|
||||
"name": "stringifiedVersionsExample",
|
||||
"params": [],
|
||||
"result": {
|
||||
"name": "bliggityblaow",
|
||||
"value": "{\n \"versions\": [\n {\n \"status\": \"CURRENT\",\n \"updated\": \"2011-01-21T11:33:21Z\",\n \"id\": \"v2.0\",\n \"urls\": [\n {\n \"href\": \"http://127.0.0.1:8774/v2/\",\n \"rel\": \"self\"\n }\n ]\n },\n {\n \"status\": \"EXPERIMENTAL\",\n \"updated\": \"2013-07-23T11:33:21Z\",\n \"id\": \"v3.0\",\n \"urls\": [\n {\n \"href\": \"http://127.0.0.1:8774/v3/\",\n \"rel\": \"self\"\n }\n ]\n }\n ]\n}\n"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
682
aiprompts/herolib_advanced/osal.md
Normal file
682
aiprompts/herolib_advanced/osal.md
Normal file
@@ -0,0 +1,682 @@
|
||||
# OSAL Core Module (incubaid.herolib.osal.core)
|
||||
|
||||
This document describes the core functionalities of the Operating System Abstraction Layer (OSAL) module, designed for platform-independent system operations in V.
|
||||
|
||||
```v
|
||||
//example how to get started
|
||||
|
||||
import incubaid.herolib.osal.core as osal
|
||||
|
||||
osal.exec(...)!
|
||||
|
||||
```
|
||||
|
||||
## 1. Process Management
|
||||
|
||||
### `osal.exec(cmd: Command) !Job`
|
||||
|
||||
Executes a shell command with extensive configuration.
|
||||
|
||||
* **Parameters**:
|
||||
* `cmd` (`Command` struct):
|
||||
* `cmd` (string): The command string.
|
||||
* `timeout` (int, default: 3600): Max execution time in seconds.
|
||||
* `retry` (int): Number of retries on failure.
|
||||
* `work_folder` (string): Working directory.
|
||||
* `environment` (map[string]string): Environment variables.
|
||||
* `stdout` (bool, default: true): Show command output.
|
||||
* `stdout_log` (bool, default: true): Log stdout to internal buffer.
|
||||
* `raise_error` (bool, default: true): Raise V error on failure.
|
||||
* `ignore_error` (bool): Do not raise error, just report.
|
||||
* `debug` (bool): Enable debug output.
|
||||
* `shell` (bool): Execute in interactive shell.
|
||||
* `interactive` (bool, default: true): Run in interactive mode.
|
||||
* `async` (bool): Run command asynchronously.
|
||||
* `runtime` (`RunTime` enum): Specify runtime (`.bash`, `.python`, etc.).
|
||||
* **Returns**: `Job` struct (contains `status`, `output`, `error`, `exit_code`, `start`, `end`, `process`, `runnr`).
|
||||
* **Error Handling**: Returns `JobError` with `error_type` (`.exec`, `.timeout`, `.args`).
|
||||
|
||||
### `osal.execute_silent(cmd string) !string`
|
||||
|
||||
Executes a command silently.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
### `osal.execute_debug(cmd string) !string`
|
||||
|
||||
Executes a command with debug output.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
### `osal.execute_stdout(cmd string) !string`
|
||||
|
||||
Executes a command and prints output to stdout.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `string` (command output).
|
||||
|
||||
### `osal.execute_interactive(cmd string) !`
|
||||
|
||||
### `osal.execute_ok(cmd string) bool`
|
||||
|
||||
Executes a command and returns `true` if the command exits with a zero status, `false` otherwise.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
* **Returns**: `bool`.
|
||||
Executes a command in an interactive shell.
|
||||
|
||||
### `osal.exec_fast(cmd: CommandFast) !string`
|
||||
|
||||
Executes a command quickly, with options for profile sourcing and environment variables.
|
||||
|
||||
* **Parameters**:
|
||||
* `cmd` (`CommandFast` struct):
|
||||
* `cmd` (string): The command string.
|
||||
* `ignore_error` (bool): Do not raise error on non-zero exit code.
|
||||
* `work_folder` (string): Working directory.
|
||||
* `environment` (map[string]string): Environment variables.
|
||||
* `ignore_error_codes` ([]int): List of exit codes to ignore.
|
||||
* `debug` (bool): Enable debug output.
|
||||
* `includeprofile` (bool): Source the user's profile before execution.
|
||||
* `notempty` (bool): Return an error if the output is empty.
|
||||
* **Returns**: `string` (command output).
|
||||
* **Parameters**: `cmd` (string): The command string.
|
||||
|
||||
### `osal.cmd_exists(cmd string) bool`
|
||||
|
||||
Checks if a command exists in the system's PATH.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.processmap_get() !ProcessMap`
|
||||
|
||||
Scans and returns a map of all running processes.
|
||||
|
||||
* **Returns**: `ProcessMap` struct (contains `processes` (`[]ProcessInfo`), `lastscan`, `state`, `pids`).
|
||||
|
||||
### `osal.processinfo_get(pid int) !ProcessInfo`
|
||||
|
||||
Retrieves detailed information for a specific process by PID.
|
||||
|
||||
* **Parameters**: `pid` (int): Process ID.
|
||||
* **Returns**: `ProcessInfo` struct (contains `cpu_perc`, `mem_perc`, `cmd`, `pid`, `ppid`, `rss`).
|
||||
|
||||
### `osal.processinfo_get_byname(name string) ![]ProcessInfo`
|
||||
|
||||
Retrieves detailed information for processes matching a given name.
|
||||
|
||||
* **Parameters**: `name` (string): Process name (substring match).
|
||||
* **Returns**: `[]ProcessInfo`.
|
||||
|
||||
### `osal.process_exists(pid int) bool`
|
||||
|
||||
Checks if a process with a given PID exists.
|
||||
|
||||
* **Parameters**: `pid` (int): Process ID.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.processinfo_with_children(pid int) !ProcessMap`
|
||||
|
||||
Returns a process and all its child processes.
|
||||
|
||||
## 1.1. Done Context Management (`done.v`)
|
||||
|
||||
Functions for managing a "done" context or state using Redis.
|
||||
|
||||
* **`osal.done_set(key string, val string) !`**: Sets a key-value pair in the "done" context.
|
||||
* **`osal.done_get(key string) ?string`**: Retrieves a value from the "done" context by key.
|
||||
* **`osal.done_delete(key string) !`**: Deletes a key from the "done" context.
|
||||
* **`osal.done_get_str(key string) string`**: Retrieves a string value from the "done" context by key (panics on error).
|
||||
* **`osal.done_get_int(key string) int`**: Retrieves an integer value from the "done" context by key (panics on error).
|
||||
* **`osal.done_exists(key string) bool`**: Checks if a key exists in the "done" context.
|
||||
* **`osal.done_print() !`**: Prints all key-value pairs in the "done" context to debug output.
|
||||
* **`osal.done_reset() !`**: Resets (deletes all keys from) the "done" context.
|
||||
* **Parameters**: `pid` (int): Parent Process ID.
|
||||
* **Returns**: `ProcessMap`.
|
||||
|
||||
### `osal.processinfo_children(pid int) !ProcessMap`
|
||||
|
||||
Returns all child processes for a given PID.
|
||||
|
||||
* **Parameters**: `pid` (int): Parent Process ID.
|
||||
* **Returns**: `ProcessMap`.
|
||||
|
||||
### `osal.process_kill_recursive(args: ProcessKillArgs) !`
|
||||
|
||||
Kills a process and all its children by name or PID.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`ProcessKillArgs` struct):
|
||||
* `name` (string): Process name.
|
||||
* `pid` (int): Process ID.
|
||||
|
||||
### `osal.process_exists_byname(name string) !bool`
|
||||
|
||||
Checks if a process with a given name exists.
|
||||
|
||||
* **Parameters**: `name` (string): Process name (substring match).
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.whoami() !string`
|
||||
|
||||
Returns the current username.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
## 2. Network Utilities
|
||||
|
||||
### `osal.ping(args: PingArgs) ! bool`
|
||||
|
||||
Checks host reachability.
|
||||
|
||||
* **Parameters**:
|
||||
|
||||
### `osal.ipaddr_pub_get_check() !string`
|
||||
|
||||
Retrieves the public IP address and verifies it is bound to a local interface.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.is_ip_on_local_interface(ip string) !bool`
|
||||
|
||||
Checks if a given IP address is bound to a local network interface.
|
||||
|
||||
* **Parameters**: `ip` (string): IP address to check.
|
||||
* **Returns**: `bool`.
|
||||
* `args` (`PingArgs` struct):
|
||||
* `address` (string, required): IP address or hostname.
|
||||
* `count` (u8, default: 1): Number of pings.
|
||||
* `timeout` (u16, default: 1): Timeout in seconds per ping.
|
||||
* `retry` (u8): Number of retry attempts.
|
||||
* **Returns**: `PingResult` enum (`.ok`, `.timeout`, `.unknownhost`).
|
||||
|
||||
### `osal.tcp_port_test(args: TcpPortTestArgs) bool`
|
||||
|
||||
Tests if a TCP port is open on a given address.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`TcpPortTestArgs` struct):
|
||||
* `address` (string, required): IP address or hostname.
|
||||
* `port` (int, default: 22): TCP port number.
|
||||
* `timeout` (u16, default: 2000): Total timeout in milliseconds.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.ipaddr_pub_get() !string`
|
||||
|
||||
Retrieves the public IP address.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.is_ip_on_local_interface(ip string) !bool`
|
||||
|
||||
Checks if a given IP address is bound to a local network interface.
|
||||
|
||||
* **Parameters**: `ip` (string): IP address to check.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
## 3. File System Operations
|
||||
|
||||
### `osal.file_write(path string, text string) !`
|
||||
|
||||
Writes text content to a file.
|
||||
|
||||
* **Parameters**:
|
||||
* `path` (string): File path.
|
||||
* `text` (string): Content to write.
|
||||
|
||||
### `osal.file_read(path string) !string`
|
||||
|
||||
Reads content from a file.
|
||||
|
||||
* **Parameters**: `path` (string): File path.
|
||||
* **Returns**: `string` (file content).
|
||||
|
||||
### `osal.dir_ensure(path string) !`
|
||||
|
||||
Ensures a directory exists, creating it if necessary.
|
||||
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
### `osal.dir_delete(path string) !`
|
||||
|
||||
Deletes a directory if it exists.
|
||||
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
### `osal.dir_reset(path string) !`
|
||||
|
||||
Deletes and then recreates a directory.
|
||||
|
||||
* **Parameters**: `path` (string): Directory path.
|
||||
|
||||
### `osal.rm(todelete string) !`
|
||||
|
||||
Removes files or directories.
|
||||
|
||||
* **Parameters**: `todelete` (string): Comma or newline separated list of paths (supports `~` for home directory).
|
||||
|
||||
### `osal.env_get_all() map[string]string`
|
||||
|
||||
Returns all existing environment variables as a map.
|
||||
|
||||
* **Returns**: `map[string]string`.
|
||||
|
||||
## 4. Environment Variables
|
||||
|
||||
## 4.1. Package Management (`package.v`)
|
||||
|
||||
Functions for managing system packages.
|
||||
|
||||
* **`osal.package_refresh() !`**: Updates the package list for the detected platform.
|
||||
* **`osal.package_install(name_ string) !`**: Installs one or more packages.
|
||||
* **`osal.package_remove(name_ string) !`**: Removes one or more packages.
|
||||
|
||||
### `osal.env_set(args: EnvSet)`
|
||||
|
||||
Sets an environment variable.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`EnvSet` struct):
|
||||
* `key` (string, required): Environment variable name.
|
||||
* `value` (string, required): Value to set.
|
||||
* `overwrite` (bool, default: true): Overwrite if exists.
|
||||
|
||||
### `osal.env_unset(key string)`
|
||||
|
||||
Unsets a specific environment variable.
|
||||
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
|
||||
### `osal.env_unset_all()`
|
||||
|
||||
Unsets all environment variables.
|
||||
|
||||
### `osal.env_set_all(args: EnvSetAll)`
|
||||
|
||||
Sets multiple environment variables.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`EnvSetAll` struct):
|
||||
* `env` (map[string]string): Map of key-value pairs.
|
||||
* `clear_before_set` (bool): Clear all existing variables before setting.
|
||||
* `overwrite_if_exists` (bool, default: true): Overwrite existing variables.
|
||||
|
||||
### `osal.env_get(key string) !string`
|
||||
|
||||
Retrieves the value of a specific environment variable.
|
||||
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
* **Returns**: `string` (variable value).
|
||||
|
||||
### `osal.env_exists(key string) !bool`
|
||||
|
||||
Checks if an environment variable exists.
|
||||
|
||||
* **Parameters**: `key` (string): Environment variable name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.env_get_default(key string, def string) string`
|
||||
|
||||
Retrieves an environment variable or a default value if not found.
|
||||
|
||||
* **Parameters**:
|
||||
* `key` (string): Environment variable name.
|
||||
* `def` (string): Default value.
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.load_env_file(file_path string) !`
|
||||
|
||||
Loads environment variables from a specified file.
|
||||
|
||||
* **Parameters**: `file_path` (string): Path to the environment file.
|
||||
|
||||
## 5. Command & Profile Management
|
||||
|
||||
### `osal.cmd_add(args: CmdAddArgs) !`
|
||||
|
||||
Adds (copies or symlinks) a binary to system paths and updates user profiles.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`CmdAddArgs` struct):
|
||||
* `cmdname` (string): Name of the command (optional, derived from source if empty).
|
||||
* `source` (string, required): Path to the binary.
|
||||
* `symlink` (bool): Create a symlink instead of copying.
|
||||
* `reset` (bool, default: true): Delete existing command if found.
|
||||
|
||||
### `osal.profile_path_add_hero() !string`
|
||||
|
||||
Ensures the `~/hero/bin` path is added to the user's profile.
|
||||
|
||||
* **Returns**: `string` (the `~/hero/bin` path).
|
||||
|
||||
### `osal.bin_path() !string`
|
||||
|
||||
Returns the preferred binary installation path (`~/hero/bin`).
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.hero_path() !string`
|
||||
|
||||
Returns the `~/hero` directory path.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.usr_local_path() !string`
|
||||
|
||||
Returns `/usr/local` for Linux or `~/hero` for macOS.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.cmd_exists_profile(cmd string) bool`
|
||||
|
||||
Checks if a command exists in the system's PATH, considering the user's profile.
|
||||
|
||||
* **Parameters**: `cmd` (string): The command name.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.profile_path_source() !string`
|
||||
|
||||
Returns a source statement for the preferred profile file (e.g., `. /home/user/.zprofile`).
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.profile_path_source_and() !string`
|
||||
|
||||
Returns a source statement followed by `&&` for command chaining, or empty if profile doesn't exist.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.profile_path_add_remove(args: ProfilePathAddRemoveArgs) !`
|
||||
|
||||
Adds and/or removes paths from specified or preferred user profiles.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`ProfilePathAddRemoveArgs` struct):
|
||||
* `paths_profile` (string): Comma/newline separated list of profile file paths (optional, uses preferred if empty).
|
||||
* `paths2add` (string): Comma/newline separated list of paths to add.
|
||||
* `paths2delete` (string): Comma/newline separated list of paths to delete.
|
||||
* `allprofiles` (bool): Apply to all known profile files.
|
||||
|
||||
### `osal.cmd_path(cmd string) !string`
|
||||
|
||||
Returns the full path of an executable command using `which`.
|
||||
|
||||
* **Parameters**: `cmd` (string): Command name.
|
||||
* **Returns**: `string` (full path).
|
||||
|
||||
### `osal.cmd_delete(cmd string) !`
|
||||
|
||||
Deletes commands from their found locations.
|
||||
|
||||
* **Parameters**: `cmd` (string): Command name.
|
||||
|
||||
### `osal.profile_paths_all() ![]string`
|
||||
|
||||
Lists all possible profile file paths in the OS.
|
||||
|
||||
* **Returns**: `[]string`.
|
||||
|
||||
### `osal.profile_paths_preferred() ![]string`
|
||||
|
||||
## 5.1. SSH Key Management (`ssh_key.v`)
|
||||
|
||||
Functions and structs for managing SSH keys.
|
||||
|
||||
### `struct SSHKey`
|
||||
|
||||
Represents an SSH key pair.
|
||||
|
||||
* **Fields**: `name` (string), `directory` (string).
|
||||
* **Methods**:
|
||||
* `public_key_path() !pathlib.Path`: Returns the path to the public key.
|
||||
* `private_key_path() !pathlib.Path`: Returns the path to the private key.
|
||||
* `public_key() !string`: Returns the content of the public key.
|
||||
* `private_key() !string`: Returns the content of the private key.
|
||||
|
||||
### `struct SSHConfig`
|
||||
|
||||
Configuration for SSH key operations.
|
||||
|
||||
* **Fields**: `directory` (string, default: `~/.ssh`).
|
||||
|
||||
### `osal.get_ssh_key(key_name string, config SSHConfig) ?SSHKey`
|
||||
|
||||
Retrieves a specific SSH key by name.
|
||||
|
||||
* **Parameters**: `key_name` (string), `config` (`SSHConfig` struct).
|
||||
* **Returns**: `?SSHKey` (optional SSHKey struct).
|
||||
|
||||
### `osal.list_ssh_keys(config SSHConfig) ![]SSHKey`
|
||||
|
||||
Lists all SSH keys in the specified directory.
|
||||
|
||||
* **Parameters**: `config` (`SSHConfig` struct).
|
||||
* **Returns**: `[]SSHKey`.
|
||||
|
||||
### `osal.new_ssh_key(key_name string, config SSHConfig) !SSHKey`
|
||||
|
||||
Creates a new SSH key pair.
|
||||
|
||||
* **Parameters**: `key_name` (string), `config` (`SSHConfig` struct).
|
||||
* **Returns**: `SSHKey`.
|
||||
Lists preferred profile file paths based on the operating system.
|
||||
* **Returns**: `[]string`.
|
||||
|
||||
### `osal.profile_path() !string`
|
||||
|
||||
Returns the most preferred profile file path.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
## 6. System Information & Utilities
|
||||
|
||||
### `osal.platform() !PlatformType`
|
||||
|
||||
Identifies the operating system.
|
||||
|
||||
* **Returns**: `PlatformType` enum (`.unknown`, `.osx`, `.ubuntu`, `.alpine`, `.arch`, `.suse`).
|
||||
|
||||
### `osal.cputype() !CPUType`
|
||||
|
||||
Identifies the CPU architecture.
|
||||
|
||||
* **Returns**: `CPUType` enum (`.unknown`, `.intel`, `.arm`, `.intel32`, `.arm32`).
|
||||
|
||||
### `osal.is_linux() !bool`
|
||||
|
||||
Checks if the current OS is Linux.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_osx() !bool`
|
||||
|
||||
Checks if the current OS is macOS.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_ubuntu() !bool`
|
||||
|
||||
Checks if the current OS is Ubuntu.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_osx_arm() !bool`
|
||||
|
||||
Checks if the current OS is macOS ARM.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_linux_arm() !bool`
|
||||
|
||||
Checks if the current OS is Linux ARM.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_osx_intel() !bool`
|
||||
|
||||
Checks if the current OS is macOS Intel.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.is_linux_intel() !bool`
|
||||
|
||||
Checks if the current OS is Linux Intel.
|
||||
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.hostname() !string`
|
||||
|
||||
Returns the system hostname.
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.initname() !string`
|
||||
|
||||
Returns the init system name (e.g., `systemd`, `bash`, `zinit`).
|
||||
|
||||
* **Returns**: `string`.
|
||||
|
||||
### `osal.sleep(duration int)`
|
||||
|
||||
Pauses execution for a specified duration.
|
||||
|
||||
* **Parameters**: `duration` (int): Sleep duration in seconds.
|
||||
|
||||
### `osal.download(args: DownloadArgs) !pathlib.Path`
|
||||
|
||||
Downloads a file from a URL.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`DownloadArgs` struct):
|
||||
* `url` (string, required): URL of the file.
|
||||
* `name` (string): Optional, derived from filename if empty.
|
||||
* `reset` (bool): Force download, remove existing.
|
||||
* `hash` (string): Hash for verification.
|
||||
* `dest` (string): Destination path.
|
||||
* `timeout` (int, default: 180): Download timeout in seconds.
|
||||
* `retry` (int, default: 3): Number of retries.
|
||||
* `minsize_kb` (u32, default: 10): Minimum expected size in KB.
|
||||
* `maxsize_kb` (u32): Maximum expected size in KB.
|
||||
* `expand_dir` (string): Directory to expand archive into.
|
||||
* `expand_file` (string): File to expand archive into.
|
||||
* **Returns**: `pathlib.Path` (path to the downloaded file/directory).
|
||||
|
||||
### `osal.user_exists(username string) bool`
|
||||
|
||||
Checks if a user exists on the system.
|
||||
|
||||
* **Parameters**: `username` (string): Username to check.
|
||||
* **Returns**: `bool`.
|
||||
|
||||
### `osal.user_id_get(username string) !int`
|
||||
|
||||
Retrieves the user ID for a given username.
|
||||
|
||||
* **Parameters**: `username` (string): Username.
|
||||
* **Returns**: `int` (User ID).
|
||||
|
||||
### `osal.user_add(args: UserArgs) !int`
|
||||
|
||||
Adds a new user to the system.
|
||||
|
||||
* **Parameters**:
|
||||
* `args` (`UserArgs` struct):
|
||||
* `name` (string, required): Username to add.
|
||||
* **Returns**: `int` (User ID of the added user).
|
||||
|
||||
## Enums & Structs
|
||||
|
||||
### `enum PlatformType`
|
||||
|
||||
Represents the detected operating system.
|
||||
|
||||
* Values: `unknown`, `osx`, `ubuntu`, `alpine`, `arch`, `suse`.
|
||||
|
||||
### `enum CPUType`
|
||||
|
||||
Represents the detected CPU architecture.
|
||||
|
||||
* Values: `unknown`, `intel`, `arm`, `intel32`, `arm32`.
|
||||
|
||||
### `enum RunTime`
|
||||
|
||||
Specifies the runtime environment for command execution.
|
||||
|
||||
* Values: `bash`, `python`, `heroscript`, `herocmd`, `v`.
|
||||
|
||||
### `enum JobStatus`
|
||||
|
||||
Status of an executed command job.
|
||||
|
||||
* Values: `init`, `running`, `error_exec`, `error_timeout`, `error_args`, `done`.
|
||||
|
||||
### `enum ErrorType`
|
||||
|
||||
Types of errors that can occur during job execution.
|
||||
|
||||
* Values: `exec`, `timeout`, `args`.
|
||||
|
||||
### `enum PingResult`
|
||||
|
||||
Result of a ping operation.
|
||||
|
||||
* Values: `ok`, `timeout`, `unknownhost`.
|
||||
|
||||
### `struct Command`
|
||||
|
||||
Configuration for `osal.exec` function. (See `osal.exec` parameters for fields).
|
||||
|
||||
### `struct Job`
|
||||
|
||||
Result object returned by `osal.exec`. (See `osal.exec` returns for fields).
|
||||
|
||||
### `struct JobError`
|
||||
|
||||
Error details for failed jobs.
|
||||
|
||||
### `struct PingArgs`
|
||||
|
||||
Arguments for `osal.ping` function. (See `osal.ping` parameters for fields).
|
||||
|
||||
### `struct TcpPortTestArgs`
|
||||
|
||||
Arguments for `osal.tcp_port_test` function. (See `osal.tcp_port_test` parameters for fields).
|
||||
|
||||
### `struct EnvSet`
|
||||
|
||||
Arguments for `osal.env_set` function. (See `osal.env_set` parameters for fields).
|
||||
|
||||
### `struct EnvSetAll`
|
||||
|
||||
Arguments for `osal.env_set_all` function. (See `osal.env_set_all` parameters for fields).
|
||||
|
||||
### `struct CmdAddArgs`
|
||||
|
||||
Arguments for `osal.cmd_add` function. (See `osal.cmd_add` parameters for fields).
|
||||
|
||||
### `struct ProfilePathAddRemoveArgs`
|
||||
|
||||
Arguments for `osal.profile_path_add_remove` function. (See `osal.profile_path_add_remove` parameters for fields).
|
||||
|
||||
### `struct ProcessMap`
|
||||
|
||||
Contains a list of `ProcessInfo` objects.
|
||||
|
||||
### `struct ProcessInfo`
|
||||
|
||||
Detailed information about a single process. (See `osal.processinfo_get` returns for fields).
|
||||
|
||||
### `struct ProcessKillArgs`
|
||||
|
||||
Arguments for `osal.process_kill_recursive` function. (See `osal.process_kill_recursive` parameters for fields).
|
||||
|
||||
### `struct DownloadArgs`
|
||||
|
||||
Arguments for `osal.download` function. (See `osal.download` parameters for fields).
|
||||
|
||||
### `struct UserArgs`
|
||||
|
||||
Arguments for `osal.user_add` function. (See `osal.user_add` parameters for fields).
|
||||
93
aiprompts/herolib_advanced/ourdb.md
Normal file
93
aiprompts/herolib_advanced/ourdb.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# OurTime Module
|
||||
|
||||
The `OurTime` module in V provides flexible time handling, supporting relative and absolute time formats, Unix timestamps, and formatting utilities.
|
||||
|
||||
## Key Features
|
||||
|
||||
- Create time objects from strings or current time
|
||||
- Relative time expressions (e.g., `+1h`, `-2d`)
|
||||
- Absolute time formats (e.g., `YYYY-MM-DD HH:mm:ss`)
|
||||
- Unix timestamp conversion
|
||||
- Time formatting and warping
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import incubaid.herolib.data.ourtime
|
||||
|
||||
// Current time
|
||||
mut t := ourtime.now()
|
||||
|
||||
// From string
|
||||
t2 := ourtime.new('2022-12-05 20:14:35')!
|
||||
|
||||
// Get formatted string
|
||||
println(t2.str()) // e.g., 2022-12-05 20:14
|
||||
|
||||
// Get Unix timestamp
|
||||
println(t2.unix()) // e.g., 1670271275
|
||||
```
|
||||
|
||||
## Time Formats
|
||||
|
||||
### Relative Time
|
||||
|
||||
Use `s` (seconds), `h` (hours), `d` (days), `w` (weeks), `M` (months), `Q` (quarters), `Y` (years).
|
||||
|
||||
```v
|
||||
// Create with relative time
|
||||
mut t := ourtime.new('+1w +2d -4h')!
|
||||
|
||||
// Warp existing time
|
||||
mut t2 := ourtime.now()
|
||||
t2.warp('+1h')!
|
||||
```
|
||||
|
||||
### Absolute Time
|
||||
|
||||
Supports `YYYY-MM-DD HH:mm:ss`, `YYYY-MM-DD HH:mm`, `YYYY-MM-DD HH`, `YYYY-MM-DD`, `DD-MM-YYYY`.
|
||||
|
||||
```v
|
||||
t1 := ourtime.new('2022-12-05 20:14:35')!
|
||||
t2 := ourtime.new('2022-12-05')! // Time defaults to 00:00:00
|
||||
```
|
||||
|
||||
## Methods Overview
|
||||
|
||||
### Creation
|
||||
|
||||
```v
|
||||
now_time := ourtime.now()
|
||||
from_string := ourtime.new('2023-01-15')!
|
||||
from_epoch := ourtime.new_from_epoch(1673788800)
|
||||
```
|
||||
|
||||
### Formatting
|
||||
|
||||
```v
|
||||
mut t := ourtime.now()
|
||||
println(t.str()) // YYYY-MM-DD HH:mm
|
||||
println(t.day()) // YYYY-MM-DD
|
||||
println(t.key()) // YYYY_MM_DD_HH_mm_ss
|
||||
println(t.md()) // Markdown format
|
||||
```
|
||||
|
||||
### Operations
|
||||
|
||||
```v
|
||||
mut t := ourtime.now()
|
||||
t.warp('+1h')! // Move 1 hour forward
|
||||
unix_ts := t.unix()
|
||||
is_empty := t.empty()
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
Time parsing methods return a `Result` type and should be handled with `!` or `or` blocks.
|
||||
|
||||
```v
|
||||
t_valid := ourtime.new('2023-01-01')!
|
||||
t_invalid := ourtime.new('bad-date') or {
|
||||
println('Error: ${err}')
|
||||
ourtime.now() // Fallback
|
||||
}
|
||||
211
aiprompts/herolib_advanced/spreadsheet.md
Normal file
211
aiprompts/herolib_advanced/spreadsheet.md
Normal file
@@ -0,0 +1,211 @@
|
||||
# Herolib Spreadsheet Module for AI Prompt Engineering
|
||||
|
||||
This document provides an overview and usage instructions for the `incubaid.herolib.biz.spreadsheet` module, which offers a powerful software representation of a spreadsheet. This module is designed for business modeling, data analysis, and can be leveraged in AI prompt engineering scenarios where structured data manipulation and visualization are required.
|
||||
|
||||
## 1. Core Concepts
|
||||
|
||||
The spreadsheet module revolves around three main entities: `Sheet`, `Row`, and `Cell`.
|
||||
|
||||
### 1.1. Sheet
|
||||
|
||||
The `Sheet` is the primary container, representing the entire spreadsheet.
|
||||
|
||||
* **Properties:**
|
||||
* `name` (string): A unique identifier for the sheet.
|
||||
* `rows` (map[string]&Row): A collection of `Row` objects, indexed by their names.
|
||||
* `nrcol` (int): The number of columns in the sheet (e.g., 60 for 5 years of monthly data).
|
||||
* `params` (SheetParams): Configuration parameters, e.g., `visualize_cur` (boolean to display currency symbols).
|
||||
* `currency` (currency.Currency): The default currency for the sheet (e.g., USD), used for automatic conversions.
|
||||
|
||||
* **Creation:**
|
||||
|
||||
```v
|
||||
import incubaid.herolib.biz.spreadsheet
|
||||
|
||||
// Create a new sheet named 'my_financial_sheet' with 60 columns (e.g., 60 months)
|
||||
mut my_sheet := spreadsheet.sheet_new(
|
||||
name: 'my_financial_sheet',
|
||||
nrcol: 60,
|
||||
visualize_cur: true, // Optional: display currency symbols
|
||||
curr: 'USD' // Optional: set default currency
|
||||
)!
|
||||
|
||||
// Get an existing sheet from the global store
|
||||
mut existing_sheet := spreadsheet.sheet_get('my_financial_sheet')!
|
||||
```
|
||||
|
||||
* **Key Operations:**
|
||||
* `sheet.row_get(name string) !&Row`: Retrieves a row by its name.
|
||||
* `sheet.cell_get(row string, col int) !&Cell`: Retrieves a cell by row name and column index.
|
||||
* `sheet.row_delete(name string)` / `sheet.delete(name string)`: Deletes a row.
|
||||
* `sheet.cells_width(colnr int) !int`: Finds the maximum string length of cells in a given column.
|
||||
* `sheet.rows_names_width_max() int`: Returns the maximum width of row names/aliases.
|
||||
* `sheet.rows_description_width_max() int`: Returns the maximum width of row descriptions.
|
||||
* `sheet.header() ![]string`: Generates column headers (e.g., "M1", "Q1", "Y1") based on `nrcol`.
|
||||
|
||||
### 1.2. Row
|
||||
|
||||
A `Row` represents a single horizontal line of data within a `Sheet`.
|
||||
|
||||
* **Properties:**
|
||||
* `name` (string): Unique identifier for the row.
|
||||
* `alias` (string, optional): Alternative name.
|
||||
* `description` (string): Textual description.
|
||||
* `tags` (string): Space-separated tags for categorization (e.g., "department:hr location:belgium").
|
||||
* `cells` ([]Cell): List of `Cell` objects.
|
||||
* `aggregatetype` (RowAggregateType): Defines default aggregation for this row (`.sum`, `.avg`, `.max`, `.min`).
|
||||
|
||||
* **Creation (within a Sheet):**
|
||||
|
||||
```v
|
||||
// Assuming 'my_sheet' is an existing Sheet object
|
||||
mut salaries_row := my_sheet.row_new(
|
||||
name: 'salaries',
|
||||
tags: 'department:hr location:belgium',
|
||||
descr: 'Monthly salaries for HR department in Belgium',
|
||||
aggregatetype: .sum
|
||||
)!
|
||||
```
|
||||
|
||||
* **Key Operations:**
|
||||
* `row.values_get() []f64`: Returns all cell values in the row as a list of floats.
|
||||
|
||||
### 1.3. Cell
|
||||
|
||||
A `Cell` is the fundamental unit of data, storing a numeric value.
|
||||
|
||||
* **Properties:**
|
||||
* `val` (f64): The numeric value.
|
||||
* `empty` (bool): `true` if the cell is empty.
|
||||
|
||||
* **Key Operations:**
|
||||
* `cell.set(v string) !`: Sets the cell's value. Handles currency strings (e.g., "100 USD") by converting to the sheet's currency.
|
||||
* `cell.add(v f64)`: Adds a numeric value to the existing cell value.
|
||||
* `cell.repr() string`: Returns a formatted string representation of the value (e.g., "100.00", or "-" if empty).
|
||||
|
||||
## 2. Data Aggregation and Transformation
|
||||
|
||||
The module provides powerful tools for summarizing and transforming data.
|
||||
|
||||
### 2.1. Grouping Rows (`group2row`)
|
||||
|
||||
Aggregates selected rows into a new single row based on tags.
|
||||
|
||||
```v
|
||||
// Aggregate rows tagged 'department:dev' or 'department:engineering' into a new row
|
||||
mut total_salaries_row := my_sheet.group2row(
|
||||
name: 'total_dev_engineering_salaries',
|
||||
include: ['department:dev', 'department:engineering'],
|
||||
tags: 'summary:dev_eng',
|
||||
descr: 'Total salaries for Development and Engineering departments',
|
||||
aggregatetype: .sum // Can be .sum, .avg, .max, .min
|
||||
)!
|
||||
```
|
||||
|
||||
### 2.2. Transforming Periodicity (`toyear`, `toquarter`)
|
||||
|
||||
Creates new sheets with data aggregated into larger time periods.
|
||||
|
||||
```v
|
||||
// Assuming 'monthly_sheet' has 60 columns (monthly data)
|
||||
mut monthly_sheet := spreadsheet.sheet_new(name: 'monthly_data', nrcol: 60)!
|
||||
// ... populate monthly_sheet
|
||||
|
||||
// Create a new sheet 'yearly_data' with data aggregated by year
|
||||
mut yearly_sheet := monthly_sheet.toyear(
|
||||
name: 'yearly_data',
|
||||
namefilter: ['revenue_row', 'expenses_row'], // Optional: filter specific rows
|
||||
includefilter: ['category:income'] // Optional: filter by tags
|
||||
)!
|
||||
|
||||
// Create a new sheet 'quarterly_data' with data aggregated by quarter
|
||||
mut quarterly_sheet := monthly_sheet.toquarter(name: 'quarterly_data')!
|
||||
```
|
||||
|
||||
## 3. Exporting Data
|
||||
|
||||
Export sheet data to CSV format.
|
||||
|
||||
### 3.1. Export to CSV (`export_csv`)
|
||||
|
||||
```v
|
||||
import os
|
||||
|
||||
// Export to a CSV file with default pipe '|' separator
|
||||
my_sheet.export_csv(path: '~/output.csv')!
|
||||
|
||||
// Export with custom comma ',' separator and include empty cells
|
||||
csv_content_with_empty := my_sheet.export_csv(
|
||||
path: '~/output_with_empty.csv',
|
||||
separator: ',',
|
||||
include_empty: true
|
||||
)!
|
||||
|
||||
// Export to a string only (no file)
|
||||
csv_string := my_sheet.export_csv(path: '')!
|
||||
println(csv_string)
|
||||
```
|
||||
|
||||
* **`ExportCSVArgs` Parameters:**
|
||||
* `path` (string, optional): File path. Empty string returns content as string. `~` is expanded to home directory.
|
||||
* `include_empty` (bool, optional, default: `false`): If `true`, empty cells are included.
|
||||
* `separator` (string, optional, default: `'|'`): Delimiter character.
|
||||
|
||||
## 4. Charting Capabilities
|
||||
|
||||
Integrates with ECharts for data visualization. Charting functions return an `echarts.EChartsOption` object.
|
||||
|
||||
### 4.1. Common Charting Parameters (`RowGetArgs`)
|
||||
|
||||
Used across line, bar, and pie charts to specify data and presentation.
|
||||
|
||||
* `rowname` (string, optional): Single row name or comma-separated list.
|
||||
* `namefilter` ([]string, optional): List of exact row names to include.
|
||||
* `includefilter` ([]string, optional): List of tags to include.
|
||||
* `excludefilter` ([]string, optional): List of tags to exclude.
|
||||
* `period_type` (PeriodType, optional): X-axis period (`.month`, `.quarter`, `.year`).
|
||||
* `aggregate` (bool, optional, default: `true`): Aggregate multiple matching rows.
|
||||
* `aggregatetype` (RowAggregateType, optional, default: `.sum`): Aggregation type.
|
||||
* `unit` (UnitType, optional): Data unit.
|
||||
* `title`, `title_sub` (string, optional): Chart titles.
|
||||
* `size` (string, optional): For pie charts, defines radius (e.g., "70%").
|
||||
* `rowname_show` (bool, optional, default: `true`): Show row name in legend.
|
||||
* `descr_show` (bool, optional, default: `false`): Show row description (overrides `rowname_show`).
|
||||
* `description` (string, optional): General chart description.
|
||||
|
||||
### 4.2. Chart Types
|
||||
|
||||
* **Line Chart (`line_chart`)**: Visualizes trends over time.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.web.echarts // Required for EChartsOption type
|
||||
|
||||
line_chart_option := my_sheet.line_chart(
|
||||
rowname: 'revenue_row,expenses_row',
|
||||
period_type: .month,
|
||||
title: 'Revenue vs. Expenses Over Time'
|
||||
)!
|
||||
```
|
||||
|
||||
* **Bar Chart (`bar_chart`)**: Compares discrete categories or values.
|
||||
|
||||
```v
|
||||
bar_chart_option := my_sheet.bar_chart(
|
||||
rowname: 'profit_row',
|
||||
period_type: .quarter,
|
||||
title: 'Quarterly Profit'
|
||||
)!
|
||||
```
|
||||
|
||||
* **Pie Chart (`pie_chart`)**: Shows proportions of categories.
|
||||
|
||||
```v
|
||||
pie_chart_option := my_sheet.pie_chart(
|
||||
rowname: 'budget_allocation_row',
|
||||
period_type: .year,
|
||||
title: 'Annual Budget Allocation',
|
||||
size: '70%'
|
||||
)!
|
||||
```
|
||||
|
||||
This documentation should provide sufficient information for an AI to understand and utilize the `lib/biz/spreadsheet` module effectively for various data manipulation and visualization tasks.
|
||||
@@ -7,8 +7,8 @@ Chalk offers functions:- `console.color_fg(text string, color string)` - To chan
|
||||
|
||||
Example:
|
||||
|
||||
```vlang
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
```v
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
# basic usage
|
||||
println('I am really ' + console.color_fg('happy', 'green'))
|
||||
72
aiprompts/herolib_core/basic_instructions.md
Normal file
72
aiprompts/herolib_core/basic_instructions.md
Normal file
@@ -0,0 +1,72 @@
|
||||
|
||||
# BASIC INSTRUCTIONS
|
||||
|
||||
IMPORTANT: USE THIS PAGE AS THE ABSOLUTE AUTHORITY ON ALL INSTRUCTIONS
|
||||
|
||||
## instructions for code generation
|
||||
|
||||
> when I generate code, the following instructions can never be overruled they are the basics
|
||||
|
||||
- do not try to fix files which end with _.v because these are generated files
|
||||
|
||||
|
||||
## instruction for vlang scripts
|
||||
|
||||
when I generate vlang scripts I will always use .vsh extension and use following as first line:
|
||||
|
||||
```
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
```
|
||||
|
||||
- a .vsh is a v shell script and can be executed as is, no need to use v ...
|
||||
- in .vsh file there is no need for a main() function
|
||||
- these scripts can be used for examples or instruction scripts e.g. an installs script
|
||||
|
||||
## executing vlang scripts
|
||||
|
||||
As AI agent I should also execute .v or .vsh scripts with vrun
|
||||
|
||||
```bash
|
||||
vrun ~/code/github/incubaid/herolib/examples/biztools/bizmodel.vsh
|
||||
```
|
||||
|
||||
## executing test scripts
|
||||
|
||||
instruct user to test as follows (vtest is an alias which gets installed when herolib gets installed), can be done for a dir and for a file
|
||||
|
||||
```bash
|
||||
vtest ~/code/github/incubaid/herolib/lib/osal/package_test.v
|
||||
```
|
||||
|
||||
- use ~ so it works over all machines
|
||||
- don't use 'v test', we have vtest as alternative
|
||||
|
||||
## module imports
|
||||
|
||||
- in v all files in a folder are part of the same module, no need to import then, this is important difference in v
|
||||
|
||||
## usage of @[params]
|
||||
|
||||
- this is the best way how to pass optional parameters to functions in V
|
||||
|
||||
```
|
||||
|
||||
@[params]
|
||||
pub struct MyArgs {
|
||||
pub mut:
|
||||
name string
|
||||
passphrase string
|
||||
}
|
||||
|
||||
pub fn my_function(args MyArgs) {
|
||||
// Use args.name and args.passphrase
|
||||
}
|
||||
|
||||
//it get called as follows
|
||||
|
||||
my_function(name:"my_key", passphrase:"my_passphrase")
|
||||
|
||||
//IMPORTANT NO NEED TO INITIALIZE THE MYARGS INSIDE
|
||||
|
||||
```
|
||||
|
||||
11
aiprompts/herolib_core/core_curdir_example.md
Normal file
11
aiprompts/herolib_core/core_curdir_example.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Getting the Current Script's Path in Herolib/V Shell
|
||||
|
||||
can be used in any .v or .vsh script, easy to find content close to the script itself.
|
||||
|
||||
```v
|
||||
#!/usr/bin/env vsh
|
||||
|
||||
const script_path = os.dir(@FILE) + '/scripts'
|
||||
echo "Current scripts directory: ${script_directory}"
|
||||
|
||||
```
|
||||
44
aiprompts/herolib_core/core_globals.md
Normal file
44
aiprompts/herolib_core/core_globals.md
Normal file
@@ -0,0 +1,44 @@
|
||||
## how to remember clients, installers as a global
|
||||
|
||||
the following is a good pragmatic way to remember clients, installers as a global, use it as best practice.
|
||||
|
||||
```vmodule docsite
|
||||
|
||||
module docsite
|
||||
|
||||
import incubaid.herolib.core.texttools
|
||||
|
||||
__global (
|
||||
siteconfigs map[string]&SiteConfig
|
||||
)
|
||||
|
||||
@[params]
|
||||
pub struct FactoryArgs {
|
||||
pub mut:
|
||||
name string = "default"
|
||||
}
|
||||
|
||||
pub fn new(args FactoryArgs) !&SiteConfig {
|
||||
name := texttools.name_fix(args.name)
|
||||
siteconfigs[name] = &SiteConfig{
|
||||
name: name
|
||||
}
|
||||
return get(name:name)!
|
||||
}
|
||||
|
||||
pub fn get(args FactoryArgs) !&SiteConfig {
|
||||
name := texttools.name_fix(args.name)
|
||||
mut sc := siteconfigs[name] or {
|
||||
return error('siteconfig with name "${name}" does not exist')
|
||||
}
|
||||
return sc
|
||||
}
|
||||
|
||||
pub fn default() !&SiteConfig {
|
||||
if siteconfigs.len == 0 {
|
||||
return new(name:'default')!
|
||||
}
|
||||
return get()!
|
||||
}
|
||||
|
||||
```
|
||||
54
aiprompts/herolib_core/core_heroscript_basics.md
Normal file
54
aiprompts/herolib_core/core_heroscript_basics.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# HeroScript: Vlang Integration
|
||||
|
||||
## HeroScript Structure
|
||||
|
||||
HeroScript is a concise scripting language with the following structure:
|
||||
|
||||
```heroscript
|
||||
!!actor.action_name
|
||||
param1: 'value1'
|
||||
param2: 'value with spaces'
|
||||
multiline_description: '
|
||||
This is a multiline description.
|
||||
It can span multiple lines.
|
||||
'
|
||||
arg1 arg2 // Arguments without keys
|
||||
```
|
||||
|
||||
Key characteristics:
|
||||
|
||||
- **Actions**: Start with `!!`, followed by `actor.action_name` (e.g., `!!mailclient.configure`).
|
||||
- **Parameters**: Defined as `key:value`. Values can be quoted for spaces.
|
||||
- **Multiline Support**: Parameters like `description` can span multiple lines.
|
||||
- **Arguments**: Values without keys (e.g., `arg1`).
|
||||
|
||||
## Processing HeroScript in Vlang
|
||||
|
||||
HeroScript can be parsed into a `playbook.PlayBook` object, allowing structured access to actions and their parameters, this is used in most of the herolib modules, it allows configuration or actions in a structured way.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.playbook { PlayBook }
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
pub fn play(mut plbook PlayBook) ! {
|
||||
|
||||
if plbook.exists_once(filter: 'docusaurus.define') {
|
||||
mut action := plbook.get(filter: 'docusaurus.define')!
|
||||
mut p := action.params
|
||||
//example how we get parameters from the action see core_params.md for more details
|
||||
ds = new(
|
||||
path: p.get_default('path_publish', '')!
|
||||
production: p.get_default_false('production')
|
||||
)!
|
||||
}
|
||||
|
||||
// Process 'docusaurus.add' actions to configure individual Docusaurus sites
|
||||
actions := plbook.find(filter: 'docusaurus.add')!
|
||||
for action in actions {
|
||||
mut p := action.params
|
||||
//do more processing here
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
For detailed information on parameter retrieval methods (e.g., `p.get()`, `p.get_int()`, `p.get_default_true()`), refer to `aiprompts/ai_core/core_params.md`.
|
||||
23
aiprompts/herolib_core/core_heroscript_playbook.md
Normal file
23
aiprompts/herolib_core/core_heroscript_playbook.md
Normal file
@@ -0,0 +1,23 @@
|
||||
# PlayBook
|
||||
|
||||
## get & execute a playbook
|
||||
|
||||
HeroScript can be parsed into a `playbook.PlayBook` object, allowing structured access to actions and their parameters.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.playbook
|
||||
import incubaid.herolib.core.playcmds
|
||||
|
||||
// path string
|
||||
// text string
|
||||
// git_url string
|
||||
// git_pull bool
|
||||
// git_branch string
|
||||
// git_reset bool
|
||||
// session ?&base.Session is optional
|
||||
mut plbook := playbook.new(path: "....")!
|
||||
|
||||
//now we run all the commands as they are pre-defined in herolib, this will execute the playbook and do all actions.
|
||||
playcmds.run(mut plbook)!
|
||||
|
||||
```
|
||||
108
aiprompts/herolib_core/core_http_client.md
Normal file
108
aiprompts/herolib_core/core_http_client.md
Normal file
@@ -0,0 +1,108 @@
|
||||
# HTTPConnection Module
|
||||
|
||||
The `HTTPConnection` module provides a robust HTTP client for Vlang, supporting JSON, custom headers, retries, and caching.
|
||||
|
||||
## Key Features
|
||||
|
||||
- Type-safe JSON methods
|
||||
- Custom headers
|
||||
- Retry mechanism
|
||||
- Caching
|
||||
- URL encoding
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.httpconnection
|
||||
|
||||
// Create a new HTTP connection
|
||||
mut conn := httpconnection.new(
|
||||
name: 'my_api_client'
|
||||
url: 'https://api.example.com'
|
||||
retry: 3 // Number of retries for failed requests
|
||||
cache: true // Enable caching
|
||||
)!
|
||||
```
|
||||
|
||||
## Integration with Management Classes
|
||||
|
||||
To integrate `HTTPConnection` into a management class (e.g., `HetznerManager`), use a method to lazily initialize and return the connection:
|
||||
|
||||
```v
|
||||
// Example: HetznerManager
|
||||
pub fn (mut h HetznerManager) connection() !&httpconnection.HTTPConnection {
|
||||
mut c := h.conn or {
|
||||
mut c2 := httpconnection.new(
|
||||
name: 'hetzner_${h.name}'
|
||||
url: h.baseurl
|
||||
cache: true
|
||||
retry: 3
|
||||
)!
|
||||
c2.basic_auth(h.user, h.password)
|
||||
c2
|
||||
}
|
||||
return c
|
||||
}
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
### GET Request with JSON Response
|
||||
|
||||
```v
|
||||
struct User {
|
||||
id int
|
||||
name string
|
||||
email string
|
||||
}
|
||||
|
||||
user := conn.get_json_generic[User](
|
||||
prefix: 'users/1'
|
||||
)!
|
||||
```
|
||||
|
||||
### POST Request with JSON Data
|
||||
|
||||
```v
|
||||
struct NewUserResponse {
|
||||
id int
|
||||
status string
|
||||
}
|
||||
|
||||
new_user_resp := conn.post_json_generic[NewUserResponse](
|
||||
prefix: 'users'
|
||||
params: {
|
||||
'name': 'Jane Doe'
|
||||
'email': 'jane@example.com'
|
||||
}
|
||||
)!
|
||||
```
|
||||
|
||||
### Custom Headers
|
||||
|
||||
Set default headers or add them per request:
|
||||
|
||||
```v
|
||||
import net.http { Header }
|
||||
|
||||
// Set default header
|
||||
conn.default_header = http.new_header(key: .authorization, value: 'Bearer your-token')
|
||||
|
||||
// Add custom header for a specific request
|
||||
response := conn.get_json(
|
||||
prefix: 'protected/resource'
|
||||
header: http.new_header(key: .content_type, value: 'application/json')
|
||||
)!
|
||||
```
|
||||
|
||||
### Error Handling
|
||||
|
||||
Methods return a `Result` type for error handling:
|
||||
|
||||
```v
|
||||
user := conn.get_json_generic[User](
|
||||
prefix: 'users/1'
|
||||
) or {
|
||||
println('Error fetching user: ${err}')
|
||||
return
|
||||
}
|
||||
84
aiprompts/herolib_core/core_osal.md
Normal file
84
aiprompts/herolib_core/core_osal.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# OSAL Core Module - Key Capabilities (incubaid.herolib.osal.core)
|
||||
|
||||
> **Note:** Platform detection functions (`platform()` and `cputype()`) have moved to `incubaid.herolib.core`.
|
||||
> Use `import incubaid.herolib.core` and call `core.platform()!` and `core.cputype()!` instead.
|
||||
|
||||
```v
|
||||
//example how to get started
|
||||
|
||||
import incubaid.herolib.osal.core as osal
|
||||
|
||||
job := osal.exec(cmd: 'ls /')!
|
||||
```
|
||||
|
||||
This document describes the core functionalities of the Operating System Abstraction Layer (OSAL) module, designed for platform-independent system operations in V.
|
||||
|
||||
## 1. Process Execution
|
||||
|
||||
* **`osal.exec(cmd: Command) !Job`**: Execute a shell command.
|
||||
* **Key Parameters**: `cmd` (string), `timeout` (int), `retry` (int), `work_folder` (string), `environment` (map[string]string), `stdout` (bool), `raise_error` (bool).
|
||||
* **Returns**: `Job` (status, output, error, exit code).
|
||||
* **`osal.execute_silent(cmd string) !string`**: Execute silently, return output.
|
||||
* **`osal.execute_debug(cmd string) !string`**: Execute with debug output, return output.
|
||||
* **`osal.execute_stdout(cmd string) !string`**: Execute and print output to stdout, return output.
|
||||
* **`osal.execute_interactive(cmd string) !`**: Execute in an interactive shell.
|
||||
* **`osal.cmd_exists(cmd string) bool`**: Check if a command exists.
|
||||
|
||||
## 2. Network Utilities
|
||||
|
||||
* **`osal.ping(args: PingArgs) !bool`**: Check host reachability.
|
||||
- address string = "8.8.8.8"
|
||||
- nr_ping u16 = 3 // amount of ping requests we will do
|
||||
- nr_ok u16 = 3 //how many of them need to be ok
|
||||
- retry u8 //how many times fo we retry above sequence, basically we ping ourselves with -c 1
|
||||
**`osal.ipaddr_pub_get() !string`**: Get public IP address.
|
||||
|
||||
## 3. File System Operations
|
||||
|
||||
* **`osal.file_write(path string, text string) !`**: Write text to a file.
|
||||
* **`osal.file_read(path string) !string`**: Read content from a file.
|
||||
* **`osal.dir_ensure(path string) !`**: Ensure a directory exists.
|
||||
* **`osal.rm(todelete string) !`**: Remove files/directories.
|
||||
|
||||
## 4. Environment Variables
|
||||
|
||||
* **`osal.env_set(args: EnvSet)`**: Set an environment variable.
|
||||
* **Key Parameters**: `key` (string), `value` (string).
|
||||
* **`osal.env_unset(key string)`**: Unset a specific environment variable.
|
||||
* **`osal.env_unset_all()`**: Unset all environment variables.
|
||||
* **`osal.env_set_all(args: EnvSetAll)`**: Set multiple environment variables.
|
||||
* **Key Parameters**: `env` (map[string]string), `clear_before_set` (bool), `overwrite_if_exists` (bool).
|
||||
* **`osal.env_get(key string) !string`**: Get an environment variable's value.
|
||||
* **`osal.env_exists(key string) !bool`**: Check if an environment variable exists.
|
||||
* **`osal.env_get_default(key string, def string) string`**: Get an environment variable or a default value.
|
||||
* **`osal.load_env_file(file_path string) !`**: Load variables from a file.
|
||||
|
||||
## 5. Command & Profile Management
|
||||
|
||||
* **`osal.cmd_add(args: CmdAddArgs) !`**: Add a binary to system paths and update profiles.
|
||||
* **Key Parameters**: `source` (string, required), `cmdname` (string).
|
||||
* **`osal.profile_path_add_remove(args: ProfilePathAddRemoveArgs) !`**: Add/remove paths from profiles.
|
||||
* **Key Parameters**: `paths2add` (string), `paths2delete` (string).
|
||||
|
||||
## 6. System Information & Utilities
|
||||
|
||||
* **`osal.processmap_get() !ProcessMap`**: Get a map of all running processes.
|
||||
* **`osal.processinfo_get(pid int) !ProcessInfo`**: Get detailed information for a specific process.
|
||||
* **`osal.processinfo_get_byname(name string) ![]ProcessInfo`**: Get info for processes matching a name.
|
||||
* **`osal.process_exists(pid int) bool`**: Check if a process exists by PID.
|
||||
* **`osal.processinfo_with_children(pid int) !ProcessMap`**: Get a process and its children.
|
||||
* **`osal.processinfo_children(pid int) !ProcessMap`**: Get children of a process.
|
||||
* **`osal.process_kill_recursive(args: ProcessKillArgs) !`**: Kill a process and its children.
|
||||
* **Key Parameters**: `name` (string), `pid` (int).
|
||||
* **`osal.whoami() !string`**: Return the current username.
|
||||
* ~~**`osal.platform() !PlatformType`**: Identify the operating system.~~ → **Moved to `incubaid.herolib.core`**
|
||||
* ~~**`osal.cputype() !CPUType`**: Identify the CPU architecture.~~ → **Moved to `incubaid.herolib.core`**
|
||||
* **`osal.hostname() !string`**: Get system hostname.
|
||||
* **`osal.sleep(duration int)`**: Pause execution for a specified duration.
|
||||
* **`osal.download(args: DownloadArgs) !pathlib.Path`**: Download a file from a URL.
|
||||
* `pathlib.Path` is from `incubaid.herolib.core.pathlib`
|
||||
* **Key Parameters**: `url` (string), `dest` (string), `timeout` (int), `retry` (int).
|
||||
* **`osal.user_exists(username string) bool`**: Check if a user exists.
|
||||
* **`osal.user_id_get(username string) !int`**: Get user ID.
|
||||
* **`osal.user_add(args: UserArgs) !int`**: Add a user.
|
||||
* **Key Parameters**: `name` (string).
|
||||
93
aiprompts/herolib_core/core_ourtime.md
Normal file
93
aiprompts/herolib_core/core_ourtime.md
Normal file
@@ -0,0 +1,93 @@
|
||||
# OurTime Module
|
||||
|
||||
The `OurTime` module in V provides flexible time handling, supporting relative and absolute time formats, Unix timestamps, and formatting utilities.
|
||||
|
||||
## Key Features
|
||||
|
||||
- Create time objects from strings or current time
|
||||
- Relative time expressions (e.g., `+1h`, `-2d`)
|
||||
- Absolute time formats (e.g., `YYYY-MM-DD HH:mm:ss`)
|
||||
- Unix timestamp conversion
|
||||
- Time formatting and warping
|
||||
|
||||
## Basic Usage
|
||||
|
||||
```v
|
||||
import incubaid.herolib.data.ourtime
|
||||
|
||||
// Current time
|
||||
mut t := ourtime.now()
|
||||
|
||||
// From string
|
||||
t2 := ourtime.new('2022-12-05 20:14:35')!
|
||||
|
||||
// Get formatted string
|
||||
println(t2.str()) // e.g., 2022-12-05 20:14
|
||||
|
||||
// Get Unix timestamp
|
||||
println(t2.unix()) // e.g., 1670271275
|
||||
```
|
||||
|
||||
## Time Formats
|
||||
|
||||
### Relative Time
|
||||
|
||||
Use `s` (seconds), `h` (hours), `d` (days), `w` (weeks), `M` (months), `Q` (quarters), `Y` (years).
|
||||
|
||||
```v
|
||||
// Create with relative time
|
||||
mut t := ourtime.new('+1w +2d -4h')!
|
||||
|
||||
// Warp existing time
|
||||
mut t2 := ourtime.now()
|
||||
t2.warp('+1h')!
|
||||
```
|
||||
|
||||
### Absolute Time
|
||||
|
||||
Supports `YYYY-MM-DD HH:mm:ss`, `YYYY-MM-DD HH:mm`, `YYYY-MM-DD HH`, `YYYY-MM-DD`, `DD-MM-YYYY`.
|
||||
|
||||
```v
|
||||
t1 := ourtime.new('2022-12-05 20:14:35')!
|
||||
t2 := ourtime.new('2022-12-05')! // Time defaults to 00:00:00
|
||||
```
|
||||
|
||||
## Methods Overview
|
||||
|
||||
### Creation
|
||||
|
||||
```v
|
||||
now_time := ourtime.now()
|
||||
from_string := ourtime.new('2023-01-15')!
|
||||
from_epoch := ourtime.new_from_epoch(1673788800)
|
||||
```
|
||||
|
||||
### Formatting
|
||||
|
||||
```v
|
||||
mut t := ourtime.now()
|
||||
println(t.str()) // YYYY-MM-DD HH:mm
|
||||
println(t.day()) // YYYY-MM-DD
|
||||
println(t.key()) // YYYY_MM_DD_HH_mm_ss
|
||||
println(t.md()) // Markdown format
|
||||
```
|
||||
|
||||
### Operations
|
||||
|
||||
```v
|
||||
mut t := ourtime.now()
|
||||
t.warp('+1h')! // Move 1 hour forward
|
||||
unix_ts := t.unix()
|
||||
is_empty := t.empty()
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
Time parsing methods return a `Result` type and should be handled with `!` or `or` blocks.
|
||||
|
||||
```v
|
||||
t_valid := ourtime.new('2023-01-01')!
|
||||
t_invalid := ourtime.new('bad-date') or {
|
||||
println('Error: ${err}')
|
||||
ourtime.now() // Fallback
|
||||
}
|
||||
110
aiprompts/herolib_core/core_params.md
Normal file
110
aiprompts/herolib_core/core_params.md
Normal file
@@ -0,0 +1,110 @@
|
||||
# Parameter Parsing in Vlang
|
||||
|
||||
This document details the `paramsparser` module, essential for handling parameters in HeroScript and other contexts.
|
||||
|
||||
## Obtaining a `paramsparser` Instance
|
||||
|
||||
```v
|
||||
import incubaid.herolib.data.paramsparser
|
||||
|
||||
// Create new params from a string
|
||||
params := paramsparser.new("color:red size:'large' priority:1 enable:true")!
|
||||
|
||||
// Or create an empty instance and add parameters programmatically
|
||||
mut params := paramsparser.new_params()
|
||||
params.set("color", "red")
|
||||
```
|
||||
|
||||
## Parameter Formats
|
||||
|
||||
The parser supports various input formats:
|
||||
|
||||
1. **Key-value pairs**: `key:value`
|
||||
2. **Quoted values**: `key:'value with spaces'` (single or double quotes)
|
||||
3. **Arguments without keys**: `arg1 arg2` (accessed by index)
|
||||
4. **Comments**: `// this is a comment` (ignored during parsing)
|
||||
|
||||
Example:
|
||||
|
||||
```v
|
||||
text := "name:'John Doe' age:30 active:true // user details"
|
||||
params := paramsparser.new(text)!
|
||||
```
|
||||
|
||||
## Parameter Retrieval Methods
|
||||
|
||||
The `paramsparser` module provides a comprehensive set of methods for retrieving and converting parameter values.
|
||||
|
||||
### Basic Retrieval
|
||||
|
||||
- `get(key string) !string`: Retrieves a string value by key. Returns an error if the key does not exist.
|
||||
- `get_default(key string, defval string) !string`: Retrieves a string value by key, or returns `defval` if the key is not found.
|
||||
- `exists(key string) bool`: Checks if a keyword argument (`key:value`) exists.
|
||||
- `exists_arg(key string) bool`: Checks if an argument (value without a key) exists.
|
||||
|
||||
### Argument Retrieval (Positional)
|
||||
|
||||
- `get_arg(nr int) !string`: Retrieves an argument by its 0-based index. Returns an error if the index is out of bounds.
|
||||
- `get_arg_default(nr int, defval string) !string`: Retrieves an argument by index, or returns `defval` if the index is out of bounds.
|
||||
|
||||
### Type-Specific Retrieval
|
||||
|
||||
- `get_int(key string) !int`: Converts and retrieves an integer (int32).
|
||||
- `get_int_default(key string, defval int) !int`: Retrieves an integer with a default.
|
||||
- `get_u32(key string) !u32`: Converts and retrieves an unsigned 32-bit integer.
|
||||
- `get_u32_default(key string, defval u32) !u32`: Retrieves a u32 with a default.
|
||||
- `get_u64(key string) !u64`: Converts and retrieves an unsigned 64-bit integer.
|
||||
- `get_u64_default(key string, defval u64) !u64`: Retrieves a u64 with a default.
|
||||
- `get_u8(key string) !u8`: Converts and retrieves an unsigned 8-bit integer.
|
||||
- `get_u8_default(key string, defval u8) !u8`: Retrieves a u8 with a default.
|
||||
- `get_float(key string) !f64`: Converts and retrieves a 64-bit float.
|
||||
- `get_float_default(key string, defval f64) !f64`: Retrieves a float with a default.
|
||||
- `get_percentage(key string) !f64`: Converts a percentage string (e.g., "80%") to a float (0.8).
|
||||
- `get_percentage_default(key string, defval string) !f64`: Retrieves a percentage with a default.
|
||||
|
||||
### Boolean Retrieval
|
||||
|
||||
- `get_default_true(key string) bool`: Returns `true` if the value is empty, "1", "true", "y", or "yes". Otherwise `false`.
|
||||
- `get_default_false(key string) bool`: Returns `false` if the value is empty, "0", "false", "n", or "no". Otherwise `true`.
|
||||
|
||||
### List Retrieval
|
||||
|
||||
Lists are typically comma-separated strings (e.g., `users: "john,jane,bob"`).
|
||||
|
||||
- `get_list(key string) ![]string`: Retrieves a list of strings.
|
||||
- `get_list_default(key string, def []string) ![]string`: Retrieves a list of strings with a default.
|
||||
- `get_list_int(key string) ![]int`: Retrieves a list of integers.
|
||||
- `get_list_int_default(key string, def []int) []int`: Retrieves a list of integers with a default.
|
||||
- `get_list_f32(key string) ![]f32`: Retrieves a list of 32-bit floats.
|
||||
- `get_list_f32_default(key string, def []f32) []f32`: Retrieves a list of f32 with a default.
|
||||
- `get_list_f64(key string) ![]f64`: Retrieves a list of 64-bit floats.
|
||||
- `get_list_f64_default(key string, def []f64) []f64`: Retrieves a list of f64 with a default.
|
||||
- `get_list_i8(key string) ![]i8`: Retrieves a list of 8-bit signed integers.
|
||||
- `get_list_i8_default(key string, def []i8) []i8`: Retrieves a list of i8 with a default.
|
||||
- `get_list_i16(key string) ![]i16`: Retrieves a list of 16-bit signed integers.
|
||||
- `get_list_i16_default(key string, def []i16) []i16`: Retrieves a list of i16 with a default.
|
||||
- `get_list_i64(key string) ![]i64`: Retrieves a list of 64-bit signed integers.
|
||||
- `get_list_i64_default(key string, def []i64) []i64`: Retrieves a list of i64 with a default.
|
||||
- `get_list_u16(key string) ![]u16`: Retrieves a list of 16-bit unsigned integers.
|
||||
- `get_list_u16_default(key string, def []u16) []u16`: Retrieves a list of u16 with a default.
|
||||
- `get_list_u32(key string) ![]u32`: Retrieves a list of 32-bit unsigned integers.
|
||||
- `get_list_u32_default(key string, def []u32) []u32`: Retrieves a list of u32 with a default.
|
||||
- `get_list_u64(key string) ![]u64`: Retrieves a list of 64-bit unsigned integers.
|
||||
- `get_list_u64_default(key string, def []u64) []u64`: Retrieves a list of u64 with a default.
|
||||
- `get_list_namefix(key string) ![]string`: Retrieves a list of strings, normalizing each item (e.g., "My Name" -> "my_name").
|
||||
- `get_list_namefix_default(key string, def []string) ![]string`: Retrieves a list of name-fixed strings with a default.
|
||||
|
||||
### Specialized Retrieval
|
||||
|
||||
- `get_map() map[string]string`: Returns all parameters as a map.
|
||||
- `get_path(key string) !string`: Retrieves a path string.
|
||||
- `get_path_create(key string) !string`: Retrieves a path string, creating the directory if it doesn't exist.
|
||||
- `get_from_hashmap(key string, defval string, hashmap map[string]string) !string`: Retrieves a value from a provided hashmap based on the parameter's value.
|
||||
- `get_storagecapacity_in_bytes(key string) !u64`: Converts storage capacity strings (e.g., "10 GB", "500 MB") to bytes (u64).
|
||||
- `get_storagecapacity_in_bytes_default(key string, defval u64) !u64`: Retrieves storage capacity in bytes with a default.
|
||||
- `get_storagecapacity_in_gigabytes(key string) !u64`: Converts storage capacity strings to gigabytes (u64).
|
||||
- `get_time(key string) !ourtime.OurTime`: Parses a time string (relative or absolute) into an `ourtime.OurTime` object.
|
||||
- `get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime`: Retrieves time with a default.
|
||||
- `get_time_interval(key string) !Duration`: Parses a time interval string into a `Duration` object.
|
||||
- `get_timestamp(key string) !Duration`: Parses a timestamp string into a `Duration` object.
|
||||
- `get_timestamp_default(key string, defval Duration) !Duration`: Retrieves a timestamp with a default.
|
||||
165
aiprompts/herolib_core/core_paths.md
Normal file
165
aiprompts/herolib_core/core_paths.md
Normal file
@@ -0,0 +1,165 @@
|
||||
# Pathlib Usage Guide
|
||||
|
||||
## Overview
|
||||
|
||||
The pathlib module provides a comprehensive interface for handling file system operations. Key features include:
|
||||
|
||||
- Robust path handling for files, directories, and symlinks
|
||||
- Support for both absolute and relative paths
|
||||
- Automatic home directory expansion (~)
|
||||
- Recursive directory operations
|
||||
- Path filtering and listing
|
||||
- File and directory metadata access
|
||||
|
||||
## Basic Usage
|
||||
|
||||
### Importing pathlib
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.pathlib
|
||||
```
|
||||
|
||||
### Creating Path Objects
|
||||
|
||||
This will figure out if the path is a dir, file and if it exists.
|
||||
|
||||
```v
|
||||
// Create a Path object for a file
|
||||
mut file_path := pathlib.get("path/to/file.txt")
|
||||
|
||||
// Create a Path object for a directory
|
||||
mut dir_path := pathlib.get("path/to/directory")
|
||||
```
|
||||
|
||||
if you know in advance if you expect a dir or file its better to use `pathlib.get_dir(path:...,create:true)` or `pathlib.get_file(path:...,create:true)`.
|
||||
|
||||
### Basic Path Operations
|
||||
|
||||
```v
|
||||
// Get absolute path
|
||||
abs_path := file_path.absolute()
|
||||
|
||||
// Get real path (resolves symlinks)
|
||||
real_path := file_path.realpath()
|
||||
|
||||
// Check if path exists
|
||||
if file_path.exists() {
|
||||
// Path exists
|
||||
}
|
||||
```
|
||||
|
||||
## Path Properties and Methods
|
||||
|
||||
### Path Types
|
||||
|
||||
```v
|
||||
// Check if path is a file
|
||||
if file_path.is_file() {
|
||||
// Handle as file
|
||||
}
|
||||
|
||||
// Check if path is a directory
|
||||
if dir_path.is_dir() {
|
||||
// Handle as directory
|
||||
}
|
||||
|
||||
// Check if path is a symlink
|
||||
if file_path.is_link() {
|
||||
// Handle as symlink
|
||||
}
|
||||
```
|
||||
|
||||
### Path Normalization
|
||||
|
||||
```v
|
||||
// Normalize path (remove extra slashes, resolve . and ..)
|
||||
normalized_path := file_path.path_normalize()
|
||||
|
||||
// Get path directory
|
||||
dir_path := file_path.path_dir()
|
||||
|
||||
// Get path name without extension
|
||||
name_no_ext := file_path.name_no_ext()
|
||||
```
|
||||
|
||||
## File and Directory Operations
|
||||
|
||||
### File Operations
|
||||
|
||||
```v
|
||||
// Write to file
|
||||
file_path.write("Content to write")!
|
||||
|
||||
// Read from file
|
||||
content := file_path.read()!
|
||||
|
||||
// Delete file
|
||||
file_path.delete()!
|
||||
```
|
||||
|
||||
### Directory Operations
|
||||
|
||||
```v
|
||||
// Create directory
|
||||
mut dir := pathlib.get_dir(
|
||||
path: "path/to/new/dir"
|
||||
create: true
|
||||
)!
|
||||
|
||||
// List directory contents
|
||||
mut dir_list := dir.list()!
|
||||
|
||||
// Delete directory
|
||||
dir.delete()!
|
||||
```
|
||||
|
||||
### Symlink Operations
|
||||
|
||||
```v
|
||||
// Create symlink
|
||||
file_path.link("path/to/symlink", delete_exists: true)!
|
||||
|
||||
// Resolve symlink
|
||||
real_path := file_path.realpath()
|
||||
```
|
||||
|
||||
## Advanced Operations
|
||||
|
||||
### Path Copying
|
||||
|
||||
```v
|
||||
// Copy file to destination
|
||||
file_path.copy(dest: "path/to/destination")!
|
||||
```
|
||||
|
||||
### Recursive Operations
|
||||
|
||||
```v
|
||||
// List directory recursively
|
||||
mut recursive_list := dir.list(recursive: true)!
|
||||
|
||||
// Delete directory recursively
|
||||
dir.delete()!
|
||||
```
|
||||
|
||||
### Path Filtering
|
||||
|
||||
```v
|
||||
// List files matching pattern
|
||||
mut filtered_list := dir.list(
|
||||
regex: [r".*\.txt$"],
|
||||
recursive: true
|
||||
)!
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### Error Handling
|
||||
|
||||
```v
|
||||
if file_path.exists() {
|
||||
// Safe to operate
|
||||
} else {
|
||||
// Handle missing file
|
||||
}
|
||||
```
|
||||
204
aiprompts/herolib_core/core_redis.md
Normal file
204
aiprompts/herolib_core/core_redis.md
Normal file
@@ -0,0 +1,204 @@
|
||||
# Redisclient Module
|
||||
|
||||
The `redisclient` module in Herolib provides a comprehensive client for interacting with Redis, supporting various commands, caching, queues, and RPC mechanisms.
|
||||
|
||||
## Key Features
|
||||
|
||||
- **Direct Redis Commands**: Access to a wide range of Redis commands (strings, hashes, lists, keys, etc.).
|
||||
- **Caching**: Built-in caching mechanism with namespace support and expiration.
|
||||
- **Queues**: Simple queue implementation using Redis lists.
|
||||
- **RPC**: Remote Procedure Call (RPC) functionality over Redis queues for inter-service communication.
|
||||
|
||||
## Basic Usage
|
||||
|
||||
To get a Redis client instance, use `redisclient.core_get()`. By default, it connects to `127.0.0.1:6379`. You can specify a different address and port using the `RedisURL` struct.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.redisclient
|
||||
|
||||
// Connect to default Redis instance (127.0.0.1:6379)
|
||||
mut redis := redisclient.core_get()!
|
||||
|
||||
// Or connect to a specific Redis instance
|
||||
// mut redis_url := redisclient.RedisURL{address: 'my.redis.server', port: 6380}
|
||||
// mut redis := redisclient.core_get(redis_url)!
|
||||
|
||||
// Example: Set and Get a key
|
||||
redis.set('mykey', 'myvalue')!
|
||||
value := redis.get('mykey')!
|
||||
// assert value == 'myvalue'
|
||||
|
||||
// Example: Check if a key exists
|
||||
exists := redis.exists('mykey')!
|
||||
// assert exists == true
|
||||
|
||||
// Example: Delete a key
|
||||
redis.del('mykey')!
|
||||
```
|
||||
|
||||
## Redis Commands
|
||||
|
||||
The `Redis` object provides methods for most standard Redis commands. Here are some examples:
|
||||
|
||||
### String Commands
|
||||
|
||||
- `set(key string, value string) !`: Sets the string value of a key.
|
||||
- `get(key string) !string`: Gets the string value of a key.
|
||||
- `set_ex(key string, value string, ex string) !`: Sets a key with an expiration time in seconds.
|
||||
- `incr(key string) !int`: Increments the integer value of a key by one.
|
||||
- `decr(key string) !int`: Decrements the integer value of a key by one.
|
||||
- `append(key string, value string) !int`: Appends a value to a key.
|
||||
- `strlen(key string) !int`: Gets the length of the value stored in a key.
|
||||
|
||||
```v
|
||||
redis.set('counter', '10')!
|
||||
redis.incr('counter')! // counter is now 11
|
||||
val := redis.get('counter')! // "11"
|
||||
```
|
||||
|
||||
### Hash Commands
|
||||
|
||||
- `hset(key string, skey string, value string) !`: Sets the string value of a hash field.
|
||||
- `hget(key string, skey string) !string`: Gets the value of a hash field.
|
||||
- `hgetall(key string) !map[string]string`: Gets all fields and values in a hash.
|
||||
- `hexists(key string, skey string) !bool`: Checks if a hash field exists.
|
||||
- `hdel(key string, skey string) !int`: Deletes one or more hash fields.
|
||||
|
||||
```v
|
||||
redis.hset('user:1', 'name', 'John Doe')!
|
||||
redis.hset('user:1', 'email', 'john@example.com')!
|
||||
user_name := redis.hget('user:1', 'name')! // "John Doe"
|
||||
user_data := redis.hgetall('user:1')! // map['name':'John Doe', 'email':'john@example.com']
|
||||
```
|
||||
|
||||
### List Commands
|
||||
|
||||
- `lpush(key string, element string) !int`: Inserts all specified values at the head of the list stored at key.
|
||||
- `rpush(key string, element string) !int`: Inserts all specified values at the tail of the list stored at key.
|
||||
- `lpop(key string) !string`: Removes and returns the first element of the list stored at key.
|
||||
- `rpop(key string) !string`: Removes and returns the last element of the list stored at key.
|
||||
- `llen(key string) !int`: Gets the length of a list.
|
||||
- `lrange(key string, start int, end int) ![]resp.RValue`: Gets a range of elements from a list.
|
||||
|
||||
```v
|
||||
redis.lpush('mylist', 'item1')!
|
||||
redis.rpush('mylist', 'item2')!
|
||||
first_item := redis.lpop('mylist')! // "item1"
|
||||
```
|
||||
|
||||
### Set Commands
|
||||
|
||||
- `sadd(key string, members []string) !int`: Adds the specified members to the set stored at key.
|
||||
- `smismember(key string, members []string) ![]int`: Returns if member is a member of the set stored at key.
|
||||
|
||||
```v
|
||||
redis.sadd('myset', ['member1', 'member2'])!
|
||||
is_member := redis.smismember('myset', ['member1', 'member3'])! // [1, 0]
|
||||
```
|
||||
|
||||
### Key Management
|
||||
|
||||
- `keys(pattern string) ![]string`: Finds all keys matching the given pattern.
|
||||
- `del(key string) !int`: Deletes a key.
|
||||
- `expire(key string, seconds int) !int`: Sets a key's time to live in seconds.
|
||||
- `ttl(key string) !int`: Gets the time to live for a key in seconds.
|
||||
- `flushall() !`: Deletes all the keys of all the existing databases.
|
||||
- `flushdb() !`: Deletes all the keys of the currently selected database.
|
||||
- `selectdb(database int) !`: Changes the selected database.
|
||||
|
||||
```v
|
||||
redis.set('temp_key', 'value')!
|
||||
redis.expire('temp_key', 60)! // Expires in 60 seconds
|
||||
```
|
||||
|
||||
## Redis Cache
|
||||
|
||||
The `RedisCache` struct provides a convenient way to implement caching using Redis.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.redisclient
|
||||
|
||||
mut redis := redisclient.core_get()!
|
||||
mut cache := redis.cache('my_app_cache')
|
||||
|
||||
// Set a value in cache with expiration (e.g., 3600 seconds)
|
||||
cache.set('user:profile:123', '{ "name": "Alice" }', 3600)!
|
||||
|
||||
// Get a value from cache
|
||||
cached_data := cache.get('user:profile:123') or {
|
||||
// Cache miss, fetch from source
|
||||
println('Cache miss for user:profile:123')
|
||||
return
|
||||
}
|
||||
// println('Cached data: ${cached_data}')
|
||||
|
||||
// Check if a key exists in cache
|
||||
exists := cache.exists('user:profile:123')
|
||||
// assert exists == true
|
||||
|
||||
// Reset the cache for the namespace
|
||||
cache.reset()!
|
||||
```
|
||||
|
||||
## Redis Queue
|
||||
|
||||
The `RedisQueue` struct provides a simple queue mechanism using Redis lists.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.redisclient
|
||||
import time
|
||||
|
||||
mut redis := redisclient.core_get()!
|
||||
mut my_queue := redis.queue_get('my_task_queue')
|
||||
|
||||
// Add items to the queue
|
||||
my_queue.add('task1')!
|
||||
my_queue.add('task2')!
|
||||
|
||||
// Get an item from the queue with a timeout (e.g., 1000 milliseconds)
|
||||
task := my_queue.get(1000)!
|
||||
// assert task == 'task1'
|
||||
|
||||
// Pop an item without timeout (returns error if no item)
|
||||
task2 := my_queue.pop()!
|
||||
// assert task2 == 'task2'
|
||||
```
|
||||
|
||||
## Redis RPC
|
||||
|
||||
The `RedisRpc` struct enables Remote Procedure Call (RPC) over Redis, allowing services to communicate by sending messages to queues and waiting for responses.
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.redisclient
|
||||
import json
|
||||
import time
|
||||
|
||||
mut redis := redisclient.core_get()!
|
||||
mut rpc_client := redis.rpc_get('my_rpc_service')
|
||||
|
||||
// Define a function to process RPC requests (server-side)
|
||||
fn my_rpc_processor(cmd string, data string) !string {
|
||||
// Simulate some processing based on cmd and data
|
||||
return 'Processed: cmd=${cmd}, data=${data}'
|
||||
}
|
||||
|
||||
// --- Client Side (calling the RPC) ---
|
||||
// Call the RPC service
|
||||
response := rpc_client.call(
|
||||
cmd: 'greet',
|
||||
data: '{"name": "World"}',
|
||||
wait: true,
|
||||
timeout: 5000 // 5 seconds timeout
|
||||
)!
|
||||
// println('RPC Response: ${response}')
|
||||
// assert response == 'Processed: cmd=greet, data={"name": "World"}'
|
||||
|
||||
// --- Server Side (processing RPC requests) ---
|
||||
// In a separate goroutine or process, you would run:
|
||||
// rpc_client.process(my_rpc_processor, timeout: 0)! // timeout 0 means no timeout, keeps processing
|
||||
|
||||
// Example of how to process a single request (for testing/demonstration)
|
||||
// In a real application, this would be in a loop or a background worker
|
||||
// return_queue_name := rpc_client.process(my_rpc_processor, timeout: 1000)!
|
||||
// result := rpc_client.result(1000, return_queue_name)!
|
||||
// println('Processed result: ${result}')
|
||||
127
aiprompts/herolib_core/core_text.md
Normal file
127
aiprompts/herolib_core/core_text.md
Normal file
@@ -0,0 +1,127 @@
|
||||
# TextTools Module
|
||||
|
||||
The `texttools` module provides a comprehensive set of utilities for text manipulation and processing.
|
||||
|
||||
## Functions and Examples
|
||||
|
||||
```v
|
||||
import incubaid.herolib.core.texttools
|
||||
|
||||
assert hello_world == texttools.name_fix("Hello World!")
|
||||
|
||||
```
|
||||
|
||||
### Name/Path Processing
|
||||
|
||||
* `name_fix(name string) string`: Normalizes filenames and paths.
|
||||
* `name_fix_keepspace(name string) !string`: Like name_fix but preserves spaces.
|
||||
* `name_fix_no_ext(name_ string) string`: Removes file extension.
|
||||
* `name_fix_snake_to_pascal(name string) string`: Converts snake_case to PascalCase.
|
||||
|
||||
```v
|
||||
name := texttools.name_fix_snake_to_pascal("hello_world") // Result: "HelloWorld"
|
||||
```
|
||||
|
||||
* `snake_case(name string) string`: Converts PascalCase to snake_case.
|
||||
|
||||
```v
|
||||
name := texttools.snake_case("HelloWorld") // Result: "hello_world"
|
||||
```
|
||||
|
||||
* `name_split(name string) !(string, string)`: Splits name into site and page components.
|
||||
|
||||
### Text Cleaning
|
||||
|
||||
* `name_clean(r string) string`: Normalizes names by removing special characters.
|
||||
|
||||
```v
|
||||
name := texttools.name_clean("Hello@World!") // Result: "HelloWorld"
|
||||
```
|
||||
|
||||
* `ascii_clean(r string) string`: Removes all non-ASCII characters.
|
||||
* `remove_empty_lines(text string) string`: Removes empty lines from text.
|
||||
|
||||
```v
|
||||
text := texttools.remove_empty_lines("line1\n\nline2\n\n\nline3") // Result: "line1\nline2\nline3"
|
||||
```
|
||||
|
||||
* `remove_double_lines(text string) string`: Removes consecutive empty lines.
|
||||
* `remove_empty_js_blocks(text string) string`: Removes empty code blocks (```...```).
|
||||
|
||||
### Command Line Parsing
|
||||
|
||||
* `cmd_line_args_parser(text string) ![]string`: Parses command line arguments with support for quotes and escaping.
|
||||
|
||||
```v
|
||||
args := texttools.cmd_line_args_parser("'arg with spaces' --flag=value") // Result: ['arg with spaces', '--flag=value']
|
||||
```
|
||||
|
||||
* `text_remove_quotes(text string) string`: Removes quoted sections from text.
|
||||
* `check_exists_outside_quotes(text string, items []string) bool`: Checks if items exist in text outside of quotes.
|
||||
|
||||
### Text Expansion
|
||||
|
||||
* `expand(txt_ string, l int, expand_with string) string`: Expands text to a specified length with a given character.
|
||||
|
||||
### Indentation
|
||||
|
||||
* `indent(text string, prefix string) string`: Adds indentation prefix to each line.
|
||||
|
||||
```v
|
||||
text := texttools.indent("line1\nline2", " ") // Result: " line1\n line2\n"
|
||||
```
|
||||
|
||||
* `dedent(text string) string`: Removes common leading whitespace from every line.
|
||||
|
||||
```v
|
||||
text := texttools.dedent(" line1\n line2") // Result: "line1\nline2"
|
||||
```
|
||||
|
||||
### String Validation
|
||||
|
||||
* `is_int(text string) bool`: Checks if text contains only digits.
|
||||
* `is_upper_text(text string) bool`: Checks if text contains only uppercase letters.
|
||||
|
||||
### Multiline Processing
|
||||
|
||||
* `multiline_to_single(text string) !string`: Converts multiline text to a single line with proper escaping.
|
||||
|
||||
### Text Splitting
|
||||
|
||||
* `split_smart(t string, delimiter_ string) []string`: Intelligent string splitting that respects quotes.
|
||||
|
||||
### Tokenization
|
||||
|
||||
* `tokenize(text_ string) TokenizerResult`: Tokenizes text into meaningful parts.
|
||||
* `text_token_replace(text string, tofind string, replacewith string) !string`: Replaces tokens in text.
|
||||
|
||||
### Version Parsing
|
||||
|
||||
* `version(text_ string) int`: Converts version strings to comparable integers.
|
||||
|
||||
```v
|
||||
ver := texttools.version("v0.4.36") // Result: 4036
|
||||
ver = texttools.version("v1.4.36") // Result: 1004036
|
||||
```
|
||||
|
||||
### Formatting
|
||||
|
||||
* `format_rfc1123(t time.Time) string`: Formats a time.Time object into RFC 1123 format.
|
||||
|
||||
### Array Operations
|
||||
|
||||
* `to_array(r string) []string`: Converts a comma or newline separated list to an array of strings.
|
||||
|
||||
```v
|
||||
text := "item1,item2,item3"
|
||||
array := texttools.to_array(text) // Result: ['item1', 'item2', 'item3']
|
||||
```
|
||||
|
||||
* `to_array_int(r string) []int`: Converts a text list to an array of integers.
|
||||
* `to_map(mapstring string, line string, delimiter_ string) map[string]string`: Intelligent mapping of a line to a map based on a template.
|
||||
|
||||
```v
|
||||
r := texttools.to_map("name,-,-,-,-,pid,-,-,-,-,path",
|
||||
"root 304 0.0 0.0 408185328 1360 ?? S 16Dec23 0:34.06 /usr/sbin/distnoted")
|
||||
// Result: {'name': 'root', 'pid': '1360', 'path': '/usr/sbin/distnoted'}
|
||||
```
|
||||
@@ -4,8 +4,8 @@ has mechanisms to print better to console, see the methods below
|
||||
|
||||
import as
|
||||
|
||||
```vlang
|
||||
import freeflowuniverse.herolib.ui.console
|
||||
```v
|
||||
import incubaid.herolib.ui.console
|
||||
|
||||
```
|
||||
|
||||
@@ -24,23 +24,23 @@ fn color_fg(c ForegroundColor) string
|
||||
|
||||
struct PrintArgs {
|
||||
pub mut:
|
||||
foreground ForegroundColor
|
||||
background BackgroundColor
|
||||
text string
|
||||
style Style
|
||||
reset_before bool = true
|
||||
reset_after bool = true
|
||||
foreground ForegroundColor
|
||||
background BackgroundColor
|
||||
text string
|
||||
style Style
|
||||
reset_before bool = true
|
||||
reset_after bool = true
|
||||
}
|
||||
|
||||
fn cprint(args PrintArgs)
|
||||
// print with colors, reset...
|
||||
// ```
|
||||
// foreground ForegroundColor
|
||||
// background BackgroundColor
|
||||
// text string
|
||||
// style Style
|
||||
// reset_before bool = true
|
||||
// reset_after bool = true
|
||||
// foreground ForegroundColor
|
||||
// background BackgroundColor
|
||||
// text string
|
||||
// style Style
|
||||
// reset_before bool = true
|
||||
// reset_after bool = true
|
||||
// ```
|
||||
|
||||
fn cprintln(args_ PrintArgs)
|
||||
@@ -95,11 +95,11 @@ Is used to ask feedback to users
|
||||
|
||||
struct UIConsole {
|
||||
pub mut:
|
||||
x_max int = 80
|
||||
y_max int = 60
|
||||
prev_lf bool
|
||||
prev_title bool
|
||||
prev_item bool
|
||||
x_max int = 80
|
||||
y_max int = 60
|
||||
prev_lf bool
|
||||
prev_title bool
|
||||
prev_item bool
|
||||
}
|
||||
|
||||
//DropDownArgs:
|
||||
@@ -150,51 +150,51 @@ fn (mut c UIConsole) status() string
|
||||
|
||||
```v
|
||||
enum BackgroundColor {
|
||||
default_color = 49 // 'default' is a reserved keyword in V
|
||||
black = 40
|
||||
red = 41
|
||||
green = 42
|
||||
yellow = 43
|
||||
blue = 44
|
||||
magenta = 45
|
||||
cyan = 46
|
||||
light_gray = 47
|
||||
dark_gray = 100
|
||||
light_red = 101
|
||||
light_green = 102
|
||||
light_yellow = 103
|
||||
light_blue = 104
|
||||
light_magenta = 105
|
||||
light_cyan = 106
|
||||
white = 107
|
||||
default_color = 49 // 'default' is a reserved keyword in V
|
||||
black = 40
|
||||
red = 41
|
||||
green = 42
|
||||
yellow = 43
|
||||
blue = 44
|
||||
magenta = 45
|
||||
cyan = 46
|
||||
light_gray = 47
|
||||
dark_gray = 100
|
||||
light_red = 101
|
||||
light_green = 102
|
||||
light_yellow = 103
|
||||
light_blue = 104
|
||||
light_magenta = 105
|
||||
light_cyan = 106
|
||||
white = 107
|
||||
}
|
||||
enum ForegroundColor {
|
||||
default_color = 39 // 'default' is a reserved keyword in V
|
||||
white = 97
|
||||
black = 30
|
||||
red = 31
|
||||
green = 32
|
||||
yellow = 33
|
||||
blue = 34
|
||||
magenta = 35
|
||||
cyan = 36
|
||||
light_gray = 37
|
||||
dark_gray = 90
|
||||
light_red = 91
|
||||
light_green = 92
|
||||
light_yellow = 93
|
||||
light_blue = 94
|
||||
light_magenta = 95
|
||||
light_cyan = 96
|
||||
default_color = 39 // 'default' is a reserved keyword in V
|
||||
white = 97
|
||||
black = 30
|
||||
red = 31
|
||||
green = 32
|
||||
yellow = 33
|
||||
blue = 34
|
||||
magenta = 35
|
||||
cyan = 36
|
||||
light_gray = 37
|
||||
dark_gray = 90
|
||||
light_red = 91
|
||||
light_green = 92
|
||||
light_yellow = 93
|
||||
light_blue = 94
|
||||
light_magenta = 95
|
||||
light_cyan = 96
|
||||
}
|
||||
enum Style {
|
||||
normal = 99
|
||||
bold = 1
|
||||
dim = 2
|
||||
underline = 4
|
||||
blink = 5
|
||||
reverse = 7
|
||||
hidden = 8
|
||||
normal = 99
|
||||
bold = 1
|
||||
dim = 2
|
||||
underline = 4
|
||||
blink = 5
|
||||
reverse = 7
|
||||
hidden = 8
|
||||
}
|
||||
|
||||
```
|
||||
18
aiprompts/herolib_core/core_vshell.md
Normal file
18
aiprompts/herolib_core/core_vshell.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# how to run the vshell example scripts
|
||||
|
||||
this is how we want example scripts to be, see the first line
|
||||
|
||||
```v
|
||||
#!/usr/bin/env -S v -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import incubaid.herolib...
|
||||
|
||||
```
|
||||
|
||||
the files are in ~/code/github/incubaid/herolib/examples for herolib
|
||||
|
||||
## important instructions
|
||||
|
||||
- never use fn main() in a .vsh script
|
||||
- always use the top line as in example above
|
||||
- these scripts can be executed as is but can also use vrun $pathOfFile
|
||||
165
aiprompts/herolib_core/v_templates.md
Normal file
165
aiprompts/herolib_core/v_templates.md
Normal file
@@ -0,0 +1,165 @@
|
||||
V allows for easily using text templates, expanded at compile time to
|
||||
V functions, that efficiently produce text output. This is especially
|
||||
useful for templated HTML views, but the mechanism is general enough
|
||||
to be used for other kinds of text output also.
|
||||
|
||||
# Template directives
|
||||
|
||||
Each template directive begins with an `@` sign.
|
||||
Some directives contain a `{}` block, others only have `''` (string) parameters.
|
||||
|
||||
Newlines on the beginning and end are ignored in `{}` blocks,
|
||||
otherwise this (see [if](#if) for this syntax):
|
||||
|
||||
```html
|
||||
@if bool_val {
|
||||
<span>This is shown if bool_val is true</span>
|
||||
}
|
||||
```
|
||||
|
||||
... would output:
|
||||
|
||||
```html
|
||||
|
||||
<span>This is shown if bool_val is true</span>
|
||||
|
||||
```
|
||||
|
||||
... which is less readable.
|
||||
|
||||
## if
|
||||
|
||||
The if directive, consists of three parts, the `@if` tag, the condition (same syntax like in V)
|
||||
and the `{}` block, where you can write html, which will be rendered if the condition is true:
|
||||
|
||||
```
|
||||
@if <condition> {}
|
||||
```
|
||||
|
||||
### Example
|
||||
|
||||
```html
|
||||
@if bool_val {
|
||||
<span>This is shown if bool_val is true</span>
|
||||
}
|
||||
```
|
||||
|
||||
One-liner:
|
||||
|
||||
```html
|
||||
@if bool_val { <span>This is shown if bool_val is true</span> }
|
||||
```
|
||||
|
||||
The first example would result in:
|
||||
|
||||
```html
|
||||
<span>This is shown if bool_val is true</span>
|
||||
```
|
||||
|
||||
... while the one-liner results in:
|
||||
|
||||
```html
|
||||
<span>This is shown if bool_val is true</span>
|
||||
```
|
||||
|
||||
## for
|
||||
|
||||
The for directive consists of three parts, the `@for` tag,
|
||||
the condition (same syntax like in V) and the `{}` block,
|
||||
where you can write text, rendered for each iteration of the loop:
|
||||
|
||||
```
|
||||
@for <condition> {}
|
||||
```
|
||||
|
||||
### Example for @for
|
||||
|
||||
```html
|
||||
@for i, val in my_vals {
|
||||
<span>$i - $val</span>
|
||||
}
|
||||
```
|
||||
|
||||
One-liner:
|
||||
|
||||
```html
|
||||
@for i, val in my_vals { <span>$i - $val</span> }
|
||||
```
|
||||
|
||||
The first example would result in:
|
||||
|
||||
```html
|
||||
<span>0 - "First"</span>
|
||||
<span>1 - "Second"</span>
|
||||
<span>2 - "Third"</span>
|
||||
...
|
||||
```
|
||||
|
||||
... while the one-liner results in:
|
||||
|
||||
```html
|
||||
<span>0 - "First"</span>
|
||||
<span>1 - "Second"</span>
|
||||
<span>2 - "Third"</span>
|
||||
...
|
||||
```
|
||||
|
||||
You can also write (and all other for condition syntaxes that are allowed in V):
|
||||
|
||||
```html
|
||||
@for i = 0; i < 5; i++ {
|
||||
<span>$i</span>
|
||||
}
|
||||
```
|
||||
|
||||
## include
|
||||
|
||||
The include directive is for including other html files (which will be processed as well)
|
||||
and consists of two parts, the `@include` tag and a following `'<path>'` string.
|
||||
The path parameter is relative to the template file being called.
|
||||
|
||||
### Example for the folder structure of a project using templates:
|
||||
|
||||
```
|
||||
Project root
|
||||
/templates
|
||||
- index.html
|
||||
/headers
|
||||
- base.html
|
||||
```
|
||||
|
||||
`index.html`
|
||||
|
||||
```html
|
||||
|
||||
<div>@include 'header/base'</div>
|
||||
```
|
||||
|
||||
> Note that there shouldn't be a file suffix,
|
||||
> it is automatically appended and only allows `html` files.
|
||||
|
||||
|
||||
## js
|
||||
|
||||
The js directive consists of two parts, the `@js` tag and `'<path>'` string,
|
||||
where you can insert your src
|
||||
|
||||
```
|
||||
@js '<url>'
|
||||
```
|
||||
|
||||
### Example for the @js directive:
|
||||
|
||||
```html
|
||||
@js 'myscripts.js'
|
||||
```
|
||||
|
||||
# Variables
|
||||
|
||||
All variables, which are declared before the $tmpl can be used through the `@{my_var}` syntax.
|
||||
It's also possible to use properties of structs here like `@{my_struct.prop}`.
|
||||
|
||||
# Escaping
|
||||
|
||||
The `@` symbol starts a template directive. If you need to use `@` as a regular
|
||||
character within a template, escape it by using a double `@` like this: `@@`.
|
||||
38
aiprompts/herolib_start_here.md
Normal file
38
aiprompts/herolib_start_here.md
Normal file
@@ -0,0 +1,38 @@
|
||||
|
||||
## instructions for code generation
|
||||
|
||||
> when I generate code, the following instructions can never be overruled they are the basics
|
||||
|
||||
- do not try to fix files which end with _.v because these are generated files
|
||||
|
||||
|
||||
## instruction for vlang scripts
|
||||
|
||||
when I generate vlang scripts I will always use .vsh extension and use following as first line:
|
||||
|
||||
```
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
```
|
||||
|
||||
- a .vsh is a v shell script and can be executed as is, no need to use v ...
|
||||
- in .vsh file there is no need for a main() function
|
||||
- these scripts can be used for examples or instruction scripts e.g. an installs script
|
||||
|
||||
## executing vlang scripts
|
||||
|
||||
As AI agent I should also execute v or .vsh scripts with vrun
|
||||
|
||||
```bash
|
||||
vrun ~/code/github/incubaid/herolib/examples/biztools/bizmodel.vsh
|
||||
```
|
||||
|
||||
## executing test scripts
|
||||
|
||||
instruct user to test as follows (vtest is an alias which gets installed when herolib gets installed), can be done for a dir and for a file
|
||||
|
||||
```bash
|
||||
vtest ~/code/github/incubaid/herolib/lib/osal/package_test.v
|
||||
```
|
||||
|
||||
- use ~ so it works over all machines
|
||||
- don't use 'v test', we have vtest as alternative
|
||||
819
aiprompts/heromodel_instruct.md
Normal file
819
aiprompts/heromodel_instruct.md
Normal file
@@ -0,0 +1,819 @@
|
||||
# HeroModels Implementation Guide
|
||||
|
||||
This guide provides comprehensive instructions for creating new models in the HeroModels system, including best practices for model structure, serialization/deserialization, testing, and integration with the HeroModels factory.
|
||||
|
||||
## Table of Contents
|
||||
1. [Model Structure Overview](#model-structure-overview)
|
||||
2. [Creating a New Model](#creating-a-new-model)
|
||||
3. [Serialization and Deserialization](#serialization-and-deserialization)
|
||||
4. [Database Operations](#database-operations)
|
||||
5. [API Handler Implementation](#api-handler-implementation)
|
||||
6. [Testing Models](#testing-models)
|
||||
7. [Integration with Factory](#integration-with-factory)
|
||||
8. [Advanced Features](#advanced-features)
|
||||
9. [Best Practices](#best-practices)
|
||||
10. [Example Implementation](#example-implementation)
|
||||
|
||||
## Model Structure Overview
|
||||
|
||||
Each model in the HeroModels system consists of several components:
|
||||
|
||||
1. **Model Struct**: The core data structure inheriting from `db.Base`
|
||||
2. **DB Wrapper Struct**: Provides database operations for the model
|
||||
3. **Argument Struct**: Used for creating and updating model instances
|
||||
4. **API Handler Function**: Handles RPC calls for the model
|
||||
5. **List Arguments Struct**: Used for filtering when listing instances
|
||||
|
||||
### Directory Structure
|
||||
|
||||
```
|
||||
lib/hero/heromodels/
|
||||
├── model_name.v # Main model file
|
||||
├── model_name_test.v # Tests for the model
|
||||
└── factory.v # Factory integration
|
||||
```
|
||||
|
||||
## Creating a New Model
|
||||
|
||||
### 1. Define the Model Struct
|
||||
|
||||
Create a new file `model_name.v` in the `lib/hero/heromodels` directory.
|
||||
|
||||
```v
|
||||
module heromodels
|
||||
|
||||
import incubaid.herolib.core.db
|
||||
import incubaid.herolib.core.encoder
|
||||
import incubaid.herolib.core.ourtime
|
||||
import incubaid.herolib.core.jsonrpc { Response }
|
||||
import json
|
||||
|
||||
// Model struct - inherits from db.Base
|
||||
pub struct ModelName {
|
||||
pub mut:
|
||||
db.Base // Inherit from db.Base
|
||||
name string
|
||||
description string
|
||||
created_at u64
|
||||
updated_at u64
|
||||
// Add additional fields as needed
|
||||
}
|
||||
|
||||
// TypeName returns the type name used for serialization
|
||||
pub fn (self ModelName) type_name() string {
|
||||
return 'heromodels.ModelName'
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Define the Argument Struct for Model Creation/Updates
|
||||
|
||||
```v
|
||||
// Argument struct for creating/updating models with params attribute
|
||||
@[params]
|
||||
pub struct ModelNameArg {
|
||||
pub mut:
|
||||
id u32 // Optional for updates, ignored for creation
|
||||
name string @[required] // Required field
|
||||
description string
|
||||
// Add additional fields as needed
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Define the List Arguments Struct for Filtering
|
||||
|
||||
```v
|
||||
// Arguments for filtering when listing models
|
||||
@[params]
|
||||
pub struct ModelNameListArg {
|
||||
pub mut:
|
||||
// Add filter fields (e.g., status, type, etc.)
|
||||
limit int = 100 // Default limit
|
||||
}
|
||||
```
|
||||
|
||||
### 4. Create the DB Wrapper Struct
|
||||
|
||||
```v
|
||||
// DB Wrapper struct for database operations
|
||||
pub struct DBModelName {
|
||||
pub mut:
|
||||
db &db.DB
|
||||
}
|
||||
```
|
||||
|
||||
## Serialization and Deserialization
|
||||
|
||||
Implement the `dump` and `load` methods for serialization/deserialization.
|
||||
|
||||
### Dump Method (Serialization)
|
||||
|
||||
```v
|
||||
// Dump serializes the model to the encoder
|
||||
pub fn (self ModelName) dump(mut e encoder.Encoder) ! {
|
||||
// Always dump the Base first
|
||||
self.Base.dump(mut e)!
|
||||
|
||||
// Dump model-specific fields in the same order they will be loaded
|
||||
e.add_string(self.name)!
|
||||
e.add_string(self.description)!
|
||||
e.add_u64(self.created_at)!
|
||||
e.add_u64(self.updated_at)!
|
||||
// Add more fields in the exact order they should be loaded
|
||||
}
|
||||
```
|
||||
|
||||
### Load Method (Deserialization)
|
||||
|
||||
```v
|
||||
// Load deserializes the model from the decoder
|
||||
pub fn (mut self DBModelName) load(mut obj ModelName, mut d encoder.Decoder) ! {
|
||||
// Always load the Base first
|
||||
obj.Base.load(mut d)!
|
||||
|
||||
// Load model-specific fields in the same order they were dumped
|
||||
obj.name = d.get_string()!
|
||||
obj.description = d.get_string()!
|
||||
obj.created_at = d.get_u64()!
|
||||
obj.updated_at = d.get_u64()!
|
||||
// Add more fields in the exact order they were dumped
|
||||
}
|
||||
```
|
||||
|
||||
## Database Operations
|
||||
|
||||
Implement the standard CRUD operations and additional methods.
|
||||
|
||||
### New Instance Creation
|
||||
|
||||
```v
|
||||
// Create a new model instance from arguments
|
||||
pub fn (mut self DBModelName) new(args ModelNameArg) !ModelName {
|
||||
mut o := ModelName{
|
||||
name: args.name
|
||||
description: args.description
|
||||
// Initialize other fields
|
||||
created_at: ourtime.now().unix()
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
|
||||
// Additional initialization logic
|
||||
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Set (Create or Update)
|
||||
|
||||
```v
|
||||
// Save or update a model instance
|
||||
pub fn (mut self DBModelName) set(o ModelName) !ModelName {
|
||||
return self.db.set[ModelName](o)!
|
||||
}
|
||||
```
|
||||
|
||||
### Get
|
||||
|
||||
```v
|
||||
// Retrieve a model instance by ID
|
||||
pub fn (mut self DBModelName) get(id u32) !ModelName {
|
||||
mut o, data := self.db.get_data[ModelName](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
}
|
||||
```
|
||||
|
||||
### Delete
|
||||
|
||||
```v
|
||||
// Delete a model instance by ID
|
||||
pub fn (mut self DBModelName) delete(id u32) !bool {
|
||||
// Check if the item exists before trying to delete
|
||||
if !self.db.exists[ModelName](id)! {
|
||||
return false
|
||||
}
|
||||
self.db.delete[ModelName](id)!
|
||||
return true
|
||||
}
|
||||
```
|
||||
|
||||
### Exist
|
||||
|
||||
```v
|
||||
// Check if a model instance exists by ID
|
||||
pub fn (mut self DBModelName) exist(id u32) !bool {
|
||||
return self.db.exists[ModelName](id)!
|
||||
}
|
||||
```
|
||||
|
||||
### List with Filtering
|
||||
|
||||
```v
|
||||
// List model instances with optional filtering
|
||||
pub fn (mut self DBModelName) list(args ModelNameListArg) ![]ModelName {
|
||||
// Get all instances
|
||||
all_items := self.db.list[ModelName]()!.map(self.get(it)!)
|
||||
|
||||
// Apply filters
|
||||
mut filtered_items := []ModelName{}
|
||||
for item in all_items {
|
||||
// Apply your filter conditions here
|
||||
// Example:
|
||||
// if args.some_filter && item.some_property != args.filter_value {
|
||||
// continue
|
||||
// }
|
||||
|
||||
filtered_items << item
|
||||
}
|
||||
|
||||
// Apply limit
|
||||
mut limit := args.limit
|
||||
if limit > 100 {
|
||||
limit = 100
|
||||
}
|
||||
if filtered_items.len > limit {
|
||||
return filtered_items[..limit]
|
||||
}
|
||||
|
||||
return filtered_items
|
||||
}
|
||||
```
|
||||
|
||||
## API Handler Implementation
|
||||
|
||||
Create the handler function for RPC requests.
|
||||
|
||||
```v
|
||||
// Handler for RPC calls to this model
|
||||
pub fn model_name_handle(mut f ModelsFactory, rpcid int, servercontext map[string]string, userref UserRef, method string, params string) !Response {
|
||||
match method {
|
||||
'get' {
|
||||
id := db.decode_u32(params)!
|
||||
res := f.model_name.get(id)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
'set' {
|
||||
mut args := db.decode_generic[ModelNameArg](params)!
|
||||
mut o := f.model_name.new(args)!
|
||||
if args.id != 0 {
|
||||
o.id = args.id
|
||||
}
|
||||
o = f.model_name.set(o)!
|
||||
return new_response_int(rpcid, int(o.id))
|
||||
}
|
||||
'delete' {
|
||||
id := db.decode_u32(params)!
|
||||
deleted := f.model_name.delete(id)!
|
||||
if deleted {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_error(rpcid,
|
||||
code: 404
|
||||
message: 'ModelName with ID ${id} not found'
|
||||
)
|
||||
}
|
||||
}
|
||||
'exist' {
|
||||
id := db.decode_u32(params)!
|
||||
if f.model_name.exist(id)! {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_response_false(rpcid)
|
||||
}
|
||||
}
|
||||
'list' {
|
||||
args := db.decode_generic[ModelNameListArg](params)!
|
||||
res := f.model_name.list(args)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
else {
|
||||
return new_error(rpcid,
|
||||
code: 32601
|
||||
message: 'Method ${method} not found on model_name'
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Testing Models
|
||||
|
||||
Create a `model_name_test.v` file to test your model.
|
||||
|
||||
```v
|
||||
module heromodels
|
||||
|
||||
fn test_model_name_crud() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create
|
||||
mut args := ModelNameArg{
|
||||
name: 'Test Model'
|
||||
description: 'A test model'
|
||||
}
|
||||
|
||||
mut model := db_model.new(args)!
|
||||
model = db_model.set(model)!
|
||||
model_id := model.id
|
||||
|
||||
// Verify ID assignment
|
||||
assert model_id > 0
|
||||
|
||||
// Read
|
||||
retrieved_model := db_model.get(model_id)!
|
||||
assert retrieved_model.name == 'Test Model'
|
||||
assert retrieved_model.description == 'A test model'
|
||||
|
||||
// Update
|
||||
retrieved_model.description = 'Updated description'
|
||||
updated_model := db_model.set(retrieved_model)!
|
||||
assert updated_model.description == 'Updated description'
|
||||
|
||||
// Delete
|
||||
deleted := db_model.delete(model_id)!
|
||||
assert deleted == true
|
||||
|
||||
// Verify deletion
|
||||
exists := db_model.exist(model_id)!
|
||||
assert exists == false
|
||||
}
|
||||
|
||||
fn test_model_name_type_name() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model
|
||||
mut model := db_model.new(
|
||||
name: 'Type Test'
|
||||
description: 'Testing type_name'
|
||||
)!
|
||||
|
||||
// Test type_name method
|
||||
assert model.type_name() == 'heromodels.ModelName'
|
||||
}
|
||||
|
||||
fn test_model_name_description() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model
|
||||
mut model := db_model.new(
|
||||
name: 'Description Test'
|
||||
description: 'Testing description method'
|
||||
)!
|
||||
|
||||
// Test description method for each methodname
|
||||
assert model.description('set') == 'Create or update a model. Returns the ID of the model.'
|
||||
assert model.description('get') == 'Retrieve a model by ID. Returns the model object.'
|
||||
assert model.description('delete') == 'Delete a model by ID. Returns true if successful.'
|
||||
assert model.description('exist') == 'Check if a model exists by ID. Returns true or false.'
|
||||
assert model.description('list') == 'List all models. Returns an array of model objects.'
|
||||
}
|
||||
|
||||
fn test_model_name_example() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model
|
||||
mut model := db_model.new(
|
||||
name: 'Example Test'
|
||||
description: 'Testing example method'
|
||||
)!
|
||||
|
||||
// Test example method for each methodname
|
||||
set_call, set_result := model.example('set')
|
||||
// Assert expected call and result format
|
||||
|
||||
get_call, get_result := model.example('get')
|
||||
// Assert expected call and result format
|
||||
|
||||
delete_call, delete_result := model.example('delete')
|
||||
// Assert expected call and result format
|
||||
|
||||
exist_call, exist_result := model.example('exist')
|
||||
// Assert expected call and result format
|
||||
|
||||
list_call, list_result := model.example('list')
|
||||
// Assert expected call and result format
|
||||
}
|
||||
|
||||
fn test_model_name_encoding_decoding() ! {
|
||||
// Initialize DB for testing
|
||||
mut mydb := db.new_test()!
|
||||
mut db_model := DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
|
||||
// Create a model with all fields populated
|
||||
mut args := ModelNameArg{
|
||||
name: 'Encoding Test'
|
||||
description: 'Testing encoding/decoding'
|
||||
// Set other fields
|
||||
}
|
||||
|
||||
mut model := db_model.new(args)!
|
||||
|
||||
// Save the model
|
||||
model = db_model.set(model)!
|
||||
model_id := model.id
|
||||
|
||||
// Retrieve and verify all fields were properly encoded/decoded
|
||||
retrieved_model := db_model.get(model_id)!
|
||||
|
||||
// Verify all fields match the original
|
||||
assert retrieved_model.name == 'Encoding Test'
|
||||
assert retrieved_model.description == 'Testing encoding/decoding'
|
||||
// Check other fields
|
||||
}
|
||||
```
|
||||
|
||||
## Integration with Factory
|
||||
|
||||
Update the `factory.v` file to include your new model.
|
||||
|
||||
### 1. Add the Model to the Factory Struct
|
||||
|
||||
```v
|
||||
// In factory.v
|
||||
pub struct ModelsFactory {
|
||||
pub mut:
|
||||
db &db.DB
|
||||
user DBUser
|
||||
group DBGroup
|
||||
// Add your new model
|
||||
model_name DBModelName
|
||||
// Other models...
|
||||
rpc_handler &jsonrpc.Handler
|
||||
}
|
||||
```
|
||||
|
||||
### 2. Initialize the Model in the Factory New Method
|
||||
|
||||
```v
|
||||
// In factory.v, in the new() function
|
||||
pub fn new(args ModelsFactoryArgs) !&ModelsFactory {
|
||||
// Existing code...
|
||||
|
||||
mut f := ModelsFactory{
|
||||
db: &mydb
|
||||
user: DBUser{
|
||||
db: &mydb
|
||||
}
|
||||
// Add your new model
|
||||
model_name: DBModelName{
|
||||
db: &mydb
|
||||
}
|
||||
// Other models...
|
||||
rpc_handler: &h
|
||||
}
|
||||
|
||||
// Existing code...
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Add Handler Registration to the Factory API Handler
|
||||
|
||||
```v
|
||||
// In factory.v, in the group_api_handler function
|
||||
pub fn group_api_handler(rpcid int, servercontext map[string]string, actorname string, methodname string, params string) !jsonrpc.Response {
|
||||
// Existing code...
|
||||
|
||||
match actorname {
|
||||
// Existing cases...
|
||||
|
||||
'model_name' {
|
||||
return model_name_handle(mut f, rpcid, servercontext, userref, methodname, params)!
|
||||
}
|
||||
|
||||
// Existing cases...
|
||||
|
||||
else {
|
||||
// Error handling
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Custom Methods
|
||||
|
||||
You can add custom methods to your model for specific business logic:
|
||||
|
||||
```v
|
||||
// Add a custom method to the model
|
||||
pub fn (mut self ModelName) custom_operation(param string) !string {
|
||||
// Custom business logic
|
||||
self.updated_at = ourtime.now().unix()
|
||||
return 'Performed ${param} operation'
|
||||
}
|
||||
```
|
||||
|
||||
### Enhanced RPC Handling
|
||||
|
||||
Extend the RPC handler to support your custom methods:
|
||||
|
||||
```v
|
||||
// In the model_name_handle function
|
||||
match method {
|
||||
// Standard CRUD methods...
|
||||
|
||||
'custom_operation' {
|
||||
id := db.decode_u32(params)!
|
||||
mut model := f.model_name.get(id)!
|
||||
|
||||
// Extract parameter from JSON
|
||||
param_struct := json.decode(struct { param string }, params) or {
|
||||
return new_error(rpcid,
|
||||
code: 32602
|
||||
message: 'Invalid parameters for custom_operation'
|
||||
)
|
||||
}
|
||||
|
||||
result := model.custom_operation(param_struct.param)!
|
||||
model = f.model_name.set(model)! // Save changes
|
||||
return new_response(rpcid, json.encode(result))
|
||||
}
|
||||
|
||||
else {
|
||||
// Error handling
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
1. **Field Order**: Keep field ordering consistent between `dump` and `load` methods
|
||||
2. **Error Handling**: Use the `!` operator consistently for error propagation
|
||||
3. **Timestamp Management**: Initialize timestamps using `ourtime.now().unix()`
|
||||
4. **Required Fields**: Mark mandatory fields with `@[required]` attribute
|
||||
5. **Limits**: Enforce list limits (default 100)
|
||||
6. **ID Handling**: Always check existence before operations like delete
|
||||
7. **Validation**: Add validation in the `new` and `set` methods
|
||||
8. **API Methods**: Implement the standard CRUD operations (get, set, delete, exist, list)
|
||||
9. **Comments**: Document all fields and methods
|
||||
10. **Testing**: Create comprehensive tests covering all methods
|
||||
|
||||
## Example Implementation
|
||||
|
||||
Here is a complete example of a simple "Project" model:
|
||||
|
||||
```v
|
||||
module heromodels
|
||||
|
||||
import incubaid.herolib.core.db
|
||||
import incubaid.herolib.core.encoder
|
||||
import incubaid.herolib.core.ourtime
|
||||
import incubaid.herolib.core.jsonrpc { Response }
|
||||
import json
|
||||
|
||||
// Project model
|
||||
pub struct Project {
|
||||
pub mut:
|
||||
db.Base // Inherit from db.Base
|
||||
name string
|
||||
description string
|
||||
status ProjectStatus
|
||||
owner_id u32
|
||||
members []u32
|
||||
created_at u64
|
||||
updated_at u64
|
||||
}
|
||||
|
||||
// Project status enum
|
||||
pub enum ProjectStatus {
|
||||
active
|
||||
completed
|
||||
archived
|
||||
}
|
||||
|
||||
// TypeName for serialization
|
||||
pub fn (self Project) type_name() string {
|
||||
return 'heromodels.Project'
|
||||
}
|
||||
|
||||
// Dump serializes the model
|
||||
pub fn (self Project) dump(mut e encoder.Encoder) ! {
|
||||
self.Base.dump(mut e)!
|
||||
e.add_string(self.name)!
|
||||
e.add_string(self.description)!
|
||||
e.add_u8(u8(self.status))!
|
||||
e.add_u32(self.owner_id)!
|
||||
e.add_array_u32(self.members)!
|
||||
e.add_u64(self.created_at)!
|
||||
e.add_u64(self.updated_at)!
|
||||
}
|
||||
|
||||
// Project argument struct
|
||||
@[params]
|
||||
pub struct ProjectArg {
|
||||
pub mut:
|
||||
id u32
|
||||
name string @[required]
|
||||
description string
|
||||
status ProjectStatus = .active
|
||||
owner_id u32 @[required]
|
||||
members []u32
|
||||
}
|
||||
|
||||
// Project list argument struct
|
||||
@[params]
|
||||
pub struct ProjectListArg {
|
||||
pub mut:
|
||||
status ProjectStatus
|
||||
owner_id u32
|
||||
limit int = 100
|
||||
}
|
||||
|
||||
// DB wrapper struct
|
||||
pub struct DBProject {
|
||||
pub mut:
|
||||
db &db.DB
|
||||
}
|
||||
|
||||
// Load deserializes the model
|
||||
pub fn (mut self DBProject) load(mut obj Project, mut d encoder.Decoder) ! {
|
||||
obj.Base.load(mut d)!
|
||||
obj.name = d.get_string()!
|
||||
obj.description = d.get_string()!
|
||||
obj.status = unsafe { ProjectStatus(d.get_u8()!) }
|
||||
obj.owner_id = d.get_u32()!
|
||||
obj.members = d.get_array_u32()!
|
||||
obj.created_at = d.get_u64()!
|
||||
obj.updated_at = d.get_u64()!
|
||||
}
|
||||
|
||||
// Create a new Project
|
||||
pub fn (mut self DBProject) new(args ProjectArg) !Project {
|
||||
mut o := Project{
|
||||
name: args.name
|
||||
description: args.description
|
||||
status: args.status
|
||||
owner_id: args.owner_id
|
||||
members: args.members
|
||||
created_at: ourtime.now().unix()
|
||||
updated_at: ourtime.now().unix()
|
||||
}
|
||||
|
||||
return o
|
||||
}
|
||||
|
||||
// Save or update a Project
|
||||
pub fn (mut self DBProject) set(o Project) !Project {
|
||||
return self.db.set[Project](o)!
|
||||
}
|
||||
|
||||
// Get a Project by ID
|
||||
pub fn (mut self DBProject) get(id u32) !Project {
|
||||
mut o, data := self.db.get_data[Project](id)!
|
||||
mut e_decoder := encoder.decoder_new(data)
|
||||
self.load(mut o, mut e_decoder)!
|
||||
return o
|
||||
}
|
||||
|
||||
// Delete a Project by ID
|
||||
pub fn (mut self DBProject) delete(id u32) !bool {
|
||||
if !self.db.exists[Project](id)! {
|
||||
return false
|
||||
}
|
||||
self.db.delete[Project](id)!
|
||||
return true
|
||||
}
|
||||
|
||||
// Check if a Project exists
|
||||
pub fn (mut self DBProject) exist(id u32) !bool {
|
||||
return self.db.exists[Project](id)!
|
||||
}
|
||||
|
||||
// List Projects with filtering
|
||||
pub fn (mut self DBProject) list(args ProjectListArg) ![]Project {
|
||||
all_projects := self.db.list[Project]()!.map(self.get(it)!)
|
||||
|
||||
mut filtered_projects := []Project{}
|
||||
for project in all_projects {
|
||||
// Filter by status if provided
|
||||
if args.status != .active && project.status != args.status {
|
||||
continue
|
||||
}
|
||||
|
||||
// Filter by owner_id if provided
|
||||
if args.owner_id != 0 && project.owner_id != args.owner_id {
|
||||
continue
|
||||
}
|
||||
|
||||
filtered_projects << project
|
||||
}
|
||||
|
||||
mut limit := args.limit
|
||||
if limit > 100 {
|
||||
limit = 100
|
||||
}
|
||||
if filtered_projects.len > limit {
|
||||
return filtered_projects[..limit]
|
||||
}
|
||||
|
||||
return filtered_projects
|
||||
}
|
||||
|
||||
// API description method
|
||||
pub fn (self Project) description(methodname string) string {
|
||||
match methodname {
|
||||
'set' { return 'Create or update a project. Returns the ID of the project.' }
|
||||
'get' { return 'Retrieve a project by ID. Returns the project object.' }
|
||||
'delete' { return 'Delete a project by ID. Returns true if successful.' }
|
||||
'exist' { return 'Check if a project exists by ID. Returns true or false.' }
|
||||
'list' { return 'List all projects. Returns an array of project objects.' }
|
||||
else { return 'This is generic method for the root object, TODO fill in, ...' }
|
||||
}
|
||||
}
|
||||
|
||||
// API example method
|
||||
pub fn (self Project) example(methodname string) (string, string) {
|
||||
match methodname {
|
||||
'set' {
|
||||
return '{"project": {"name": "Website Redesign", "description": "Redesign company website", "status": "active", "owner_id": 1, "members": [2, 3]}}', '1'
|
||||
}
|
||||
'get' {
|
||||
return '{"id": 1}', '{"name": "Website Redesign", "description": "Redesign company website", "status": "active", "owner_id": 1, "members": [2, 3]}'
|
||||
}
|
||||
'delete' {
|
||||
return '{"id": 1}', 'true'
|
||||
}
|
||||
'exist' {
|
||||
return '{"id": 1}', 'true'
|
||||
}
|
||||
'list' {
|
||||
return '{}', '[{"name": "Website Redesign", "description": "Redesign company website", "status": "active", "owner_id": 1, "members": [2, 3]}]'
|
||||
}
|
||||
else {
|
||||
return '{}', '{}'
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// API handler function
|
||||
pub fn project_handle(mut f ModelsFactory, rpcid int, servercontext map[string]string, userref UserRef, method string, params string) !Response {
|
||||
match method {
|
||||
'get' {
|
||||
id := db.decode_u32(params)!
|
||||
res := f.project.get(id)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
'set' {
|
||||
mut args := db.decode_generic[ProjectArg](params)!
|
||||
mut o := f.project.new(args)!
|
||||
if args.id != 0 {
|
||||
o.id = args.id
|
||||
}
|
||||
o = f.project.set(o)!
|
||||
return new_response_int(rpcid, int(o.id))
|
||||
}
|
||||
'delete' {
|
||||
id := db.decode_u32(params)!
|
||||
deleted := f.project.delete(id)!
|
||||
if deleted {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_error(rpcid,
|
||||
code: 404
|
||||
message: 'Project with ID ${id} not found'
|
||||
)
|
||||
}
|
||||
}
|
||||
'exist' {
|
||||
id := db.decode_u32(params)!
|
||||
if f.project.exist(id)! {
|
||||
return new_response_true(rpcid)
|
||||
} else {
|
||||
return new_response_false(rpcid)
|
||||
}
|
||||
}
|
||||
'list' {
|
||||
args := db.decode_generic[ProjectListArg](params)!
|
||||
res := f.project.list(args)!
|
||||
return new_response(rpcid, json.encode_pretty(res))
|
||||
}
|
||||
else {
|
||||
return new_error(rpcid,
|
||||
code: 32601
|
||||
message: 'Method ${method} not found on project'
|
||||
)
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This complete guide should provide all the necessary information to create and maintain models in the HeroModels system following the established patterns and best practices.
|
||||
@@ -1 +0,0 @@
|
||||
../lib/core/httpconnection/readme.md
|
||||
1454
aiprompts/instructions/herodb_base_fs.md
Normal file
1454
aiprompts/instructions/herodb_base_fs.md
Normal file
File diff suppressed because it is too large
Load Diff
52
aiprompts/instructions_archive/documentation_from_v.md
Normal file
52
aiprompts/instructions_archive/documentation_from_v.md
Normal file
@@ -0,0 +1,52 @@
|
||||
params:
|
||||
|
||||
- filepath: /Users/despiegk/code/github/incubaid/herolib/lib/clients/openai
|
||||
|
||||
make a dense overview of the code above, easy to understand for AI
|
||||
|
||||
the result is 1 markdown file called codeoverview.md and is stored in $filepath
|
||||
|
||||
try to figure out which functions are more important and which are less important, so that the most important functions are at the top of section you are working on
|
||||
|
||||
the template is as follows
|
||||
|
||||
```md
|
||||
# the name of the module
|
||||
|
||||
2-5 liner description
|
||||
|
||||
## factory
|
||||
|
||||
is there factory, which one and quick example how to call, don’t say in which file not relevant
|
||||
show how to import the module is as follows: import incubaid.herolib.
|
||||
and then starting from lib e.g. lib/clients/mycelium would result in import incubaid.herolib. clients.mycelium
|
||||
|
||||
## overview
|
||||
|
||||
quick overview as list with identations, of the structs and its methods
|
||||
|
||||
## structs
|
||||
|
||||
### structname
|
||||
|
||||
now list the methods & arguments, for arguments use table
|
||||
|
||||
for each method show the arguments needed to call the method, and what it returns
|
||||
|
||||
### methods
|
||||
|
||||
- if any methods which are on module
|
||||
- only show public methods, don't show the get/set/exists methods on module level as part of factory.
|
||||
|
||||
|
||||
```
|
||||
|
||||
don't mention what we don't show because of rules above.
|
||||
|
||||
the only output we want is markdown file as follows
|
||||
|
||||
===WRITE===
|
||||
$filepath
|
||||
===CONTENT===
|
||||
$the content of the generated markdown file
|
||||
===END===
|
||||
20
aiprompts/instructions_archive/documentation_from_v_md.md
Normal file
20
aiprompts/instructions_archive/documentation_from_v_md.md
Normal file
@@ -0,0 +1,20 @@
|
||||
remove all navigation elements, and index
|
||||
for each method, move the args as used in the methods to the method section so its easier to read
|
||||
|
||||
start of output file is:
|
||||
|
||||
# the name of the module
|
||||
|
||||
2-5 liner description
|
||||
|
||||
## factory
|
||||
|
||||
is there factory, which one and quick example how to call, don’t say in which file not relevant
|
||||
show how to import the module is as follows: import incubaid.herolib.
|
||||
and then starting from lib e.g. lib/clients/mycelium would result in import incubaid.herolib. clients.mycelium
|
||||
|
||||
## structs and methods
|
||||
|
||||
quick overview as list with identations, of the structs and its methods
|
||||
|
||||
ONLY OUTPUT THE MARKDOWN FILE, NOTHING ELSE
|
||||
2522
aiprompts/instructions_archive/models_from_v/complete.md
Normal file
2522
aiprompts/instructions_archive/models_from_v/complete.md
Normal file
File diff suppressed because it is too large
Load Diff
18
aiprompts/instructions_archive/models_from_v/generics.md
Normal file
18
aiprompts/instructions_archive/models_from_v/generics.md
Normal file
@@ -0,0 +1,18 @@
|
||||
in hero.db
|
||||
|
||||
make a generic function which takes any of the root objects (which inherits from Base)
|
||||
|
||||
and gets a json from it and add a save() function to it to store it in postgresql (see postgresql client)
|
||||
and also a get and deserializes
|
||||
|
||||
the json is put in table as follows
|
||||
|
||||
tablename: $dirname_$rootobjectname all lowercase
|
||||
|
||||
each table has
|
||||
|
||||
- id
|
||||
- ... the fields which represents indexes (see @[index])
|
||||
- data which is the json
|
||||
|
||||
information how to use generics see aiprompts/v_advanced/generics.md and aiprompts/v_advanced/reflection.md
|
||||
43
aiprompts/instructions_archive/models_from_v/prompt.md
Normal file
43
aiprompts/instructions_archive/models_from_v/prompt.md
Normal file
@@ -0,0 +1,43 @@
|
||||
$NAME = calendar
|
||||
|
||||
walk over all models from biz: db/heromodels/src/models/$NAME in the rust repo
|
||||
create nice structured public models in Vlang (V) see instructions in herlolib
|
||||
|
||||
put the results in /Users/despiegk/code/github/incubaid/herolib/lib/hero/models/$NAME
|
||||
|
||||
put decorator on fields which need to be indexed: use @[index] for that at end of line of the property of the struct
|
||||
|
||||
copy the documentation as well and put on the vstruct and on its fields
|
||||
|
||||
make instructions so a coding agent can execute it, put the models in files, ...
|
||||
|
||||
keep it all simple
|
||||
|
||||
don't do anything additional for modules, don't do import
|
||||
|
||||
at top of each file we have ```module $NAME```
|
||||
|
||||
make sure all time related fields are in u64 format, use unix timestamp for that
|
||||
|
||||
don't create management classes, only output the structs, don't create a mod.v, don't make .v scripts executatble, don't create a main.v
|
||||
|
||||
## now also make sure we use core.base as follows
|
||||
|
||||
```
|
||||
import incubaid.herolib.hero.models.core
|
||||
|
||||
// Account represents a financial account for tracking balances and transactions
|
||||
// Supports multiple account types (checking, savings, investment, etc.)
|
||||
pub struct Account {
|
||||
core.Base
|
||||
|
||||
```
|
||||
|
||||
remove Local BaseModel
|
||||
|
||||
make sure module ... is always at first line of file
|
||||
|
||||
- remove id from the model we update because it is in the Base
|
||||
- created_at u64 // Creation timestamp
|
||||
- updated_at u64 // Last modification timestamp
|
||||
- basically each property in the Base should be removed from the model
|
||||
1
aiprompts/instructions_archive/models_from_v/readme.md
Normal file
1
aiprompts/instructions_archive/models_from_v/readme.md
Normal file
@@ -0,0 +1 @@
|
||||
Kimi k2 on groq is doing well
|
||||
20
aiprompts/instructions_archive/models_from_v/update.md
Normal file
20
aiprompts/instructions_archive/models_from_v/update.md
Normal file
@@ -0,0 +1,20 @@
|
||||
in lib/hero/models
|
||||
for governance and legal
|
||||
|
||||
make sure we use core.base as follows
|
||||
|
||||
import incubaid.herolib.hero.models.core
|
||||
|
||||
// Account represents a financial account for tracking balances and transactions
|
||||
// Supports multiple account types (checking, savings, investment, etc.)
|
||||
pub struct Account {
|
||||
core.Base
|
||||
|
||||
remove Local BaseModel
|
||||
|
||||
make sure module ... is always at first line of file
|
||||
|
||||
- remove id from the model we update because it is in the Base
|
||||
- created_at u64 // Creation timestamp
|
||||
- updated_at u64 // Last modification timestamp
|
||||
- basically each property in the Base should be removed from the model
|
||||
109
aiprompts/instructions_archive/processing/heroscript.md
Normal file
109
aiprompts/instructions_archive/processing/heroscript.md
Normal file
@@ -0,0 +1,109 @@
|
||||
## INTENT
|
||||
|
||||
we use heroscript to communicate actions and events in a structured format.
|
||||
we want you to parse user intents and generate the corresponding heroscript.
|
||||
|
||||
ONLY RETURN THE HEROSCRIPT STATEMENTS, can be more than 1
|
||||
|
||||
## HEROSCRIPT FORMAT
|
||||
|
||||
HeroScript is a concise scripting language with the following structure:
|
||||
|
||||
```heroscript
|
||||
!!actor.action_name
|
||||
param1: 'value1'
|
||||
param2: 'value with spaces'
|
||||
multiline_description: '
|
||||
This is a multiline description.
|
||||
It can span multiple lines.
|
||||
'
|
||||
arg1 arg2 // Arguments without keys
|
||||
|
||||
!!actor.action_name2 param1:something param2:'something with spaces' nr:3
|
||||
```
|
||||
|
||||
Key characteristics:
|
||||
|
||||
- **Actions**: Start with `!!`, followed by `actor.action_name` (e.g., `!!mailclient.configure`).
|
||||
- **Parameters**: Defined as `key:value`. Values can be quoted for spaces.
|
||||
- **Multiline Support**: Parameters like `description` can span multiple lines.
|
||||
- **Arguments**: Values without keys (e.g., `arg1`).
|
||||
- params can be on 1 line, with spaces in between
|
||||
- time can be as +1h, +1d, +1w (hour, day, week), ofcourse 1 can be any number, +1 means 1 hour from now
|
||||
- time format is: dd/mm/yyyy hh:mm (ONLY USE THIS)
|
||||
- comma separation is used a lot in arguments e.g. 'jan,kristof' or 'jan , kristof' remove spaces, is list of 2
|
||||
- note only !! is at start of line, rest has spaces per instruction
|
||||
- make one empty line between 1 heroscript statements
|
||||
- everything after // is comment
|
||||
|
||||
## HEROSCRIPT SCHEMA
|
||||
|
||||
the language we understand
|
||||
|
||||
### calendar management
|
||||
|
||||
```heroscript
|
||||
!!calendar.create when:'+1h' descr:'this is event to discuss eng' attendees:'jan,kristof' name:'meet1' tags:'eng,urgent'
|
||||
!!calendar.delete name:'meet1'
|
||||
!!calendar.list tags:'urgent'
|
||||
|
||||
```
|
||||
|
||||
### contact management
|
||||
|
||||
```heroscript
|
||||
!!contact.add name:'jan' email:'jan@example.com' phone:'123-456-7890'
|
||||
!!contact.remove name:'jan'
|
||||
!!contact.list
|
||||
|
||||
```
|
||||
|
||||
### task management
|
||||
|
||||
```heroscript
|
||||
!!task.create title:'Prepare presentation' due:'+1d' assignee:'jan' name:'task1' tags:'eng,urgent'
|
||||
deadline:'+10d' duration:'1h'
|
||||
!!task.update name:'task1' status:'in progress'
|
||||
!!task.delete name:'task1'
|
||||
!!task.list
|
||||
|
||||
```
|
||||
|
||||
### project management
|
||||
|
||||
```heroscript
|
||||
!!project.create title:'Cloud Product Development' description:'Track progress of cloud product development' name:'cloud_prod'
|
||||
!!project.update name:'cloud_prod' status:'in progress'
|
||||
!!project.delete name:'cloud_prod'
|
||||
!!project.list
|
||||
!!project.tasks_list name:'cloud_prod' //required properties are name, description, and assignee of not given ask
|
||||
!!project.tasks_add names:'task1, task2'
|
||||
!!project.tasks_remove names:'task1, task2'
|
||||
|
||||
```
|
||||
|
||||
### SUPPORTED TAGS
|
||||
|
||||
only tags supported are:
|
||||
|
||||
- for intent: eng, prod, support, mgmt, marketing
|
||||
- for urgency: urgent, high, medium, low
|
||||
|
||||
### generic remarks
|
||||
|
||||
- names are lowercase and snake_case, can be distilled out of title if only title given, often a user will say name but that means title
|
||||
- time: format of returned data or time is always dd/mm/yyyy hh:min
|
||||
|
||||
## IMPORTANT STARTING INFO
|
||||
|
||||
- current time is 10/08/2025 05:10 , use this to define any time-related parameters
|
||||
|
||||
## USER INTENT
|
||||
|
||||
I want a meeting tomorrow 10am, where we will discuss our new product for the cloud with jan and alex, and the urgency is high
|
||||
|
||||
also let me know which other meetings I have which are urgent
|
||||
|
||||
can you make a project where we can track the progress of our new product development? Name is 'Cloud Product Development'
|
||||
|
||||
Please add tasks to the project in line to creating specifications, design documents, and implementation plans.
|
||||
64
aiprompts/instructions_archive/processing/heroscript2.md
Normal file
64
aiprompts/instructions_archive/processing/heroscript2.md
Normal file
@@ -0,0 +1,64 @@
|
||||
SYSTEM
|
||||
You are a HeroScript compiler. Convert user intents into valid HeroScript statements.
|
||||
|
||||
OUTPUT RULES
|
||||
|
||||
1) Return ONLY HeroScript statements. No prose, no backticks.
|
||||
2) Separate each statement with exactly ONE blank line.
|
||||
3) Keys use snake_case. Names are lowercase snake_case derived from titles (non-alnum → "_", collapse repeats, trim).
|
||||
4) Lists are comma-separated with NO spaces (e.g., "jan,alex").
|
||||
5) Times: OUTPUT MUST BE ABSOLUTE in "dd/mm/yyyy hh:mm" (Europe/Zurich). Convert relative times (e.g., "tomorrow 10am") using CURRENT_TIME.
|
||||
6) Tags: include at most one intent tag and at most one urgency tag when present.
|
||||
- intent: eng,prod,support,mgmt,marketing
|
||||
- urgency: urgent,high,medium,low
|
||||
7) Quotes: quote values containing spaces; otherwise omit quotes (allowed either way).
|
||||
8) Comments only with // if the user explicitly asks for explanations; otherwise omit.
|
||||
|
||||
SCHEMA (exact actions & parameters)
|
||||
|
||||
!!calendar.create when:'dd/mm/yyyy hh:mm' name:'<name>' descr:'<text>' attendees:'a,b,c' tags:'intent,urgency'
|
||||
!!calendar.delete name:'<name>'
|
||||
!!calendar.list [tags:'tag1,tag2']
|
||||
|
||||
!!contact.add name:'<name>' email:'<email>' phone:'<phone>'
|
||||
!!contact.remove name:'<name>'
|
||||
!!contact.list
|
||||
|
||||
!!task.create title:'<title>' name:'<name>' [due:'dd/mm/yyyy hh:mm'] [assignee:'<name>'] [tags:'intent,urgency'] [deadline:'dd/mm/yyyy hh:mm'] [duration:'<Nd Nh Nm> or <Nh>']
|
||||
!!task.update name:'<name>' [status:'in progress|done|blocked|todo']
|
||||
!!task.delete name:'<name>'
|
||||
!!task.list
|
||||
|
||||
!!project.create title:'<title>' description:'<text>' name:'<name>'
|
||||
!!project.update name:'<name>' [status:'in progress|done|blocked|todo']
|
||||
!!project.delete name:'<name>'
|
||||
!!project.list
|
||||
!!project.tasks_list name:'<project_name>'
|
||||
!!project.tasks_add name:'<project_name>' names:'task_a,task_b'
|
||||
!!project.tasks_remove name:'<project_name>' names:'task_a,task_b'
|
||||
|
||||
NORMALIZATION & INFERENCE (silent)
|
||||
- Derive names from titles when missing (see rule 3). Ensure consistency across statements.
|
||||
- Map phrases to tags when obvious (e.g., "new product" ⇒ intent: prod; "high priority" ⇒ urgency: high).
|
||||
- Attendees: split on commas, trim, lowercase given names.
|
||||
- If the user asks for “urgent meetings,” use tags:'urgent' specifically.
|
||||
- Prefer concise descriptions pulled from the user’s phrasing.
|
||||
- Name's are required, if missing ask for clarification.
|
||||
- For calendar management, ensure to include all relevant details such as time, attendees, and description.
|
||||
|
||||
|
||||
CURRENT_TIME
|
||||
|
||||
10/08/2025 05:10
|
||||
|
||||
USER_MESSAGE
|
||||
|
||||
I want a meeting tomorrow 10am, where we will discuss our new product for the cloud with jan and alex, and the urgency is high
|
||||
|
||||
also let me know which other meetings I have which are urgent
|
||||
|
||||
can you make a project where we can track the progress of our new product development? Name is 'Cloud Product Development'
|
||||
|
||||
Please add tasks to the project in line to creating specifications, design documents, and implementation plans.
|
||||
|
||||
END
|
||||
82
aiprompts/instructions_archive/processing/intent.md
Normal file
82
aiprompts/instructions_archive/processing/intent.md
Normal file
@@ -0,0 +1,82 @@
|
||||
## INSTRUCTIONS
|
||||
|
||||
the user will send me multiple instructions what they wants to do, I want you to put them in separate categories
|
||||
|
||||
The categories we have defined are:
|
||||
|
||||
- calendar management
|
||||
- schedule meetings, events, reminders
|
||||
- list these events
|
||||
- delete them
|
||||
- contact management
|
||||
- add/remove contact information e.g. phone numbers, email addresses, address information
|
||||
- list contacts, search
|
||||
- task or project management
|
||||
- anything we need to do, anything we need to track and plan
|
||||
- create/update tasks, set deadlines
|
||||
- mark tasks as complete
|
||||
- delete tasks
|
||||
- project management
|
||||
- communication (chat, email)
|
||||
- see what needs to be communicate e.g. send a chat to ...
|
||||
- search statements
|
||||
- find on internet, find specific information from my friends
|
||||
|
||||
I want you to detect the intent and make multiple blocks out of the intent, each block should correspond to one of the identified intents, identify the intent with name of the category eg. calendar, only use above names
|
||||
|
||||
|
||||
|
||||
what user wants to do, stay as close as possible to the original instructions, copy the exact instructions as where given by the user, we only need to sort the instructions in these blocks
|
||||
|
||||
for each instruction make a separate block, e.g. if 2 tasks are given, create 2 blocks
|
||||
|
||||
the format to return is: (note newline after each title of block)
|
||||
|
||||
```template
|
||||
===CALENDAR===\n
|
||||
|
||||
$the copied text from what user wants
|
||||
|
||||
===CONTACT===\n
|
||||
...
|
||||
|
||||
===QUESTION===\n
|
||||
|
||||
put here what our system needs to ask to the user anything which is not clear
|
||||
|
||||
===END===\n
|
||||
|
||||
```
|
||||
|
||||
I want you to execute above on instructions as given by user below, give text back ONLY supporting the template
|
||||
|
||||
note for format is only ===$NAME=== and then on next lines the original instructions from the user, don't change
|
||||
|
||||
## special processing of info
|
||||
|
||||
- if a date or time specified e.g. tomorrow, time, ... calculate back from current date
|
||||
|
||||
## IMPORTANT STARTING INFO
|
||||
|
||||
- current time is 10/08/2025 05:10 (format of returned data is always dd/mm/yyyy hh:min)
|
||||
- use the current time to define formatted time out of instructions
|
||||
- only return the formatted time
|
||||
|
||||
## UNCLEAR INFO
|
||||
|
||||
check in instructions e.g. things specified like you, me, ...
|
||||
are not clear ask specifically who do you mean
|
||||
|
||||
if task, specify per task, who needs to do it and when, make sure each instruction (block) is complete and clear for further processing
|
||||
|
||||
be very specific with the questions e.g. who is you, ...
|
||||
|
||||
## EXECUTE ABOVE ON THE FOLLOWING
|
||||
|
||||
I am planning a birthday for my daughters tomorrow, there will be 10 people.
|
||||
|
||||
I would like to know if you can help me with the preparations.
|
||||
|
||||
I need a place for my daughter's birthday party.
|
||||
|
||||
I need to send message to my wife isabelle that she needs to pick up the cake.
|
||||
@@ -0,0 +1,93 @@
|
||||
We have our own instruction language called heroscript, below you will find details how to use it.
|
||||
|
||||
## heroscript
|
||||
|
||||
|
||||
Heroscript is our small scripting language which is used for communicating with our digital tools like calendar management.
|
||||
|
||||
which has following structure
|
||||
|
||||
```heroscript
|
||||
|
||||
!!calendar.event_add
|
||||
title: 'go to dentist'
|
||||
start: '2025/03/01'
|
||||
description: '
|
||||
a description can be multiline
|
||||
|
||||
like this
|
||||
'
|
||||
|
||||
!!calendar.event_delete
|
||||
title: 'go to dentist'
|
||||
|
||||
```
|
||||
|
||||
- the format is !!$actor.$action (there is no space before !!)
|
||||
- every parameter comes on next line with spaces in front (4 spaces, always use 4 spaces, dont make variation)
|
||||
- every actor.action starts with !!
|
||||
- the first part is the actor e.g. calendar in this case
|
||||
- the 2e part is the action name
|
||||
- multilines are supported see the description field
|
||||
|
||||
below you will find the instructions for different actors, comments how to use it are behind # which means not part of the the definition itself
|
||||
|
||||
## remarks on parameters used
|
||||
|
||||
- date
|
||||
- format of the date is yyyy/mm/dd hh:mm:ss
|
||||
- +1h means 1 hour later than now
|
||||
- +1m means 1 min later than now
|
||||
- +1d means 1 day later than now
|
||||
- same for -1h, -1m, -1d
|
||||
- money expressed as
|
||||
- $val $cursymbol
|
||||
- $cursymbol is 3 letters e.g. USD, capital
|
||||
- lists are comma separated and '...' around
|
||||
|
||||
|
||||
## generic instructions
|
||||
|
||||
- do not add information if not specifically asked for
|
||||
|
||||
|
||||
## circle
|
||||
|
||||
every actor action happens in a circle, a user can ask to switch circles, command available is
|
||||
|
||||
```
|
||||
!!circle.switch
|
||||
name: 'project x'
|
||||
|
||||
```
|
||||
|
||||
## calendar
|
||||
|
||||
```heroscript
|
||||
|
||||
!!calendar.event_add
|
||||
title: 'go to dentist'
|
||||
start: '2025/03/01'
|
||||
end: '+1h' #if + notation used is later than the start
|
||||
description: '
|
||||
a description can be multiline
|
||||
|
||||
like this
|
||||
'
|
||||
attendees: 'tim, rob'
|
||||
|
||||
!!calendar.event_delete
|
||||
title: 'go to dentist'
|
||||
|
||||
```
|
||||
|
||||
## NOW DO ONE
|
||||
|
||||
schedule event tomorrow 10 am, for 1h, with tim & rob, we want to product management threefold
|
||||
now is friday jan 17
|
||||
|
||||
only give me the instructions needed, only return the heroscript no text around
|
||||
|
||||
if not clear enough ask the user for more info
|
||||
|
||||
if not sure do not invent, only give instructions as really asked for
|
||||
@@ -0,0 +1,58 @@
|
||||
|
||||
|
||||
# how to manage my agenda
|
||||
|
||||
## Metadata for function calling
|
||||
|
||||
functions_metadata = [
|
||||
{
|
||||
"name": "event_add",
|
||||
"description": "Adds a calendar event.",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {"type": "string", "description": "Title of the event."},
|
||||
"start": {"type": "string", "description": "Start date and time in 'YYYY/MM/DD hh:mm' format."},
|
||||
"end": {"type": "string", "description": "End date or duration (e.g., +2h)."},
|
||||
"description": {"type": "string", "description": "Event description."},
|
||||
"attendees": {"type": "string", "description": "Comma-separated list of attendees' emails."},
|
||||
},
|
||||
"required": ["title", "start"]
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "event_delete",
|
||||
"description": "Deletes a calendar event by title.",
|
||||
"parameters": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"title": {"type": "string", "description": "Title of the event to delete."},
|
||||
},
|
||||
"required": ["title"]
|
||||
}
|
||||
}
|
||||
]
|
||||
|
||||
## example call
|
||||
|
||||
{
|
||||
"function": "event_add",
|
||||
"parameters": {
|
||||
"title": "Team Sync",
|
||||
"start": "2025/02/01 10:00",
|
||||
"end": "+1h",
|
||||
"description": "",
|
||||
"attendees": "alice@example.com, bob@example.com"
|
||||
}
|
||||
}
|
||||
|
||||
## how to use
|
||||
|
||||
Parse the user query to determine intent (e.g., "schedule" maps to event_add, "cancel" maps to event_delete).
|
||||
|
||||
Extract required parameters (e.g., title, start date).
|
||||
|
||||
Invoke the appropriate function with the extracted parameters.
|
||||
|
||||
Return the function's result as the response.
|
||||
|
||||
72
aiprompts/instructions_archive/what_is_a_hero_twin.md
Normal file
72
aiprompts/instructions_archive/what_is_a_hero_twin.md
Normal file
@@ -0,0 +1,72 @@
|
||||
you represent a digital twin for a user, the user talks to you to get things done for his digital life
|
||||
|
||||
you will interprete the instructions the user prompts, and figure out the multiple instructions, break it up and categorize them as follows:
|
||||
|
||||
- cat: calendar
|
||||
- manage calendar for the user
|
||||
- cat: contacts
|
||||
- manage contacts for the user
|
||||
- cat: communicate
|
||||
- communicate with others using text
|
||||
- cat: tasks
|
||||
- manage my tasks
|
||||
- cat: circle
|
||||
- define circle we work in, a circle is like a project context in which we do above, so can be for a team or a project, try to find it
|
||||
- cat: sysadmin
|
||||
- system administration, e.g. creation of virtual machines (VM), containers, start stop see monitoring information
|
||||
- cat: notes
|
||||
- anything to do with transctiptions, note takings, summaries
|
||||
- how we recorded meetings e.g. zoom, google meet, ...
|
||||
- how we are looking for info in meeting
|
||||
- cat: unknown
|
||||
- anything we can't understand
|
||||
|
||||
try to understand what user wants and put it in blocks (one per category for the action e.g. calendar)
|
||||
|
||||
- before each block (instruction) put ###########################
|
||||
- in the first line mention the category as defined above, only mention this category once and there is only one per block
|
||||
- then reformulate in clear instructions what needs to be done after that
|
||||
- the instructions are put in lines following the instruction (not in the instruction line)
|
||||
- only make blocks for instructions as given
|
||||
|
||||
what you output will be used further to do more specific prompting
|
||||
|
||||
if circle, always put these instructions first
|
||||
|
||||
if time is specified put the time as follows
|
||||
|
||||
- if relative e.g. next week, tomorrow, after tomorrow, in one hour then start from the current time
|
||||
- time is in format: YYYY/MM/DD hh:mm format
|
||||
- current time is friday 2025/01/17 10:12
|
||||
- if e.g. next month jan, or next tuesday then don't repeat the browd instructions like tuesday, this just show the date as YYYY/MM/DD hh:mm
|
||||
|
||||
if not clear for a date, don't invent just repeat the original instruction
|
||||
|
||||
if the category is not clear, just use unknown
|
||||
|
||||
|
||||
NOW DO EXAMPLE 1
|
||||
|
||||
```
|
||||
hi good morning
|
||||
|
||||
Can you help me find meetings I have done around research of threefold in the last 2 weeks
|
||||
|
||||
I need to create a new VM, 4 GB of memory, 2 vcpu, in belgium, with ubuntu
|
||||
|
||||
I would like do schedule a meeting, need to go to the dentist tomorrow at 10am, its now friday jan 17
|
||||
|
||||
also remind me I need to do the dishes after tomorrow in the morning
|
||||
|
||||
can you also add jef as a contact, he lives in geneva, he is doing something about rocketscience
|
||||
|
||||
I need to paint my wall in my room next week wednesday
|
||||
|
||||
cancel all my meetings next sunday
|
||||
|
||||
can you give me list of my contacts who live in geneva and name sounds like tom
|
||||
|
||||
send a message to my mother, I am seeing here in 3 days at 7pm
|
||||
|
||||
```
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
../lib/osal/readme.md
|
||||
@@ -1 +0,0 @@
|
||||
../lib/data/ourdb/README.md
|
||||
@@ -1 +0,0 @@
|
||||
../lib/data/ourtime/readme.md
|
||||
@@ -1 +0,0 @@
|
||||
../lib/data/paramsparser/readme.md
|
||||
@@ -1,60 +0,0 @@
|
||||
|
||||
## instructions for code generation
|
||||
|
||||
> when I generate code, the following instructions can never be overruled they are the basics
|
||||
|
||||
- do not try to fix files which end with _.v because these are generated files
|
||||
|
||||
|
||||
## instruction for vlang scripts
|
||||
|
||||
when I generate vlang scripts I will always use .vsh extension and use following as first line:
|
||||
|
||||
```
|
||||
#!/usr/bin/env -S v -n -w -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
```
|
||||
|
||||
- a .vsh is a v shell script and can be executed as is, no need to use v ...
|
||||
- in .vsh file there is no need for a main() function
|
||||
- these scripts can be used for examples or instruction scripts e.g. an installs script
|
||||
|
||||
## to do argument parsing use following examples
|
||||
|
||||
```v
|
||||
#!/usr/bin/env -S v -n -w -cg -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
import os
|
||||
import flag
|
||||
|
||||
mut fp := flag.new_flag_parser(os.args)
|
||||
fp.application('compile.vsh')
|
||||
fp.version('v0.1.0')
|
||||
fp.description('Compile hero binary in debug or production mode')
|
||||
fp.skip_executable()
|
||||
|
||||
prod_mode := fp.bool('prod', `p`, false, 'Build production version (optimized)')
|
||||
help_requested := fp.bool('help', `h`, false, 'Show help message')
|
||||
|
||||
if help_requested {
|
||||
println(fp.usage())
|
||||
exit(0)
|
||||
}
|
||||
|
||||
additional_args := fp.finalize() or {
|
||||
eprintln(err)
|
||||
println(fp.usage())
|
||||
exit(1)
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
|
||||
## when creating a test script
|
||||
|
||||
instruct user to test as follows (vtest is an alias which gets installed when herolib gets installed), can be done for a dir and for a file
|
||||
|
||||
```bash
|
||||
vtest ~/code/github/freeflowuniverse/herolib/lib/osal/package_test.v
|
||||
```
|
||||
|
||||
- use ~ so it works over all machines
|
||||
@@ -1,309 +0,0 @@
|
||||
# how to work with heroscript in vlang
|
||||
|
||||
## heroscript
|
||||
|
||||
Heroscript is our small scripting language which has following structure
|
||||
|
||||
an example of a heroscript is
|
||||
|
||||
```heroscript
|
||||
|
||||
!!dagu.script_define
|
||||
name: 'test_dag'
|
||||
homedir:''
|
||||
title:'a title'
|
||||
reset:1
|
||||
start:true //trie or 1 is same
|
||||
colors: 'green,red,purple' //lists are comma separated
|
||||
description: '
|
||||
a description can be multiline
|
||||
|
||||
like this
|
||||
'
|
||||
|
||||
|
||||
!!dagu.add_step
|
||||
dag: 'test_dag'
|
||||
name: 'hello_world'
|
||||
command: 'echo hello world'
|
||||
|
||||
!!dagu.add_step
|
||||
dag: 'test_dag'
|
||||
name: 'last_step'
|
||||
command: 'echo last step'
|
||||
|
||||
|
||||
```
|
||||
|
||||
Notice how:
|
||||
- every action starts with !!
|
||||
- the first part is the actor e.g. dagu in this case
|
||||
- the 2e part is the action name
|
||||
- multilines are supported see the description field
|
||||
|
||||
## how to process heroscript in Vlang
|
||||
|
||||
- heroscript can be converted to a struct,
|
||||
- the methods available to get the params are in 'params' section further in this doc
|
||||
|
||||
|
||||
```vlang
|
||||
|
||||
fn test_play_dagu() ! {
|
||||
mut plbook := playbook.new(text: thetext_from_above)!
|
||||
play_dagu(mut plbook)! //see below in vlang block there it all happens
|
||||
}
|
||||
|
||||
|
||||
pub fn play_dagu(mut plbook playbook.PlayBook) ! {
|
||||
|
||||
//find all actions are !!$actor.$actionname. in this case above the actor is !!dagu, we check with the fitler if it exists, if not we return
|
||||
dagu_actions := plbook.find(filter: 'dagu.')!
|
||||
if dagu_actions.len == 0 {
|
||||
return
|
||||
}
|
||||
play_dagu_basic(mut plbook)!
|
||||
}
|
||||
|
||||
pub struct DaguScript {
|
||||
pub mut:
|
||||
name string
|
||||
homedir string
|
||||
title string
|
||||
reset bool
|
||||
start bool
|
||||
colors []string
|
||||
}
|
||||
|
||||
// play_dagu plays the dagu play commands
|
||||
pub fn play_dagu_basic(mut plbook playbook.PlayBook) ! {
|
||||
|
||||
//now find the specific ones for dagu.script_define
|
||||
mut actions := plbook.find(filter: 'dagu.script_define')!
|
||||
|
||||
if actions.len > 0 {
|
||||
for myaction in actions {
|
||||
mut p := myaction.params //get the params object from the action object, this can then be processed using the param getters
|
||||
mut obj := DaguScript{
|
||||
//INFO: all details about the get methods can be found in 'params get methods' section
|
||||
name : p.get('name')! //will give error if not exist
|
||||
homedir : p.get('homedir')!
|
||||
title : p.get_default('title', 'My Hero DAG')! //uses a default if not set
|
||||
reset : p.get_default_false('reset')
|
||||
start : p.get_default_true('start')
|
||||
colors : p.get_list('colors')
|
||||
description : p.get_default('description','')!
|
||||
}
|
||||
...
|
||||
}
|
||||
}
|
||||
|
||||
//there can be more actions which will have other filter
|
||||
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## params get methods (param getters)
|
||||
|
||||
```vlang
|
||||
|
||||
fn (params &Params) exists(key_ string) bool
|
||||
|
||||
//check if arg exist (arg is just a value in the string e.g. red, not value:something)
|
||||
fn (params &Params) exists_arg(key_ string) bool
|
||||
|
||||
//see if the kwarg with the key exists if yes return as string trimmed
|
||||
fn (params &Params) get(key_ string) !string
|
||||
|
||||
//return the arg with nr, 0 is the first
|
||||
fn (params &Params) get_arg(nr int) !string
|
||||
|
||||
//return arg, if the nr is larger than amount of args, will return the defval
|
||||
fn (params &Params) get_arg_default(nr int, defval string) !string
|
||||
|
||||
fn (params &Params) get_default(key string, defval string) !string
|
||||
|
||||
fn (params &Params) get_default_false(key string) bool
|
||||
|
||||
fn (params &Params) get_default_true(key string) bool
|
||||
|
||||
fn (params &Params) get_float(key string) !f64
|
||||
|
||||
fn (params &Params) get_float_default(key string, defval f64) !f64
|
||||
|
||||
fn (params &Params) get_from_hashmap(key_ string, defval string, hashmap map[string]string) !string
|
||||
|
||||
fn (params &Params) get_int(key string) !int
|
||||
|
||||
fn (params &Params) get_int_default(key string, defval int) !int
|
||||
|
||||
//Looks for a list of strings in the parameters. ',' are used as deliminator to list
|
||||
fn (params &Params) get_list(key string) ![]string
|
||||
|
||||
fn (params &Params) get_list_default(key string, def []string) ![]string
|
||||
|
||||
fn (params &Params) get_list_f32(key string) ![]f32
|
||||
|
||||
fn (params &Params) get_list_f32_default(key string, def []f32) []f32
|
||||
|
||||
fn (params &Params) get_list_f64(key string) ![]f64
|
||||
|
||||
fn (params &Params) get_list_f64_default(key string, def []f64) []f64
|
||||
|
||||
fn (params &Params) get_list_i16(key string) ![]i16
|
||||
|
||||
fn (params &Params) get_list_i16_default(key string, def []i16) []i16
|
||||
|
||||
fn (params &Params) get_list_i64(key string) ![]i64
|
||||
|
||||
fn (params &Params) get_list_i64_default(key string, def []i64) []i64
|
||||
|
||||
fn (params &Params) get_list_i8(key string) ![]i8
|
||||
|
||||
fn (params &Params) get_list_i8_default(key string, def []i8) []i8
|
||||
|
||||
fn (params &Params) get_list_int(key string) ![]int
|
||||
|
||||
fn (params &Params) get_list_int_default(key string, def []int) []int
|
||||
|
||||
fn (params &Params) get_list_namefix(key string) ![]string
|
||||
|
||||
fn (params &Params) get_list_namefix_default(key string, def []string) ![]string
|
||||
|
||||
fn (params &Params) get_list_u16(key string) ![]u16
|
||||
|
||||
fn (params &Params) get_list_u16_default(key string, def []u16) []u16
|
||||
|
||||
fn (params &Params) get_list_u32(key string) ![]u32
|
||||
|
||||
fn (params &Params) get_list_u32_default(key string, def []u32) []u32
|
||||
|
||||
fn (params &Params) get_list_u64(key string) ![]u64
|
||||
|
||||
fn (params &Params) get_list_u64_default(key string, def []u64) []u64
|
||||
|
||||
fn (params &Params) get_list_u8(key string) ![]u8
|
||||
|
||||
fn (params &Params) get_list_u8_default(key string, def []u8) []u8
|
||||
|
||||
fn (params &Params) get_map() map[string]string
|
||||
|
||||
fn (params &Params) get_path(key string) !string
|
||||
|
||||
fn (params &Params) get_path_create(key string) !string
|
||||
|
||||
fn (params &Params) get_percentage(key string) !f64
|
||||
|
||||
fn (params &Params) get_percentage_default(key string, defval string) !f64
|
||||
|
||||
//convert GB, MB, KB to bytes e.g. 10 GB becomes bytes in u64
|
||||
fn (params &Params) get_storagecapacity_in_bytes(key string) !u64
|
||||
|
||||
fn (params &Params) get_storagecapacity_in_bytes_default(key string, defval u64) !u64
|
||||
|
||||
fn (params &Params) get_storagecapacity_in_gigabytes(key string) !u64
|
||||
|
||||
//Get Expiration object from time string input input can be either relative or absolute## Relative time
|
||||
fn (params &Params) get_time(key string) !ourtime.OurTime
|
||||
|
||||
fn (params &Params) get_time_default(key string, defval ourtime.OurTime) !ourtime.OurTime
|
||||
|
||||
fn (params &Params) get_time_interval(key string) !Duration
|
||||
|
||||
fn (params &Params) get_timestamp(key string) !Duration
|
||||
|
||||
fn (params &Params) get_timestamp_default(key string, defval Duration) !Duration
|
||||
|
||||
fn (params &Params) get_u32(key string) !u32
|
||||
|
||||
fn (params &Params) get_u32_default(key string, defval u32) !u32
|
||||
|
||||
fn (params &Params) get_u64(key string) !u64
|
||||
|
||||
fn (params &Params) get_u64_default(key string, defval u64) !u64
|
||||
|
||||
fn (params &Params) get_u8(key string) !u8
|
||||
|
||||
fn (params &Params) get_u8_default(key string, defval u8) !u8
|
||||
|
||||
```
|
||||
|
||||
## how internally a heroscript gets parsed for params
|
||||
|
||||
- example to show how a heroscript gets parsed in action with params
|
||||
- params are part of action object
|
||||
|
||||
```heroscript
|
||||
example text to parse (heroscript)
|
||||
|
||||
id:a1 name6:aaaaa
|
||||
name:'need to do something 1'
|
||||
description:
|
||||
'
|
||||
## markdown works in it
|
||||
description can be multiline
|
||||
lets see what happens
|
||||
|
||||
- a
|
||||
- something else
|
||||
|
||||
### subtitle
|
||||
'
|
||||
|
||||
name2: test
|
||||
name3: hi
|
||||
name10:'this is with space' name11:aaa11
|
||||
|
||||
name4: 'aaa'
|
||||
|
||||
//somecomment
|
||||
name5: 'aab'
|
||||
```
|
||||
|
||||
the params are part of the action and are represented as follow for the above:
|
||||
|
||||
```vlang
|
||||
Params{
|
||||
params: [Param{
|
||||
key: 'id'
|
||||
value: 'a1'
|
||||
}, Param{
|
||||
key: 'name6'
|
||||
value: 'aaaaa'
|
||||
}, Param{
|
||||
key: 'name'
|
||||
value: 'need to do something 1'
|
||||
}, Param{
|
||||
key: 'description'
|
||||
value: '## markdown works in it
|
||||
|
||||
description can be multiline
|
||||
lets see what happens
|
||||
|
||||
- a
|
||||
- something else
|
||||
|
||||
### subtitle
|
||||
'
|
||||
}, Param{
|
||||
key: 'name2'
|
||||
value: 'test'
|
||||
}, Param{
|
||||
key: 'name3'
|
||||
value: 'hi'
|
||||
}, Param{
|
||||
key: 'name10'
|
||||
value: 'this is with space'
|
||||
}, Param{
|
||||
key: 'name11'
|
||||
value: 'aaa11'
|
||||
}, Param{
|
||||
key: 'name4'
|
||||
value: 'aaa'
|
||||
}, Param{
|
||||
key: 'name5'
|
||||
value: 'aab'
|
||||
}]
|
||||
}
|
||||
```
|
||||
3614
aiprompts/todo/refactor_herofs.md
Normal file
3614
aiprompts/todo/refactor_herofs.md
Normal file
File diff suppressed because it is too large
Load Diff
@@ -2238,7 +2238,7 @@ be faster, since there is no need for a re-compilation of a script, that has not
|
||||
An example `deploy.vsh`:
|
||||
|
||||
```v oksyntax
|
||||
#!/usr/bin/env -S v -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
#!/usr/bin/env -S v -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
// Note: The shebang line above, associates the .vsh file to V on Unix-like systems,
|
||||
// so it can be run just by specifying the path to the .vsh file, once it's made
|
||||
@@ -2300,11 +2300,11 @@ Whilst V does normally not allow vsh scripts without the designated file extensi
|
||||
to circumvent this rule and have a file with a fully custom name and shebang. Whilst this feature
|
||||
exists it is only recommended for specific usecases like scripts that will be put in the path and
|
||||
should **not** be used for things like build or deploy scripts. To access this feature start the
|
||||
file with `#!/usr/bin/env -S v -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
file with `#!/usr/bin/env -S v -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
the built executable. This will run in crun mode so it will only rebuild if changes to the script
|
||||
were made and keep the binary as `tmp.<scriptfilename>`. **Caution**: if this filename already
|
||||
exists the file will be overridden. If you want to rebuild each time and not keep this binary
|
||||
instead use `#!/usr/bin/env -S v -gc none -no-retry-compilation -cc tcc -d use_openssl -enable-globals run
|
||||
instead use `#!/usr/bin/env -S v -gc none -cc tcc -d use_openssl -enable-globals run
|
||||
|
||||
# Appendices
|
||||
|
||||
73
aiprompts/v_advanced/blake3.md
Normal file
73
aiprompts/v_advanced/blake3.md
Normal file
@@ -0,0 +1,73 @@
|
||||
|
||||
## `crypto.blake3` Module
|
||||
|
||||
|
||||
```v
|
||||
fn sum256(data []u8) []u8
|
||||
```
|
||||
|
||||
Returns the Blake3 256-bit hash of the provided data.
|
||||
|
||||
```v
|
||||
fn sum_derive_key256(context []u8, key_material []u8) []u8
|
||||
```
|
||||
|
||||
Computes the Blake3 256-bit derived-key hash based on the context and key material.
|
||||
|
||||
```v
|
||||
fn sum_keyed256(data []u8, key []u8) []u8
|
||||
```
|
||||
|
||||
Returns the Blake3 256-bit keyed hash of the data using the specified key.
|
||||
|
||||
---
|
||||
|
||||
### Digest-Based API
|
||||
|
||||
```v
|
||||
fn Digest.new_derive_key_hash(context []u8) !Digest
|
||||
```
|
||||
|
||||
Initializes a `Digest` struct for creating a Blake3 derived‑key hash, using the provided context.
|
||||
|
||||
```v
|
||||
fn Digest.new_hash() !Digest
|
||||
```
|
||||
|
||||
Initializes a `Digest` struct for a standard (unkeyed) Blake3 hash.
|
||||
|
||||
```v
|
||||
fn Digest.new_keyed_hash(key []u8) !Digest
|
||||
```
|
||||
|
||||
Initializes a `Digest` struct for a keyed Blake3 hash, with the given key.
|
||||
|
||||
---
|
||||
|
||||
### `Digest` Methods
|
||||
|
||||
```v
|
||||
fn (mut d Digest) write(data []u8) !
|
||||
```
|
||||
|
||||
Feeds additional data bytes into the ongoing hash computation.
|
||||
|
||||
```v
|
||||
fn (mut d Digest) checksum(size u64) []u8
|
||||
```
|
||||
|
||||
Finalizes the hash and returns the resulting output.
|
||||
|
||||
* The `size` parameter specifies the number of output bytes—commonly `32` for a 256-bit digest, but can be up to `2**64`.
|
||||
|
||||
---
|
||||
|
||||
### Recommended Usage (in V)
|
||||
|
||||
```v
|
||||
import crypto.blake3
|
||||
|
||||
mut hasher := crypto.blake3.Digest.new_hash() or { panic(err) }
|
||||
hasher.write(data) or { panic(err) }
|
||||
digest := hasher.checksum(24) // returns a []u8 of length 24 (192 bits)
|
||||
```
|
||||
45
aiprompts/v_advanced/compress.md
Normal file
45
aiprompts/v_advanced/compress.md
Normal file
@@ -0,0 +1,45 @@
|
||||
The `compress` module in V provides low-level functionalities for compressing and decompressing byte arrays.
|
||||
|
||||
**Functions Overview (Low-Level):**
|
||||
|
||||
* **`compress(data []u8, flags int) ![]u8`**: Compresses an array of bytes.
|
||||
* **`decompress(data []u8, flags int) ![]u8`**: Decompresses an array of bytes.
|
||||
* **`decompress_with_callback(data []u8, cb ChunkCallback, userdata voidptr, flags int) !u64`**: Decompresses byte arrays using a callback function for chunks.
|
||||
|
||||
**Type Definition (Low-Level):**
|
||||
|
||||
* **`ChunkCallback`**: A function type `fn (chunk []u8, userdata voidptr) int` used to receive decompressed chunks.
|
||||
|
||||
---
|
||||
|
||||
**`compress.gzip` Module (High-Level Gzip Operations):**
|
||||
|
||||
For high-level gzip compression and decompression, use the `compress.gzip` module. This module provides a more convenient and recommended way to handle gzip operations compared to the low-level `compress` module.
|
||||
|
||||
**Key Features of `compress.gzip`:**
|
||||
|
||||
* **`compress(data []u8, params CompressParams) ![]u8`**: Compresses data using gzip, allowing specification of `CompressParams` like `compression_level` (0-4095).
|
||||
* **`decompress(data []u8, params DecompressParams) ![]u8`**: Decompresses gzip-compressed data, allowing specification of `DecompressParams` for verification.
|
||||
* **`decompress_with_callback(data []u8, cb compr.ChunkCallback, userdata voidptr, params DecompressParams) !int`**: Decompresses gzip data with a callback for chunks, similar to the low-level version but for gzip streams.
|
||||
* **`validate(data []u8, params DecompressParams) !GzipHeader`**: Validates a gzip header and returns its details.
|
||||
|
||||
**Parameter Structures:**
|
||||
|
||||
* **`CompressParams`**: Configures compression, primarily `compression_level` (0-4095).
|
||||
* **`DecompressParams`**: Configures decompression, including `verify_header_checksum`, `verify_length`, and `verify_checksum`.
|
||||
* **`GzipHeader`**: Represents the structure of a gzip header.
|
||||
|
||||
**Inline Code Example (Gzip Compression/Decompression):**
|
||||
|
||||
```v
|
||||
import compress.gzip
|
||||
|
||||
data := 'Hello, Gzip!'
|
||||
compressed := gzip.compress(data.bytes(), compression_level: 4095)!
|
||||
decompressed := gzip.decompress(compressed)!
|
||||
|
||||
// Check if decompressed data matches original
|
||||
// if data.bytes() == decompressed { ... }
|
||||
```
|
||||
|
||||
**Important Note:** Always prefer `compress.gzip` for general gzip compression/decompression tasks over the low-level `compress` module.
|
||||
64
aiprompts/v_advanced/generics.md
Normal file
64
aiprompts/v_advanced/generics.md
Normal file
@@ -0,0 +1,64 @@
|
||||
|
||||
```v
|
||||
|
||||
struct Repo[T] {
|
||||
db DB
|
||||
}
|
||||
|
||||
struct User {
|
||||
id int
|
||||
name string
|
||||
}
|
||||
|
||||
struct Post {
|
||||
id int
|
||||
user_id int
|
||||
title string
|
||||
body string
|
||||
}
|
||||
|
||||
fn new_repo[T](db DB) Repo[T] {
|
||||
return Repo[T]{db: db}
|
||||
}
|
||||
|
||||
// This is a generic function. V will generate it for every type it's used with.
|
||||
fn (r Repo[T]) find_by_id(id int) ?T {
|
||||
table_name := T.name // in this example getting the name of the type gives us the table name
|
||||
return r.db.query_one[T]('select * from ${table_name} where id = ?', id)
|
||||
}
|
||||
|
||||
db := new_db()
|
||||
users_repo := new_repo[User](db) // returns Repo[User]
|
||||
posts_repo := new_repo[Post](db) // returns Repo[Post]
|
||||
user := users_repo.find_by_id(1)? // find_by_id[User]
|
||||
post := posts_repo.find_by_id(1)? // find_by_id[Post]
|
||||
|
||||
```
|
||||
|
||||
Currently generic function definitions must declare their type parameters, but in future V will infer generic type parameters from single-letter type names in runtime parameter types. This is why find_by_id can omit [T], because the receiver argument r uses a generic type T.
|
||||
|
||||
```v
|
||||
fn compare[T](a T, b T) int {
|
||||
if a < b {
|
||||
return -1
|
||||
}
|
||||
if a > b {
|
||||
return 1
|
||||
}
|
||||
return 0
|
||||
}
|
||||
|
||||
// compare[int]
|
||||
println(compare(1, 0)) // Outputs: 1
|
||||
println(compare(1, 1)) // 0
|
||||
println(compare(1, 2)) // -1
|
||||
// compare[string]
|
||||
println(compare('1', '0')) // Outputs: 1
|
||||
println(compare('1', '1')) // 0
|
||||
println(compare('1', '2')) // -1
|
||||
// compare[f64]
|
||||
println(compare(1.1, 1.0)) // Outputs: 1
|
||||
println(compare(1.1, 1.1)) // 0
|
||||
println(compare(1.1, 1.2)) // -1
|
||||
```
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
module net
|
||||
## Description
|
||||
|
||||
|
||||
`net` provides networking functions. It is mostly a wrapper to BSD sockets, so you can listen on a port, connect to remote TCP/UDP services, and communicate with them.
|
||||
|
||||
const msg_nosignal = 0x4000
|
||||
const err_connection_refused = error_with_code('net: connection refused', errors_base + 10)
|
||||
const err_option_wrong_type = error_with_code('net: set_option_xxx option wrong type',
|
||||
errors_base + 3)
|
||||
errors_base + 3)
|
||||
const opts_can_set = [
|
||||
SocketOption.broadcast,
|
||||
.debug,
|
||||
.dont_route,
|
||||
.keep_alive,
|
||||
.linger,
|
||||
.oob_inline,
|
||||
.receive_buf_size,
|
||||
.receive_low_size,
|
||||
.receive_timeout,
|
||||
.send_buf_size,
|
||||
.send_low_size,
|
||||
.send_timeout,
|
||||
.ipv6_only,
|
||||
SocketOption.broadcast,
|
||||
.debug,
|
||||
.dont_route,
|
||||
.keep_alive,
|
||||
.linger,
|
||||
.oob_inline,
|
||||
.receive_buf_size,
|
||||
.receive_low_size,
|
||||
.receive_timeout,
|
||||
.send_buf_size,
|
||||
.send_low_size,
|
||||
.send_timeout,
|
||||
.ipv6_only,
|
||||
]
|
||||
const error_eagain = C.EAGAIN
|
||||
const err_port_out_of_range = error_with_code('net: port out of range', errors_base + 5)
|
||||
@@ -29,12 +29,12 @@ const err_connect_failed = error_with_code('net: connect failed', errors_base +
|
||||
const errors_base = 0
|
||||
Well defined errors that are returned from socket functions
|
||||
const opts_int = [
|
||||
SocketOption.receive_buf_size,
|
||||
.receive_low_size,
|
||||
.receive_timeout,
|
||||
.send_buf_size,
|
||||
.send_low_size,
|
||||
.send_timeout,
|
||||
SocketOption.receive_buf_size,
|
||||
.receive_low_size,
|
||||
.receive_timeout,
|
||||
.send_buf_size,
|
||||
.send_low_size,
|
||||
.send_timeout,
|
||||
]
|
||||
const error_eintr = C.EINTR
|
||||
const error_ewouldblock = C.EWOULDBLOCK
|
||||
@@ -43,17 +43,17 @@ const error_einprogress = C.EINPROGRESS
|
||||
const err_timed_out_code = errors_base + 9
|
||||
const err_connect_timed_out = error_with_code('net: connect timed out', errors_base + 8)
|
||||
const err_new_socket_failed = error_with_code('net: new_socket failed to create socket',
|
||||
errors_base + 1)
|
||||
errors_base + 1)
|
||||
const msg_dontwait = C.MSG_DONTWAIT
|
||||
const infinite_timeout = time.infinite
|
||||
infinite_timeout should be given to functions when an infinite_timeout is wanted (i.e. functions only ever return with data)
|
||||
const no_timeout = time.Duration(0)
|
||||
no_timeout should be given to functions when no timeout is wanted (i.e. all functions return instantly)
|
||||
const err_timed_out = error_with_code('net: op timed out', errors_base + 9)
|
||||
const tcp_default_read_timeout = 30 * time.second
|
||||
const tcp_default_read_timeout = 30 *time.second
|
||||
const err_option_not_settable = error_with_code('net: set_option_xxx option not settable',
|
||||
errors_base + 2)
|
||||
const tcp_default_write_timeout = 30 * time.second
|
||||
errors_base + 2)
|
||||
const tcp_default_write_timeout = 30* time.second
|
||||
fn addr_from_socket_handle(handle int) Addr
|
||||
addr_from_socket_handle returns an address, based on the given integer socket `handle`
|
||||
fn close(handle int) !
|
||||
@@ -94,16 +94,16 @@ fn validate_port(port int) !u16
|
||||
validate_port checks whether a port is valid and returns the port or an error
|
||||
fn wrap_error(error_code int) !
|
||||
interface Connection {
|
||||
addr() !Addr
|
||||
peer_addr() !Addr
|
||||
addr() !Addr
|
||||
peer_addr() !Addr
|
||||
mut:
|
||||
read(mut []u8) !int
|
||||
write([]u8) !int
|
||||
close() !
|
||||
read(mut []u8) !int
|
||||
write([]u8) !int
|
||||
close() !
|
||||
}
|
||||
Connection provides a generic SOCK_STREAM style interface that protocols can use as a base connection object to support TCP, UNIX Domain Sockets and various proxying solutions.
|
||||
interface Dialer {
|
||||
dial(address string) !Connection
|
||||
dial(address string) !Connection
|
||||
}
|
||||
Dialer is an abstract dialer interface for producing connections to adresses.
|
||||
fn (mut s TcpSocket) set_option_bool(opt SocketOption, value bool) !
|
||||
@@ -114,49 +114,49 @@ fn (mut s TcpSocket) bind(addr string) !
|
||||
fn (mut s UdpSocket) set_option_bool(opt SocketOption, value bool) !
|
||||
fn (mut s UdpSocket) set_dualstack(on bool) !
|
||||
enum AddrFamily {
|
||||
unix = C.AF_UNIX
|
||||
ip = C.AF_INET
|
||||
ip6 = C.AF_INET6
|
||||
unspec = C.AF_UNSPEC
|
||||
unix = C.AF_UNIX
|
||||
ip = C.AF_INET
|
||||
ip6 = C.AF_INET6
|
||||
unspec = C.AF_UNSPEC
|
||||
}
|
||||
AddrFamily are the available address families
|
||||
enum ShutdownDirection {
|
||||
read
|
||||
write
|
||||
read_and_write
|
||||
read
|
||||
write
|
||||
read_and_write
|
||||
}
|
||||
ShutdownDirection is used by `net.shutdown`, for specifying the direction for which the communication will be cut.
|
||||
enum SocketOption {
|
||||
// TODO: SO_ACCEPT_CONN is not here because windows doesn't support it
|
||||
// and there is no easy way to define it
|
||||
broadcast = C.SO_BROADCAST
|
||||
debug = C.SO_DEBUG
|
||||
dont_route = C.SO_DONTROUTE
|
||||
error = C.SO_ERROR
|
||||
keep_alive = C.SO_KEEPALIVE
|
||||
linger = C.SO_LINGER
|
||||
oob_inline = C.SO_OOBINLINE
|
||||
reuse_addr = C.SO_REUSEADDR
|
||||
receive_buf_size = C.SO_RCVBUF
|
||||
receive_low_size = C.SO_RCVLOWAT
|
||||
receive_timeout = C.SO_RCVTIMEO
|
||||
send_buf_size = C.SO_SNDBUF
|
||||
send_low_size = C.SO_SNDLOWAT
|
||||
send_timeout = C.SO_SNDTIMEO
|
||||
socket_type = C.SO_TYPE
|
||||
ipv6_only = C.IPV6_V6ONLY
|
||||
// TODO: SO_ACCEPT_CONN is not here because windows doesn't support it
|
||||
// and there is no easy way to define it
|
||||
broadcast = C.SO_BROADCAST
|
||||
debug = C.SO_DEBUG
|
||||
dont_route = C.SO_DONTROUTE
|
||||
error = C.SO_ERROR
|
||||
keep_alive = C.SO_KEEPALIVE
|
||||
linger = C.SO_LINGER
|
||||
oob_inline = C.SO_OOBINLINE
|
||||
reuse_addr = C.SO_REUSEADDR
|
||||
receive_buf_size = C.SO_RCVBUF
|
||||
receive_low_size = C.SO_RCVLOWAT
|
||||
receive_timeout = C.SO_RCVTIMEO
|
||||
send_buf_size = C.SO_SNDBUF
|
||||
send_low_size = C.SO_SNDLOWAT
|
||||
send_timeout = C.SO_SNDTIMEO
|
||||
socket_type = C.SO_TYPE
|
||||
ipv6_only = C.IPV6_V6ONLY
|
||||
}
|
||||
enum SocketType {
|
||||
udp = C.SOCK_DGRAM
|
||||
tcp = C.SOCK_STREAM
|
||||
seqpacket = C.SOCK_SEQPACKET
|
||||
udp = C.SOCK_DGRAM
|
||||
tcp = C.SOCK_STREAM
|
||||
seqpacket = C.SOCK_SEQPACKET
|
||||
}
|
||||
SocketType are the available sockets
|
||||
struct Addr {
|
||||
pub:
|
||||
len u8
|
||||
f u8
|
||||
addr AddrData
|
||||
len u8
|
||||
f u8
|
||||
addr AddrData
|
||||
}
|
||||
fn (a Addr) family() AddrFamily
|
||||
family returns the family/kind of the given address `a`
|
||||
@@ -168,72 +168,72 @@ fn (a Addr) str() string
|
||||
str returns a string representation of the address `a`
|
||||
struct C.addrinfo {
|
||||
mut:
|
||||
ai_family int
|
||||
ai_socktype int
|
||||
ai_flags int
|
||||
ai_protocol int
|
||||
ai_addrlen int
|
||||
ai_addr voidptr
|
||||
ai_canonname voidptr
|
||||
ai_next voidptr
|
||||
ai_family int
|
||||
ai_socktype int
|
||||
ai_flags int
|
||||
ai_protocol int
|
||||
ai_addrlen int
|
||||
ai_addr voidptr
|
||||
ai_canonname voidptr
|
||||
ai_next voidptr
|
||||
}
|
||||
struct C.fd_set {}
|
||||
struct C.sockaddr_in {
|
||||
mut:
|
||||
sin_len u8
|
||||
sin_family u8
|
||||
sin_port u16
|
||||
sin_addr u32
|
||||
sin_zero [8]char
|
||||
sin_len u8
|
||||
sin_family u8
|
||||
sin_port u16
|
||||
sin_addr u32
|
||||
sin_zero [8]char
|
||||
}
|
||||
struct C.sockaddr_in6 {
|
||||
mut:
|
||||
// 1 + 1 + 2 + 4 + 16 + 4 = 28;
|
||||
sin6_len u8 // 1
|
||||
sin6_family u8 // 1
|
||||
sin6_port u16 // 2
|
||||
sin6_flowinfo u32 // 4
|
||||
sin6_addr [16]u8 // 16
|
||||
sin6_scope_id u32 // 4
|
||||
// 1 + 1 + 2 + 4 + 16 + 4 = 28;
|
||||
sin6_len u8 // 1
|
||||
sin6_family u8 // 1
|
||||
sin6_port u16 // 2
|
||||
sin6_flowinfo u32 // 4
|
||||
sin6_addr [16]u8 // 16
|
||||
sin6_scope_id u32 // 4
|
||||
}
|
||||
struct C.sockaddr_un {
|
||||
mut:
|
||||
sun_len u8
|
||||
sun_family u8
|
||||
sun_path [max_unix_path]char
|
||||
sun_len u8
|
||||
sun_family u8
|
||||
sun_path [max_unix_path]char
|
||||
}
|
||||
struct Ip {
|
||||
port u16
|
||||
addr [4]u8
|
||||
// Pad to size so that socket functions
|
||||
// dont complain to us (see in.h and bind())
|
||||
// TODO(emily): I would really like to use
|
||||
// some constant calculations here
|
||||
// so that this doesnt have to be hardcoded
|
||||
sin_pad [8]u8
|
||||
port u16
|
||||
addr [4]u8
|
||||
// Pad to size so that socket functions
|
||||
// dont complain to us (see in.h and bind())
|
||||
// TODO(emily): I would really like to use
|
||||
// some constant calculations here
|
||||
// so that this doesnt have to be hardcoded
|
||||
sin_pad [8]u8
|
||||
}
|
||||
fn (a Ip) str() string
|
||||
str returns a string representation of `a`
|
||||
struct Ip6 {
|
||||
port u16
|
||||
flow_info u32
|
||||
addr [16]u8
|
||||
scope_id u32
|
||||
port u16
|
||||
flow_info u32
|
||||
addr [16]u8
|
||||
scope_id u32
|
||||
}
|
||||
fn (a Ip6) str() string
|
||||
str returns a string representation of `a`
|
||||
struct ListenOptions {
|
||||
pub:
|
||||
dualstack bool = true
|
||||
backlog int = 128
|
||||
dualstack bool = true
|
||||
backlog int = 128
|
||||
}
|
||||
struct ShutdownConfig {
|
||||
pub:
|
||||
how ShutdownDirection = .read_and_write
|
||||
how ShutdownDirection = .read_and_write
|
||||
}
|
||||
struct Socket {
|
||||
pub:
|
||||
handle int
|
||||
handle int
|
||||
}
|
||||
fn (s &Socket) address() !Addr
|
||||
address gets the address of a socket
|
||||
@@ -243,13 +243,13 @@ fn (t TCPDialer) dial(address string) !Connection
|
||||
dial will try to create a new abstract connection to the given address. It will return an error, if that is not possible.
|
||||
struct TcpConn {
|
||||
pub mut:
|
||||
sock TcpSocket
|
||||
handle int
|
||||
write_deadline time.Time
|
||||
read_deadline time.Time
|
||||
read_timeout time.Duration
|
||||
write_timeout time.Duration
|
||||
is_blocking bool = true
|
||||
sock TcpSocket
|
||||
handle int
|
||||
write_deadline time.Time
|
||||
read_deadline time.Time
|
||||
read_timeout time.Duration
|
||||
write_timeout time.Duration
|
||||
is_blocking bool = true
|
||||
}
|
||||
fn (c &TcpConn) addr() !Addr
|
||||
fn (mut c TcpConn) close() !
|
||||
@@ -265,7 +265,7 @@ fn (c TcpConn) read(mut buf []u8) !int
|
||||
fn (mut c TcpConn) read_deadline() !time.Time
|
||||
fn (mut con TcpConn) read_line() string
|
||||
read_line is a *simple*, *non customizable*, blocking line reader. It will return a line, ending with LF, or just '', on EOF.
|
||||
|
||||
|
||||
Note: if you want more control over the buffer, please use a buffered IO reader instead: `io.new_buffered_reader({reader: io.make_reader(con)})`
|
||||
fn (mut con TcpConn) read_line_max(max_line_len int) string
|
||||
read_line_max is a *simple*, *non customizable*, blocking line reader. It will return a line, ending with LF, '' on EOF. It stops reading, when the result line length exceeds max_line_len.
|
||||
@@ -278,7 +278,7 @@ fn (mut c TcpConn) set_read_deadline(deadline time.Time)
|
||||
fn (mut c TcpConn) set_read_timeout(t time.Duration)
|
||||
fn (mut c TcpConn) set_sock() !
|
||||
set_sock initialises the c.sock field. It should be called after `.accept_only()!`.
|
||||
|
||||
|
||||
Note: just use `.accept()!`. In most cases it is simpler, and calls `.set_sock()!` for you.
|
||||
fn (mut c TcpConn) set_write_deadline(deadline time.Time)
|
||||
fn (mut c TcpConn) set_write_timeout(t time.Duration)
|
||||
@@ -295,19 +295,17 @@ fn (mut c TcpConn) write_string(s string) !int
|
||||
fn (c &TcpConn) write_timeout() time.Duration
|
||||
struct TcpListener {
|
||||
pub mut:
|
||||
sock TcpSocket
|
||||
accept_timeout time.Duration
|
||||
accept_deadline time.Time
|
||||
is_blocking bool = true
|
||||
sock TcpSocket
|
||||
accept_timeout time.Duration
|
||||
accept_deadline time.Time
|
||||
is_blocking bool = true
|
||||
}
|
||||
fn (mut l TcpListener) accept() !&TcpConn
|
||||
accept a tcp connection from an external source to the listener `l`.
|
||||
fn (mut l TcpListener) accept_only() !&TcpConn
|
||||
accept_only accepts a tcp connection from an external source to the listener `l`. Unlike `accept`, `accept_only` *will not call* `.set_sock()!` on the result, and is thus faster.
|
||||
|
||||
|
||||
|
||||
Note: you *need* to call `.set_sock()!` manually, before using theconnection after calling `.accept_only()!`, but that does not have to happen in the same thread that called `.accept_only()!`. The intention of this API, is to have a more efficient way to accept connections, that are later processed by a thread pool, while the main thread remains active, so that it can accept other connections. See also vlib/vweb/vweb.v .
|
||||
|
||||
Note: you *need* to call `.set_sock()!` manually, before using theconnection after calling `.accept_only()!`, but that does not have to happen in the same thread that called `.accept_only()!`. The intention of this API, is to have a more efficient way to accept connections, that are later processed by a thread pool, while the main thread remains active, so that it can accept other connections. See also vlib/veb/veb.v .
|
||||
|
||||
If you do not need that, just call `.accept()!` instead, which will call `.set_sock()!` for you.
|
||||
fn (c &TcpListener) accept_deadline() !time.Time
|
||||
@@ -319,12 +317,12 @@ fn (mut c TcpListener) close() !
|
||||
fn (c &TcpListener) addr() !Addr
|
||||
struct UdpConn {
|
||||
pub mut:
|
||||
sock UdpSocket
|
||||
sock UdpSocket
|
||||
mut:
|
||||
write_deadline time.Time
|
||||
read_deadline time.Time
|
||||
read_timeout time.Duration
|
||||
write_timeout time.Duration
|
||||
write_deadline time.Time
|
||||
read_deadline time.Time
|
||||
read_timeout time.Duration
|
||||
write_timeout time.Duration
|
||||
}
|
||||
fn (mut c UdpConn) write_ptr(b &u8, len int) !int
|
||||
sock := UdpSocket{ handle: sbase.handle l: local r: resolve_wrapper(raddr) } }
|
||||
@@ -350,5 +348,5 @@ fn (mut c UdpConn) wait_for_write() !
|
||||
fn (c &UdpConn) str() string
|
||||
fn (mut c UdpConn) close() !
|
||||
struct Unix {
|
||||
path [max_unix_path]char
|
||||
path [max_unix_path]char
|
||||
}
|
||||
187
aiprompts/v_advanced/reflection.md
Normal file
187
aiprompts/v_advanced/reflection.md
Normal file
@@ -0,0 +1,187 @@
|
||||
## Compile time reflection
|
||||
|
||||
$ is used as a prefix for compile time (also referred to as 'comptime') operations.
|
||||
|
||||
Having built-in JSON support is nice, but V also allows you to create efficient serializers for any data format. V has compile time if and for constructs:
|
||||
|
||||
.fields
|
||||
You can iterate over struct fields using .fields, it also works with generic types (e.g. T.fields) and generic arguments (e.g. param.fields where fn gen[T](param T) {).
|
||||
|
||||
struct User {
|
||||
name string
|
||||
age int
|
||||
}
|
||||
|
||||
fn main() {
|
||||
$for field in User.fields {
|
||||
$if field.typ is string {
|
||||
println('${field.name} is of type string')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Output:
|
||||
// name is of type string
|
||||
.values
|
||||
You can read Enum values and their attributes.
|
||||
|
||||
enum Color {
|
||||
red @[RED] // first attribute
|
||||
blue @[BLUE] // second attribute
|
||||
}
|
||||
|
||||
fn main() {
|
||||
$for e in Color.values {
|
||||
println(e.name)
|
||||
println(e.attrs)
|
||||
}
|
||||
}
|
||||
|
||||
// Output:
|
||||
// red
|
||||
// ['RED']
|
||||
// blue
|
||||
// ['BLUE']
|
||||
.attributes
|
||||
You can read Struct attributes.
|
||||
|
||||
@[COLOR]
|
||||
struct Foo {
|
||||
a int
|
||||
}
|
||||
|
||||
fn main() {
|
||||
$for e in Foo.attributes {
|
||||
println(e)
|
||||
}
|
||||
}
|
||||
|
||||
// Output:
|
||||
// StructAttribute{
|
||||
// name: 'COLOR'
|
||||
// has_arg: false
|
||||
// arg: ''
|
||||
// kind: plain
|
||||
// }
|
||||
.variants
|
||||
You can read variant types from Sum type.
|
||||
|
||||
type MySum = int | string
|
||||
|
||||
fn main() {
|
||||
$for v in MySum.variants {
|
||||
$if v.typ is int {
|
||||
println('has int type')
|
||||
} $else $if v.typ is string {
|
||||
println('has string type')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Output:
|
||||
// has int type
|
||||
// has string type
|
||||
.methods
|
||||
You can retrieve information about struct methods.
|
||||
|
||||
struct Foo {
|
||||
}
|
||||
|
||||
fn (f Foo) test() int {
|
||||
return 123
|
||||
}
|
||||
|
||||
fn (f Foo) test2() string {
|
||||
return 'foo'
|
||||
}
|
||||
|
||||
fn main() {
|
||||
foo := Foo{}
|
||||
$for m in Foo.methods {
|
||||
$if m.return_type is int {
|
||||
print('${m.name} returns int: ')
|
||||
println(foo.$method())
|
||||
} $else $if m.return_type is string {
|
||||
print('${m.name} returns string: ')
|
||||
println(foo.$method())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Output:
|
||||
// test returns int: 123
|
||||
// test2 returns string: foo
|
||||
.params
|
||||
You can retrieve information about struct method params.
|
||||
|
||||
struct Test {
|
||||
}
|
||||
|
||||
fn (t Test) foo(arg1 int, arg2 string) {
|
||||
}
|
||||
|
||||
fn main() {
|
||||
$for m in Test.methods {
|
||||
$for param in m.params {
|
||||
println('${typeof(param.typ).name}: ${param.name}')
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Output:
|
||||
// int: arg1
|
||||
// string: arg2
|
||||
|
||||
## Example
|
||||
|
||||
```v
|
||||
// An example deserializer implementation
|
||||
|
||||
struct User {
|
||||
name string
|
||||
age int
|
||||
}
|
||||
|
||||
fn main() {
|
||||
data := 'name=Alice\nage=18'
|
||||
user := decode[User](data)
|
||||
println(user)
|
||||
}
|
||||
|
||||
fn decode[T](data string) T {
|
||||
mut result := T{}
|
||||
// compile-time `for` loop
|
||||
// T.fields gives an array of a field metadata type
|
||||
$for field in T.fields {
|
||||
$if field.typ is string {
|
||||
// $(string_expr) produces an identifier
|
||||
result.$(field.name) = get_string(data, field.name)
|
||||
} $else $if field.typ is int {
|
||||
result.$(field.name) = get_int(data, field.name)
|
||||
}
|
||||
}
|
||||
return result
|
||||
}
|
||||
|
||||
fn get_string(data string, field_name string) string {
|
||||
for line in data.split_into_lines() {
|
||||
key_val := line.split('=')
|
||||
if key_val[0] == field_name {
|
||||
return key_val[1]
|
||||
}
|
||||
}
|
||||
return ''
|
||||
}
|
||||
|
||||
fn get_int(data string, field string) int {
|
||||
return get_string(data, field).int()
|
||||
}
|
||||
|
||||
// `decode<User>` generates:
|
||||
// fn decode_User(data string) User {
|
||||
// mut result := User{}
|
||||
// result.name = get_string(data, 'name')
|
||||
// result.age = get_int(data, 'age')
|
||||
// return result
|
||||
// }
|
||||
```
|
||||
@@ -83,7 +83,7 @@ fn main() {
|
||||
}
|
||||
```
|
||||
|
||||
```vlang
|
||||
```v
|
||||
|
||||
module time
|
||||
|
||||
785
aiprompts/v_core/array/arrays.md
Normal file
785
aiprompts/v_core/array/arrays.md
Normal file
@@ -0,0 +1,785 @@
|
||||
# module arrays
|
||||
|
||||
|
||||
## Contents
|
||||
- [append](#append)
|
||||
- [binary_search](#binary_search)
|
||||
- [carray_to_varray](#carray_to_varray)
|
||||
- [chunk](#chunk)
|
||||
- [chunk_while](#chunk_while)
|
||||
- [concat](#concat)
|
||||
- [copy](#copy)
|
||||
- [distinct](#distinct)
|
||||
- [each](#each)
|
||||
- [each_indexed](#each_indexed)
|
||||
- [filter_indexed](#filter_indexed)
|
||||
- [find_first](#find_first)
|
||||
- [find_last](#find_last)
|
||||
- [flat_map](#flat_map)
|
||||
- [flat_map_indexed](#flat_map_indexed)
|
||||
- [flatten](#flatten)
|
||||
- [fold](#fold)
|
||||
- [fold_indexed](#fold_indexed)
|
||||
- [group](#group)
|
||||
- [group_by](#group_by)
|
||||
- [idx_max](#idx_max)
|
||||
- [idx_min](#idx_min)
|
||||
- [index_of_first](#index_of_first)
|
||||
- [index_of_last](#index_of_last)
|
||||
- [join_to_string](#join_to_string)
|
||||
- [lower_bound](#lower_bound)
|
||||
- [map_indexed](#map_indexed)
|
||||
- [map_of_counts](#map_of_counts)
|
||||
- [map_of_indexes](#map_of_indexes)
|
||||
- [max](#max)
|
||||
- [merge](#merge)
|
||||
- [min](#min)
|
||||
- [partition](#partition)
|
||||
- [reduce](#reduce)
|
||||
- [reduce_indexed](#reduce_indexed)
|
||||
- [reverse_iterator](#reverse_iterator)
|
||||
- [rotate_left](#rotate_left)
|
||||
- [rotate_right](#rotate_right)
|
||||
- [sum](#sum)
|
||||
- [uniq](#uniq)
|
||||
- [uniq_all_repeated](#uniq_all_repeated)
|
||||
- [uniq_only](#uniq_only)
|
||||
- [uniq_only_repeated](#uniq_only_repeated)
|
||||
- [upper_bound](#upper_bound)
|
||||
- [window](#window)
|
||||
- [ReverseIterator[T]](#ReverseIterator[T])
|
||||
- [next](#next)
|
||||
- [free](#free)
|
||||
- [ReverseIterator](#ReverseIterator)
|
||||
- [WindowAttribute](#WindowAttribute)
|
||||
|
||||
## append
|
||||
```v
|
||||
fn append[T](a []T, b []T) []T
|
||||
```
|
||||
|
||||
append the second array `b` to the first array `a`, and return the result. Note, that unlike arrays.concat, arrays.append is less flexible, but more efficient, since it does not require you to use ...a for the second parameter.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.append([1, 3, 5, 7], [2, 4, 6, 8]) // => [1, 3, 5, 7, 2, 4, 6, 8]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## binary_search
|
||||
```v
|
||||
fn binary_search[T](array []T, target T) !int
|
||||
```
|
||||
|
||||
binary_search, requires `array` to be sorted, returns index of found item or error. Binary searches on sorted lists can be faster than other array searches because at maximum the algorithm only has to traverse log N elements
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.binary_search([1, 2, 3, 4], 4)! // => 3
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## carray_to_varray
|
||||
```v
|
||||
fn carray_to_varray[T](c_array_data voidptr, items int) []T
|
||||
```
|
||||
|
||||
carray_to_varray copies a C byte array into a V array of type `T`. See also: `cstring_to_vstring`
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## chunk
|
||||
```v
|
||||
fn chunk[T](array []T, size int) [][]T
|
||||
```
|
||||
|
||||
chunk array into a single array of arrays where each element is the next `size` elements of the original.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.chunk([1, 2, 3, 4, 5, 6, 7, 8, 9], 2) // => [[1, 2], [3, 4], [5, 6], [7, 8], [9]]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## chunk_while
|
||||
```v
|
||||
fn chunk_while[T](a []T, predicate fn (before T, after T) bool) [][]T
|
||||
```
|
||||
|
||||
chunk_while splits the input array `a` into chunks of varying length, using the `predicate`, passing to it pairs of adjacent elements `before` and `after`. Each chunk, will contain all ajdacent elements, for which the `predicate` returned true. The chunks are split *between* the `before` and `after` elements, for which the `predicate` returned false.
|
||||
|
||||
Examples
|
||||
```v
|
||||
|
||||
assert arrays.chunk_while([0,9,2,2,3,2,7,5,9,5],fn(x int,y int)bool{return x<=y})==[[0,9],[2,2,3],[2,7],[5,9],[5]]
|
||||
|
||||
assert arrays.chunk_while('aaaabbbcca'.runes(),fn(x rune,y rune)bool{return x==y})==[[`a`,`a`,`a`,`a`],[`b`,`b`,`b`],[`c`,`c`],[`a`]]
|
||||
|
||||
assert arrays.chunk_while('aaaabbbcca'.runes(),fn(x rune,y rune)bool{return x==y}).map({it[0]:it.len})==[{`a`:4},{`b`:3},{`c`:2},{`a`:1}]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## concat
|
||||
```v
|
||||
fn concat[T](a []T, b ...T) []T
|
||||
```
|
||||
|
||||
concatenate an array with an arbitrary number of additional values.
|
||||
|
||||
Note: if you have two arrays, you should simply use the `<<` operator directly.
|
||||
|
||||
Examples
|
||||
```v
|
||||
|
||||
assert arrays.concat([1, 2, 3], 4, 5, 6) == [1, 2, 3, 4, 5, 6]
|
||||
|
||||
assert arrays.concat([1, 2, 3], ...[4, 5, 6]) == [1, 2, 3, 4, 5, 6]
|
||||
|
||||
mut arr := arrays.concat([1, 2, 3], 4); arr << [10,20]; assert arr == [1,2,3,4,10,20] // note: arr is mutable
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## copy
|
||||
```v
|
||||
fn copy[T](mut dst []T, src []T) int
|
||||
```
|
||||
|
||||
copy copies the `src` array elements to the `dst` array. The number of the elements copied is the minimum of the length of both arrays. Returns the number of elements copied.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## distinct
|
||||
```v
|
||||
fn distinct[T](a []T) []T
|
||||
```
|
||||
|
||||
distinct returns all distinct elements from the given array a. The results are guaranteed to be unique, i.e. not have duplicates. See also arrays.uniq, which can be used to achieve the same goal, but needs you to first sort the array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
assert arrays.distinct( [5, 5, 1, 5, 2, 1, 1, 9] ) == [1, 2, 5, 9]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## each
|
||||
```v
|
||||
fn each[T](a []T, cb fn (elem T))
|
||||
```
|
||||
|
||||
each calls the callback fn `cb`, for each element of the given array `a`.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## each_indexed
|
||||
```v
|
||||
fn each_indexed[T](a []T, cb fn (i int, e T))
|
||||
```
|
||||
|
||||
each_indexed calls the callback fn `cb`, for each element of the given array `a`. It passes the callback both the index of the current element, and the element itself.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## filter_indexed
|
||||
```v
|
||||
fn filter_indexed[T](array []T, predicate fn (idx int, elem T) bool) []T
|
||||
```
|
||||
|
||||
filter_indexed filters elements based on `predicate` function being invoked on each element with its index in the original array.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## find_first
|
||||
```v
|
||||
fn find_first[T](array []T, predicate fn (elem T) bool) ?T
|
||||
```
|
||||
|
||||
find_first returns the first element that matches the given predicate. Returns `none` if no match is found.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.find_first([1, 2, 3, 4, 5], fn (i int) bool { return i == 3 })? // => 3
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## find_last
|
||||
```v
|
||||
fn find_last[T](array []T, predicate fn (elem T) bool) ?T
|
||||
```
|
||||
|
||||
find_last returns the last element that matches the given predicate. Returns `none` if no match is found.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.find_last([1, 2, 3, 4, 5], fn (i int) bool { return i == 3})? // => 3
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## flat_map
|
||||
```v
|
||||
fn flat_map[T, R](array []T, transform fn (elem T) []R) []R
|
||||
```
|
||||
|
||||
flat_map creates a new array populated with the flattened result of calling transform function being invoked on each element of `list`.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## flat_map_indexed
|
||||
```v
|
||||
fn flat_map_indexed[T, R](array []T, transform fn (idx int, elem T) []R) []R
|
||||
```
|
||||
|
||||
flat_map_indexed creates a new array with the flattened result of calling the `transform` fn, invoked on each idx,elem pair from the original.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## flatten
|
||||
```v
|
||||
fn flatten[T](array [][]T) []T
|
||||
```
|
||||
|
||||
flatten flattens n + 1 dimensional array into n dimensional array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.flatten[int]([[1, 2, 3], [4, 5]]) // => [1, 2, 3, 4, 5]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## fold
|
||||
```v
|
||||
fn fold[T, R](array []T, init R, fold_op fn (acc R, elem T) R) R
|
||||
```
|
||||
|
||||
fold sets `acc = init`, then successively calls `acc = fold_op(acc, elem)` for each element in `array`. returns `acc`.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
// Sum the length of each string in an array
|
||||
a := ['Hi', 'all']
|
||||
r := arrays.fold[string, int](a, 0,
|
||||
fn (r int, t string) int { return r + t.len })
|
||||
assert r == 5
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## fold_indexed
|
||||
```v
|
||||
fn fold_indexed[T, R](array []T, init R, fold_op fn (idx int, acc R, elem T) R) R
|
||||
```
|
||||
|
||||
fold_indexed sets `acc = init`, then successively calls `acc = fold_op(idx, acc, elem)` for each element in `array`. returns `acc`.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## group
|
||||
```v
|
||||
fn group[T](arrs ...[]T) [][]T
|
||||
```
|
||||
|
||||
group n arrays into a single array of arrays with n elements. This function is analogous to the "zip" function of other languages. To fully interleave two arrays, follow this function with a call to `flatten`.
|
||||
|
||||
Note: An error will be generated if the type annotation is omitted.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.group[int]([1, 2, 3], [4, 5, 6]) // => [[1, 4], [2, 5], [3, 6]]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## group_by
|
||||
```v
|
||||
fn group_by[K, V](array []V, grouping_op fn (val V) K) map[K][]V
|
||||
```
|
||||
|
||||
group_by groups together elements, for which the `grouping_op` callback produced the same result.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.group_by[int, string](['H', 'el', 'lo'], fn (v string) int { return v.len }) // => {1: ['H'], 2: ['el', 'lo']}
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## idx_max
|
||||
```v
|
||||
fn idx_max[T](array []T) !int
|
||||
```
|
||||
|
||||
idx_max returns the index of the maximum value in the array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.idx_max([1, 2, 3, 0, 9])! // => 4
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## idx_min
|
||||
```v
|
||||
fn idx_min[T](array []T) !int
|
||||
```
|
||||
|
||||
idx_min returns the index of the minimum value in the array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.idx_min([1, 2, 3, 0, 9])! // => 3
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## index_of_first
|
||||
```v
|
||||
fn index_of_first[T](array []T, predicate fn (idx int, elem T) bool) int
|
||||
```
|
||||
|
||||
index_of_first returns the index of the first element of `array`, for which the predicate fn returns true. If predicate does not return true for any of the elements, then index_of_first will return -1.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
assert arrays.index_of_first([4,5,0,7,0,9], fn(idx int, x int) bool { return x == 0 }) == 2
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## index_of_last
|
||||
```v
|
||||
fn index_of_last[T](array []T, predicate fn (idx int, elem T) bool) int
|
||||
```
|
||||
|
||||
index_of_last returns the index of the last element of `array`, for which the predicate fn returns true. If predicate does not return true for any of the elements, then index_of_last will return -1.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
assert arrays.index_of_last([4,5,0,7,0,9], fn(idx int, x int) bool { return x == 0 }) == 4
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## join_to_string
|
||||
```v
|
||||
fn join_to_string[T](array []T, separator string, transform fn (elem T) string) string
|
||||
```
|
||||
|
||||
join_to_string takes in a custom transform function and joins all elements into a string with the specified separator
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## lower_bound
|
||||
```v
|
||||
fn lower_bound[T](array []T, val T) !T
|
||||
```
|
||||
|
||||
returns the smallest element >= val, requires `array` to be sorted.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.lower_bound([2, 4, 6, 8], 3)! // => 4
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## map_indexed
|
||||
```v
|
||||
fn map_indexed[T, R](array []T, transform fn (idx int, elem T) R) []R
|
||||
```
|
||||
|
||||
map_indexed creates a new array with the result of calling the `transform` fn, invoked on each idx,elem pair from the original.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## map_of_counts
|
||||
```v
|
||||
fn map_of_counts[T](array []T) map[T]int
|
||||
```
|
||||
|
||||
map_of_counts returns a map, where each key is an unique value in `array`. Each value in that map for that key, is how many times that value occurs in `array`. It can be useful for building histograms of discrete measurements.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
assert arrays.map_of_counts([1,2,3,4,4,2,1,4,4]) == {1: 2, 2: 2, 3: 1, 4: 4}
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## map_of_indexes
|
||||
```v
|
||||
fn map_of_indexes[T](array []T) map[T][]int
|
||||
```
|
||||
|
||||
map_of_indexes returns a map, where each key is an unique value in `array`. Each value in that map for that key, is an array, containing the indexes in `array`, where that value has been found.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
assert arrays.map_of_indexes([1,2,3,4,4,2,1,4,4,999]) == {1: [0, 6], 2: [1, 5], 3: [2], 4: [3, 4, 7, 8], 999: [9]}
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## max
|
||||
```v
|
||||
fn max[T](array []T) !T
|
||||
```
|
||||
|
||||
max returns the maximum value in the array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.max([1, 2, 3, 0, 9])! // => 9
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## merge
|
||||
```v
|
||||
fn merge[T](a []T, b []T) []T
|
||||
```
|
||||
|
||||
merge two sorted arrays (ascending) and maintain sorted order.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.merge([1, 3, 5, 7], [2, 4, 6, 8]) // => [1, 2, 3, 4, 5, 6, 7, 8]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## min
|
||||
```v
|
||||
fn min[T](array []T) !T
|
||||
```
|
||||
|
||||
min returns the minimum value in the array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.min([1, 2, 3, 0, 9])! // => 0
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## partition
|
||||
```v
|
||||
fn partition[T](array []T, predicate fn (elem T) bool) ([]T, []T)
|
||||
```
|
||||
|
||||
partition splits the original array into pair of lists. The first list contains elements for which the predicate fn returned true, while the second list contains elements for which the predicate fn returned false.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## reduce
|
||||
```v
|
||||
fn reduce[T](array []T, reduce_op fn (acc T, elem T) T) !T
|
||||
```
|
||||
|
||||
reduce sets `acc = array[0]`, then successively calls `acc = reduce_op(acc, elem)` for each remaining element in `array`. returns the accumulated value in `acc`. returns an error if the array is empty. See also: [fold](#fold).
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.reduce([1, 2, 3, 4, 5], fn (t1 int, t2 int) int { return t1 * t2 })! // => 120
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## reduce_indexed
|
||||
```v
|
||||
fn reduce_indexed[T](array []T, reduce_op fn (idx int, acc T, elem T) T) !T
|
||||
```
|
||||
|
||||
reduce_indexed sets `acc = array[0]`, then successively calls `acc = reduce_op(idx, acc, elem)` for each remaining element in `array`. returns the accumulated value in `acc`. returns an error if the array is empty. See also: [fold_indexed](#fold_indexed).
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## reverse_iterator
|
||||
```v
|
||||
fn reverse_iterator[T](a []T) ReverseIterator[T]
|
||||
```
|
||||
|
||||
reverse_iterator can be used to iterate over the elements in an array. i.e. you can use this syntax: `for elem in arrays.reverse_iterator(a) {` .
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## rotate_left
|
||||
```v
|
||||
fn rotate_left[T](mut array []T, mid int)
|
||||
```
|
||||
|
||||
rotate_left rotates the array in-place. It does it in such a way, that the first `mid` elements of the array, move to the end, while the last `array.len - mid` elements move to the front. After calling `rotate_left`, the element previously at index `mid` will become the first element in the array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
mut x := [1,2,3,4,5,6]
|
||||
arrays.rotate_left(mut x, 2)
|
||||
println(x) // [3, 4, 5, 6, 1, 2]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## rotate_right
|
||||
```v
|
||||
fn rotate_right[T](mut array []T, k int)
|
||||
```
|
||||
|
||||
rotate_right rotates the array in-place. It does it in such a way, that the first `array.len - k` elements of the array, move to the end, while the last `k` elements move to the front. After calling `rotate_right`, the element previously at index `array.len - k` will become the first element in the array.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
mut x := [1,2,3,4,5,6]
|
||||
arrays.rotate_right(mut x, 2)
|
||||
println(x) // [5, 6, 1, 2, 3, 4]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## sum
|
||||
```v
|
||||
fn sum[T](array []T) !T
|
||||
```
|
||||
|
||||
sum up array, return an error, when the array has no elements.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.sum([1, 2, 3, 4, 5])! // => 15
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## uniq
|
||||
```v
|
||||
fn uniq[T](a []T) []T
|
||||
```
|
||||
|
||||
uniq filters the adjacent matching elements from the given array. All adjacent matching elements, are merged to their first occurrence, so the output will have no repeating elements.
|
||||
|
||||
Note: `uniq` does not detect repeats, unless they are adjacent. You may want to call a.sorted() on your array, before passing the result to arrays.uniq(). See also arrays.distinct, which is essentially arrays.uniq(a.sorted()) .
|
||||
|
||||
Examples
|
||||
```v
|
||||
|
||||
assert arrays.uniq( []int{} ) == []
|
||||
|
||||
assert arrays.uniq( [1, 1] ) == [1]
|
||||
|
||||
assert arrays.uniq( [2, 1] ) == [2, 1]
|
||||
|
||||
assert arrays.uniq( [5, 5, 1, 5, 2, 1, 1, 9] ) == [5, 1, 5, 2, 1, 9]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## uniq_all_repeated
|
||||
```v
|
||||
fn uniq_all_repeated[T](a []T) []T
|
||||
```
|
||||
|
||||
uniq_all_repeated produces all adjacent matching elements from the given array. Unique elements, with no duplicates are removed. The output will contain all the duplicated elements, repeated just like they were in the original.
|
||||
|
||||
Note: `uniq_all_repeated` does not detect repeats, unless they are adjacent. You may want to call a.sorted() on your array, before passing the result to arrays.uniq_all_repeated().
|
||||
|
||||
Examples
|
||||
```v
|
||||
|
||||
assert arrays.uniq_all_repeated( []int{} ) == []
|
||||
|
||||
assert arrays.uniq_all_repeated( [1, 5] ) == []
|
||||
|
||||
assert arrays.uniq_all_repeated( [5, 5] ) == [5,5]
|
||||
|
||||
assert arrays.uniq_all_repeated( [5, 5, 1, 5, 2, 1, 1, 9] ) == [5, 5, 1, 1]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## uniq_only
|
||||
```v
|
||||
fn uniq_only[T](a []T) []T
|
||||
```
|
||||
|
||||
uniq_only filters the adjacent matching elements from the given array. All adjacent matching elements, are removed. The output will contain only the elements that *did not have* any adjacent matches.
|
||||
|
||||
Note: `uniq_only` does not detect repeats, unless they are adjacent. You may want to call a.sorted() on your array, before passing the result to arrays.uniq_only().
|
||||
|
||||
Examples
|
||||
```v
|
||||
|
||||
assert arrays.uniq_only( []int{} ) == []
|
||||
|
||||
assert arrays.uniq_only( [1, 1] ) == []
|
||||
|
||||
assert arrays.uniq_only( [2, 1] ) == [2, 1]
|
||||
|
||||
assert arrays.uniq_only( [1, 5, 5, 1, 5, 2, 1, 1, 9] ) == [1, 1, 5, 2, 9]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## uniq_only_repeated
|
||||
```v
|
||||
fn uniq_only_repeated[T](a []T) []T
|
||||
```
|
||||
|
||||
uniq_only_repeated produces the adjacent matching elements from the given array. Unique elements, with no duplicates are removed. Adjacent matching elements, are reduced to just 1 element per repeat group.
|
||||
|
||||
Note: `uniq_only_repeated` does not detect repeats, unless they are adjacent. You may want to call a.sorted() on your array, before passing the result to arrays.uniq_only_repeated().
|
||||
|
||||
Examples
|
||||
```v
|
||||
|
||||
assert arrays.uniq_only_repeated( []int{} ) == []
|
||||
|
||||
assert arrays.uniq_only_repeated( [1, 5] ) == []
|
||||
|
||||
assert arrays.uniq_only_repeated( [5, 5] ) == [5]
|
||||
|
||||
assert arrays.uniq_only_repeated( [5, 5, 1, 5, 2, 1, 1, 9] ) == [5, 1]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## upper_bound
|
||||
```v
|
||||
fn upper_bound[T](array []T, val T) !T
|
||||
```
|
||||
|
||||
returns the largest element <= val, requires `array` to be sorted.
|
||||
|
||||
Example
|
||||
```v
|
||||
|
||||
arrays.upper_bound([2, 4, 6, 8], 3)! // => 2
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## window
|
||||
```v
|
||||
fn window[T](array []T, attr WindowAttribute) [][]T
|
||||
```
|
||||
|
||||
get snapshots of the window of the given size sliding along array with the given step, where each snapshot is an array.- `size` - snapshot size
|
||||
- `step` - gap size between each snapshot, default is 1.
|
||||
|
||||
|
||||
|
||||
Examples
|
||||
```v
|
||||
|
||||
arrays.window([1, 2, 3, 4], size: 2) // => [[1, 2], [2, 3], [3, 4]]
|
||||
|
||||
arrays.window([1, 2, 3, 4, 5, 6, 7, 8, 9, 10], size: 3, step: 2) // => [[1, 2, 3], [3, 4, 5], [5, 6, 7], [7, 8, 9]]
|
||||
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## ReverseIterator[T]
|
||||
## next
|
||||
```v
|
||||
fn (mut iter ReverseIterator[T]) next() ?&T
|
||||
```
|
||||
|
||||
next is the required method, to implement an iterator in V. It returns none when the iteration should stop. Otherwise it returns the current element of the array.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## free
|
||||
```v
|
||||
fn (iter &ReverseIterator[T]) free()
|
||||
```
|
||||
|
||||
free frees the iterator resources.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## ReverseIterator
|
||||
```v
|
||||
struct ReverseIterator[T] {
|
||||
mut:
|
||||
a []T
|
||||
i int
|
||||
}
|
||||
```
|
||||
|
||||
ReverseIterator provides a convenient way to iterate in reverse over all elements of an array without allocations. I.e. it allows you to use this syntax: `for elem in arrays.reverse_iterator(a) {` .
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## WindowAttribute
|
||||
```v
|
||||
struct WindowAttribute {
|
||||
pub:
|
||||
size int
|
||||
step int = 1
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
#### Powered by vdoc. Generated on: 2 Sep 2025 07:19:06
|
||||
76
aiprompts/v_core/array/diff.md
Normal file
76
aiprompts/v_core/array/diff.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# module diff
|
||||
|
||||
|
||||
## Contents
|
||||
- [diff](#diff)
|
||||
- [DiffContext[T]](#DiffContext[T])
|
||||
- [generate_patch](#generate_patch)
|
||||
- [DiffChange](#DiffChange)
|
||||
- [DiffContext](#DiffContext)
|
||||
- [DiffGenStrParam](#DiffGenStrParam)
|
||||
|
||||
## diff
|
||||
```v
|
||||
fn diff[T](a []T, b []T) &DiffContext[T]
|
||||
```
|
||||
|
||||
diff returns the difference of two arrays.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## DiffContext[T]
|
||||
## generate_patch
|
||||
```v
|
||||
fn (mut c DiffContext[T]) generate_patch(param DiffGenStrParam) string
|
||||
```
|
||||
|
||||
generate_patch generate a diff string of two arrays.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## DiffChange
|
||||
```v
|
||||
struct DiffChange {
|
||||
pub mut:
|
||||
a int // position in input a []T
|
||||
b int // position in input b []T
|
||||
del int // delete Del elements from input a
|
||||
ins int // insert Ins elements from input b
|
||||
}
|
||||
```
|
||||
|
||||
DiffChange contains one or more deletions or inserts at one position in two arrays.
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## DiffContext
|
||||
```v
|
||||
struct DiffContext[T] {
|
||||
mut:
|
||||
a []T
|
||||
b []T
|
||||
flags []DiffContextFlag
|
||||
max int
|
||||
// forward and reverse d-path endpoint x components
|
||||
forward []int
|
||||
reverse []int
|
||||
pub mut:
|
||||
changes []DiffChange
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
## DiffGenStrParam
|
||||
```v
|
||||
struct DiffGenStrParam {
|
||||
pub mut:
|
||||
colorful bool
|
||||
unified int = 3 // how many context lines before/after diff block
|
||||
block_header bool // output `@@ -3,4 +3,5 @@` or not
|
||||
}
|
||||
```
|
||||
|
||||
[[Return to contents]](#Contents)
|
||||
|
||||
#### Powered by vdoc. Generated on: 2 Sep 2025 07:19:06
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user