- Add ability to choose a different formatter (internal, none, shfmt)

Author: DannyBen

lib/bashly.rb

@@ -22,7 +22,7 @@ module Bashly
   module Script
     autoloads 'bashly/script', %i[
       Argument Base CatchAll Command Dependency EnvironmentVariable Flag
-      Variable Wrapper
+      Formatter Variable Wrapper
     ]
 
     module Introspection

lib/bashly/exceptions.rb

@@ -3,4 +3,5 @@ class Interrupt < Interrupt; end
   class Error < StandardError; end
   class InitError < Error; end
   class ConfigurationError < Error; end
+  class DependencyError < Error; end
 end

lib/bashly/extensions/string.rb

@@ -44,8 +44,8 @@ def wrap(length = 80)
     end * "\n"
   end
 
-  def lint
-    gsub(/\s+\n/m, "\n\n").lines.grep_v(/^\s*##/).join
+  def remove_private_comments
+    lines.grep_v(/^\s*##/).join
   end
 
   def remove_front_matter

lib/bashly/libraries/settings/settings.yml

@@ -41,16 +41,22 @@ partials_extension: sh
 #-------------------------------------------------------------------------------
 
 # Configure the bash options that will be added to the initialize function:
-# strict: true       Bash strict mode (set -euo pipefail)
-# strict: false      Only exit on errors (set -e)
-# strict: ''         Do not add any 'set' directive
-# strict: <string>   Add any other custom 'set' directive
+# strict: true       # Bash strict mode (set -euo pipefail)
+# strict: false      # Only exit on errors (set -e)
+# strict: ''         # Do not add any 'set' directive
+# strict: <string>   # Add any other custom 'set' directive
 strict: false
 
 # When true, the generated script will use tab indentation instead of spaces
 # (every 2 leading spaces will be converted to a tab character)
 tab_indent: false
 
+# Choose a post-processor for the generated script:
+# formatter: internal   # Use Bashly's internal formatter (compacts newlines)
+# formatter: none       # Disable all post-processing
+# formatter: shfmt      # Use shfmt if installed
+formatter: internal
+
 
 #-------------------------------------------------------------------------------
 # INTERFACE OPTIONS
@@ -100,10 +106,10 @@ env: development
 
 # Tweak the script output by enabling or disabling some script output.
 # These options accept one of the following strings:
-# - production      render this feature only when env == production
-# - development     render this feature only when env == development
-# - always          render this feature in any environment
-# - never           do not render this feature
+# - production      # render this feature only when env == production
+# - development     # render this feature only when env == development
+# - always          # render this feature in any environment
+# - never           # do not render this feature
 enable_header_comment: always
 enable_bash3_bouncer: always
 enable_view_markers: development

lib/bashly/script/formatter.rb

@@ -0,0 +1,40 @@
+require 'open3'
+
+module Bashly
+  module Script
+    class Formatter
+      MODES = %i[internal none shfmt]
+
+      attr_reader :script, :mode
+
+      def initialize(script, mode: nil)
+        @script = script
+        @mode = MODES.include?(mode&.to_sym) ? mode.to_sym : MODES.first
+      end
+
+      def formatted_script
+        case mode
+        when :internal then script.gsub(/\s+\n/m, "\n\n")
+        when :shfmt then shfmt_result
+        else script
+        end
+      end
+
+    private
+
+      def shfmt_result
+        unless system 'command -v shfmt > /dev/null 2>&1'
+          raise DependencyError,
+            'Cannot find g`shfmt`.\nEither install it or change to the g`internal` formatter.'
+        end
+
+        output, error, status =
+          Open3.capture3 %w[shfmt --case-indent --indent 2], stdin_data: script
+
+        raise DependencyError, "Failed running g`shfmt`:\n\n#{error}" unless status.success?
+
+        output
+      end
+    end
+  end
+end

lib/bashly/script/wrapper.rb

@@ -23,7 +23,13 @@ def base_code
           [header, body]
         end
 
-        result.join("\n").lint
+        clean_code result.join("\n")
+      end
+
+      def clean_code(script)
+        script.remove_private_comments
+        formatter = Formatter.new script, mode: Settings.formatter
+        formatter.formatted_script
       end
 
       def header

lib/bashly/settings.rb

@@ -15,6 +15,7 @@ class << self
         :enable_inspect_args,
         :enable_sourcing,
         :enable_view_markers,
+        :formatter,
         :function_names,
         :lib_dir,
         :partials_extension,
@@ -86,6 +87,10 @@ def env=(value)
         @env = value&.to_sym
       end
 
+      def formatter
+        @formatter ||= get :formatter
+      end
+
       def full_lib_dir
         "#{source_dir}/#{lib_dir}"
       end

schemas/settings.json

@@ -213,6 +213,17 @@
       ],
       "default": "development"
     },
+    "formatter": {
+      "title": "formatter",
+      "description": "Choose how to post-process the generated script\nhttps://bashly.dev/usage/settings/#formatter",
+      "type": "string",
+      "enum": [
+        "internal",
+        "none",
+        "shfmt"
+      ],
+      "default": "internal"
+    },
     "partials_extension": {
       "title": "partials extension",
       "description": "The extension to use when reading/writing partial script snippets\nhttps://bashly.dev/usage/settings/#partials_extension",

support/schema/settings.yml

@@ -181,6 +181,17 @@ properties:
     type: string
     enum: *feature_toggles
     default: development
+  formatter:
+    title: formatter
+    description: |-
+      Choose how to post-process the generated script
+      https://bashly.dev/usage/settings/#formatter
+    type: string
+    enum:
+      - internal
+      - none
+      - shfmt
+    default: internal
   partials_extension:
     title: partials extension
     description: |-