na 1.2.20 → 1.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20a02c7a0e5644aa0aef147e434a8d6dc9daa1705a50e9563255a7c2f6688267
-  data.tar.gz: a097a253c572eb83c2fd74b6ba978fbbe5f328d804cdd309af6a6e66e682d384
+  metadata.gz: ccb815bfd051b4cd15b198c14ff1bb1efcde847005d88aa4322d88aec4ac8d72
+  data.tar.gz: 75ce04d2a86f842668118e5e58497627c5616618479b7838f4f6fcd34baf910a
 SHA512:
-  metadata.gz: 33c341298f6c7855dce8541f185aa46bf2d7d08cb5f97d709fda5fe1e0cf1537cec96297c80a88b1e69fb9089c7d15219d943dc4704a3fcca60be58b0e430ff6
-  data.tar.gz: 3c000719d4b5d7d2f6713c1865cdcc713878eac017379e40fffc98199843abbb23c4517b0a621ed80ae1b7d8a11d35633f820c48c38c8261ff833d39e23ae675
+  metadata.gz: 2cee616b47b7ee5918d9062a48f38ff45ec4ee6a20fe3027b31c778d4fe7d08881ac5138498cc02b1e66c691c925a35f8b3d72a1ca23d034b48853ad7ac87540
+  data.tar.gz: d262fb01720b1b9daa30c26b75ef1771e047ba8879cc04ca66be6076a7c99aa143ed3d2a0b254785bee0c0f95fa76ab0cbf282199dc3fd0867c1ec12edc81df2

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### 1.2.22
+
+2023-06-05 10:35
+
+#### NEW
+
+- Global `--template PATH` option to define a template for new files, can be added to .na.rc
+
+#### IMPROVED
+
+- Help verbiage and examples
+
+#### FIXED
+
+- Variable assignment warnings
+
 ### 1.2.20
 
 2023-05-09 10:40

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    na (1.2.20)
+    na (1.2.22)
       chronic (~> 0.10, >= 0.10.2)
       gli (~> 2.21.0)
       mdless (~> 1.0, >= 1.0.32)
@@ -33,6 +33,7 @@ GEM
 PLATFORMS
   arm64-darwin-20
   arm64-darwin-21
+  x86_64-darwin-20
 
 DEPENDENCIES
   minitest (~> 5.14)

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.2.20
+The current version of `na` is 1.2.22
 .
 
 `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. 
@@ -77,13 +77,14 @@ SYNOPSIS
     na [global options] command [command options] [arguments...]
 
 VERSION
-    1.2.20
+    1.2.22
 
 GLOBAL OPTIONS
-    -a, --[no-]add          - Add a next action (deprecated, for backwards compatibility)
+    -a, --add               - Add a next action (deprecated, for backwards compatibility)
     --add_at=POSITION       - Add all new/moved entries at [s]tart or [e]nd of target project (default: start)
+    --[no-]color            - Colorize output (default: enabled)
     --cwd_as=TYPE           - Use current working directory as [p]roject, [t]ag, or [n]one (default: none)
-    -d, --depth=DEPTH       - Recurse to depth (default: 3)
+    -d, --depth=DEPTH       - Recurse to depth (default: 1)
     --[no-]debug            - Display verbose output
     --ext=EXT               - File extension to consider a todo file (default: taskpaper)
     -f, --file=PATH         - Use a single file as global todo, use --initconfig to make permanent (default: none)
@@ -92,6 +93,7 @@ GLOBAL OPTIONS
     -p, --priority=PRIORITY - Set a priority 0-5 (deprecated, for backwards compatibility) (default: none)
     -r, --[no-]recurse      - Recurse 3 directories deep (deprecated, for backwards compatability)
     -t, --na_tag=TAG        - Tag to consider a next action (default: na)
+    --template=PATH         - Provide a template for new/blank todo files, use --initconfig to make permanent (default: none)
     --version               - Display the program version
 
 COMMANDS
@@ -203,17 +205,17 @@ SYNOPSIS
     na [global options] find [command options] PATTERN
 
 DESCRIPTION
-    Search tokens are separated by spaces. Actions matching all tokens in the pattern will be shown   (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe` 
+    Search tokens are separated by spaces. Actions matching all tokens in the pattern will be shown   (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`,   add a - or ! to ignore matches containing that token. 
 
 COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: none)
     --[no-]done                            - Include @done actions
     -e, --regex                            - Interpret search pattern as regular expression
     --in=TODO_PATH                         - Show actions from a specific todo file in history. May use wildcards (* and ?) (default: none)
-    --[no-]nest                            - Output actions nested by file
+    --nest                                 - Output actions nested by file
     --[no-]notes                           - Include notes in output
     -o, --or                               - Combine search tokens with OR, displaying actions matching ANY of the terms
-    --[no-]omnifocus                       - Output actions nested by file and project
+    --omnifocus                            - Output actions nested by file and project
     --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
     --save=TITLE                           - Save this search for future use (default: none)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
@@ -225,6 +227,9 @@ EXAMPLES
     # Find all actions containing feature, idea, and swift
     na find feature idea swift
 
+    # Find all actions containing feature and idea but NOT swift
+    na find feature idea -swift
+
     # Find all actions containing the exact text "feature idea"
     na find -x feature idea
 ```
@@ -272,13 +277,13 @@ DESCRIPTION
 COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: none)
     --[no-]done                            - Include @done actions
-    --[no-]exact                           - Search query is exact text match (not tokens)
+    --exact                                - Search query is exact text match (not tokens)
     --in, --todo=TODO_FILE                 - Display matches from a known todo file (may be used more than once, default: none)
-    --[no-]nest                            - Output actions nested by file
+    --nest                                 - Output actions nested by file
     --[no-]notes                           - Include notes in output
-    --[no-]omnifocus                       - Output actions nested by file and project
+    --omnifocus                            - Output actions nested by file and project
     --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
-    --[no-]regex                           - Search query is regular expression
+    --regex                                - Search query is regular expression
     --search=QUERY                         - Filter results using search terms (may be used more than once, default: none)
     -t, --tag=TAG                          - Alternate tag to search for (default: none)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)
@@ -338,8 +343,8 @@ DESCRIPTION
     Run without argument to list saved searches 
 
 COMMAND OPTIONS
-    -d, --[no-]delete - Delete the specified search definition
-    -e, --[no-]edit   - Open the saved search file in $EDITOR
+    -d, --delete - Delete the specified search definition
+    -e, --edit   - Open the saved search file in $EDITOR
 
 EXAMPLES
 
@@ -378,13 +383,13 @@ DESCRIPTION
 COMMAND OPTIONS
     -d, --depth=DEPTH                      - Recurse to depth (default: none)
     --[no-]done                            - Include @done actions
-    --[no-]exact                           - Search query is exact text match (not tokens)
+    --exact                                - Search query is exact text match (not tokens)
     --in, --todo=TODO_FILE                 - Display matches from a known todo file (may be used more than once, default: none)
-    --[no-]nest                            - Output actions nested by file
+    --nest                                 - Output actions nested by file
     --[no-]notes                           - Include notes in output
-    --[no-]omnifocus                       - Output actions nested by file and project
+    --omnifocus                            - Output actions nested by file and project
     --proj, --project=PROJECT[/SUBPROJECT] - Show actions from a specific project (default: none)
-    --[no-]regex                           - Search query is regular expression
+    --regex                                - Search query is regular expression
     --search=QUERY                         - Filter results using search terms (may be used more than once, default: none)
     -t, --tag=TAG                          - Alternate tag to search for (default: none)
     --tagged=TAG                           - Match actions containing tag. Allows value comparisons (may be used more than once, default: none)

data/bin/na

@@ -34,7 +34,10 @@ class App
   NA::Color.coloring = $stdin.isatty
 
   desc 'Add a next action (deprecated, for backwards compatibility)'
-  switch %i[a add]
+  switch %i[a add], negatable: false
+
+  desc 'Colorize output'
+  switch %i[color], negatable: true, default_value: true
 
   desc 'Set a priority 0-5 (deprecated, for backwards compatibility)'
   arg_name 'PRIORITY'
@@ -44,6 +47,10 @@ class App
   arg_name 'PATH'
   flag %i[f file]
 
+  desc 'Provide a template for new/blank todo files, use --initconfig to make permanent'
+  arg_name 'PATH'
+  flag %[template]
+
   desc 'Use current working directory as [p]roject, [t]ag, or [n]one'
   arg_name 'TYPE'
   flag %i[cwd_as], must_match: /^[ptn].*?$/i, default_value: 'none'
@@ -104,10 +111,10 @@ class App
     c.flag %i[search], multiple: true
 
     c.desc 'Search query is regular expression'
-    c.switch %i[regex]
+    c.switch %i[regex], negatable: false
 
     c.desc 'Search query is exact text match (not tokens)'
-    c.switch %i[exact]
+    c.switch %i[exact], negatable: false
 
     c.desc 'Include notes in output'
     c.switch %i[notes], negatable: true, default_value: false
@@ -116,10 +123,10 @@ class App
     c.switch %i[done]
 
     c.desc 'Output actions nested by file'
-    c.switch %[nest]
+    c.switch %[nest], negatable: false
 
     c.desc 'Output actions nested by file and project'
-    c.switch %[omnifocus]
+    c.switch %[omnifocus], negatable: false
 
     c.action do |global_options, options, args|
       if global_options[:add]
@@ -248,7 +255,7 @@ class App
     c.flag %i[t tag]
 
     c.desc 'Don\'t add next action tag to new entry'
-    c.switch %i[x]
+    c.switch %i[x], negatable: false
 
     c.desc 'Specify the file to which the task should be added'
     c.arg_name 'PATH'
@@ -616,10 +623,12 @@ class App
 
   desc 'Find actions matching a search pattern'
   long_desc 'Search tokens are separated by spaces. Actions matching all tokens in the pattern will be shown
-  (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`'
+  (partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`,
+  add a - or ! to ignore matches containing that token.'
   arg_name 'PATTERN'
   command %i[find grep] do |c|
     c.example 'na find feature idea swift', desc: 'Find all actions containing feature, idea, and swift'
+    c.example 'na find feature idea -swift', desc: 'Find all actions containing feature and idea but NOT swift'
     c.example 'na find -x feature idea', desc: 'Find all actions containing the exact text "feature idea"'
 
     c.desc 'Interpret search pattern as regular expression'
@@ -661,10 +670,10 @@ class App
     c.flag %i[save]
 
     c.desc 'Output actions nested by file'
-    c.switch %[nest]
+    c.switch %[nest], negatable: false
 
     c.desc 'Output actions nested by file and project'
-    c.switch %[omnifocus]
+    c.switch %[omnifocus], negatable: false
 
     c.action do |global_options, options, args|
       options[:nest] = true if options[:omnifocus]
@@ -785,10 +794,10 @@ class App
     c.flag %i[search], multiple: true
 
     c.desc 'Search query is regular expression'
-    c.switch %i[regex]
+    c.switch %i[regex], negatable: false
 
     c.desc 'Search query is exact text match (not tokens)'
-    c.switch %i[exact]
+    c.switch %i[exact], negatable: false
 
     c.desc 'Include @done actions'
     c.switch %i[done]
@@ -801,10 +810,10 @@ class App
     c.flag %i[save]
 
     c.desc 'Output actions nested by file'
-    c.switch %[nest]
+    c.switch %[nest], negatable: false
 
     c.desc 'Output actions nested by file and project'
-    c.switch %[omnifocus]
+    c.switch %[omnifocus], negatable: false
 
     c.action do |global_options, options, args|
       options[:nest] = true if options[:omnifocus]
@@ -1095,16 +1104,16 @@ class App
     c.example 'na tagged "+maybe,+priority<=3" --save maybelater', description: 'save a search called "maybelater"'
     c.example 'na saved maybelater', description: 'perform the search named "maybelater"'
     c.example 'na saved maybe',
-              description: 'perform the search named "maybelater", assuming no other searches match "may"'
+              description: 'perform the search named "maybelater", assuming no other searches match "maybe"'
     c.example 'na maybe',
               description: 'na run with no command and a single argument automatically performs a matching saved search'
     c.example 'na saved', description: 'list available searches'
 
     c.desc 'Open the saved search file in $EDITOR'
-    c.switch %i[e edit]
+    c.switch %i[e edit], negatable: false
 
     c.desc 'Delete the specified search definition'
-    c.switch %i[d delete]
+    c.switch %i[d delete], negatable: false
 
     c.action do |_global_options, options, args|
       NA.edit_searches if options[:edit]
@@ -1128,6 +1137,7 @@ class App
 
   pre do |global, _command, _options, _args|
     NA.verbose = global[:debug]
+    NA::Color.coloring = global[:color]
     NA.extension = global[:ext]
     NA.na_tag = global[:na_tag]
     NA.global_file = global[:file]

data/lib/na/action.rb

@@ -24,7 +24,7 @@ module NA
              else
                ''
              end
-      "(#{@file}:#{@line}) #{@project}:#{@parent.join('>')} | #{@action}#{@note}"
+      "(#{@file}:#{@line}) #{@project}:#{@parent.join('>')} | #{@action}#{note}"
     end
 
     def inspect

data/lib/na/colors.rb

@@ -226,6 +226,7 @@ module NA
       ##
       def template(input)
         input = input.join(' ') if input.is_a? Array
+        return input.gsub(/(?<!\\)\{(\w+)\}/i, '') unless NA::Color.coloring?
 
         fmt = input.gsub(/%/, '%%')
         fmt = fmt.gsub(/(?<!\\)\{(\w+)\}/i) do
@@ -305,7 +306,7 @@ module NA
       %w[r g b].each do |e|
         t << parts[e].hex
       end
-      color =
+
       "\e[#{is_bg ? '48' : '38'};2;#{t.join(';')}m"
     end
 

data/lib/na/next_action.rb

@@ -72,21 +72,25 @@ module NA
     ## @param      target    [String] The target path
     ## @param      basename  [String] The project base name
     ##
-    def create_todo(target, basename)
+    def create_todo(target, basename, template: nil)
       File.open(target, 'w') do |f|
-        content = <<~ENDCONTENT
-          Inbox:
-          #{basename}:
-          \tFeature Requests:
-          \tIdeas:
-          \tBugs:
-          Archive:
-          Search Definitions:
-          \tTop Priority @search(@priority = 5 and not @done)
-          \tHigh Priority @search(@priority > 3 and not @done)
-          \tMaybe @search(@maybe)
-          \tNext @search(@#{NA.na_tag} and not @done and not project = \"Archive\")
-        ENDCONTENT
+        if template && File.exist?(template)
+          content = IO.read(template)
+        else
+          content = <<~ENDCONTENT
+            Inbox:
+            #{basename}:
+            \tFeature Requests:
+            \tIdeas:
+            \tBugs:
+            Archive:
+            Search Definitions:
+            \tTop Priority @search(@priority = 5 and not @done)
+            \tHigh Priority @search(@priority > 3 and not @done)
+            \tMaybe @search(@maybe)
+            \tNext @search(@#{NA.na_tag} and not @done and not project = \"Archive\")
+          ENDCONTENT
+        end
         f.puts(content)
       end
       save_working_dir(target)
@@ -600,7 +604,6 @@ module NA
         content = file.read_file
         indent_level = 0
         parent = []
-        last_line = 0
         in_action = false
         content.split("\n").each.with_index do |line, idx|
           if line.project?

data/lib/na/version.rb

@@ -1,3 +1,3 @@
 module Na
-  VERSION = '1.2.20'
+  VERSION = '1.2.22'
 end

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.2.19<!--END VER-->.
+The current version of `na` is <!--VER-->1.2.21<!--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. 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: na
 version: !ruby/object:Gem::Version
-  version: 1.2.20
+  version: 1.2.22
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-09 00:00:00.000000000 Z
+date: 2023-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -246,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: A command line tool for adding and listing project todos