howzit 1.2.6 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca091b1137f05559c0e53738d8cf283e3e301bbd434b3241a54592ded4aac39a
-  data.tar.gz: 99f0a601a6d2655954da642621df18573f15bcefe44ccb458b3ef61f397ec92b
+  metadata.gz: fba37c5c428aeab92ed337697a52323d5b98d5f9398776187e000043e3a5173b
+  data.tar.gz: 6f3a3ebfe50f50476837c2d702cd1c9854d49ff4960c51a06641e79d88abb410
 SHA512:
-  metadata.gz: 24215ee9b271df785dedee31da6f2bf3ecbc4be69231635ee0d77a6e9a76b5fa1507e4125ee9b896cc15559842d7546302f25a789b726a87a7a4a3531a6a49bf
-  data.tar.gz: a1754b95775992055ba92a294215bc9680e296f932cf2d2664a0e00e9d5442742469ac2f51e8acd741f788b49a9b39053083c4cd0d271d7aa2db167394fb343e
+  metadata.gz: 015bc504dca39d5b7a32b6d81a4df037abf61467f58b392e88389557f38a2abfb078fd3dc5ced7411b5d1654479d5a79b94da843f8384d4cf77216e9efa1c24c
+  data.tar.gz: c0b2003e8c1b24efa1e193520a66e01813fab6e9d8e21318a7d0c82718540fa8ef1c99b075d40dc07254c678015ca3fe687b64a2be6f8ce541c22e786ac63c9a

data/CHANGELOG.md

@@ -1,10 +1,181 @@
-# Change Log
+### 1.2.10
 
-All notable changes to this project will be documented in this file.
-This project adheres to [Semantic Versioning](http://semver.org/).
-This change log follows the conventions of
-[keep a CHANGELOG](http://keepachangelog.com/).
+2022-08-01 07:45
 
-## [Unreleased]
+#### FIXED
 
-[Unreleased]: https://github.com/ttscoff/howzit/compare/v1.2.4...HEAD
+- Headline formatting when iTerm markers are inserted
+
+### 1.2.9
+
+2022-08-01 07:09
+
+### 1.2.8
+
+2022-08-01 07:01
+
+#### FIXED
+
+- Frozen string error
+
+### 1.2.6
+
+2022-08-01 06:09
+
+#### NEW
+
+- Use @before...@end and @after...@end to specify prerequisites and a post-run message. Topics with @before will require y/n verification before running
+
+#### FIXED
+
+- ITerm markers weren't being inserted when paging was off
+
+### 1.2.3
+
+2022-07-31 14:20
+
+#### IMPROVED
+
+- Don't include a topic multiple times in one display
+- Don't execute nested topics more than once
+- Indicate nested includes in headers
+- Code cleanup
+
+### 1.2.2
+
+2022-07-31 08:56
+
+- Add -F option to pager setup (quit if less than one screen)
+
+### 1.2.1
+
+2022-07-31 05:12
+
+- Add handling for delta pager to not clear screen on exit
+
+### 1.2.0
+
+2022-07-31 04:59
+
+- Add grep feature, searches topic/content for pattern and displays matches (selection menu if multiple matches)
+
+### 1.1.27
+
+2022-01-17 11:45
+
+#### NEW
+
+- Use fzf for menus if available
+- "@run() TITLE" will show TITLE instead of command when listing runnable topics
+- @include(FILENAME) will import an external file if the path exists
+
+### 1.1.26
+
+- Fix for error in interactive build notes creation
+
+### 1.1.25
+
+- Hide run block contents by default
+- :show_all_code: config setting to include run block contents
+- --show-code flag to display run block contents at runtime
+- Modify include display
+
+### 1.1.24
+
+- Use ~/.config/howzit/ignore.yaml to ignore patterns when scanning for build notes
+- Use `required` and `optional` keys in templates to request that metadata be defined when importing
+- Allow templates to include other templates
+
+### 1.1.23
+
+- Add flags to allow content to stay onscreen after exiting pager (less and bat)
+
+### 1.1.21
+
+- Merge directive and block handling so execution order is sequential
+
+### 1.1.20
+
+- Template functionality for including common tasks/topics
+
+### 1.1.19
+
+- Add `--upstream` option to traverse up parent directories for additional build notes
+
+### 1.1.15
+
+- Code refactoring/cleanup
+- Rename "sections" to "topics"
+- If no match found for topic search, only show error (`:show_all_on_error: false` option)
+
+### 1.1.14
+
+- Fix removal of non-alphanumeric characters from titles
+- -s/--select option to display a menu of all available topics
+- Allow arguments to be passed after `--` for variable substitution
+- Allow --matching TYPE to match first non-ambigous keyword match
+
+### 1.1.13
+
+- --matching [fuzzy,beginswith,partial,exact] flag
+- --edit-config flag
+- sort flags in help
+
+### 1.1.12
+
+- After consideration, remove full fuzzy matching. Too many positives for shorter strings.
+
+### 1.1.11
+
+- Add full fuzzy matching for topic titles
+- Add `@include(TOPIC)` command to import another topic's tasks
+
+### 1.1.10
+
+- Add config file for default options
+
+### 1.1.9
+
+- Use `system` instead of `exec` to allow multiple @run commands
+- Add code block runner
+
+### 1.1.8
+
+- Add `-e/--edit` flag to open build notes in $EDITOR
+
+### 1.1.7
+
+- Use `exec` for @run commands to allow interactive processes (e.g. vim)
+
+### 1.1.6
+
+- Add option for outputting title with notes
+- Add option for outputting note title only
+
+### 1.1.4
+
+- Fix for "topic not found" when run with no arguments
+
+### 1.1.1
+
+- Reorganize and rename long output options
+- Fix wrapping long lines without spaces
+
+### 1.1.0
+
+- Add -R switch for listing "runnable" topics
+- Add -T switch for completion-compatible listing of "runnable" topics
+- Add -L switch for completion-compatible listing of all topics
+
+### 1.0.1
+
+- Allow topic matching within title, not just at start
+- Remove formatting of topic text for better compatibility with mdless/mdcat
+- Add @run() syntax to allow executable commands
+- Add @copy() syntax to copy text to clipboard
+- Add @url/@open() syntax to open urls/files, OS agnostic (hopefully)
+- Add support for mdless/mdcat
+- Add support for pager
+- Offer to create skeleton buildnotes if none found
+- Set iTerm 2 marks for navigation when paging is disabled
+- Wrap output with option to specify width (default 80, 0 to disable)

data/README.md

@@ -87,6 +87,12 @@ You can include commands that can be executed by howzit. Commands start at the b
 - `@include(TOPIC)`
 
     Includes all tasks from another topic, matching the name (partial match allowed) and returning first match.
+- `@before...@end`
+    
+    A block defined between @before and @end markers will be considered prerequisite for any task the topic can run. If one or more of these blocks exist in the topic, they will be displayed before running and a yes/no dialog will request confirmation that the prerequisites have been met. The content between these markers is still included when viewing the topic, but the tags themselves do not show up in output.
+- `@after...@end`
+
+    A block defined between @after and @end markers will be displayed after a topic is run. Use it to remind yourself of additional tasks after automated ones have been executed. The content between these markers is still included when viewing the topic, but the tags themselves do not show up in output.
 
 ### Run blocks (embedded scripts)
 

data/lib/howzit/buildnotes.rb

@@ -132,8 +132,12 @@ module Howzit
       end
     end
 
+    def should_mark_iterm?
+      ENV['TERM_PROGRAM'] =~ /^iTerm/ && !@options[:run] && !@options[:paginate]
+    end
+
     def iterm_marker
-      "\e]1337;SetMark\a\n" if ENV['TERM_PROGRAM'] =~ /^iTerm/ && !@options[:run] && !@options[:paginate]
+      "\e]1337;SetMark\a" if should_mark_iterm?
     end
 
     def color_single_options(choices = %w[y n])
@@ -226,16 +230,23 @@ module Howzit
       options = {
         hr: "\u{254C}",
         color: '1;32',
-        border: '0'
+        border: '0',
+        mark: false
       }
 
       options.merge!(opts)
 
       cols = TTY::Screen.columns
+
       cols = @options[:wrap] if (@options[:wrap]).positive? && cols > @options[:wrap]
-      title = "\e[#{options[:border]}m#{options[:hr]}#{options[:hr]}( \e[#{options[:color]}m#{title}\e[#{options[:border]}m )"
-      tail = options[:hr] * (cols - title.uncolor.length)
-      options[:hr] =~ /╌/ ? "#{iterm_marker}#{title}#{tail}\e[0m" : "#{title}#{tail}\e[0m"
+      title = "\e[#{options[:border]}m#{options[:hr] * 2}( \e[#{options[:color]}m#{title}\e[#{options[:border]}m )"
+
+      tail = if should_mark_iterm?
+               "#{options[:hr] * (cols - title.uncolor.length - 15)}#{options[:mark] ? iterm_marker : ''}"
+             else
+               options[:hr] * (cols - title.uncolor.length)
+             end
+      "#{title}#{tail}\e[0m"
     end
 
     def os_open(command)
@@ -344,7 +355,7 @@ module Howzit
 
       output = []
       if opt[:header]
-        output.push(format_header(key))
+        output.push(format_header(key, { mark: should_mark_iterm? }))
         output.push('')
       end
       topic = topics[key].strip

data/lib/howzit/stringutils.rb

@@ -49,11 +49,11 @@ module Howzit
     # Truncate string to nearest word
     # @param len <number> max length of string
     def trunc(len)
-      split(/ /).each_with_object('') do |x, ob|
-        break ob unless ob.length + ' '.length + x.length <= len
+      split(/ /).each_with_object([]) do |x, ob|
+        break ob unless ob.join(' ').length + ' '.length + x.length <= len
 
-        ob << (" #{x}")
-      end.strip
+        ob.push(x)
+      end.join(' ').strip
     end
 
     def trunc!(len)

data/lib/howzit/version.rb

@@ -2,5 +2,5 @@
 # Primary module for this gem.
 module Howzit
   # Current Howzit version.
-  VERSION = '1.2.6'.freeze
+  VERSION = '1.2.10'.freeze
 end

metadata

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