From eaec539c229343d76a23ba9422b592a8160045f7 Mon Sep 17 00:00:00 2001
From: Aaron Fiore <founder@evergreencrypto.co>
Date: Wed, 7 Aug 2024 23:01:10 -0700
Subject: [PATCH] client: lib_gen: generate plugins

- Sets a location for plugins
  * Allows for end-user custom plugins
- Provides default example plugin
---
 client/src/docker/lib/internal/lib_gen.bash | 86 ++++++++++++++++++++-
 1 file changed, 82 insertions(+), 4 deletions(-)

diff --git a/client/src/docker/lib/internal/lib_gen.bash b/client/src/docker/lib/internal/lib_gen.bash
index fb1892d..cbb07c5 100644
--- a/client/src/docker/lib/internal/lib_gen.bash
+++ b/client/src/docker/lib/internal/lib_gen.bash
@@ -436,15 +436,93 @@ function lib_gen::__gen_container()
     mkdir -p "$DOCKER_FINANCE_CLIENT_FLOW" || lib_utils::die_fatal
   fi
 
-  #
-  # Generate profile/subprofile
-  #
-
+  lib_gen::__gen_plugins
   lib_gen::__gen_profile
 }
 
+#
+# Generate flow: plugins
+#
+#  - Provides a place to drop-in any custom plugin
+#  - Provides a default example plugin
+#
+
+function lib_gen::__gen_plugins()
+{
+  lib_utils::print_debug "Generating plugins"
+
+  local -r _plugins="${DOCKER_FINANCE_CLIENT_FLOW}/plugins"
+  if [ ! -d "$_plugins" ]; then
+    mkdir -p "$_plugins" || lib_utils::die_fatal
+  fi
+
+  local -r _example="${_plugins}/example.bash"
+
+  if [ -f "$_example" ]; then
+    lib_utils::print_debug "Example plugin found, overwriting: '${_example}'"
+  fi
+
+  echo "#!/usr/bin/env bash
+
+# docker-finance | modern accounting for the power-user
+#
+# Copyright (C) 2024 Aaron Fiore (Founder, Evergreen Crypto LLC)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+#
+# Plugins
+#
+# The plugins path (this directory) is where you can place any executable.
+#
+# Any plugin found in this directory will be made available via the \`plugins\` command.
+# As such, your plugin will have access to all global variables provided by finance.bash
+#
+# The following is an example of how to create your own plugin:
+#
+
+echo -e \"
+This container's environment:
+
+\$(printenv | grep ^DOCKER_FINANCE)
+
+This plugin's caller profile:
+
+    \${global_parent_profile}\${global_arg_delim_1}\${global_child_profile}
+
+This plugin's path is:
+
+    \$0
+
+This plugin's arguments:
+
+    '\${@}'
+\"
+
+# vim: sw=2 sts=2 si ai et" >"$_example"
+
+  chmod +x "$_example" || lib_utils::die_fatal
+}
+
+#
+# Generate flow: profile/subprofile
+#
+
 function lib_gen::__gen_profile()
 {
+  lib_utils::print_debug "Generating profiles"
+
   local -r _profiles="${DOCKER_FINANCE_CLIENT_FLOW}/profiles"
   if [ ! -d "$_profiles" ]; then
     mkdir -p "$_profiles" || lib_utils::die_fatal