howzit 2.1.34 → 2.1.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae81c9417b55c96c640ddd014616581b1f9c0f0f0a97e11344b9b36bf32a00ea
-  data.tar.gz: 52ac587c3b0315a50a8798c6c9714daa931d01d0383273c3fd5d061d20d5fac6
+  metadata.gz: 33c0053826d6797da462f0fdfa4cb505f91fd16fbff68b1feebf4e30b2e20a67
+  data.tar.gz: e9251bd45bc5ef8dc59a25ce2be80850eba66a3c9fbe9c1786b2f5637d2946e6
 SHA512:
-  metadata.gz: d840417614ccdb60428112cd5b65c9310617844134090a5f98dbf40942a91cd8d3eaeb87fff5a96164ab1065e4eb5babef824b4cf237ac58bfa5fc5aa1139ae8
-  data.tar.gz: 021be86757f28f7aa8cdc37dbe7ff3279e8eedcc7e8ac23934e99a56e9221fb1c207af826eed76ed92e234325db54d5b9d74c2c46f75be13b3aa2ab4ab9d1052
+  metadata.gz: 1c6e5cf35607d239357b4848b24893ae2091b04a4d264ed472c8ef0553c4c676c2e6417fb6af8d76e1333af2e5f9f050afd0fa8ec791a0a2ffe023297db63e59
+  data.tar.gz: d5af3431513b66d9f64b253ab1096470c67075780e893aae909b1991027358ea23ad7c759fc4e5dd0c23b95a4e8587879feb0b0964bb044b37fcfc3ce7354c8b

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 2.1.35
+
+2026-01-14 04:36
+
+#### CHANGED
+
+- Variables are no longer rendered when displaying topics, showing the raw ${variable} syntax so users can see where variable substitution will occur
+
+#### NEW
+
+- Topic headers now display accepted variables with their defaults, e.g., "Deploy (increment:1, target:prod)"
+- Variable placeholders (${VAR} and ${VAR:default}) are syntax highlighted in topic display with blue delimiters, bright white variable names, and yellow default values
+
 ### 2.1.34
 
 2026-01-09 10:22

data/lib/howzit/buildnote.rb

@@ -1242,14 +1242,14 @@ module Howzit
       if Howzit.options[:run]
         Howzit.options[:paginate] = false
         summary = Howzit::RunReport.format
-        unless summary.empty?
+        if summary.empty?
+          Util.show(output.join("\n").strip, Howzit.options)
+        else
           # Display main output first
           Util.show(output.join("\n").strip, Howzit.options)
           # Display report separately without highlighting to prevent markdown highlighter
           # from reformatting it based on item count
           Util.show(summary, { color: Howzit.options[:color], highlight: false, paginate: false, wrap: 0 })
-        else
-          Util.show(output.join("\n").strip, Howzit.options)
         end
       else
         Util.show(output.join("\n").strip, Howzit.options)

data/lib/howzit/topic.rb

@@ -7,7 +7,7 @@ module Howzit
 
     attr_accessor :content
 
-    attr_reader :title, :tasks, :prereqs, :postreqs, :results, :named_args, :directives
+    attr_reader :title, :tasks, :prereqs, :postreqs, :results, :named_args, :directives, :arg_definitions
 
     ##
     ## Initialize a topic object
@@ -32,6 +32,7 @@ module Howzit
 
     # Get named arguments from title
     def arguments
+      @arg_definitions = []
       return unless @title =~ /\(.*?\) *$/
 
       a = @title.match(/\((?<args>.*?)\) *$/)
@@ -39,6 +40,8 @@ module Howzit
 
       args.each_with_index do |arg, idx|
         arg_name, default = arg.split(/:/).map(&:strip)
+        # Store original definition for display purposes
+        @arg_definitions << (default ? "#{arg_name}:#{default}" : arg_name)
 
         @named_args[arg_name] = if Howzit.arguments && Howzit.arguments.count >= idx + 1
                                   Howzit.arguments[idx]
@@ -277,7 +280,13 @@ module Howzit
 
       output = []
       if opt[:header]
-        output.push(@title.format_header)
+        # Include argument definitions in header if present
+        header_title = @title.dup
+        unless @arg_definitions.nil? || @arg_definitions.empty?
+          formatted_args = @arg_definitions.map { |arg| format_arg_definition(arg) }.join('{l}, '.c)
+          header_title += " {l}({x}#{formatted_args}{l}){x}".c
+        end
+        output.push(header_title.format_header)
         output.push('')
       end
       # Process conditional blocks first
@@ -302,11 +311,50 @@ module Howzit
           output.push("{bmK}\u{25B6} {bwK}#{title_code_block(Regexp.last_match.named_captures.symbolize_keys)}{x}".c)
         else
           l.wrap!(Howzit.options[:wrap]) if Howzit.options[:wrap].positive?
-          output.push(l)
+          # Highlight variable placeholders in content
+          output.push(highlight_variables(l))
         end
       end
       Howzit.named_arguments = @named_args
-      output.push('').map(&:render_arguments)
+      output.push('')
+    end
+
+    ##
+    ## Format an argument definition with syntax highlighting
+    ## Parentheses in blue, variable name in bright white, default in yellow
+    ##
+    ## @param      arg  [String] The argument definition (e.g., "var" or "var:default")
+    ##
+    ## @return     [String] Colorized argument definition
+    ##
+    def format_arg_definition(arg)
+      if arg.include?(':')
+        name, default = arg.split(':', 2)
+        "{bw}#{name}{l}:{y}#{default}{x}".c
+      else
+        "{bw}#{arg}{x}".c
+      end
+    end
+
+    ##
+    ## Highlight variable placeholders in content
+    ## Format: ${variable} or ${variable:default}
+    ## Dollar sign and braces in blue, variable name in bright white, default in yellow
+    ##
+    ## @param      text  [String] The text to process
+    ##
+    ## @return     [String] Text with highlighted variables
+    ##
+    def highlight_variables(text)
+      text.gsub(/\$\{([A-Za-z0-9_]+)(?::([^}]*))?\}/) do
+        var_name = Regexp.last_match(1)
+        default = Regexp.last_match(2)
+        if default
+          "{l}\\$\\{{bw}#{var_name}{l}:{y}#{default}{l}\\}{x}".c
+        else
+          "{l}\\$\\{{bw}#{var_name}{l}\\}{x}".c
+        end
+      end
     end
 
     include Comparable

data/lib/howzit/version.rb

@@ -3,5 +3,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '2.1.34'
+  VERSION = '2.1.35'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: howzit
 version: !ruby/object:Gem::Version
-  version: 2.1.34
+  version: 2.1.35
 platform: ruby
 authors:
 - Brett Terpstra