- Add BASHLY_ENV and bashly generate --env

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

@@ -15,7 +15,7 @@ def strings
 
     def view_marker(id = nil)
       id ||= ":#{caller_locations.first.path}"
-      "# #{id}" unless ENV['BASHLY_PRODUCTION']
+      "# #{id}" unless Bashly.production?
     end
 
   private

lib/bashly/script/command.rb

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

spec/approvals/cli/generate/help

@@ -1,7 +1,7 @@
 Generate the bash script and required files
 
 Usage:
-  bashly generate [--force --quiet --upgrade --wrap FUNCTION]
+  bashly generate [options]
   bashly generate (-h|--help)
 
 Options:
@@ -17,6 +17,9 @@ Options:
   -w --wrap FUNCTION
     Wrap the entire script in a function so it can also be sourced
 
+  -e --env ENV
+    Force the generation environment (see BASHLY_ENV)
+
   -h --help
     Show this help
 
@@ -34,6 +37,13 @@ Environment Variables:
   BASHLY_STRICT
     When not empty, enable bash strict mode (set -euo pipefail)
 
+  BASHLY_ENV
+    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]
+
 Examples:
   bashly generate --force
   bashly generate --wrap my_function

spec/approvals/cli/generate/production

@@ -0,0 +1,7 @@
+creating production version
+creating user files in spec/tmp/src
+created spec/tmp/src/initialize.sh
+created spec/tmp/src/download_command.sh
+created spec/tmp/src/upload_command.sh
+created spec/tmp/cli
+run spec/tmp/cli --help to test your bash script

spec/approvals/cli/generate/production-env-var

@@ -0,0 +1,7 @@
+creating production version
+creating user files in spec/tmp/src
+created spec/tmp/src/initialize.sh
+created spec/tmp/src/download_command.sh
+created spec/tmp/src/upload_command.sh
+created spec/tmp/cli
+run spec/tmp/cli --help to test your bash script

spec/bashly/commands/generate_spec.rb

@@ -3,6 +3,7 @@
 describe Commands::Generate do
   let(:source_dir) { Settings.source_dir }
   let(:target_dir) { Settings.target_dir }
+  let(:cli_script_content) { File.read cli_script }
   subject { CLI.runner }
 
   context "with --help" do
@@ -25,6 +26,17 @@
       expect(File).to exist(cli_script)
     end
 
+    context "when BASHLY_ENV=production" do
+      before { ENV['BASHLY_ENV'] = 'production' }
+      after  { ENV['BASHLY_ENV'] = nil }
+
+      it "generates a script without view markers" do
+        expect { subject.run %w[generate] }.to output_approval('cli/generate/production-env-var')
+        expect(File).to exist(cli_script)
+        expect(cli_script_content).to_not include '# :'
+      end
+    end
+
     context "when source files already exist" do
       before do
         expect { subject.run %w[generate] }.to output_approval('cli/generate/no-args')
@@ -83,6 +95,25 @@
     end
   end
 
+  context "with --env production" do
+    let(:cli_script) { "#{target_dir}/cli" }
+    let(:cli_script_content) { File.read cli_script }
+
+    before do
+      reset_tmp_dir
+      success = system "mkdir -p #{source_dir} && cp lib/bashly/templates/bashly.yml #{source_dir}/bashly.yml"
+      expect(success).to be true
+    end
+
+    after  { ENV['BASHLY_ENV'] = nil }
+
+    it "generates a script without view markers" do
+      expect { subject.run %w[generate --env production] }.to output_approval('cli/generate/production')
+      expect(File).to exist(cli_script)
+      expect(cli_script_content).to_not include '# :'
+    end
+  end
+
   context "with --upgrade" do
     let(:lib_files) { Dir["spec/tmp/src/lib/**/*.sh"].sort }
     let(:outdated_text) { "OUTDATED TEXT" }

spec/spec_helper.rb

@@ -22,6 +22,9 @@
 ENV['COLUMNS'] = '80'
 ENV['LINES'] = '30'
 
+# Unset any user env settings
+ENV['BASHLY_ENV'] = nil
+
 RSpec.configure do |c|
   c.include SpecMixin
   c.strip_ansi_escape = true