Merge pull request #299 from DannyBen/refactor/example-artifacts

DannyBen · web-flow · commit 72cdcfac6cba · 2022-11-30T17:14:54.000+02:00
Normalize examples to include `src/*.sh` artifacts
diff --git a/examples/command-aliases/.gitignore b/examples/command-aliases/.gitignore
@@ -1,2 +1 @@
-src/*.sh
 cli
diff --git a/examples/command-aliases/src/download_command.sh b/examples/command-aliases/src/download_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/download_command.sh'"
+echo "# code for 'cli download' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/command-aliases/src/initialize.sh b/examples/command-aliases/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/command-aliases/src/upload_command.sh b/examples/command-aliases/src/upload_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/upload_command.sh'"
+echo "# code for 'cli upload' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/command-filenames/.gitignore b/examples/command-filenames/.gitignore
@@ -1,4 +1 @@
-src/*.sh
-src/dir_commands
-src/file_commands
 cli
diff --git a/examples/command-function/.gitignore b/examples/command-function/.gitignore
@@ -1,2 +1 @@
-src/*.sh
 cli
diff --git a/examples/command-function/src/container_start_command.sh b/examples/command-function/src/container_start_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/container_start_command.sh'"
+echo "# code for 'cli container-start' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/command-function/src/initialize.sh b/examples/command-function/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/command-function/test.sh b/examples/command-function/test.sh
@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 # Cleanup before testing
-rm -f "src/*.sh"
+rm -f src/*.sh
 
 set -x
 
diff --git a/examples/command-private/.gitignore b/examples/command-private/.gitignore
@@ -1,6 +1 @@
-src/connect_ftp_command.sh
-src/connect_ssh_command.sh
-src/download_command.sh
-src/initialize.sh
-src/upload_command.sh
 cli
diff --git a/examples/command-private/src/connect_ftp_command.sh b/examples/command-private/src/connect_ftp_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/connect_ftp_command.sh'"
+echo "# code for 'cli connect-ftp' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/command-private/src/connect_ssh_command.sh b/examples/command-private/src/connect_ssh_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/connect_ssh_command.sh'"
+echo "# code for 'cli connect-ssh' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/command-private/src/initialize.sh b/examples/command-private/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/command-private/test.sh b/examples/command-private/test.sh
@@ -1,11 +1,11 @@
 #!/usr/bin/env bash
 
 # Cleanup before testing
-rm -f "src/connect_ftp_command.sh"
-rm -f "src/connect_ssh_command.sh"
-rm -f "src/download_command.sh"
-rm -f "src/initialize.sh"
-rm -f "src/upload_command.sh"
+rm -f src/connect_ftp_command.sh
+rm -f src/connect_ssh_command.sh
+rm -f src/download_command.sh
+rm -f src/initialize.sh
+rm -f src/upload_command.sh
 
 set -x
 
diff --git a/examples/commands-expose/.gitignore b/examples/commands-expose/.gitignore
@@ -1,2 +1 @@
 cli
-src/*.sh
diff --git a/examples/commands-expose/src/config_edit_command.sh b/examples/commands-expose/src/config_edit_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/config_edit_command.sh'"
+echo "# code for 'cli config edit' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/commands-expose/src/config_show_command.sh b/examples/commands-expose/src/config_show_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/config_show_command.sh'"
+echo "# code for 'cli config show' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/commands-expose/src/container_down_command.sh b/examples/commands-expose/src/container_down_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/container_down_command.sh'"
+echo "# code for 'cli container down' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/commands-expose/src/container_exec_command.sh b/examples/commands-expose/src/container_exec_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/container_exec_command.sh'"
+echo "# code for 'cli container exec' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/commands-expose/src/init_command.sh b/examples/commands-expose/src/init_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/init_command.sh'"
+echo "# code for 'cli init' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/commands-expose/src/initialize.sh b/examples/commands-expose/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/commands-expose/src/server_start_command.sh b/examples/commands-expose/src/server_start_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/server_start_command.sh'"
+echo "# code for 'cli server start' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/commands-expose/src/server_stop_command.sh b/examples/commands-expose/src/server_stop_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/server_stop_command.sh'"
+echo "# code for 'cli server stop' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/dependencies/.gitignore b/examples/dependencies/.gitignore
@@ -1,3 +1 @@
 cli
-src/*.sh
-src/lib
diff --git a/examples/reusable-flags/.gitignore b/examples/reusable-flags/.gitignore
@@ -1,2 +1 @@
 cli
-src/*.sh
diff --git a/examples/reusable-flags/src/download_command.sh b/examples/reusable-flags/src/download_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/download_command.sh'"
+echo "# code for 'cli download' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/reusable-flags/src/initialize.sh b/examples/reusable-flags/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/reusable-flags/src/upload_command.sh b/examples/reusable-flags/src/upload_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/upload_command.sh'"
+echo "# code for 'cli upload' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/settings/.gitignore b/examples/settings/.gitignore
@@ -1,2 +1 @@
-/src/*.sh
-/out/cli
+out/cli
diff --git a/examples/settings/src/download_command.sh b/examples/settings/src/download_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/download_command.sh'"
+echo "# code for 'cli download' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/settings/src/initialize.sh b/examples/settings/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/settings/src/upload_command.sh b/examples/settings/src/upload_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/upload_command.sh'"
+echo "# code for 'cli upload' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/split-config/.gitignore b/examples/split-config/.gitignore
@@ -1,3 +1 @@
-src/download_command.sh
-src/initialize.sh
-cli
+cli
diff --git a/examples/split-config/src/download_command.sh b/examples/split-config/src/download_command.sh
@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/download_command.sh'"
+echo "# code for 'cli download' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args
diff --git a/examples/split-config/src/initialize.sh b/examples/split-config/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/examples/stdin/.gitignore b/examples/stdin/.gitignore
@@ -1,2 +1 @@
-src/initialize.sh
-cli
+cli
diff --git a/examples/stdin/src/initialize.sh b/examples/stdin/src/initialize.sh
@@ -0,0 +1,6 @@
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.
diff --git a/spec/approvals/examples/command-function b/spec/approvals/examples/command-function
@@ -1,7 +1,7 @@
 + bashly generate
 creating user files in src
-skipped src/initialize.sh (exists)
-skipped src/container_start_command.sh (exists)
+created src/initialize.sh
+created src/container_start_command.sh
 skipped src/container_start_command.sh (exists)
 created ./cli
 run ./cli --help to test your bash script
