Add find utility method for searching for issues among multiple issue states.

- We now always protect the left margin when printing task details
  (including tags) to make it easier to skim down that line.
- Also made the actual summary always follow immediately after the ID,
  to align to that skimmable line.
- Moved the information about the delegatee to the end of the summary,
  next to the tags, and changed the color of the delegatee to make it
  easier to distinguish.
- Added the `-G` option, to allow filtering out issues matching any of
  the provided tags.
- We now allow options to be passed to both the `delegate` and `help`
  command. Any options are ignored, but this allows the use of tools
  like `cmd_shell` which always wrap commands with the pre-given
  options.

pit.nimble

@@ -1,24 +1,28 @@
 # Package
 
-version       = "4.20.0"
+version       = "4.22.1"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"
 srcDir        = "src"
+installExt    = @["nim"]
 bin           = @["pit", "pit_api"]
 
 # Dependencies
 
 requires @[
   "nim >= 1.4.0",
-  "docopt 0.6.8",
-  "jester 0.5.0",
-  "uuids 0.1.10",
+  "docopt >= 0.6.8",
+  "jester >= 0.5.0",
+  "uuids >= 0.1.10"
+]
 
-  "https://git.jdb-software.com/jdb/nim-cli-utils.git >= 0.6.4",
-  "https://git.jdb-software.com/jdb/nim-lang-utils.git >= 0.4.0",
-  "https://git.jdb-software.com/jdb/nim-time-utils.git >= 0.4.0",
-  "https://git.jdb-software.com/jdb/nim-data-uri.git >= 1.0.0",
+# Dependencies from git.jdb-software.com/nim-jdb/packages
+requires @[
+  "cliutils >= 0.6.4",
+  "langutils >= 0.4.0",
+  "timeutils >= 0.4.0",
+  "data_uri > 1.0.0",
   "https://git.jdb-software.com/jdb/update-nim-package-version >= 0.2.0"
 ]
 

src/pit.nim

@@ -1,8 +1,9 @@
 ## Personal Issue Tracker CLI interface
 ## ====================================
 
-import algorithm, cliutils, data_uri, docopt, json, logging, options, os,
-  sequtils, std/wordwrap, tables, terminal, times, timeutils, unicode, uuids
+import std/algorithm, std/logging, std/options, std/os, std/sequtils,
+  std/wordwrap, std/tables, std/terminal, std/times, std/unicode
+import cliutils, data_uri, docopt, json, timeutils, uuids
 
 from nre import re
 import strutils except alignLeft, capitalize, strip, toUpper, toLower
@@ -15,7 +16,6 @@ type
     cfg*: PitConfig
     contexts*: TableRef[string, string]
     defaultContext*: Option[string]
-    tasksDir*: string
     issues*: TableRef[IssueState, seq[Issue]]
     termWidth*: int
     triggerPtk*, verbose*: bool
@@ -42,7 +42,6 @@ proc initContext(args: Table[string, Value]): CliContext =
       else: some(cliJson["defaultContext"].getStr()),
     verbose: parseBool(cliCfg.getVal("verbose", "false")) and not args["--quiet"],
     issues: newTable[IssueState, seq[Issue]](),
-    tasksDir: pitCfg.tasksDir,
     termWidth: parseInt(cliCfg.getVal("termWidth", "80")),
     triggerPtk: cliJson.getOrDefault("triggerPtk").getBool(false))
 
@@ -71,46 +70,68 @@ proc formatIssue(ctx: CliContext, issue: Issue): string =
 
   result &= termReset
 
-proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
-                verbose = false): string =
-
-  result = ""
-
-  var showDetails = not issue.details.isEmptyOrWhitespace and verbose
-
-  var prefixLen = 0
-  var summaryIndentLen = indent.len + 7
-
-  if issue.hasProp("delegated-to"): prefixLen += issue["delegated-to"].len + 2 # space for the ':' and ' '
-
-  # Wrap and write the summary.
-  var wrappedSummary = ("+".repeat(prefixLen) & issue.summary).wrapWords(width - summaryIndentLen).indent(summaryIndentLen)
-
-  wrappedSummary = wrappedSummary[(prefixLen + summaryIndentLen)..^1]
+proc formatSectionIssue(
+    ctx: CliContext,
+    issue: Issue,
+    width: int,
+    indent = "",
+    verbose = false): string =
 
   result = (indent & ($issue.id)[0..<6]).withColor(fgBlack, true) & " "
 
-  if issue.hasProp("delegated-to"):
-    result &= (issue["delegated-to"] & ": ").withColor(fgGreen)
+  let showDetails = not issue.details.isEmptyOrWhitespace and verbose
 
-  result &= wrappedSummary.withColor(fgWhite)
+  let summaryIndentLen = indent.len + 7
+  let summaryWidth = width - summaryIndentLen
+
+  let summaryLines = issue.summary
+    .wrapWords(summaryWidth)
+    .splitLines
+
+  result &= summaryLines[0].withColor(fgWhite)
+
+  for line in summaryLines[1..^1]:
+    result &= "\p" & line.indent(summaryIndentLen)
+
+  var lastLineLen = summaryLines[^1].len
+
+  if issue.hasProp("delegated-to"):
+    if lastLineLen + issue["delegated-to"].len + 1 < summaryWidth:
+      result &= " " & issue["delegated-to"].withColor(fgMagenta)
+      lastLineLen += issue["delegated-to"].len + 1
+    else:
+      result &= "\p" & issue["delegated-to"]
+        .withColor(fgMagenta)
+        .indent(summaryIndentLen)
+      lastLineLen = issue["delegated-to"].len
 
   if issue.tags.len > 0:
-    let tagsStr = "(" & issue.tags.join(", ") & ")"
-    if (result.splitLines[^1].len + tagsStr.len + 1) > (width - 2):
-      result &= "\n" & indent
-    result &= " " & tagsStr.withColor(fgGreen)
+    let tagsStrLines = ("(" & issue.tags.join(", ") & ")")
+      .wrapWords(summaryWidth)
+      .splitLines
 
+    if tagsStrLines.len == 1 and
+       (lastLineLen + tagsStrLines[0].len + 1) < summaryWidth:
+      result &= " " & tagsStrLines[0].withColor(fgGreen)
+      lastLineLen += tagsStrLines[0].len + 1
+    else:
+      result &= "\p" & tagsStrLines
+        .mapIt(it.indent(summaryIndentLen))
+        .join("\p")
+        .withColor(fgGreen)
+      lastLineLen = tagsStrLines[^1].len
 
   if issue.hasProp("pending"):
-    let startIdx = "Pending: ".len
-    var pendingText = issue["pending"].wrapWords(width - startIdx - summaryIndentLen)
-                                      .indent(startIdx)
-    pendingText = ("Pending: " & pendingText[startIdx..^1]).indent(summaryIndentLen)
-    result &= "\n" & pendingText.withColor(fgCyan)
+    result &= "\p" & ("Pending: " & issue["pending"])
+      .wrapwords(summaryWidth)
+      .withColor(fgCyan)
+      .indent(summaryIndentLen)
 
   if showDetails:
-    result &= "\n" & issue.details.strip.indent(indent.len + 2).withColor(fgCyan)
+    result &= "\p" & issue.details
+      .strip
+      .withColor(fgBlack, bright = true)
+      .indent(summaryIndentLen)
 
   result &= termReset
 
@@ -146,15 +167,14 @@ proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
   else: result &= ctx.formatSectionIssueList(issues, innerWidth, indent, verbose)
 
 proc loadIssues(ctx: CliContext, state: IssueState) =
-  ctx.issues[state] = loadIssues(ctx.tasksDir / $state)
+  ctx.issues[state] = loadIssues(ctx.cfg.tasksDir, state)
 
 proc loadOpenIssues(ctx: CliContext) =
   ctx.issues = newTable[IssueState, seq[Issue]]()
   for state in [Current, TodoToday, Todo, Pending, Todo]: ctx.loadIssues(state)
 
 proc loadAllIssues(ctx: CliContext) =
-  ctx.issues = newTable[IssueState, seq[Issue]]()
-  for state in IssueState: ctx.loadIssues(state)
+  ctx.issues = ctx.cfg.tasksDir.loadAllIssues()
 
 proc filterIssues(ctx: CliContext, filter: IssueFilter) =
   for state, issueList in ctx.issues:
@@ -191,7 +211,7 @@ proc reorder(ctx: CliContext, state: IssueState) =
 
   # load the issues to make sure the order file contains all issues in the state.
   ctx.loadIssues(state)
-  discard os.execShellCmd(EDITOR & " '" & (ctx.tasksDir / $state / "order.txt") & "' </dev/tty >/dev/tty")
+  discard os.execShellCmd(EDITOR & " '" & (ctx.cfg.tasksDir / $state / "order.txt") & "' </dev/tty >/dev/tty")
 
 proc edit(issue: Issue) =
 
@@ -295,7 +315,7 @@ when isMainModule:
   if args["--echo-args"]: stderr.writeLine($args)
 
   if args["help"]:
-    stderr.writeLine(USAGE & "\n")
+    stderr.writeLine(USAGE & "\p")
     stderr.writeLine(ONLINE_HELP)
     quit()
 
@@ -306,6 +326,7 @@ when isMainModule:
   var propertiesOption = none(TableRef[string,string])
   var exclPropsOption = none(TableRef[string,seq[string]])
   var tagsOption = none(seq[string])
+  var exclTagsOption = none(seq[string])
 
   if args["--properties"] or args["--context"]:
 
@@ -333,6 +354,9 @@ when isMainModule:
 
   if args["--tags"]: tagsOption = some(($args["--tags"]).split(",").mapIt(it.strip))
 
+  if args["--excl-tags"]: exclTagsOption =
+    some(($args["--excl-tags"]).split(",").mapIt(it.strip))
+
   ## Actual command runners
   if args["new"] or args["add"]:
     let state =
@@ -350,10 +374,10 @@ when isMainModule:
       summary: $args["<summary>"],
       properties: issueProps,
       tags:
-        if args["--tags"]: ($args["--tags"]).split(",").mapIt(it.strip)
+        if tagsOption.isSome: tagsOption.get
         else: newSeq[string]())
 
-    ctx.tasksDir.store(issue, state)
+    ctx.cfg.tasksDir.store(issue, state)
 
     stdout.writeLine ctx.formatIssue(issue)
 
@@ -373,25 +397,25 @@ when isMainModule:
         ctx.loadIssues(state)
         for issue in ctx.issues[state]: edit(issue)
 
-      else: edit(ctx.tasksDir.loadIssueById(editRef))
+      else: edit(ctx.cfg.tasksDir.loadIssueById(editRef))
 
   elif args["tag"]:
-    if not args["--tags"]: raise newException(Exception, "no tags given")
+    if tagsOption.isNone: raise newException(Exception, "no tags given")
 
-    let newTags = ($args["--tags"]).split(",").mapIt(it.strip)
+    let newTags = tagsOption.get
 
     for id in @(args["<id>"]):
-      var issue = ctx.tasksDir.loadIssueById(id)
+      var issue = ctx.cfg.tasksDir.loadIssueById(id)
       issue.tags = deduplicate(issue.tags & newTags)
       issue.store()
 
   elif args["untag"]:
     let tagsToRemove: seq[string] =
-      if args["--tags"]: ($args["--tags"]).split(",").mapIt(it.strip)
+      if tagsOption.isSome: tagsOption.get
       else: @[]
 
     for id in @(args["<id>"]):
-      var issue = ctx.tasksDir.loadIssueById(id)
+      var issue = ctx.cfg.tasksDir.loadIssueById(id)
       if tagsToRemove.len > 0:
         issue.tags = issue.tags.filter(
           proc (tag: string): bool = not tagsToRemove.anyIt(it == tag))
@@ -410,24 +434,24 @@ when isMainModule:
     elif args["suspend"]: targetState = Dormant
 
     for id in @(args["<id>"]):
-      var issue = ctx.tasksDir.loadIssueById(id)
+      var issue = ctx.cfg.tasksDir.loadIssueById(id)
       if propertiesOption.isSome:
         for k,v in propertiesOption.get:
           issue[k] = v
       if targetState == Done:
         issue["completed"] = getTime().local.formatIso8601
         if issue.hasProp("recurrence") and issue.getRecurrence.isSome:
-          let nextIssue = ctx.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
-          ctx.tasksDir.store(nextIssue, Todo)
+          let nextIssue = ctx.cfg.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
+          ctx.cfg.tasksDir.store(nextIssue, Todo)
           info "created the next recurrence:"
           stdout.writeLine ctx.formatIssue(nextIssue)
 
 
-      issue.changeState(ctx.tasksDir, targetState)
+      issue.changeState(ctx.cfg.tasksDir, targetState)
 
     if ctx.triggerPtk or args["--ptk"]:
       if targetState == Current:
-        let issue = ctx.tasksDir.loadIssueById($(args["<id>"][0]))
+        let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"][0]))
         var cmd = "ptk start"
         if issue.tags.len > 0 or issue.hasProp("context"):
           let tags = concat(
@@ -444,14 +468,14 @@ when isMainModule:
 
   elif args["hide-until"]:
 
-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
     issue.setDateTime("hide-until", parseDate($args["<date>"]))
 
     issue.store()
 
   elif args["delegate"]:
 
-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
     issue["delegated-to"] = $args["<delegated-to>"]
 
     issue.store()
@@ -459,7 +483,7 @@ when isMainModule:
   elif args["delete"] or args["rm"]:
     for id in @(args["<id>"]):
 
-      let issue = ctx.tasksDir.loadIssueById(id)
+      let issue = ctx.cfg.tasksDir.loadIssueById(id)
 
       if not args["--yes"]:
         stderr.write("Delete '" & issue.summary & "' (y/n)? ")
@@ -498,8 +522,12 @@ when isMainModule:
       filter.properties["context"] = ctx.defaultContext.get
       filterOption = some(filter)
 
-    if args["--tags"]:
-      filter.hasTags = ($args["--tags"]).split(',')
+    if tagsOption.isSome:
+      filter.hasTags = tagsOption.get
+      filterOption = some(filter)
+
+    if exclTagsOption.isSome:
+      filter.exclTags = exclTagsOption.get
       filterOption = some(filter)
 
     # Finally, if the "context" is "all", don't filter on context
@@ -538,7 +566,7 @@ when isMainModule:
     # List a specific issue
     elif issueIdsOption.isSome:
       for issueId in issueIdsOption.get:
-        let issue = ctx.tasksDir.loadIssueById(issueId)
+        let issue = ctx.cfg.tasksDir.loadIssueById(issueId)
         stdout.writeLine ctx.formatIssue(issue)
 
     # List all issues
@@ -554,7 +582,7 @@ when isMainModule:
         verbose = ctx.verbose)
 
   elif args["add-binary-property"]:
-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
 
     let propIn =
       if $(args["<propSource>"]) == "-": stdin
@@ -566,7 +594,7 @@ when isMainModule:
     issue.store()
 
   elif args["get-binary-property"]:
-    let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
+    let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
 
     if not issue.hasProp($(args["<propName>"])):
       raise newException(Exception,

src/pitpkg/cliconstants.nim

@@ -1,4 +1,4 @@
-const PIT_VERSION* = "4.20.0"
+const PIT_VERSION* = "4.22.1"
 
 const USAGE* = """Usage:
   pit ( new | add) <summary> [<state>] [options]
@@ -9,12 +9,12 @@ const USAGE* = """Usage:
   pit tag <id>... [options]
   pit untag <id>... [options]
   pit reorder <state> [options]
-  pit delegate <id> <delegated-to>
+  pit delegate <id> <delegated-to> [options]
   pit hide-until <id> <date> [options]
   pit ( delete | rm ) <id>... [options]
   pit add-binary-property <id> <propName> <propSource> [options]
   pit get-binary-property <id> <propName> <propDest> [options]
-  pit help
+  pit help [options]
 
 Options:
 
@@ -38,7 +38,13 @@ Options:
                             separate names. For example: -C ctx1,ctx2
                             Shorthand for '-P context:<ctx>'
 
-  -g, --tags <tags>         Specify tags for an issue.
+  -g, --tags <tags>         Specify tags for an issue. Tags are specified as a
+                            comma-delimited list. For example: -g tag1,tag2
+
+  -G, --excl-tags <tags>    When used with the list command, exclude issues
+                            that contain any of the provided tags. Tags are
+                            specified as a comma-delimited list.
+                            For example: -G tag1,tag2
 
   -T, --today               Limit to today's issues.
 

src/pitpkg/private/libpit.nim

@@ -1,5 +1,6 @@
-import cliutils, docopt, json, logging, langutils, options, os,
-  sequtils, strformat, strutils, tables, times, timeutils, uuids
+import std/json, std/logging, std/options, std/os, std/sequtils, std/strformat,
+  std/strutils, std/tables, std/times
+import cliutils, docopt, langutils, timeutils, uuids
 
 import nre except toSeq
 
@@ -23,6 +24,7 @@ type
     completedRange*: Option[tuple[b, e: DateTime]]
     fullMatch*, summaryMatch*: Option[Regex]
     hasTags*: seq[string]
+    exclTags*: seq[string]
     properties*: TableRef[string, string]
     exclProperties*: TableRef[string, seq[string]]
 
@@ -115,6 +117,7 @@ proc initFilter*(): IssueFilter =
     fullMatch: none(Regex),
     summaryMatch: none(Regex),
     hasTags: @[],
+    exclTags: @[],
     properties: newTable[string, string](),
     exclProperties: newTable[string,seq[string]]())
 
@@ -303,6 +306,13 @@ proc loadIssues*(path: string): seq[Issue] =
   # Finally, save current order
   result.storeOrder(path)
 
+proc loadIssues*(tasksDir: string, state: IssueState): seq[Issue] =
+  loadIssues(tasksDir / $state)
+
+proc loadAllIssues*(tasksDir: string): TableRef[IssueState, seq[Issue]] =
+  result = newTable[IssueState, seq[Issue]]()
+  for state in IssueState: result[state] = tasksDir.loadIssues(state)
+
 proc changeState*(issue: Issue, tasksDir: string, newState: IssueState) =
   let oldFilepath = issue.filepath
   if newState == Done: issue.setDateTime("completed", getTime().local)
@@ -372,6 +382,17 @@ proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
   for tag in filter.hasTags:
     result = result.filterIt(it.tags.find(tag) >= 0)
 
+  for exclTag in filter.exclTags:
+    result = result.filterIt(it.tags.find(exclTag) < 0)
+
+proc find*(
+    issues: TableRef[IssueState, seq[Issue]],
+    filter: IssueFilter
+  ): seq[Issue] =
+
+  result = @[]
+  for stateIssues in issues.values: result &= stateIssues.filter(filter)
+
 ### Configuration utilities
 proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitConfig =
   let pitrcLocations = @[