Merge pull request #206 from DannyBen/add/markerless-generation

Allow generating script without file marker comments

Author: DannyBen

lib/bashly.rb

@@ -15,3 +15,15 @@
 requires 'bashly/commands/base'
 requires 'bashly/libraries/base'
 requires 'bashly'
+
+module Bashly
+  class << self
+    def env
+      ENV['BASHLY_ENV']&.to_sym
+    end
+
+    def production?
+      env == :production
+    end
+  end
+end

lib/bashly/commands/generate.rb

@@ -3,24 +3,34 @@ module Commands
     class Generate < Base
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force --quiet --upgrade --wrap FUNCTION]"
+      usage "bashly generate [options]"
       usage "bashly generate (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
       option "-q --quiet", "Disable on-screen progress report"
       option "-u --upgrade", "Upgrade all added library functions"
       option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
+      option "-e --env ENV", "Force the generation environment (see BASHLY_ENV)"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
       environment "BASHLY_LIB_DIR", "The path to use for upgrading library files, relative to the source dir [default: lib]"
       environment "BASHLY_STRICT", "When not empty, enable bash strict mode (set -euo pipefail)"
+      environment "BASHLY_ENV", <<~EOF
+        Set to 'production' or 'development':
+        - production    generate a smaller script, without file markers
+        - development   generate with file markers
+
+        Can be overridden with --env [default: development]
+      EOF
 
       example "bashly generate --force"
       example "bashly generate --wrap my_function"
 
       def run
         validate_config
+        ENV['BASHLY_ENV'] = args['--env'] if args['--env']
+        quiet_say "creating !txtgrn!production!txtrst! version" if Bashly.production?
         create_user_files
         upgrade_libs if args['--upgrade']
         create_master_script

lib/bashly/concerns/renderable.rb

@@ -4,13 +4,20 @@ module Bashly
   module Renderable
     def render(view)
       template = File.read view_path(view)
-      ERB.new(template, trim_mode: '%-').result(binding)
+      erb = ERB.new(template, trim_mode: '%-')
+      erb.filename = "#{views_subfolder}.#{view}"
+      erb.result binding
     end
 
     def strings
       @strings ||= MessageStrings.new
     end
 
+    def view_marker(id = nil)
+      id ||= ":#{caller_locations.first.path}"
+      "# #{id}" unless Bashly.production?
+    end
+
   private
 
     def view_path(view)

lib/bashly/script/command.rb

@@ -102,7 +102,7 @@ def load_user_file(file, placeholder: true)
           default_content
         end
 
-        "# :#{path}\n#{content}"
+        Bashly.production? ? content : "#{view_marker path}\n#{content}"
       end
 
       # Returns an array of all parents. For example, the command 

lib/bashly/views/argument/usage.erb

@@ -1,4 +1,4 @@
-# :argument.usage
+<%= view_marker %>
 echo "  <%= label %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
 % if allowed

lib/bashly/views/argument/validations.erb

@@ -1,4 +1,4 @@
-# :argument.validations
+<%= view_marker %>
 % if validate
 if [[ -n $(validate_<%= validate %> "$1") ]]; then
   printf "<%= strings[:validation_error] %>\n" "<%= name.upcase %>" "$(validate_<%= validate %> "$1")"

lib/bashly/views/command/catch_all_filter.erb

@@ -1,4 +1,4 @@
-# :command.catch_all_filter
+<%= view_marker %>
 % if catch_all.required?
 if [[ ${#other_args[@]} -eq 0 ]]; then
   printf "<%= strings[:missing_required_argument] % { arg: catch_all.label, usage: usage_string } %>\n"

lib/bashly/views/command/command_fallback.erb

@@ -1,4 +1,4 @@
-# :command.command_fallback
+<%= view_marker %>
 % if default_command
 "" )
   <%= function_name %>_usage

lib/bashly/views/command/command_filter.erb

@@ -1,4 +1,4 @@
-# :command.command_filter
+<%= view_marker %>
 % if commands.any?
 action=${1:-}
 

lib/bashly/views/command/command_functions.erb

@@ -1,4 +1,4 @@
-# :command.command_functions
+<%= view_marker %>
 % deep_commands.each do |command|
 <%= command.render :function unless command.commands.any? %>
 % end