- Add support for environment variable validations

Author: DannyBen

lib/bashly/libraries/strings/strings.yml

@@ -42,3 +42,4 @@ disallowed_argument: "%{name} must be one of: %{allowed}"
 disallowed_environment_variable: "%{name} environment variable must be one of: %{allowed}"
 unsupported_bash_version: "bash version 4 or higher is required"
 validation_error: "validation error in %s:\\n%s"
+environment_variable_validation_error: "validation error in environment variable %s:\\n%s"

lib/bashly/script/environment_variable.rb

@@ -3,7 +3,9 @@ module Script
     class EnvironmentVariable < Base
       class << self
         def option_keys
-          @option_keys ||= %i[allowed default help name required private]
+          @option_keys ||= %i[
+            allowed default help name required private validate
+          ]
         end
       end
 

lib/bashly/script/introspection/environment_variables.rb

@@ -30,6 +30,11 @@ def required_environment_variables
         def whitelisted_environment_variables
           environment_variables.select(&:allowed)
         end
+
+        # Returns an array of all the environment_variables with a validation
+        def validated_environment_variables
+          environment_variables.select(&:validate)
+        end
       end
     end
   end

lib/bashly/views/command/environment_variables_filter.gtx

@@ -24,3 +24,9 @@ if whitelisted_environment_variables.any?
     > fi
   end
 end
+
+if validated_environment_variables.any?
+  validated_environment_variables.each do |env_var|
+    = env_var.render(:validations)
+  end
+end

lib/bashly/views/environment_variable/validations.gtx

@@ -0,0 +1,9 @@
+if validate
+  = view_marker
+
+  > if [[ -v {{ name.upcase }} && -n $(validate_{{ validate }} "${{ name.upcase }}") ]]; then
+  >   printf "{{ strings[:environment_variable_validation_error] }}\n" "{{ usage_string }}" "$(validate_{{ validate }} "${{ name.upcase }}")" >&2
+  >   exit 1
+  > fi
+  >
+end