na 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92a40acdde96bfe4a27a093edf4e0f909b23b1c300d6be4f742323ac4e9233be
-  data.tar.gz: bfddb6edfe9cddf7a631819bd980708fd816d2853b3146f348c2095b1ca7aee2
+  metadata.gz: ac0a37d801443c68aaee6eee3b6c4a31461a61d4221c7a073beb0f176d7d7424
+  data.tar.gz: d04d6bd01a3104f6858e9a797af728486b80a8482b6644a09940a6272ae2ec4b
 SHA512:
-  metadata.gz: 77fd24c44ea1b7dba5fb2feb8d36e625972b7662c3032d96ffb7af28843cc08ad16f911fb58778b7cfc831b329859effb04134168517eb596f1da4e9d62cc001
-  data.tar.gz: 212c87e2f59706bd6ed9b5e4cec2ecbd629e9b344a7538f653d8b278dd0f9e62aeb2ceada2d2ed8ef12421fc8c54396ec6e2462b77fe28f90d90946a6aed3967
+  metadata.gz: 7ec40b0dd9ff9f154cc22e5d1cb2df700fae82e9c8118110d72b0ea3aeed46a0bd7543955e8b491f99816a9c5dea8ede5866534c362abbb771a3fefbe8d346d9
+  data.tar.gz: c66d44910edfe4200655b6775665ead7836b47dd7b8b20385da29ee21ce6ba38d5fef0f99b2da009385d9962204cf491d3ee928b2c255bd5d2ce278d8a4c15fa

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+### 1.0.6
+
+2022-09-28 04:22
+
+#### NEW
+
+- `na prompt [show|install]` command to help with adding prompt hooks to your shell
+
 ### 1.0.5
 
 2022-09-28 01:53

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.0.4)
+    na (1.0.5)
       gli (~> 2.21.0)
       tty-reader (~> 0.9, >= 0.9.0)
       tty-screen (~> 0.8, >= 0.8.1)

data/README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is 1.0.4.
+The current version of `na` is 1.0.5.
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
 
@@ -293,7 +293,6 @@ Fish (in ~/.config/fish/conf.d/*.fish):
 
 ```fish
 function __should_na --on-variable PWD
-	# function __should_na --on-event fish_prompt
 	test -s (basename $PWD)".taskpaper" && na
 end
 ```

data/bin/na

@@ -48,7 +48,7 @@ class App
   flag %i[d depth], type: :integer, must_match: /^\d+$/
 
   desc 'Display verbose output'
-  switch %i[verbose]
+  switch %i[debug]
 
   desc 'Show next actions'
   arg_name 'OPTIONAL_QUERY'
@@ -94,11 +94,9 @@ class App
       tag = options[:tag] == global_options[:na_tag] ? nil : options[:tag]
       files, actions = NA.parse_actions(depth: depth,
                                         query: tokens,
-                                        extension: global_options[:ext],
-                                        na_tag: global_options[:na_tag],
                                         tag: tag)
 
-      NA.output_actions(actions, depth, global_options[:ext], files: files)
+      NA.output_actions(actions, depth, files: files)
     end
   end
 
@@ -148,7 +146,7 @@ class App
         action = "#{action.gsub(/@priority\(\d+\)/, '')} @priority(#{options[:priority]})"
       end
 
-      na_tag = global_options[:na_tag]
+      na_tag = NA.na_tag
       na_tag = options[:tag] unless options[:tag].nil?
 
       action = "#{action.gsub(/@#{na_tag}/, '')} @#{na_tag}"
@@ -167,7 +165,7 @@ class App
           print NA::Color.template('{by}Specified file not found, create it? {w}(y/{g}N{w}){x} ')
           res = reader.read_char
           if res =~ /y/i
-            basename = File.basename(target, ".#{global_options[:ext]}")
+            basename = File.basename(target, ".#{NA.extension}")
             NA.create_todo(target, basename)
           else
             puts NA::Color.template('{r}Cancelled{x}')
@@ -175,15 +173,15 @@ class App
           end
         end
       else
-        files = NA.find_files(depth: 1, extension: global_options[:ext])
+        files = NA.find_files(depth: 1)
         if files.count == 0
           print NA::Color.template('{by}No todo file found, create one? {w}(y/{g}N{w}){x} ')
           res = reader.read_char
           if res =~ /y/i
             basename = File.expand_path('.').split('/').last
-            target = "#{basename}.#{global_options[:ext]}"
+            target = "#{basename}.#{NA.extension}"
             NA.create_todo(target, basename)
-            files = NA.find_files(depth: 1, extension: global_options[:ext])
+            files = NA.find_files(depth: 1)
           end
         end
         target = files.count > 1 ? NA.select_file(files) : files[0]
@@ -236,10 +234,8 @@ class App
       end
 
       files, actions = NA.parse_actions(depth: depth,
-                                        extension: global_options[:ext],
-                                        na_tag: global_options[:na_tag],
                                         search: tokens)
-      NA.output_actions(actions, depth, global_options[:ext], files: files)
+      NA.output_actions(actions, depth, files: files)
     end
   end
 
@@ -278,10 +274,8 @@ class App
       end
 
       files, actions = NA.parse_actions(depth: depth,
-                                        extension: global_options[:ext],
-                                        na_tag: global_options[:na_tag],
                                         tag: tags)
-      NA.output_actions(actions, depth, global_options[:ext], files: files)
+      NA.output_actions(actions, depth, files: files)
     end
   end
 
@@ -300,7 +294,7 @@ class App
         project = reader.read_line(NA::Color.template('{y}Project name {bw}> {x}'), value: project).strip
       end
 
-      target = "#{project}.#{global_options[:ext]}"
+      target = "#{project}.#{NA.extension}"
 
       if File.exist?(target)
         print NA::Color.template("{r}File {bw}#{target}{r} already exists, overwrite it? {br}y{w}/{bg}N{x} ")
@@ -339,7 +333,7 @@ class App
               else
                 options[:depth].nil? ? global_options[:depth].to_i : options[:depth].to_i
               end
-      files = NA.find_files(depth: depth, extension: global_options[:ext])
+      files = NA.find_files(depth: depth)
       file = if files.count > 1
                NA.select_file(files)
              else
@@ -354,8 +348,59 @@ class App
     end
   end
 
+  desc 'Show or install prompt hooks for the current shell'
+  long_desc 'Installing the prompt hook allows you to automatically
+  list next actions when you cd into a directory'
+  command %i[prompt] do |c|
+    c.desc 'Output the prompt hook for the current shell to STDOUT. Pass an argument to specify a shell (zsh, bash, fish)'
+    c.arg_name '[SHELL]'
+    c.command %i[show] do |s|
+      s.action do |global_options, options, args|
+        if args.count.positive?
+          shell = args[0]
+        else
+          shell = File.basename(ENV['SHELL'])
+        end
+
+        case shell
+        when /^f/i
+          NA::Prompt.show_prompt_hook(:fish)
+        when /^z/i
+          NA::Prompt.show_prompt_hook(:zsh)
+        when /^b/i
+          NA::Prompt.show_prompt_hook(:bash)
+        end
+      end
+    end
+
+    c.desc 'Install the hook for the current shell to the appropriate startup file.'
+    c.arg_name '[SHELL]'
+    c.command %i[install] do |s|
+      s.action do |global_options, options, args|
+        if args.count.positive?
+          shell = args[0]
+        else
+          shell = File.basename(ENV['SHELL'])
+        end
+
+        case shell
+        when /^f/i
+          NA::Prompt.install_prompt_hook(:fish)
+        when /^z/i
+          NA::Prompt.install_prompt_hook(:zsh)
+        when /^b/i
+          NA::Prompt.install_prompt_hook(:bash)
+        end
+      end
+    end
+  end
+
+
+
   pre do |global, command, options, args|
-    NA.verbose = global[:verbose]
+    NA.verbose = global[:debug]
+    NA.extension = global[:ext]
+    NA.na_tag = global[:na_tag]
     true
   end
 

data/lib/na/next_action.rb

@@ -3,7 +3,7 @@
 # Next Action methods
 module NA
   class << self
-    attr_accessor :verbose
+    attr_accessor :verbose, :extension, :na_tag
 
     def create_todo(target, basename)
       File.open(target, 'w') do |f|
@@ -22,11 +22,11 @@ module NA
         ENDCONTENT
         f.puts(content)
       end
-      puts NA::Color.template("{y}Created {bw}#{target}{x}")
+      $stderr.puts NA::Color.template("{y}Created {bw}#{target}{x}")
     end
 
-    def find_files(depth: 1, extension: 'taskpaper')
-      `find . -name "*.#{extension}" -maxdepth #{depth}`.strip.split("\n")
+    def find_files(depth: 1)
+      `find . -name "*.#{NA.extension}" -maxdepth #{depth}`.strip.split("\n")
     end
 
     def select_file(files)
@@ -39,7 +39,7 @@ module NA
       elsif TTY::Which.exist?('fzf')
         res = choose_from(files, prompt: 'Use which file?')
         unless res
-          puts 'No file selected, cancelled'
+          $stderr.puts 'No file selected, cancelled'
           Process.exit 1
         end
 
@@ -69,17 +69,17 @@ module NA
 
       File.open(file, 'w') { |f| f.puts content }
 
-      puts NA::Color.template("{by}Task added to {bw}#{file}{x}")
+      $stderr.puts NA::Color.template("{by}Task added to {bw}#{file}{x}")
     end
 
-    def output_actions(actions, depth, extension, files: nil)
+    def output_actions(actions, depth, files: nil)
       template = if files&.count.positive?
                    if files.count == 1
                      '%parent%action'
                    else
                      '%filename%parent%action'
                    end
-                 elsif NA.find_files(depth: depth, extension: extension).count > 1
+                 elsif NA.find_files(depth: depth).count > 1
                    if depth > 1
                      '%filename%parent%action'
                    else
@@ -89,13 +89,13 @@ module NA
                    '%parent%action'
                  end
       if files && @verbose
-        puts files.map { |f| NA::Color.template("{dw}#{f}{x}") }
+        $stderr.puts files.map { |f| NA::Color.template("{dw}#{f}{x}") }
       end
 
       puts actions.map { |action| action.pretty(template: { output: template }) }
     end
 
-    def parse_actions(depth: 1, extension: 'taskpaper', na_tag: 'na', query: nil, tag: nil, search: nil)
+    def parse_actions(depth: 1, query: nil, tag: nil, search: nil)
       actions = []
       required = []
       optional = []
@@ -122,10 +122,10 @@ module NA
         end
       end
 
-      na_tag = "@#{na_tag.sub(/^@/, '')}"
+      na_tag = "@#{NA.na_tag.sub(/^@/, '')}"
 
       if query.nil?
-        files = find_files(depth: depth, extension: extension)
+        files = find_files(depth: depth)
       else
         files = match_working_dir(query)
       end
@@ -156,8 +156,8 @@ module NA
 
             end
 
-            action = line.sub(/^[ \t]*- /, '').sub(/ #{na_tag}/, '')
-            new_action = NA::Action.new(file, File.basename(file, ".#{extension}"), parent.dup, action)
+            action = line.sub(/^[ \t]*- /, '').sub(/ #{NA.na_tag}/, '')
+            new_action = NA::Action.new(file, File.basename(file, ".#{NA.extension}"), parent.dup, action)
             actions.push(new_action)
           end
         end
@@ -220,7 +220,7 @@ module NA
         dirs.delete_if { |d| !d.matches(any: optional, all: required) }
         dirs.sort.uniq
       else
-        puts NA::Color.template('{r}No na database found{x}')
+        $stderr.puts NA::Color.template('{r}No na database found{x}')
         Process.exit 1
       end
     end
@@ -269,7 +269,7 @@ module NA
         if 'xdg-open'.available?
           `xdg-open #{Shellwords.escape(file)}`
         else
-          puts NA::Color.template('{r}Unable to determine executable for `open`.{x}')
+          $stderr.puts NA::Color.template('{r}Unable to determine executable for `open`.{x}')
         end
       end
     end

data/lib/na/prompt.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module NA
+  # Prompt Hooks
+  module Prompt
+    class << self
+      def prompt_hook(shell)
+        case shell
+        when :zsh
+          <<~EOHOOK
+            # zsh prompt hook for na
+            chpwd() { na }
+          EOHOOK
+        when :fish
+          <<~EOHOOK
+            # Fish Prompt Command
+            function __should_na --on-variable PWD
+              test -s (basename $PWD)".#{NA.extension}" && na
+            end
+          EOHOOK
+        when :bash
+          <<~EOHOOK
+            # Bash PROMPT_COMMAND for na
+            last_command_was_cd() {
+              [[ $(history 1|sed -e "s/^[ ]*[0-9]*[ ]*//") =~ ^((cd|z|j|jump|g|f|pushd|popd|exit)([ ]|$)) ]] && na
+            }
+            if [[ -z "$PROMPT_COMMAND" ]]; then
+              PROMPT_COMMAND="eval 'last_command_was_cd'"
+            else
+              echo $PROMPT_COMMAND | grep -v -q "last_command_was_cd" && PROMPT_COMMAND="$PROMPT_COMMAND;"'eval "last_command_was_cd"'
+            fi
+          EOHOOK
+        end
+      end
+
+      def prompt_file(shell)
+        files = {
+          zsh: '~/.zshrc',
+          fish: '~/.config/fish/conf.d/na.fish',
+          bash: '~/.bash_profile'
+        }
+
+        files[shell]
+      end
+
+      def show_prompt_hook(shell)
+        file = prompt_file(shell)
+
+        $stderr.puts NA::Color.template("{bw}# Add this to {y}#{file}{x}")
+        puts prompt_hook(shell)
+      end
+
+      def install_prompt_hook(shell)
+        file = prompt_file(shell)
+
+        File.open(File.expand_path(file), 'a') { |f| f.puts prompt_hook(shell) }
+        $stderr.puts NA::Color.template("{y}Added {bw}#{shell}{xy} prompt hook to {bw}#{file}{x}")
+      end
+    end
+  end
+end

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

data/lib/na.rb

@@ -11,3 +11,4 @@ require 'na/colors.rb'
 require 'na/string.rb'
 require 'na/action.rb'
 require 'na/next_action.rb'
+require 'na/prompt.rb'

data/src/README.md

@@ -9,7 +9,7 @@
 _If you're one of the rare people like me who find this useful, feel free to
 [buy me some coffee][donate]._
 
-The current version of `na` is <!--VER-->1.0.4<!--END VER-->.
+The current version of `na` is <!--VER-->1.0.5<!--END VER-->.
 
 `na` ("next action") is a command line tool designed to make it easy to see what your next actions are for any project, right from the command line. It works with TaskPaper-formatted files (but any plain text format will do), looking for `@na` tags (or whatever you specify) in todo files in your current folder. 
 
@@ -293,7 +293,6 @@ Fish (in ~/.config/fish/conf.d/*.fish):
 
 ```fish
 function __should_na --on-variable PWD
-	# function __should_na --on-event fish_prompt
 	test -s (basename $PWD)".taskpaper" && na
 end
 ```

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Brett Terpstra
@@ -170,6 +170,7 @@ files:
 - lib/na/action.rb
 - lib/na/colors.rb
 - lib/na/next_action.rb
+- lib/na/prompt.rb
 - lib/na/string.rb
 - lib/na/version.rb
 - na.gemspec