Initial ideas around a related-to special property.

src/pitpkg/cliconstants.nim

@@ -101,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
 
@@ -110,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
@@ -123,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
@@ -144,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".
 
@@ -169,6 +181,30 @@ 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

src/pitpkg/private/libpit.nim

@@ -11,6 +11,7 @@ type
     filepath*: string
     summary*, details*: string
     properties*: TableRef[string, string]
+    relations*: seq[Relation]
     tags*: seq[string]
     state*: IssueState
 
@@ -40,6 +41,19 @@ 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"
 
@@ -173,6 +187,11 @@ 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
@@ -180,6 +199,7 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
   result = Issue(
     id: parseUUID(id),
     properties: newTable[string,string](),
+    relations: @[],
     tags: @[])
 
   var parseState = ReadingSummary
@@ -203,14 +223,16 @@ 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`
+      # Take care of special properties: `tags` and `relations`
       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:
@@ -231,6 +253,11 @@ 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("--------")