Format listed issues plainly when STDOUT 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.22.2"
+version       = "4.25.1"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"
@@ -14,12 +14,13 @@ requires @[
   "nim >= 1.4.0",
   "docopt >= 0.6.8",
   "jester >= 0.5.0",
-  "uuids >= 0.1.10"
+  "uuids >= 0.1.10",
+  "zero_functional"
 ]
 
 # 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

@@ -1,8 +1,8 @@
 ## Personal Issue Tracker CLI interface
 ## ====================================
 
-import std/algorithm, std/logging, std/options, std/os, std/sequtils,
-  std/wordwrap, std/tables, std/terminal, std/times, std/unicode
+import std/[algorithm, logging, options, os, sequtils, wordwrap, tables,
+            terminal, times, unicode]
 import cliutils, data_uri, docopt, json, timeutils, uuids
 
 from nre import re
@@ -51,7 +51,7 @@ proc getIssueContextDisplayName(ctx: CliContext, context: string): string =
     else: return context.capitalize()
   return ctx.contexts[context]
 
-proc formatIssue(ctx: CliContext, issue: Issue): string =
+proc formatIssue*(issue: Issue): string =
   result = ($issue.id).withColor(fgBlack, true) & "\n"&
            issue.summary.withColor(fgWhite) & "\n"
 
@@ -70,10 +70,27 @@ proc formatIssue(ctx: CliContext, issue: Issue): string =
 
   result &= termReset
 
-proc formatSectionIssue(
-    ctx: CliContext,
+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,
+    width: int = 80,
     indent = "",
     verbose = false): string =
 
@@ -135,12 +152,15 @@ proc formatSectionIssue(
 
   result &= termReset
 
-proc formatSectionIssueList(ctx: CliContext, issues: seq[Issue], width: int,
-        indent: string, verbose: bool): string =
+proc formatSectionIssueList*(
+    issues: seq[Issue],
+    width: int = 80,
+    indent: string = "",
+    verbose: bool = false): string =
 
   result = ""
   for i in issues:
-    var issueText = ctx.formatSectionIssue(i, width, indent, verbose)
+    var issueText = formatSectionIssue(i, width, indent, verbose)
     result &= issueText & "\n"
 
 proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
@@ -161,10 +181,10 @@ proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
         indent & ctx.getIssueContextDisplayName(context) & ":" &
         termReset & "\n\n"
 
-      result &= ctx.formatSectionIssueList(ctxIssues, innerWidth - 2, indent & "  ", verbose)
+      result &= formatSectionIssueList(ctxIssues, innerWidth - 2, indent & "  ", verbose)
       result &= "\n"
 
-  else: result &= ctx.formatSectionIssueList(issues, innerWidth, indent, verbose)
+  else: result &= formatSectionIssueList(issues, innerWidth, indent, verbose)
 
 proc loadIssues(ctx: CliContext, state: IssueState) =
   ctx.issues[state] = loadIssues(ctx.cfg.tasksDir, state)
@@ -224,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()
@@ -249,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(stdout):
+        stdout.write ctx.formatSection(ctx.issues[state], state, "", verbose)
+
+      else:
+        stdout.writeLine ctx.issues[state]
+          .mapIt(formatPlainIssueSummary(it))
+          .join("\n")
+
+
     trace "listing complete"
     return
 
@@ -277,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(stdout):
+          stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+
+        else:
+          stdout.writeLine visibleIssues
+            .mapIt(formatPlainIssueSummary(it))
+            .join("\n")
 
   # Future items
   if future:
@@ -294,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(stdout):
+          stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+
+        else:
+          stdout.writeLine visibleIssues
+            .mapIt(formatPlainIssueSummary(it))
+            .join("\n")
 
   trace "listing complete"
 
@@ -379,7 +419,7 @@ when isMainModule:
 
     ctx.cfg.tasksDir.store(issue, state)
 
-    stdout.writeLine ctx.formatIssue(issue)
+    stdout.writeLine formatIssue(issue)
 
   elif args["reorder"]:
     ctx.reorder(parseEnum[IssueState]($args["<state>"]))
@@ -390,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
@@ -442,9 +482,9 @@ 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 ctx.formatIssue(nextIssue)
+          stdout.writeLine formatIssue(nextIssue)
 
 
       issue.changeState(ctx.cfg.tasksDir, targetState)
@@ -461,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")
@@ -543,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:
@@ -567,7 +611,7 @@ when isMainModule:
     elif issueIdsOption.isSome:
       for issueId in issueIdsOption.get:
         let issue = ctx.cfg.tasksDir.loadIssueById(issueId)
-        stdout.writeLine ctx.formatIssue(issue)
+        stdout.writeLine formatIssue(issue)
 
     # List all issues
     else:
@@ -608,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.22.2"
+const PIT_VERSION* = "4.25.1"
 
 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

@@ -1,8 +1,9 @@
-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 std/[json, logging, options, os, strformat, strutils, tables, times]
+import cliutils, docopt, langutils, uuids, zero_functional
 
 import nre except toSeq
+import timeutils except `>`
+from sequtils import deduplicate, toSeq
 
 type
   Issue* = ref object
@@ -11,6 +12,7 @@ type
     summary*, details*: string
     properties*: TableRef[string, string]
     tags*: seq[string]
+    state*: IssueState
 
   IssueState* = enum
     Current = "current",
@@ -39,6 +41,7 @@ type
     isFromCompletion*: bool
 
 const DONE_FOLDER_FORMAT* = "yyyy-MM"
+const ISO8601_MS = "yyyy-MM-dd'T'HH:mm:ss'.'fffzzz"
 
 let ISSUE_FILE_PATTERN = re"[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}\.txt"
 let RECURRENCE_PATTERN = re"(every|after) ((\d+) )?((hour|day|week|month|year)s?)(, ([0-9a-fA-F]+))?"
@@ -165,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)
@@ -201,12 +204,13 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
         continue
 
 
-      let parts = line.split({':'}, 1).mapIt(it.strip())
+      let parts = line.split({':'}, 1) --> map(it.strip())
       if parts.len != 2:
         raise newException(ValueError, "unable to parse property line: " & line)
 
       # Take care of special properties: `tags`
-      if parts[0] == "tags": result.tags = parts[1].split({','}).mapIt(it.strip())
+      if parts[0] == "tags":
+        result.tags = parts[1].split({','}) --> map(it.strip())
       else: result[parts[0]] = parts[1]
 
     of ReadingDetails:
@@ -216,12 +220,17 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
 
 proc toStorageFormat*(issue: Issue, withComments = false): string =
   var lines: seq[string] = @[]
+
   if withComments: lines.add("# Summary (one line):")
   lines.add(issue.summary)
+
   if withComments: lines.add("# Properties (\"key:value\" per line):")
+  issue.properties["last-updated"] = now().format(ISO8601_MS)
   for key, val in issue.properties:
     if not val.isEmptyOrWhitespace: lines.add(key & ": " & val)
+
   if issue.tags.len > 0: lines.add("tags: " & issue.tags.join(","))
+
   if not isEmptyOrWhitespace(issue.details) or withComments:
     if withComments: lines.add("# Details go below the \"--------\"")
     lines.add("--------")
@@ -234,6 +243,11 @@ proc loadIssue*(filePath: string): Issue =
   result = fromStorageFormat(splitFile(filePath).name, readFile(filePath))
   result.filepath = filePath
 
+  let parentDirName = filePath.splitFile().dir.splitFile().name
+  let issueState = IssueState.items.toSeq --> find($it == parentDirName)
+  if issueState.isSome: result.state = issueState.get
+  else: result.state = IssueState.Done
+
 proc loadIssueById*(tasksDir, id: string): Issue =
   for path in walkDirRec(tasksDir):
     if path.splitFile.name.startsWith(id):
@@ -273,10 +287,10 @@ proc loadIssues*(path: string): seq[Issue] =
 
   let orderedIds =
     if fileExists(orderFile):
-      toSeq(orderFile.lines)
-        .mapIt(it.split(' ')[0])
-        .deduplicate
-        .filterIt(not it.startsWith("> ") and not it.isEmptyOrWhitespace)
+      (orderFile.lines.toSeq -->
+        map(it.split(' ')[0]).
+        filter(not it.startsWith("> ") and not it.isEmptyOrWhitespace)).
+        deduplicate()
     else: newSeq[string]()
 
   type TaggedIssue = tuple[issue: Issue, ordered: bool]
@@ -318,6 +332,7 @@ proc changeState*(issue: Issue, tasksDir: string, newState: IssueState) =
   if newState == Done: issue.setDateTime("completed", getTime().local)
   tasksDir.store(issue, newState)
   if oldFilePath != issue.filepath: removeFile(oldFilepath)
+  issue.state = newState
 
 proc delete*(issue: Issue) = removeFile(issue.filepath)
 
@@ -332,6 +347,7 @@ proc nextRecurrence*(tasksDir: string, rec: Recurrence, defaultIssue: Issue): Is
 
   result = Issue(
     id: genUUID(),
+    state: baseIssue.state,
     summary: baseIssue.summary,
     properties: newProps,
     tags: baseIssue.tags)
@@ -354,36 +370,38 @@ proc nextRecurrence*(tasksDir: string, rec: Recurrence, defaultIssue: Issue): Is
 
 ## Utilities for working with issue collections.
 proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
-  result = issues
+  var f: seq[Issue] = issues
 
   for k,v in filter.properties:
-    result = result.filterIt(it.hasProp(k) and it[k] == v)
+    f = f --> filter(it.hasProp(k) and it[k] == v)
 
   for k,v in filter.exclProperties:
-    result = result.filter(proc (iss: Issue): bool =
-      not iss.hasProp(k) or
-      not v.anyIt(it == iss[k])
-    )
+    f = f --> filter(not (it.hasProp(k) and v.contains(it[k])))
 
   if filter.completedRange.isSome:
     let range = filter.completedRange.get
-    result = result.filterIt(
+    f = f --> filter(
              not it.hasProp("completed") or
              it.getDateTime("completed").between(range.b, range.e))
 
   if filter.summaryMatch.isSome:
     let p = filter.summaryMatch.get
-    result = result.filterIt(it.summary.find(p).isSome)
+    f = f --> filter(it.summary.find(p).isSome)
 
   if filter.fullMatch.isSome:
     let p = filter.fullMatch.get
-    result = result.filterIt( it.summary.find(p).isSome or it.details.find(p).isSome)
+    f = f -->
+      filter(it.summary.find(p).isSome or it.details.find(p).isSome)
 
-  for tag in filter.hasTags:
-    result = result.filterIt(it.tags.find(tag) >= 0)
+  for tagLent in filter.hasTags:
+    let tag = tagLent
+    f = f --> filter(it.tags.find(tag) >= 0)
 
-  for exclTag in filter.exclTags:
-    result = result.filterIt(it.tags.find(exclTag) < 0)
+  for exclTagLent in filter.exclTags:
+    let exclTag = exclTagLent
+    f = f --> filter(it.tags.find(exclTag) < 0)
+
+  return f # not using result because zero_functional doesn't play nice with it
 
 proc find*(
     issues: TableRef[IssueState, seq[Issue]],
@@ -395,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 =
-    foldl(pitrcLocations, if len(a) > 0: a elif fileExists(b): b else: "")
-
-  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"
@@ -410,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")