Format listed issues plainly when STDIN is not a TTY

When calling pit from other programs or as part of a pipe, the display
style typically used to format listed issues contains a lot of unwanted
output (ANSI escape code, headings, etc.). Now when STDIN is not a TTY,
a plain and consistently formatted version of the issues is listed
without any additional formatting, one issue per line of output.

pit.nimble

@@ -1,6 +1,6 @@
 # Package
 
-version       = "4.23.2"
+version       = "4.25.0"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"
@@ -20,7 +20,7 @@ requires @[
 
 # Dependencies from git.jdb-software.com/nim-jdb/packages
 requires @[
-  "cliutils >= 0.6.4",
+  "cliutils >= 0.8.1",
   "langutils >= 0.4.0",
   "timeutils >= 0.5.4",
   "data_uri > 1.0.0",

src/pit.nim

@@ -70,6 +70,24 @@ proc formatIssue*(issue: Issue): string =
 
   result &= termReset
 
+proc formatPlainIssueSummary*(issue: Issue): string =
+
+  result = "$#: $# $#" % [
+    $issue.state,
+    ($issue.id)[0..<6],
+    issue.summary ]
+
+  if issue.hasProp("delegated-to") or issue.hasProp("pending"):
+    var parts = newSeq[string]()
+
+    if issue.hasProp("delegated-to"):
+      parts.add("delegated to " & issue["delegated-to"])
+
+    if issue.hasProp("pending"):
+      parts.add("pendin: " & issue["pending"])
+
+    result &= "($#)" % [ parts.join("; ") ]
+
 proc formatSectionIssue*(
     issue: Issue,
     width: int = 80,
@@ -226,7 +244,7 @@ proc edit(issue: Issue) =
     # Try to parse the newly-edited issue to make sure it was successful.
     let editedIssue = loadIssue(issue.filepath)
     editedIssue.store()
-  except:
+  except CatchableError:
     fatal "updated issue is invalid (ignoring edits): \n\t" &
       getCurrentExceptionMsg()
     issue.store()
@@ -251,7 +269,15 @@ proc list(
           it.hasProp("completed") and
           sameDay(getTime().local, it.getDateTime("completed")))
 
-      stdout.write ctx.formatSection(ctx.issues[state], state, "", verbose)
+      if isatty(stdin):
+        stdout.write ctx.formatSection(ctx.issues[state], state, "", verbose)
+
+      else:
+        stdout.writeLine ctx.issues[state]
+          .mapIt(formatPlainIssueSummary(it))
+          .join("\n")
+
+
     trace "listing complete"
     return
 
@@ -279,7 +305,13 @@ proc list(
           not (it.hasProp("hide-until") and
                it.getDateTime("hide-until") > getTime().local))
 
-        stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+        if isatty(stdin):
+          stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+
+        else:
+          stdout.writeLine visibleIssues
+            .mapIt(formatPlainIssueSummary(it))
+            .join("\n")
 
   # Future items
   if future:
@@ -296,7 +328,13 @@ proc list(
           not (it.hasProp("hide-until") and
                it.getDateTime("hide-until") > getTime().local))
 
-        stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+        if isatty(stdin):
+          stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+
+        else:
+          stdout.writeLine visibleIssues
+            .mapIt(formatPlainIssueSummary(it))
+            .join("\n")
 
   trace "listing complete"
 
@@ -392,7 +430,7 @@ when isMainModule:
       var stateOption = none(IssueState)
 
       try: stateOption = some(parseEnum[IssueState](editRef))
-      except: discard
+      except CatchableError: discard
 
       if stateOption.isSome:
         let state = stateOption.get
@@ -444,7 +482,7 @@ when isMainModule:
         issue["completed"] = getTime().local.formatIso8601
         if issue.hasProp("recurrence") and issue.getRecurrence.isSome:
           let nextIssue = ctx.cfg.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
-          ctx.cfg.tasksDir.store(nextIssue, Todo)
+          ctx.cfg.tasksDir.store(nextIssue, TodoToday)
           info "created the next recurrence:"
           stdout.writeLine formatIssue(nextIssue)
 
@@ -463,7 +501,7 @@ when isMainModule:
           )
           cmd &= " -g \"" & tags.join(",") & "\""
         cmd &= " -n \"pit-id: " & $issue.id & "\""
-        cmd &= " \"" & issue.summary & "\""
+        cmd &= " \"[" & ($issue.id)[0..<6] & "] " & issue.summary & "\""
         discard execShellCmd(cmd)
       elif targetState == Done or targetState == Pending:
         discard execShellCmd("ptk stop")
@@ -545,8 +583,12 @@ when isMainModule:
 
     if args["contexts"]: listContexts = true
     elif args["<stateOrId>"]:
-      try: statesOption = some(args["<stateOrId>"].mapIt(parseEnum[IssueState]($it)))
-      except: issueIdsOption = some(args["<stateOrId>"].mapIt($it))
+      try:
+        statesOption =
+          some(args["<stateOrId>"].
+          mapIt(parseEnum[IssueState]($it)))
+      except CatchableError:
+        issueIdsOption = some(args["<stateOrId>"].mapIt($it))
 
     # List the known contexts
     if listContexts:
@@ -610,7 +652,23 @@ when isMainModule:
     try: write(propOut, decodeDataUri(issue[$(args["<propName>"])]))
     finally: close(propOut)
 
- except:
+  elif args["show-dupes"]:
+    ctx.loadAllIssues()
+
+    var idsToPaths = newTable[string, var seq[string]]()
+    for (state, issues) in pairs(ctx.issues):
+      for issue in issues:
+        let issueId = $issue.id
+
+        if idsToPaths.hasKey(issueId): idsToPaths[issueId].add(issue.filepath)
+        else: idsToPaths[issueId] = @[issue.filepath]
+
+    for (issueId, issuePaths) in pairs(idsToPaths):
+      if issuePaths.len < 2: continue
+      stdout.writeLine(issueId & ":\p  " & issuePaths.join("\p  ") & "\p\p")
+
+ except CatchableError:
   fatal getCurrentExceptionMsg()
+  debug getCurrentException().getStackTrace()
   #raise getCurrentException()
   quit(QuitFailure)

src/pitpkg/cliconstants.nim

@@ -1,4 +1,4 @@
-const PIT_VERSION* = "4.23.2"
+const PIT_VERSION* = "4.25.0"
 
 const USAGE* = """Usage:
   pit ( new | add) <summary> [<state>] [options]
@@ -14,6 +14,7 @@ const USAGE* = """Usage:
   pit ( delete | rm ) <id>... [options]
   pit add-binary-property <id> <propName> <propSource> [options]
   pit get-binary-property <id> <propName> <propDest> [options]
+  pit show-dupes
   pit help [options]
 
 Options:
@@ -100,7 +101,9 @@ Issue Properties:
     created
 
       If present, expected to be an ISO 8601-formatted date that represents the
-      time when the issue was created.
+      time when the issue was created. E.g.:
+
+          created: 2023-07-13T13:28:41-05:00
 
     completed
 
@@ -109,12 +112,16 @@ Issue Properties:
       property automatically when you use the "done" command, and can filter on
       this value.
 
+          completed: 2023-04-27T11:52:28-05:00
+
     context
 
       Allows issues to be organized into contexts. The -c option is short-hand
       for '-p context:<context-name>' and the 'list contexts' command will show
       all values of 'context' set in existing issues.
 
+          context: family
+
     delegated-to
 
       When an issue now belongs to someone else, but needs to be monitored for
@@ -122,17 +129,23 @@ Issue Properties:
       note how it has been delegated. When present PIT will prepend this value
       to the issue summary with an accent color.
 
+          delegated-to: Bob Ross
+
     hide-until
 
       When present, expected to be an ISO 8601-formatted date and used to
       supress the display of the issue until on or after the given date.
 
+          hide-until: 2024-01-01T13:45:00-05:00
+
     pending
 
       When an issue is blocked by a third party, this property can be used to
       capture details about the dependency When present PIT will display this
       value after the issue summary.
 
+          pending: Results of WCAG analysis.
+
     recurrence
 
       When an issue is moved to the "done" state, if the issue has a valid
@@ -143,7 +156,7 @@ Issue Properties:
       A valid recurrence value has a time value and optionally has an source
       issue ID. For example:
 
-        every 5 days, 10a544
+          recurrence: every 5 days, 10a544
 
       The first word, "every", is expected to be either "every" or "after".
 
@@ -161,12 +174,12 @@ Issue Properties:
 
       Examples:
 
-        every day
-        every 2 days
-        after 2 days
-        every week
-        after 12 hours
-        every 2 weeks, 10a544
+          every day
+          every 2 days
+          after 2 days
+          every week
+          after 12 hours
+          every 2 weeks, 10a544
 
     tags
 

src/pitpkg/private/libpit.nim

@@ -168,7 +168,7 @@ proc parseDate*(d: string): DateTime =
   var errMsg = ""
   for df in DATE_FORMATS:
     try: return d.parse(df)
-    except:
+    except CatchableError:
       errMsg &= "\n\tTried " & df & " with " & d
       continue
   raise newException(ValueError, "Unable to parse input as a date: " & d & errMsg)
@@ -413,14 +413,12 @@ proc find*(
 
 ### Configuration utilities
 proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitConfig =
-  let pitrcLocations = @[
-    if args["--config"]: $args["--config"] else: "",
-    ".pitrc", $getEnv("PITRC"), $getEnv("HOME") & "/.pitrc"]
+  var pitrcFilename: string
 
-  var pitrcFilename: string =
-    pitrcLocations --> fold("", if fileExists(it): it else: a)
-
-  if not fileExists(pitrcFilename):
+  try:
+    pitrcFilename = findConfigFile(".pitrc",
+      if args["--config"]: @[$args["--config"]] else: @[])
+  except ValueError:
     warn "could not find .pitrc file: " & pitrcFilename
     if isEmptyOrWhitespace(pitrcFilename):
       pitrcFilename = $getEnv("HOME") & "/.pitrc"
@@ -428,25 +426,19 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
     try:
       cfgFile = open(pitrcFilename, fmWrite)
       cfgFile.write("{\"tasksDir\": \"/path/to/tasks\"}")
-    except: warn "could not write default .pitrc to " & pitrcFilename
+    except CatchableError: warn "could not write default .pitrc to " & pitrcFilename
     finally: close(cfgFile)
 
-  var cfgJson: JsonNode
-  try: cfgJson = parseFile(pitrcFilename)
-  except: raise newException(IOError,
-    "unable to read config file: " & pitrcFilename &
-    "\x0D\x0A" & getCurrentExceptionMsg())
-
-  let cfg = CombinedConfig(docopt: args, json: cfgJson)
+  debug "loading config from '$#'" % [pitrcFilename]
+  let cfg = initCombinedConfig(pitrcFilename, args)
 
   result = PitConfig(
     cfg: cfg,
     contexts: newTable[string,string](),
     tasksDir: cfg.getVal("tasks-dir", ""))
 
-  if cfgJson.hasKey("contexts"):
-    for k, v in cfgJson["contexts"]:
-      result.contexts[k] = v.getStr()
+  for k, v in cfg.getJson("contexts", newJObject()):
+    result.contexts[k] = v.getStr()
 
   if isEmptyOrWhitespace(result.tasksDir):
     raise newException(Exception, "no tasks directory configured")