howzit 1.2.14 → 1.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3858dec6b009f75173d3d72067a94c330cb826b0e367109c7416b2db19065fa8
-  data.tar.gz: 2e05520b1ff9d5da82aba03b1af3ed31ee0a635f3fe42c50b3a515c45337c38b
+  metadata.gz: f1d8a45dca4630f76f10fd6f410c63fd4e1685844ca895231d9910717ca97d9b
+  data.tar.gz: 27476b1f987f6f1555e81f14270e923867d75519f5c25d3241a104ec861ddbe3
 SHA512:
-  metadata.gz: 90cb7e647c7956823e73eac6e4884a1ffe26875acd531cc70be6a1b334aa9653213cafbf0830cd69a634579c7fa61553585bbbc95f997a02b0192d093a85be1b
-  data.tar.gz: bfba515bc66d5f15ae33d967866e83e2e9e4c887160d0c66269542ee909acf8383742fd0e64f5639013a1ccdc16253664a3c90cd150fd5a67529280473ed1a88
+  metadata.gz: f3105ab63cc58b59f488f10a9717b457892b83b10760a303364bd9d790d7bb3630d30663ad6232979ce8dbab361c4ba67ee837009cc2f53c12c6bbb2035b8eca
+  data.tar.gz: 661c54c86f55cbe939001b30848c3c35e7779571bb9a5797af96c107db761322cd37f11c2bf4d0e2b61d65173c9855735296fe46f029283845fd5a1c19f61103

data/.rubocop.yml

@@ -4,6 +4,11 @@ AllCops:
     - Guardfile
     - Rakefile
 
+Metrics/BlockLength:
+  Exclude:
+    - bin/howzit
+    - lib/*.rb
+
 Style/RegexpLiteral:
   Exclude:
     - Guardfile

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+### 1.2.17
+
+2022-08-03 12:10
+
+#### FIXED
+
+- Variables in topics not being replaced with metadata
+- Allow default response in yes/no prompt
+
+### 1.2.16
+
+2022-08-03 11:41
+
+#### IMPROVED
+
+- Complete code refactoring
+
+#### FIXED
+
+- Multiple includes of upstream files when templates are specified
+
+### 1.2.15
+
+2022-08-02 11:59
+
+#### NEW
+
+- Option to set :header_format: to block for alternate topic title appearance
+
+#### FIXED
+
+- Missing spacing around topic titles when displaying multiple topics
+
 ### 1.2.14
 
 2022-08-02 11:01

data/README.md

@@ -265,6 +265,7 @@ Some of the command line options can be set as defaults. The first time you run
     :include_upstream: false
     :log_level: 1
     :multiple_matches: choose
+    :header_format: border
 
 If `:color:` is false, output will not be colored, and markdown highlighting will be bypassed.
 
@@ -282,6 +283,8 @@ Set `:log_level:` to 0 for debug messages, or 3 to suppress superfluous info mes
 
 `:multiple_matches:` determines how howzit will handle cases where a search results in multiple matches. It can be set to "first" (first match in notes), "best" (shortest topic match), "all" (display all results), or "choose" (displays a menu of results). Default is "choose." When grepping for results, only "all" or "choose" are valid, if the default is something else, "choose" will be used. Can be overridden with the `--multiple TYPE` flag.
 
+`:header_format:` changes the way topic titles are displayed. Setting it to "border" will add a horizontal rule and brackets around the title. Setting it to "block" will mark topic titles with a unicode block instead.
+
 ### Matching
 
 All matching is case insensitive. This setting can be overridden by the `--matching TYPE` flag on the command line.

data/bin/howzit

@@ -4,5 +4,196 @@
 $LOAD_PATH.unshift File.join(__dir__, '..', 'lib')
 require 'howzit'
 
-how = Howzit::BuildNotes.new(ARGV)
-how.process
+Howzit::Color.coloring = $stdout.isatty
+
+parts = Shellwords.shelljoin(ARGV).split(/ -- /)
+args = parts[0] ? Shellwords.shellsplit(parts[0]) : []
+Howzit.arguments = parts[1] ? Shellwords.shellsplit(parts[1]) : []
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{__FILE__} [OPTIONS] [TOPIC]"
+  opts.separator ''
+  opts.separator 'Show build notes for the current project (buildnotes.md).
+  Include a topic name to see just that topic, or no argument to display all.'
+  opts.separator ''
+  opts.separator 'Options:'
+
+  opts.on('-c', '--create', 'Create a skeleton build note in the current working directory') do
+    Howzit.buildnote.create_note
+    Process.exit 0
+  end
+
+  opts.on('-e', '--edit', "Edit buildnotes file in current working directory
+          using $EDITOR") do
+    Howzit.buildnote.edit
+    Process.exit 0
+  end
+
+  opts.on('--grep PATTERN', 'Display sections matching a search pattern') do |pat|
+    Howzit.options[:grep] = pat
+  end
+
+  opts.on('-L', '--list-completions', 'List topics for completion') do
+    Howzit.options[:list_topics] = true
+    Howzit.options[:list_topic_titles] = true
+  end
+
+  opts.on('-l', '--list', 'List available topics') do
+    Howzit.options[:list_topics] = true
+  end
+
+  opts.on('-m', '--matching TYPE', MATCHING_OPTIONS,
+          'Topics matching type', "(#{MATCHING_OPTIONS.join(', ')})") do |c|
+    Howzit.options[:matching] = c
+  end
+
+  opts.on('--multiple TYPE', MULTIPLE_OPTIONS,
+          'Multiple result handling', "(#{MULTIPLE_OPTIONS.join(', ')}, default choose)") do |c|
+    Howzit.options[:multiple_matches] = c.to_sym
+  end
+
+  opts.on('-R', '--list-runnable', 'List topics containing @ directives (verbose)') do
+    Howzit.options[:list_runnable] = true
+  end
+
+  opts.on('-r', '--run', 'Execute @run, @open, and/or @copy commands for given topic') do
+    Howzit.options[:run] = true
+  end
+
+  opts.on('-s', '--select', 'Select topic from menu') do
+    Howzit.options[:choose] = true
+  end
+
+  opts.on('-T', '--task-list', 'List topics containing @ directives (completion-compatible)') do
+    Howzit.options[:list_runnable] = true
+    Howzit.options[:list_runnable_titles] = true
+  end
+
+  opts.on('-t', '--title', 'Output title with build notes') do
+    Howzit.options[:output_title] = true
+  end
+
+  opts.on('-q', '--quiet', 'Silence info message') do
+    Howzit.options[:log_level] = 3
+  end
+
+  opts.on('-v', '--verbose', 'Show all messages') do
+    Howzit.options[:log_level] = 0
+  end
+
+  opts.on('-u', '--[no-]upstream', 'Traverse up parent directories for additional build notes') do |p|
+    Howzit.options[:include_upstream] = p
+  end
+
+  opts.on('--show-code', 'Display the content of fenced run blocks') do
+    Howzit.options[:show_all_code] = true
+  end
+
+  opts.on('-w', '--wrap COLUMNS', 'Wrap to specified width (default 80, 0 to disable)') do |w|
+    Howzit.options[:wrap] = w.to_i
+  end
+
+  opts.on('--config-get [KEY]', 'Display the configuration settings or setting for a specific key') do |k|
+    if k.nil?
+      Howzit.options.sort_by { |key, _| key }.each do |key, val|
+        print "#{key}: "
+        p val
+      end
+    else
+      k.sub!(/^:/, '')
+      if Howzit.options.key?(k.to_sym)
+        puts Howzit.options[k.to_sym]
+      else
+        puts "Key #{k} not found"
+      end
+    end
+    Process.exit 0
+  end
+
+  opts.on('--config-set KEY=VALUE', 'Set a config value (must be a valid key)') do |key|
+    raise 'Argument must be KEY=VALUE' unless key =~ /\S=\S/
+
+    parts = key.split(/=/)
+    k = parts[0].sub(/^:/, '')
+    v = parts[1..-1].join(' ')
+
+    if Howzit.options.key?(k.to_sym)
+      Howzit.options[k.to_sym] = v.to_config_value(Howzit.options[k.to_sym])
+    else
+      puts "Key #{k} not found"
+    end
+    Howzit.config.write_config(Howzit.options)
+    Process.exit 0
+  end
+
+  opts.on('--edit-config', 'Edit configuration file using default $EDITOR') do
+    Howzit.config.editor
+    Process.exit 0
+  end
+
+  opts.on('--title-only', 'Output title only') do
+    Howzit.options[:output_title] = true
+    Howzit.options[:title_only] = true
+  end
+
+  opts.on('--templates', 'List available templates') do
+    Dir.chdir(Howzit.config.template_folder)
+    Dir.glob('*.md').each do |file|
+      template = File.basename(file, '.md')
+      puts Howzit::Color.template("{Mk}template:{Yk}#{template}{x}")
+      puts Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}')
+      metadata = file.extract_metadata
+      topics = Howzit.buildnote.read_file(file)
+      topics.each do |topic|
+        puts Howzit::Color.template(" {bk}│{bw}-{x} {bcK}#{template}:#{topic.title.sub(/^.*?:/, '')}{x}")
+      end
+      unless metadata.empty?
+        meta = []
+        meta << metadata['required'].split(/\s*,\s*/).map { |m| "*{bw}#{m}{xw}" } if metadata.key?('required')
+        meta << metadata['optional'].split(/\s*,\s*/).map(&:to_s) if metadata.key?('optional')
+        puts Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}')
+        puts Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}")
+      end
+      puts Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}')
+    end
+    Process.exit 0
+  end
+
+  opts.on('--header-format TYPE', HEADER_FORMAT_OPTIONS,
+          "Formatting style for topic titles (#{HEADER_FORMAT_OPTIONS.join(', ')})") do |t|
+    Howzit.options[:header_format] = t
+  end
+
+  opts.on('--[no-]color', 'Colorize output (default on)') do |c|
+    Howzit.options[:color] = c
+    Howzit.options[:highlight] = false unless c
+  end
+
+  opts.on('--[no-]md-highlight', 'Highlight Markdown syntax (default on), requires mdless or mdcat') do |m|
+    Howzit.options[:highlight] = Howzit.options[:color] ? m : false
+  end
+
+  opts.on('--[no-]pager', 'Paginate output (default on)') do |p|
+    Howzit.options[:paginate] = p
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    Process.exit 0
+  end
+
+  opts.on('-v', '--version', 'Display version number') do
+    puts "how v#{Howzit::VERSION}"
+    Process.exit 0
+  end
+
+  opts.on('--default', 'Answer all prompts with default response') do
+    Howzit.options[:default] = true
+  end
+end.parse!(args)
+
+Howzit.options[:multiple_matches] = Howzit.options[:multiple_matches].to_sym
+Howzit.options[:header_format] = Howzit.options[:header_format].to_sym
+
+Howzit.cli_args = args
+Howzit.buildnote.run