- Add support for generating tab-indented scripts using BASHLY_TAB_INDENT

Author: DannyBen

examples/heredoc/README.md

@@ -1,24 +1,24 @@
 # Heredoc Example
 
-This example shows how (and where) you can use *Here document* (heredoc)
-constructs.
+This example shows how you can use *Here document* (heredoc) constructs.
 
-Since bashly applies indentation to most of your code, it is not possible to 
-use heredoc everywhere. Code in the `src/lib` directory is injected to your
-script as is, so in cases where you must use heredocs, this is where you can.
+By default, bashly indents all code using spaces. In order for heredoc to
+properly work in bash, all leading spaces within the heredoc document must use
+the tab character.
+
+Setting the environment variable `BASHLY_TAB_INDENT` to any value will make
+bashly replace the space indentation in the result, with tabs.
 
 This example was generated with:
 
 ```bash
 $ bashly init
-$ bashly add lib
 # ... now edit src/bashly.yml to match the example ...
 # ... now edit src/root_command.sh to match the example ...
-# ... now edit src/lib/heredocs.sh to match the example ...
-$ bashly generate
+$ BASHLY_TAB_INDENT=1 bashly generate
 ```
 
-<!-- include: src/root_command.sh src/lib/heredocs.sh -->
+<!-- include: src/root_command.sh -->
 
 -----
 
@@ -33,20 +33,19 @@ version: 0.1.0
 ## `src/root_command.sh`
 
 ```bash
-text="$(message1)"
-echo "$text"
-```
-
-## `src/lib/heredocs.sh`
+cat <<-EOF
+multiline
+heredoc text
+EOF
 
-```bash
-message1() {
-  cat << EOF
-this is a
-  multiline
-    heredoc text
+# In case an inner indentation is needed, use a whitespace that is not a space
+# and not a tab character. For example, Unicode U+3000 [　]
+cat <<-EOF
+this is
+　an indented
+　　multiline text
 EOF
-}
+
 
 ```
 
@@ -56,9 +55,11 @@ EOF
 ### `$ ./cli`
 
 ```shell
-this is a
-  multiline
-    heredoc text
+multiline
+heredoc text
+this is
+　an indented
+　　multiline text
 
 
 ```

examples/heredoc/src/lib/heredocs.sh

@@ -1,2 +1,13 @@
-text="$(message1)"
-echo "$text"
+cat <<-EOF
+multiline
+heredoc text
+EOF
+
+# In case an inner indentation is needed, use a whitespace that is not a space
+# and not a tab character. For example, Unicode U+3000 [　]
+cat <<-EOF
+this is
+　an indented
+　　multiline text
+EOF
+

examples/heredoc/src/root_command.sh

@@ -2,7 +2,7 @@
 
 set -x
 
-bashly generate
+BASHLY_TAB_INDENT=1 bashly generate
 
 ### Try Me ###
 

examples/heredoc/test.sh

@@ -16,6 +16,7 @@ class Generate < Base
       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_TAB_INDENT", "When not empty, the generated script will use tab indentation instead of spaces (every 2 leading spaces will be converted to a tab character)"
       environment "BASHLY_ENV", <<~EOF
         Set to 'production' or 'development':
         - production    generate a smaller script, without file markers
@@ -114,7 +115,7 @@ def create_file(file, content)
       end
 
       def create_master_script
-        File.write master_script_path, script.code
+        File.write master_script_path, script.code(tab_indent: Settings.tab_indent)
         FileUtils.chmod "+x", master_script_path
         quiet_say "!txtgrn!created!txtrst! #{master_script_path}"
       end

lib/bashly/commands/generate.rb

@@ -31,4 +31,10 @@ def remove_front_matter
     split(/^---\s*/).last
   end
 
+  def expand_tabs(tabstop = 2)
+    gsub(/^( {#{tabstop}}+)/) do
+      "\t" * ($1.size / tabstop)
+    end
+  end
+
 end

lib/bashly/extensions/string.rb

@@ -9,18 +9,22 @@ def initialize(command, function_name = nil)
         @command, @function_name = command, function_name
       end
 
-      def code
-        if function_name
-          result = [header, render('wrapper')].join "\n"
+      def code(tab_indent: false)
+        tab_indent ? base_code.expand_tabs : base_code
+      end
+
+    private
+
+      def base_code
+        result = if function_name
+          [header, render('wrapper')]
         else
-          result = [header, body].join "\n"
+          [header, body]
         end
 
-        result.lint
+        result.join("\n").lint
       end
 
-    private
-
       def header
         @header ||= header!
       end

lib/bashly/script/wrapper.rb

@@ -1,7 +1,7 @@
 module Bashly
   class Settings
     class << self
-      attr_writer :source_dir, :target_dir, :lib_dir, :strict
+      attr_writer :source_dir, :target_dir, :lib_dir, :strict, :tab_indent
 
       def source_dir
         @source_dir ||= ENV['BASHLY_SOURCE_DIR'] || 'src'
@@ -22,6 +22,10 @@ def strict
       def full_lib_dir
         "#{source_dir}/#{lib_dir}"
       end
+
+      def tab_indent
+        @tab_indent ||= ENV['BASHLY_TAB_INDENT']
+      end
     end
   end
 end

lib/bashly/settings.rb

@@ -37,6 +37,10 @@ Environment Variables:
   BASHLY_STRICT
     When not empty, enable bash strict mode (set -euo pipefail)
 
+  BASHLY_TAB_INDENT
+    When not empty, the generated script will use tab indentation instead of
+    spaces (every 2 leading spaces will be converted to a tab character)
+
   BASHLY_ENV
     Set to 'production' or 'development':
     - production    generate a smaller script, without file markers

spec/approvals/cli/generate/help

@@ -1,10 +1,13 @@
++ BASHLY_TAB_INDENT=1
 + bashly generate
 creating user files in src
 skipped src/initialize.sh (exists)
 skipped src/root_command.sh (exists)
 created ./cli
 run ./cli --help to test your bash script
 + ./cli
-this is a
-  multiline
-    heredoc text
+multiline
+heredoc text
+this is
+　an indented
+　　multiline text