howzit 2.1.30 → 2.1.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1b854ebbde3ca3bdeac5fa4a633911993e6a9361c02ccc8c7364b7624edb4a1
-  data.tar.gz: 3a7f716c2f331acb4cb767d0ea3eff2b59dfc82b8756f5716b86b6045d6c46f6
+  metadata.gz: 816754b14a92ca32bab9ae753a03926d0163e2af860164032b7d1fdfff58f716
+  data.tar.gz: 32fb6fee068779ba312051bd2613c8d47e24777760ecce28da796f2c35899fdd
 SHA512:
-  metadata.gz: f2cec86d81ab9b1b51c65d21b0ef628483e214545bba722267e3670978305d862b634dcdb93db8bad56d66627213a60939784feb6d021d9cbd2bfc9639451bea
-  data.tar.gz: b925f6cbe26ac39b5aa18fcd21896885b85742b88098d25e0b1fb35915983da3c602bc912bc44745fe3fd6f92396bcecdf7ff036411ffe872c54145d00fdf888
+  metadata.gz: 2741d38466727329dc19755f910acc88a67068b66c1665256365fecffd31ed64a9d0040b97f26140444676a74bec53b1e33c96048dd9b7044b8aecafa0e3a845
+  data.tar.gz: fbe6e5aa03de0eadbc3d4af7a34d67b0a1628d0926dbf0d908ab9ae8f49b31236b5b6d89d5433ef88785e0d78a9066a969ad7a757b5c81e33f7ada0a923bbc24

data/CHANGELOG.md

@@ -1,3 +1,32 @@
+### 2.1.32
+
+2026-01-06 05:21
+
+#### IMPROVED
+
+- Completion output for howzit -L and howzit -T now shows topic titles without parenthetical variable names, making completion lists cleaner and easier to read while still preserving variable information in verbose output (howzit -R).
+
+### 2.1.31
+
+2026-01-06 04:57
+
+#### CHANGED
+
+- Updated Howzit to use XDG_CONFIG_HOME/howzit (or ~/.config/howzit if XDG_CONFIG_HOME is not set) for all configuration files, templates, themes, and script support files instead of ~/.local/share/howzit.
+
+#### NEW
+
+- Added automatic migration prompt that detects existing ~/.local/share/howzit directory and offers to migrate all files to the new config location, merging contents and overwriting existing files in the new location while preserving files that only exist in the new location.
+- Added --migrate flag to explicitly trigger migration of legacy ~/.local/share/howzit directory to the new config location.
+
+#### IMPROVED
+
+- Migration prompt now appears during config initialization to catch legacy directories before creating new config files, preventing confusion about file locations.
+
+#### FIXED
+
+- Fixed ArgumentError when topic titles were longer than terminal width by ensuring horizontal rule width calculation never goes negative, clamping to zero when title exceeds available space.
+
 ### 2.1.30
 
 2026-01-06 03:55

data/bin/howzit

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+#!/usr/bin/env ruby -W0
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
@@ -248,6 +248,11 @@ OptionParser.new do |opts|
     Process.exit 0
   end
 
+  opts.on('--migrate', 'Migrate legacy files from ~/.local/share/howzit to the new config location') do
+    Howzit::ScriptSupport.migrate_legacy_support(early_init: false)
+    Process.exit 0
+  end
+
   opts.on('-v', '--version', 'Display version number') do
     puts "#{File.basename(__FILE__)} v#{Howzit::VERSION}"
     Process.exit 0

data/lib/howzit/buildnote.rb

@@ -21,9 +21,31 @@ module Howzit
       content = Util.read_file(file)
       raise "{br}No content found in build note (#{file}){x}".c if content.nil? || content.empty?
 
+      # Global metadata from config (e.g. ~/.config/howzit/howzit.yml)
+      # Expecting something like:
+      # metadata:
+      #   author: Brett Terpstra
+      #   license: MIT
+      global_meta = {}
+      raw_global = Howzit.options[:metadata] || Howzit.options['metadata']
+      if raw_global.is_a?(Hash)
+        raw_global.each do |k, v|
+          global_meta[k.to_s.downcase] = v
+        end
+      end
+
+      # Metadata defined in the build note itself (before the first heading)
       this_meta = content.split(/^#/)[0].strip.metadata
 
-      @metadata = meta.nil? ? this_meta : meta.merge(this_meta)
+      # Merge order:
+      # 1. Global config metadata (lowest precedence)
+      # 2. Metadata passed in via meta argument (e.g. templates)
+      # 3. Build note metadata (highest precedence)
+      combined_meta = global_meta.dup
+      combined_meta.merge!(meta) if meta
+      combined_meta.merge!(this_meta) if this_meta
+
+      @metadata = combined_meta
 
       read_help(file)
     end
@@ -146,9 +168,7 @@ module Howzit
     ##
     def list_topics
       @topics.map do |topic|
-        title = topic.title
-        title += "(#{topic.named_args.keys.join(', ')})" unless topic.named_args.empty?
-        title
+        topic.title
       end
     end
 
@@ -173,9 +193,7 @@ module Howzit
       @topics.each do |topic|
         next unless topic.tasks.count.positive?
 
-        title = topic.title
-        title += "(#{topic.named_args.keys.join(', ')})" unless topic.named_args.empty?
-        output.push(title)
+        output.push(topic.title)
       end
       output.join("\n")
     end

data/lib/howzit/config.rb

@@ -251,6 +251,14 @@ module Howzit
     ## @param      default     [Hash] default configuration to write
     ##
     def create_config(default)
+      # If a legacy ~/.local/share/howzit directory exists, offer to migrate it
+      # into the new config root before creating any new files to avoid confusion
+      # about where Howzit stores its configuration.
+      # Use early_init=true since we're called during config initialization and can't access Howzit.options yet
+      if defined?(Howzit::ScriptSupport) && File.directory?(File.expand_path(Howzit::ScriptSupport::LEGACY_SUPPORT_DIR))
+        Howzit::ScriptSupport.migrate_legacy_support(early_init: true)
+      end
+
       unless File.directory?(config_dir)
         Howzit::ConsoleLogger.new(1).info "Creating config directory at #{config_dir}"
         FileUtils.mkdir_p(config_dir)

data/lib/howzit/script_support.rb

@@ -8,7 +8,15 @@ module Howzit
   # Handles helper script installation and injection for run blocks
   # rubocop:disable Metrics/ModuleLength
   module ScriptSupport
-    SUPPORT_DIR = '~/.local/share/howzit/support'
+    # Prefer XDG_CONFIG_HOME/howzit/support if set, otherwise ~/.config/howzit/support.
+    # For backwards compatibility, we detect an existing ~/.local/share/howzit directory
+    # and can optionally migrate it to the new location.
+    LEGACY_SUPPORT_DIR = File.join(Dir.home, '.local', 'share', 'howzit')
+    SUPPORT_DIR = if ENV['XDG_CONFIG_HOME'] && !ENV['XDG_CONFIG_HOME'].empty?
+                    File.join(ENV['XDG_CONFIG_HOME'], 'howzit', 'support')
+                  else
+                    File.join(Dir.home, '.config', 'howzit', 'support')
+                  end
 
     class << self
       ##
@@ -25,11 +33,96 @@ module Howzit
       ##
       def ensure_support_dir
         dir = support_dir
+        legacy_dir = File.expand_path(LEGACY_SUPPORT_DIR)
+        new_root  = File.expand_path(File.join(SUPPORT_DIR, '..'))
+
+        # If legacy files exist, always offer to migrate them before proceeding.
+        # Use early_init=false here since config is already loaded by the time we reach this point
+        migrate_legacy_support(early_init: false) if File.directory?(legacy_dir)
+
         FileUtils.mkdir_p(dir) unless File.directory?(dir)
         install_helper_scripts
         dir
       end
 
+      ##
+      ## Simple Y/N prompt that doesn't depend on Howzit.options (for use during early config initialization)
+      ##
+      def simple_yn_prompt(prompt, default: true)
+        return default unless $stdout.isatty
+
+        tty_state = `stty -g`
+        yn = default ? '[Y/n]' : '[y/N]'
+        $stdout.syswrite "\e[1;37m#{prompt} #{yn}\e[1;37m? \e[0m"
+        system 'stty raw -echo cbreak isig'
+        res = $stdin.sysread 1
+        res.chomp!
+        puts
+        system 'stty cooked'
+        system "stty #{tty_state}"
+        res.empty? ? default : res =~ /y/i
+      end
+
+      ##
+      ## Migrate legacy ~/.local/share/howzit directory into the new config root,
+      ## merging contents and removing the legacy directory when complete.
+      ##
+      ## @param      early_init  [Boolean] If true, use simple prompt that doesn't access Howzit.options
+      ##
+      def migrate_legacy_support(early_init: false)
+        legacy_dir = File.expand_path(LEGACY_SUPPORT_DIR)
+        new_root  = File.expand_path(File.join(SUPPORT_DIR, '..'))
+
+        unless File.directory?(legacy_dir)
+          if early_init
+            return
+          else
+            Howzit.console.info "No legacy Howzit directory found at #{legacy_dir}; nothing to migrate."
+            return
+          end
+        end
+
+        prompt = "Migrate Howzit files from #{legacy_dir} to #{new_root}? This will overwrite files in the new location with legacy versions, " \
+                 'add new files, and leave any extra files in the new location in place.'
+
+        if early_init
+          unless simple_yn_prompt(prompt, default: true)
+            $stderr.puts 'Migration cancelled; no changes made.'
+            return
+          end
+        else
+          unless Prompt.yn(prompt, default: true)
+            Howzit.console.info 'Migration cancelled; no changes made.'
+            return
+          end
+        end
+
+        FileUtils.mkdir_p(new_root) unless File.directory?(new_root)
+
+        # Merge legacy into new_root:
+        # - overwrite files in new_root with versions from legacy
+        # - add files that do not yet exist
+        # - leave files that exist only in new_root untouched
+        Dir.children(legacy_dir).each do |entry|
+          src = File.join(legacy_dir, entry)
+          dest = File.join(new_root, entry)
+
+          if File.directory?(src)
+            FileUtils.mkdir_p(dest)
+            FileUtils.cp_r(File.join(src, '.'), dest)
+          else
+            FileUtils.cp(src, dest)
+          end
+        end
+
+        FileUtils.rm_rf(legacy_dir)
+        if early_init
+          $stderr.puts "Migrated Howzit files from #{legacy_dir} to #{new_root}."
+        else
+          Howzit.console.info "Migrated Howzit files from #{legacy_dir} to #{new_root}."
+        end
+      end
+
       ##
       ## Detect interpreter from hashbang line
       ##

data/lib/howzit/stringutils.rb

@@ -407,15 +407,47 @@ module Howzit
     end
 
     ##
-    ## Examine text for multimarkdown-style metadata and return key/value pairs
+    ## Examine text for metadata and return key/value pairs
+    ##
+    ## Supports:
+    ## - YAML front matter (starting with --- and ending with --- or ...)
+    ## - MultiMarkdown-style key: value lines (up to first blank line)
     ##
     ## @return     [Hash] The metadata as key/value pairs
     ##
     def metadata
       data = {}
-      scan(/(?mi)^(\S[\s\S]+?): ([\s\S]*?)(?=\n\S[\s\S]*?:|\Z)/).each do |m|
-        data[m[0].strip.downcase] = m[1]
+      lines = to_s.lines
+      first_idx = lines.index { |l| l !~ /^\s*$/ }
+      return {} unless first_idx
+
+      first = lines[first_idx]
+
+      if first =~ /^---\s*$/
+        # YAML front matter: between first --- and closing --- or ...
+        closing_rel = lines[(first_idx + 1)..].index { |l| l =~ /^(---|\.\.\.)\s*$/ }
+        closing_idx = closing_rel ? first_idx + 1 + closing_rel : lines.length
+        yaml_body = lines[(first_idx + 1)...closing_idx].join
+        raw = yaml_body.strip.empty? ? {} : YAML.load(yaml_body) || {}
+        if raw.is_a?(Hash)
+          raw.each do |k, v|
+            data[k.to_s.downcase] = v
+          end
+        end
+      else
+        # MultiMarkdown-style: key: value lines up to first blank line
+        header_lines = []
+        lines[first_idx..].each do |l|
+          break if l =~ /^\s*$/
+
+          header_lines << l
+        end
+        header = header_lines.join
+        header.scan(/(?mi)^(\S[\s\S]+?): ([\s\S]*?)(?=\n\S[\s\S]*?:|\Z)/).each do |m|
+          data[m[0].strip.downcase] = m[1]
+        end
       end
+
       out = normalize_metadata(data)
       Howzit.named_arguments ||= {}
       Howzit.named_arguments = out.merge(Howzit.named_arguments)
@@ -491,11 +523,21 @@ module Howzit
         cols = Howzit.options[:wrap] if Howzit.options[:wrap].positive? && cols > Howzit.options[:wrap]
         title = Color.template("#{options[:border]}#{options[:hr] * 2}( #{options[:color]}#{title}#{options[:border]} )")
 
+        # Calculate remaining width for horizontal rule, ensuring it is never negative
+        remaining = cols - title.uncolor.length
+        if should_mark_iterm?
+          # Reserve some space for the iTerm mark escape sequence in the visual layout
+          remaining -= 15
+        end
+        remaining = 0 if remaining.negative?
+
+        hr_tail = options[:hr] * remaining
         tail = if should_mark_iterm?
-                 "#{options[:hr] * (cols - title.uncolor.length - 15)}#{options[:mark] ? iterm_marker : ''}"
+                 "#{hr_tail}#{options[:mark] ? iterm_marker : ''}"
                else
-                 options[:hr] * (cols - title.uncolor.length)
+                 hr_tail
                end
+
         Color.template("\n\n#{title}#{tail}{x}\n\n")
       end
     end

data/lib/howzit/version.rb

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

data/lib/howzit.rb

@@ -1,7 +1,12 @@
 # frozen_string_literal: true
 
 # Main config dir
-CONFIG_DIR = '~/.config/howzit'
+# Prefer XDG_CONFIG_HOME if set, otherwise fall back to ~/.config/howzit
+CONFIG_DIR = if ENV['XDG_CONFIG_HOME'] && !ENV['XDG_CONFIG_HOME'].empty?
+               File.join(ENV['XDG_CONFIG_HOME'], 'howzit')
+             else
+               File.join(Dir.home, '.config', 'howzit')
+             end
 
 # Config file name
 CONFIG_FILE = 'howzit.yaml'

data/spec/buildnote_spec.rb

@@ -8,7 +8,7 @@ describe Howzit::BuildNote do
   describe ".note_file" do
     it "locates a build note file" do
       expect(how.note_file).not_to be_empty
-      expect(how.note_file).to match /builda.md$/
+      expect(how.note_file).to match(/builda.md$/)
     end
   end
 
@@ -16,6 +16,7 @@ describe Howzit::BuildNote do
     it "finds topic containing 'bermuda'" do
       expect(how.grep('bermuda').map { |topic| topic.title }).to include('Topic Tropic')
     end
+
     it "does not return non-matching topic" do
       expect(how.grep('bermuda').map { |topic| topic.title }).not_to include('Topic Balogna')
     end
@@ -116,8 +117,9 @@ describe Howzit::BuildNote do
     it "contains 7 topics" do
       expect(how.list_topics.count).to eq 7
     end
+
     it "outputs a newline-separated string for completion" do
-      expect(how.list_completions.scan(/\n/).count).to eq 6
+      expect(how.list_completions.scan("\n").count).to eq 6
     end
   end
 
@@ -159,7 +161,7 @@ describe Howzit::BuildNote do
 
     it "falls back to fuzzy match when no exact match" do
       Howzit.options[:matching] = 'fuzzy'
-      search_terms = ['trpc']  # fuzzy for 'tropic'
+      search_terms = ['trpc'] # fuzzy for 'tropic'
       output = []
       matches = how.send(:collect_topic_matches, search_terms, output)
       expect(matches.count).to eq 1
@@ -228,7 +230,7 @@ describe Howzit::BuildNote do
 
     it "parses required variables from template metadata" do
       vars = how.send(:parse_template_required_vars, template_with_required.path)
-      expect(vars).to eq(['repo_url', 'author'])
+      expect(vars).to eq(%w[repo_url author])
     end
 
     it "returns empty array when no required metadata" do
@@ -236,4 +238,31 @@ describe Howzit::BuildNote do
       expect(vars).to eq([])
     end
   end
+
+  describe 'global metadata from config' do
+    it 'merges config metadata under metadata key before file metadata' do
+      # Simulate config metadata in Howzit.options
+      Howzit.options[:metadata] = { 'author' => 'Config Author', 'license' => 'MIT' }
+
+      note = <<~EONOTE
+        author: Note Author
+
+        # Test Note
+
+        ## Section
+      EONOTE
+
+      Tempfile.create(['buildnote_meta', '.md']) do |f|
+        f.write(note)
+        f.flush
+
+        build = Howzit::BuildNote.new(file: f.path)
+
+        expect(build.metadata['author']).to eq('Note Author')
+        expect(build.metadata['license']).to eq('MIT')
+      end
+    ensure
+      Howzit.options[:metadata] = nil
+    end
+  end
 end

data/spec/stringutils_spec.rb

@@ -78,5 +78,45 @@ describe 'StringUtils' do
       expect(result).to eq('echo ${BASH_VAR}')
     end
   end
-end
 
+  describe '#metadata' do
+    before do
+      Howzit.named_arguments = {}
+    end
+
+    it 'parses MultiMarkdown-style metadata up to first blank line' do
+      text = <<~META
+        author: Note Author
+        license: MIT
+
+        This is the rest of the file.
+        author: Should not override
+      META
+
+      meta = text.metadata
+      expect(meta['author']).to eq('Note Author')
+      expect(meta['license']).to eq('MIT')
+    end
+
+    it 'parses YAML front matter when starting with ---' do
+      text = <<~META
+        ---
+        author: Brett Terpstra
+        license: MIT
+        ---
+
+        # Title
+      META
+
+      meta = text.metadata
+      expect(meta['author']).to eq('Brett Terpstra')
+      expect(meta['license']).to eq('MIT')
+    end
+
+    it 'returns empty hash when there is no metadata' do
+      text = "Just some content\nWithout metadata\n"
+      meta = text.metadata
+      expect(meta).to eq({})
+    end
+  end
+end

metadata

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