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.24.0"
+version       = "4.25.1"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"

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,
@@ -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(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
 
@@ -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(stdout):
+          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(stdout):
+          stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
+
+        else:
+          stdout.writeLine visibleIssues
+            .mapIt(formatPlainIssueSummary(it))
+            .join("\n")
 
   trace "listing complete"
 
@@ -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")

src/pitpkg/cliconstants.nim

@@ -1,4 +1,4 @@
-const PIT_VERSION* = "4.24.0"
+const PIT_VERSION* = "4.25.1"
 
 const USAGE* = """Usage:
   pit ( new | add) <summary> [<state>] [options]
@@ -181,32 +181,8 @@ Issue Properties:
           after 12 hours
           every 2 weeks, 10a544
 
-    relations
-
-      Used to store information about relationships between issues. PIT treats
-      all relations as bi-directional and will update related tickets as
-      necessary to maintain the integrity of the links.
-
-      Relations are captured as <relation-type> <related-issue-id>. Multiple
-      relations can be separated by ",". The <related-issue-id> must be a unique
-      issue ID or ID prefix (in the case of multiple matching issues, the first
-      found will be used with no guarantee on ordering). Valid value pairs for
-      <relation-type> are:
-
-        - child-of / parent-of
-        - related-to (default)
-        - blocks / blocked-by
-        - follows / precedes
-        - caused / caused-by
-
-      Examples:
-
-          relation: child-of fb3e63, blocked-by 2b71c1
-          relation: 2b71c1, 8f2b4c, follows 184dc6
-          relation: relates-to 2b71c1
-
     tags
 
       If present, expected to be a comma-delimited list of text tags. The -g
       option is a short-hand for '-p tags:<tags-value>'.
-"""
+"""

src/pitpkg/private/libpit.nim

@@ -11,7 +11,6 @@ type
     filepath*: string
     summary*, details*: string
     properties*: TableRef[string, string]
-    relations*: seq[Relation]
     tags*: seq[string]
     state*: IssueState
 
@@ -41,19 +40,6 @@ type
     interval*: TimeInterval
     isFromCompletion*: bool
 
-  Relation* = tuple[rel: RelationType, id: UUID]
-
-  RelationType* = enum
-    ParentOf = "parent-of",
-    ChildOf = "child-of",
-    RelatedTo = "related-to",
-    Blocks = "blocks",
-    BlockedBy = "blocked-by",
-    Follow = "follows",
-    FollowedBy = "followed-by",
-    Caused = "caused",
-    CausedBy = "caused-by"
-
 const DONE_FOLDER_FORMAT* = "yyyy-MM"
 const ISO8601_MS = "yyyy-MM-dd'T'HH:mm:ss'.'fffzzz"
 
@@ -187,11 +173,6 @@ proc parseDate*(d: string): DateTime =
       continue
   raise newException(ValueError, "Unable to parse input as a date: " & d & errMsg)
 
-proc parseRelation*(relStr: string): Relation =
-  let parts = relStr.split({' '})
-  if parts.len == 1: result = (RelatedTo, parseUUID(parts[0]))
-  else: result = (parseEnum[RelationType](parts[0]), parseUUID(parts[1]))
-
 ## Parse and format issues
 proc fromStorageFormat*(id: string, issueTxt: string): Issue =
   type ParseState = enum ReadingSummary, ReadingProps, ReadingDetails
@@ -199,7 +180,6 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
   result = Issue(
     id: parseUUID(id),
     properties: newTable[string,string](),
-    relations: @[],
     tags: @[])
 
   var parseState = ReadingSummary
@@ -223,16 +203,14 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
         parseState = ReadingDetails
         continue
 
+
       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` and `relations`
+      # Take care of special properties: `tags`
       if parts[0] == "tags":
         result.tags = parts[1].split({','}) --> map(it.strip())
-      elif parts[0] == "relations":
-        result.relations = parts[1].split({','}) -->
-          map(parseRelation(it.strip))
       else: result[parts[0]] = parts[1]
 
     of ReadingDetails:
@@ -253,11 +231,6 @@ proc toStorageFormat*(issue: Issue, withComments = false): string =
 
   if issue.tags.len > 0: lines.add("tags: " & issue.tags.join(","))
 
-  if issue.relations.len > 0:
-    lines.add("relations: " &
-      (issue.relations --> map(it.rel & " " & it.id)).
-      join(', '))
-
   if not isEmptyOrWhitespace(issue.details) or withComments:
     if withComments: lines.add("# Details go below the \"--------\"")
     lines.add("--------")