howzit 1.2.13 → 1.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a27d1566deff8857d39035c0e40f696a29d78b7ae24274a73ceacc54541321
-  data.tar.gz: 7b13d6644bf397e10f629689b159102a33dd5aa2c3610f368819de3dc8736007
+  metadata.gz: 14bc9569ad9313ee45f42b23fb1181ad3c70c4c7d7c69d436feff9804035c3ac
+  data.tar.gz: e40a8f4ca0e99a8e68c6df996d24bcd121a1d69dde2780f3836237303cf85e2c
 SHA512:
-  metadata.gz: 9da1ea212df950e75a34006a44b0ade09c02fd4fe7c02ea0fddfffcf2936e6ca5db0d7f0c9e6cc44aac3d65eb4544aa9d4c03c156487f9311f39f08ee12199d4
-  data.tar.gz: 99f9be58ff9184a2f96e7db6fed83e3fc19f0945e31c9d58daa32db022b175a8c99a329a9c023528af52100f46583ac892091eb04ed5d9e9e791087fe8f8c82d
+  metadata.gz: bfa974d861fe4d225239d8b4ed496a46feeba3048b7b1eba4ec61bc5fdc5ad33e46cd1dab97dcf4553b64b916bf59cb28a8d1f3605cff6a7d222752266e0e644
+  data.tar.gz: 02c3c096d1841122c1e027274912b233e167a073c711945cad72186741e759f1c007d421a5accee7c86c0474742a033789e076a53d4858852c673317ccd0b56b

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+### 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
+
+#### NEW
+
+- Config option and flag to determine how to handle multiple results (first, best, all, choose)
+- --config-get and --config-set flags for working with config options
+
+#### IMPROVED
+
+- Allow multiple selections when using fzf
+- Clean up newlines in output
+
 ### 1.2.13
 
 2022-08-01 20:50

data/README.md

@@ -24,11 +24,10 @@ Howzit is a tool that allows you to keep Markdown-formatted notes about a projec
 
 ## Getting Started
 
-Howzit is a simple, self-contained script (at least until I get stupid and make a gem out of it).
-
 ### Prerequisites
 
 - Ruby 2.4+ (It probably works on older Rubys, but is untested prior to 2.4.1.)
+- Optional: if [`fzf`](https://github.com/junegunn/fzf) is available, it will be used for handling multiple choice selections
 - Optional: if [`bat`](https://github.com/sharkdp/bat) is available it will page with that
 - Optional: [`mdless`](https://github.com/ttscoff/mdless) or [`mdcat`](https://github.com/lunaryorn/mdcat) for formatting output
 
@@ -200,6 +199,10 @@ Include a topic name to see just that topic, or no argument to display all.
 
     howzit build
 
+You can combine multiple topic searches by separating with a comma. When multiple results are returned, the `:multiple_results:` configuration determines how they're handled.
+
+    howzit build,deploy
+
 Use `-l` to list all topics.
 
     howzit -l
@@ -216,12 +219,15 @@ Other options:
 
     Options:
         -c, --create                     Create a skeleton build note in the current working directory
-        -e, --edit                       Edit buildnotes file in current working directory using editor.sh
+        -e, --edit                       Edit buildnotes file in current working directory
+                    using $EDITOR
             --grep PATTERN               Display sections matching a search pattern
         -L, --list-completions           List topics for completion
         -l, --list                       List available topics
         -m, --matching TYPE              Topics matching type
                                          (partial, exact, fuzzy, beginswith)
+            --multiple TYPE              Multiple result handling
+                                         (first, all, choose)
         -R, --list-runnable              List topics containing @ directives (verbose)
         -r, --run                        Execute @run, @open, and/or @copy commands for given topic
         -s, --select                     Select topic from menu
@@ -229,10 +235,10 @@ Other options:
         -t, --title                      Output title with build notes
         -q, --quiet                      Silence info message
             --verbose                    Show all messages
-        -u, --upstream                   Traverse up parent directories for additional build notes
+        -u, --[no-]upstream              Traverse up parent directories for additional build notes
             --show-code                  Display the content of fenced run blocks
         -w, --wrap COLUMNS               Wrap to specified width (default 80, 0 to disable)
-            --edit-config                Edit configuration file using editor.sh
+            --edit-config                Edit configuration file using default $EDITOR
             --title-only                 Output title only
             --templates                  List available templates
             --[no-]color                 Colorize output (default on)
@@ -240,6 +246,7 @@ Other options:
             --[no-]pager                 Paginate output (default on)
         -h, --help                       Display this screen
         -v, --version                    Display version number
+            --default                    Answer all prompts with default response
 
 
 ## Configuration
@@ -257,6 +264,8 @@ Some of the command line options can be set as defaults. The first time you run
     :matching: partial
     :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.
 
@@ -272,6 +281,10 @@ If `:include_upstream:` is true, build note files in parent directories will be
 
 Set `:log_level:` to 0 for debug messages, or 3 to suppress superfluous info messages.
 
+`: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
+      if metadata.size > 0
+        meta = []
+        meta << metadata['required'].split(/\s*,\s*/).map {|m| "*{bw}#{m}{xw}" } if metadata.key?('required')
+        meta << metadata['optional'].split(/\s*,\s*/).map {|m| "#{m}" } 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