change formatter values from symbols to strings

Author: DannyBen

lib/bashly/libraries/settings/settings.yml

@@ -52,12 +52,15 @@ strict: false
 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: shfmt -mn   # Use any other string, assuming the command accepts
-#                        # the script as stdin and outputs it to stdout
-formatter: :internal
+# formatter: internal     # Use Bashly's internal formatter (compacts newlines)
+# formatter: external     # Run the external command `shfmt --case-indent --indent 2`
+# formatter: none         # Disable formatting entirely
+# formatter: <string>     # Use a custom shell command to format the script.
+#                         # The command will receive the script via stdin and
+#                         # must output the result to stdout.
+#                         # Example: shfmt --minify
+formatter: internal
+
 
 #-------------------------------------------------------------------------------
 # INTERFACE OPTIONS

lib/bashly/script/formatter.rb

@@ -4,20 +4,18 @@
 module Bashly
   module Script
     class Formatter
-      MODES = %i[internal none shfmt]
-
       attr_reader :script, :mode
 
       def initialize(script, mode: nil)
         @script = script
-        @mode = mode || :internal
+        @mode = mode&.to_s || 'internal'
       end
 
       def formatted_script
         case mode
-        when :internal then script.gsub(/\s+\n/m, "\n\n")
-        when :shfmt then shfmt_result
-        when :none then script
+        when 'internal' then script.gsub(/\s+\n/m, "\n\n")
+        when 'external' then shfmt_result
+        when 'none' then script
         else custom_formatter_result mode
         end
       end
@@ -34,10 +32,10 @@ def custom_formatter_result(command)
         begin
           output, error, status = Open3.capture3(*command, stdin_data: script)
         rescue Errno::ENOENT
-          raise Error, "Command not found: `#{command.join(' ')}`"
+          raise Error, "Command not found: g`#{command.first}`"
         end
 
-        raise Error, "Failed running `#{command.join(' ')}`:\n\n#{error}" unless status.success?
+        raise Error, "Failed running g`#{Shellwords.join command}`:\n\n#{error}" unless status.success?
 
         output
       end

schemas/settings.json

@@ -220,9 +220,9 @@
         {
           "type": "string",
           "enum": [
-            ":internal",
-            ":none",
-            ":shfmt"
+            "internal",
+            "none",
+            "external"
           ]
         },
         {

spec/approvals/formatter/error-failure

@@ -1 +1 @@
-#<Bashly::Error:"Failed running `shfmt --diff`:\n\n">
+#<Bashly::Error:"Failed running g`shfmt --diff`:\n\n">

spec/approvals/formatter/error-not-found

@@ -1 +1 @@
-#<Bashly::Error: Command not found: `my_glorious_formatter`>
+#<Bashly::Error: Command not found: g`my_formatter`>

spec/bashly/script/formatter_spec.rb

@@ -10,16 +10,16 @@
       expect(subject.formatted_script).to match_approval 'formatter/internal'
     end
 
-    context 'with mode: :none' do
-      let(:mode) { :none }
+    context 'with mode: none' do
+      let(:mode) { 'none' }
 
       it 'returns the original script' do
         expect(subject.formatted_script).to eq script
       end
     end
 
-    context 'with mode: :shfmt' do
-      let(:mode) { :shfmt }
+    context 'with mode: external' do
+      let(:mode) { 'external' }
 
       it 'uses shfmt to format the script' do
         expect(subject.formatted_script).to match_approval 'formatter/shfmt'
@@ -35,7 +35,7 @@
     end
 
     context 'when the external command does not exist' do
-      let(:mode) { 'my_glorious_formatter' }
+      let(:mode) { 'my_formatter' }
 
       it 'raises a Bashly::Error' do
         expect { subject.formatted_script }.to raise_approval 'formatter/error-not-found'

support/schema/settings.yml

@@ -189,9 +189,9 @@ properties:
     anyOf:
       - type: string
         enum:
-          - :internal
-          - :none
-          - :shfmt
+          - internal
+          - none
+          - external
       - type: string
         minLength: 1
     default: :internal