Skip to content
This repository was archived by the owner on May 13, 2022. It is now read-only.

Commit a6806f8

Browse files
committed
comments: clean up and TODO organisation
Signed-off-by: Pascal Andy <pascalandy@users.noreply.github.com>
1 parent 4bcc9bd commit a6806f8

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

bashlava.sh

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
#!/usr/bin/env bash
22

3-
# TODO normalize FATAL error messages
4-
# TODO this should not happen '"${input_2}" == "not_set"'. Just use 'App_Is_input_2_Provided'
3+
# TODO list
4+
# normalize FATAL error messages
5+
# manage core vars
6+
# manage private vars
57

68
function mainbranch {
79
App_input_2_Is_Empty_As_It_Should # fct without attributs
@@ -10,23 +12,26 @@ function mainbranch {
1012
App_Is_edge
1113
App_Show_Version
1214

13-
# Update our local state
15+
### Update our local state
1416
git checkout ${default_branch}
1517
git pull origin ${default_branch}
1618
log
1719
}
1820

19-
# TODO have this branch created with a unique ID to avoid conflicts with other developers
2021
function edge {
21-
# it assumes there will be no conflict with anybody else
22-
# as I'm the only person using 'edge'.
22+
# TODO
23+
# have this branch created with a unique ID to avoid conflicts with other developers edge_sunny
24+
25+
### it assumes there will be no conflict with anybody else
26+
### as I'm the only person using 'edge'.
2327
App_input_2_Is_Empty_As_It_Should # fct without attributs
2428
App_No_Commits_Pending
2529
App_Check_Required_Apps
2630

27-
# delete branch
31+
### delete branch
2832
git branch -D edge || true
29-
# delete branch so there is no need to use the github GUI to delete it
33+
34+
### delete branch so there is no need to use the github GUI to delete it
3035
git push origin --delete edge || true
3136

3237
git checkout -b edge
@@ -302,7 +307,9 @@ function App_No_Commits_Pending {
302307
App_Are_Var_Equal
303308
}
304309

305-
# TODO refactor this function
310+
# TODO 1
311+
# refactor this function
312+
# compare var to var
306313
function App_Is_input_2_Provided {
307314
### ensure the second attribute is not empty to continue
308315
if [[ "${input_2}" == "not_set" ]]; then
@@ -314,7 +321,7 @@ function App_Is_input_2_Provided {
314321
fi
315322
}
316323

317-
# TODO refactor this function
324+
# TODO 2
318325
function App_Is_input_3_Provided {
319326
### ensure the third attribute is not empty to continue
320327
if [[ "${input_3}" == "not_set" ]]; then
@@ -326,7 +333,7 @@ function App_Is_input_3_Provided {
326333
fi
327334
}
328335

329-
# TODO new fct not equal
336+
# TODO 3
330337
function App_input_2_Is_Empty_As_It_Should {
331338
### Stop if 2 attributes are passed.
332339
if [[ "${input_2}" != "not_set" ]]; then
@@ -389,7 +396,6 @@ function App_Check_Are_Files_Exist {
389396
file_path_is="./docs/${action}.md" && App_Does_File_Exist
390397
done
391398

392-
## TODO init are broken
393399
file_is="LICENSE" file_path_is="${_bashlava_path}/${file_is}" && App_Does_File_Exist_NoStop
394400
if [[ "${_file_do_not_exist}" == "true" ]]; then
395401
my_message="Dockerfile does not exit, let's generate one" && App_Warning && sleep 2 && App_init_license && exit 1
@@ -519,9 +525,6 @@ file_is="_entrypoint.sh"
519525
_var_name="_url_to_check" _is_it_empty=$(echo ${_url_to_check}) && App_Does_Var_Empty
520526
}
521527

522-
# TODO App_Are_Var_Equal
523-
# TODO logic '"${input_2}" == "not_set"' prevent to call it from test
524-
525528
function App_Show_Version {
526529
### Show version from three sources
527530
App_input_2_Is_Empty_As_It_Should

0 commit comments

Comments
 (0)