doing 2.1.30 → 2.1.34

data/doing.rdoc

@@ -5,7 +5,7 @@ record of what you've been doing, complete with tag-based time tracking. The
 command line tool allows you to add entries, annotate with tags and notes, and
 view your entries with myriad options, with a focus on a "natural" language syntax.
 
-v2.1.30
+v2.1.34
 
 === Global Options
 === --config_file arg
@@ -83,10 +83,6 @@ Answer all yes/no menus with yes
 
 
 === Commands
-==== Command: <tt>add_section  SECTION_NAME</tt>
-Add a new section to the "doing" file
-
-
 ==== Command: <tt>again|resume </tt>
 Repeat last entry as new entry
 
@@ -506,26 +502,42 @@ Disable Doing commands
 
 [Default Command] add
 ==== Command: <tt>completion </tt>
-Generate shell completion scripts
+Generate shell completion scripts for doing
 
 Generates the necessary scripts to add command line completion to various shells,
 so typing 'doing' and hitting tab will offer completions of subcommands and their options.
 ===== Options
-===== -f|--file PATH
+===== -t|--type arg
 
-File to write output to
+Deprecated, specify shell as argument to subcommand
 
-[Default Value] STDOUT
+[Default Value] None
+[Must Match] (?i-mx:^(?:[bzf](?:[ai]?sh)?|all)$)
 
 
-===== -t|--type SHELL
+===== Commands
+====== Command: <tt>generate  [zsh|bash|fish|all]</tt>
+Generate completion scripts, including custom plugins and command options
 
-Shell to generate for (bash, zsh, fish)
+Argument specifies which shell to install for: zsh, bash, fish, all
+======= Options
+======= -f|--file PATH
+
+Alternative file to write output to
+
+[Default Value] None
+Argument specifies which shell to install for: zsh, bash, fish, all
+
+======= --stdout
+Output result to STDOUT only
 
-[Default Value] zsh
-[Must Match] (?i-mx:^(?:[bzf](?:[ai]?sh)?|all)$)
 
 
+====== Command: <tt>install  [zsh|bash|fish]</tt>
+Install default completion scripts
+
+Argument specifies which shell to install for: zsh, bash, fish, or all
+[Default Command] generate
 ==== Command: <tt>config </tt>
 Edit the configuration file or output a value from it
 
@@ -576,8 +588,8 @@ Editor to use
 [Default Value] None
 
 
-======= -x|--[no-]default
-Use the config_editor_app defined in ~/.config/doing/config.yml (config_editor_app not set)
+======= -x|--default
+Use the config editor defined in ~/.config/doing/config.yml (Sublime Text)
 
 
 
@@ -604,6 +616,11 @@ Set a key's value in the config file
 
 
 ======= Options
+======= --local
+Force update to .doingrc in the current directory
+
+
+
 ======= -r|--remove
 Delete specified key
 
@@ -646,7 +663,7 @@ Start and end times as a date/time range `doing done --from "1am to 8am"`.
         Overrides other date flags.
 
 [Default Value] None
-[Must Match] (?i-mx:^\S+ +(?:to|through|thru|(?:un)?til|-+) ++\S+)
+[Must Match] (?i-mx:^\S+.*? +(?:to|through|thru|(?:un)?til|-+) +\S+.*?$)
 
 
 ===== -n|--note TEXT
@@ -852,7 +869,7 @@ Search entries older than date (natural language). If this is only a time (8am,
 
 ===== --bool BOOLEAN
 
-Combine multiple tags or value queries using AND, OR, or NOT
+Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans
 
 [Default Value] pattern
 [Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$)
@@ -898,6 +915,21 @@ Section
 [Default Value] All
 
 
+===== --tag TAG
+
+Filter entries by tag. Combine multiple tags with a comma. Wildcards allowed (*, ?)
+
+[Default Value] None
+
+
+===== --tag_order DIRECTION
+
+Tag sort direction (asc|desc)
+
+[Default Value] asc
+[Must Match] (?i-mx:^(?:a(?:sc)?|d(?:esc)?)$)
+
+
 ===== --tag_sort KEY
 
 Sort tags by (name|time)
@@ -915,7 +947,8 @@ Override output format with a template string containing %placeholders
 
 ===== --val QUERY
 
-Perform a tag value query ("@done > two hours ago" or "@progress < 50"). May be used multiple times, combined with --bool
+Perform a tag value query ("@done > two hours ago" or "@progress < 50").
+            May be used multiple times, combined with --bool
 
 [Default Value] None
 [Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$)
@@ -947,7 +980,7 @@ Display an interactive menu of results to perform further operations
 
 
 ===== --not
-Show items that *don't* match search string
+Search items that *don't* match search/tag filters
 
 
 
@@ -962,7 +995,7 @@ Show time intervals on @done tasks
 
 
 ===== --totals
-Show intervals with totals at the end of output
+Show time totals at the end of output
 
 
 
@@ -1476,6 +1509,36 @@ Date argument can be natural language. "thursday" would be interpreted as "last
 and "2d" would be interpreted as "two days ago." If you use "to" or "through" between two dates,
 it will create a range.
 ===== Options
+===== --after TIME_STRING
+
+View entries after specified time (e.g. 8am, 12:30pm, 15:00)
+
+[Default Value] None
+
+
+===== --before TIME_STRING
+
+View entries before specified time (e.g. 8am, 12:30pm, 15:00)
+
+[Default Value] None
+
+
+===== --bool BOOLEAN
+
+Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans
+
+[Default Value] pattern
+[Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$)
+
+
+===== --case TYPE
+
+Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]
+
+[Default Value] smart
+[Must Match] (?i-mx:^[cis].*?$)
+
+
 ===== --config_template TEMPLATE_KEY
 
 Output using a template from configuration
@@ -1483,6 +1546,14 @@ Output using a template from configuration
 [Default Value] default
 
 
+===== --from TIME_RANGE
+
+Time range to show `doing on --from "12pm to 4pm"`
+
+[Default Value] None
+[Must Match] (?i-mx:^(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon)(?: +(?:to|through|thru|(?:un)?til|-+) +(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon))?$)
+
+
 ===== -o|--output FORMAT
 
 Output to export format (csv|dayone|dayone-days|dayone-entries|doing|html|json|markdown|say|taskpaper|template|timeline|wiki)
@@ -1497,6 +1568,29 @@ Section
 [Default Value] All
 
 
+===== --search QUERY
+
+Filter entries using a search query, surround with slashes for regex (e.g. "/query.*/"),
+            start with single quote for exact match ("'query")
+
+[Default Value] None
+
+
+===== --tag TAG
+
+Filter entries by tag. Combine multiple tags with a comma. Wildcards allowed (*, ?)
+
+[Default Value] None
+
+
+===== --tag_order DIRECTION
+
+Tag sort direction (asc|desc)
+
+[Default Value] asc
+[Must Match] (?i-mx:^(?:a(?:sc)?|d(?:esc)?)$)
+
+
 ===== --tag_sort KEY
 
 Sort tags by (name|time)
@@ -1512,11 +1606,30 @@ Override output format with a template string containing %placeholders
 [Default Value] None
 
 
+===== --val QUERY
+
+Perform a tag value query ("@done > two hours ago" or "@progress < 50").
+            May be used multiple times, combined with --bool
+
+[Default Value] None
+[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$)
+
+
 ===== --[no-]duration
 Show elapsed time on entries without @done tag
 
 
 
+===== --not
+Show items that *don't* match search/tag filters
+
+
+
+===== --only_timed
+Only show items with recorded time intervals
+
+
+
 ===== -t|--[no-]times
 Show time intervals on @done tasks
 
@@ -1527,6 +1640,11 @@ Show time totals at the end of output
 
 
 
+===== -x|--exact
+Force exact search string matching (case sensitive)
+
+
+
 ==== Command: <tt>open </tt>
 Open the "doing" file in an editor
 
@@ -1595,6 +1713,14 @@ Section
 [Default Value] All
 
 
+===== --tag_order DIRECTION
+
+Tag sort direction (asc|desc)
+
+[Default Value] asc
+[Must Match] (?i-mx:^(?:a(?:sc)?|d(?:esc)?)$)
+
+
 ===== --tag_sort KEY
 
 Sort tags by (name|time)
@@ -1620,13 +1746,18 @@ Select from a menu of matching entries to perform additional operations
 
 
 
+===== --only_timed
+Only show items with recorded time intervals
+
+
+
 ===== -t|--[no-]times
 Show time intervals on @done tasks
 
 
 
 ===== --totals
-Show intervals with totals at the end of output
+Show time totals at the end of output
 
 
 
@@ -1807,15 +1938,35 @@ Force exact search string matching (case sensitive)
 
 
 ==== Command: <tt>sections </tt>
+List, add, or remove sections in the Doing file
+
+
+===== Commands
+====== Command: <tt>add  SECTION_NAME</tt>
+Add a section
+
+
+====== Command: <tt>list </tt>
 List sections
 
 
-===== Options
-===== -c|--column
+======= Options
+======= -c|--column
 List in single column
 
 
 
+====== Command: <tt>remove  SECTION_NAME</tt>
+Remove a section
+
+
+======= Options
+======= -a|--[no-]archive
+Archive entries in section before deleting. --no-archive permanently deletes section contents
+
+
+
+[Default Command] list
 ==== Command: <tt>select </tt>
 Display an interactive menu to perform operations
 
@@ -2163,7 +2314,7 @@ Show time intervals on @done tasks
 
 
 ===== --totals
-Show intervals with totals at the end of output
+Show time totals at the end of output
 
 
 
@@ -2178,6 +2329,22 @@ List entries since a date
 Date argument can be natural language and are always interpreted as being in the past. "thursday" would be interpreted as "last thursday,"
 and "2d" would be interpreted as "two days ago."
 ===== Options
+===== --bool BOOLEAN
+
+Boolean used to combine multiple tags. Use PATTERN to parse + and - as booleans
+
+[Default Value] pattern
+[Must Match] (?i-mx:^(?:and|all|any|or|not|none|p(?:at(?:tern)?)?)$)
+
+
+===== --case TYPE
+
+Case sensitivity for search string matching [(c)ase-sensitive, (i)gnore, (s)mart]
+
+[Default Value] smart
+[Must Match] (?i-mx:^[cis].*?$)
+
+
 ===== --config_template TEMPLATE_KEY
 
 Output using a template from configuration
@@ -2199,6 +2366,29 @@ Section
 [Default Value] All
 
 
+===== --search QUERY
+
+Filter entries using a search query, surround with slashes for regex (e.g. "/query.*/"),
+            start with single quote for exact match ("'query")
+
+[Default Value] None
+
+
+===== --tag TAG
+
+Filter entries by tag. Combine multiple tags with a comma. Wildcards allowed (*, ?)
+
+[Default Value] None
+
+
+===== --tag_order DIRECTION
+
+Tag sort direction (asc|desc)
+
+[Default Value] asc
+[Must Match] (?i-mx:^(?:a(?:sc)?|d(?:esc)?)$)
+
+
 ===== --tag_sort KEY
 
 Sort tags by (name|time)
@@ -2214,11 +2404,30 @@ Override output format with a template string containing %placeholders
 [Default Value] None
 
 
+===== --val QUERY
+
+Perform a tag value query ("@done > two hours ago" or "@progress < 50").
+            May be used multiple times, combined with --bool
+
+[Default Value] None
+[Must Match] (?-mix:^(?:!)?@?(?:\S+) +(?:!?[<>=][=*]?|[$*^]=) +(?:.*?)$)
+
+
 ===== --[no-]duration
 Show elapsed time on entries without @done tag
 
 
 
+===== --not
+Since items that *don't* match search/tag filters
+
+
+
+===== --only_timed
+Only show items with recorded time intervals
+
+
+
 ===== -t|--[no-]times
 Show time intervals on @done tasks
 
@@ -2229,6 +2438,11 @@ Show time totals at the end of output
 
 
 
+===== -x|--exact
+Force exact search string matching (case sensitive)
+
+
+
 ==== Command: <tt>tag  TAG...</tt>
 Add tag(s) to last entry
 
@@ -2529,6 +2743,7 @@ Output using a template from configuration
 Time range to show `doing today --from "12pm to 4pm"`
 
 [Default Value] None
+[Must Match] (?i-mx:^(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon)(?: +(?:to|through|thru|(?:un)?til|-+) +(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon))?$)
 
 
 ===== -o|--output FORMAT
@@ -2545,6 +2760,14 @@ Specify a section
 [Default Value] All
 
 
+===== --tag_order DIRECTION
+
+Tag sort direction (asc|desc)
+
+[Default Value] asc
+[Must Match] (?i-mx:^(?:a(?:sc)?|d(?:esc)?)$)
+
+
 ===== --tag_sort KEY
 
 Sort tags by (name|time)
@@ -2565,6 +2788,11 @@ Show elapsed time on entries without @done tag
 
 
 
+===== --only_timed
+Only show items with recorded time intervals
+
+
+
 ===== -t|--[no-]times
 Show time intervals on @done tasks
 
@@ -2871,10 +3099,10 @@ Output using a template from configuration
 
 ===== --from TIME_RANGE
 
-Time range to show, e.g. `doing yesterday --from "1am to 8am"`
+Time range to show `doing yesterday --from "12pm to 4pm"`
 
 [Default Value] None
-[Must Match] (?i-mx:^(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon) +(?:to|through|thru|(?:un)?til|-+) +(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon)$)
+[Must Match] (?i-mx:^(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon)(?: +(?:to|through|thru|(?:un)?til|-+) +(?:\d{1,2}+(?::\d{1,2}+)?(?: *(?:am|pm))?|midnight|noon))?$)
 
 
 ===== -o|--output FORMAT
@@ -2919,6 +3147,11 @@ Show elapsed time on entries without @done tag
 
 
 
+===== --only_timed
+Only show items with recorded time intervals
+
+
+
 ===== -t|--[no-]times
 Show time intervals on @done tasks
 

data/example_plugin.rb

@@ -54,7 +54,7 @@ module Doing
     ##   automatically be added for the user to override
     ##   The config key will be available at:
     ##
-    ##       wwid.config['export_templates'][PLUGIN_NAME]
+    ##       Doing.config.settings['export_templates'][PLUGIN_NAME]
     ##
     ## config:    (optional) A Hash which will be
     ## added to the main configuration in the plugins section.
@@ -65,7 +65,7 @@ module Doing
     ##
     ##   The configuration keys will be available at:
     ##
-    ##      wwid.config['plugins'][PLUGIN_NAME][KEY]
+    ##      Doing.config.settings['plugins'][PLUGIN_NAME][KEY]
     ##
     ## Method to return plugin settings (required)
     ##
@@ -125,6 +125,8 @@ module Doing
     def self.render(wwid, items, variables: {})
       return unless items.good?
 
+      config = Doing.config.settings
+
       # the :options key includes the flags passed to the
       # command that called the plugin use `puts
       # variables.inspect` to see properties and methods
@@ -162,8 +164,8 @@ module Doing
       title = i.title.gsub(/@/, 'hashtag ')
       tpl = template('say')
 
-      if wwid.config['export_templates'].key?('say')
-        cfg_tpl = wwid.config['export_templates']['say']
+      if config['export_templates'].key?('say')
+        cfg_tpl = config['export_templates']['say']
         tpl = cfg_tpl if cfg_tpl.good?
       end
       output = tpl.dup
@@ -188,7 +190,7 @@ module Doing
       Doing.logger.info('Spoke the last entry. Did you hear it?')
 
       # This export runs a command for fun, most plugins won't
-      voice = wwid.config['plugins']['say']['say_voice'] || 'Alex'
+      voice = config['plugins']['say']['say_voice'] || 'Alex'
       `say -v "#{voice}" "#{output}"`
 
       # Return the result (don't output to terminal with puts or print)

data/inputrc

@@ -0,0 +1,57 @@
+"\e[3~": delete-char
+"\ex": 'cd !$ \015ls\015'
+"\ez": 'cd -\015'
+"\e\C-m": '\C-a "$(\C-e|fzf)"\C-a'
+"\e/": '"$(!!|fzf)"\C-a \C-m\C-m'
+# these allow you to use alt+left/right arrow keys
+# to jump the cursor over words
+"\e[1;5C": forward-word
+"\e[1;5D": backward-word
+# "\e[D": backward-word
+# "\e[C": forward-word
+"\ea": menu-complete
+# TAB: menu-complete
+# "\e[Z": "\e-1\C-i"
+
+"\e\C-l": history-and-alias-expand-line
+
+# these allow you to start typing a command and
+# use the up/down arrow to auto complete from
+# commands in your history
+"\e[B": history-search-forward
+"\e[A": history-search-backward
+"\ew": history-search-backward
+"\es": history-search-forward
+# this lets you hit tab to auto-complete a file or
+# directory name ignoring case
+set completion-ignore-case On
+set mark-symlinked-directories On
+set completion-prefix-display-length 2
+set bell-style none
+# set bell-style visible
+set meta-flag on
+set convert-meta off
+set input-meta on
+set output-meta on
+set show-all-if-ambiguous on
+set show-all-if-unmodified on
+set completion-map-case on
+set visible-stats on
+
+# Do history expansion when space entered?
+$if bash
+	Space: magic-space
+$endif
+
+# Show extra file information when completing, like `ls -F` does
+set visible-stats on
+
+# Be more intelligent when autocompleting by also looking at the text after
+# the cursor. For example, when the current line is "cd ~/src/mozil", and
+# the cursor is on the "z", pressing Tab will not autocomplete it to "cd
+# ~/src/mozillail", but to "cd ~/src/mozilla". (This is supported by the
+# Readline used by Bash 4.)
+set skip-completed-text on
+
+# Use Alt/Meta + Delete to delete the preceding word
+"\e[3;3~": kill-word