Re-design output to make skimming easier.

- 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.
Show Pending in either Today's list of the Future list, but not both at the same time.
2022-07-31 20:01:39 -05:00 · 2022-07-28 10:48:51 -05:00 · 2022-07-22 10:39:13 -05:00 · 2022-01-22 10:31:58 -06:00 · 2022-01-21 15:01:07 -06:00
6 changed files with 147 additions and 205 deletions
--- a/pit.nimble
+++ b/pit.nimble
@ -1,6 +1,6 @@
 # Package

-version       = "4.18.1"
+version       = "4.21.0"
 author        = "Jonathan Bernard"
 description   = "Personal issue tracker."
 license       = "MIT"
--- a/src/online-help.txt
+++ b/src/online-help.txt
@ -1,93 +0,0 @@
-Issue States:
-
-  PIT organizes issues around their state, which is one of:
-
-    current     - issues actively being worked
-    todo-today  - issues planned for today
-    pending     - issues that are blocked by some third-party
-    done        - issues that have been completely resolved
-    todo        - issues that need to be done in the future
-    dormant     - issues that are low-priority, to be tracked, but hidden
-                  by default
-
-Issue Properties:
-
-  PIT supports adding arbitrary properties to any issue to track any metadata
-  about the issue the user may wish. There are several properties that have
-  special behavior attached to them. They are:
-
-    created
-
-      If present, expected to be an ISO 8601-formatted date that represents the
-      time when the issue was created.
-
-    completed
-
-      If present, expected to be an ISO 8601-formatted date that represents the
-      time when the issue moved to the "done" state.  PIT will add this
-      property automatically when you use the "done" command, and can filter on
-      this value.
-
-    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.
-
-    delegated-to
-
-      When an issue now belongs to someone else, but needs to be monitored for
-      completion, this allows you to keep the issue in its current state but
-      note how it has been delegated. When present PIT will prepend this value
-      to the issue summary with an accent color.
-
-    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.
-
-    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.
-
-    recurrence
-
-      When an issue is moved to the "done" state, if the issue has a valid
-      "recurrence" property, PIT will create a new issue and set the
-      "hide-until" property for that new issue depending on the recurrence
-      definition.
-
-      A valid recurrence value has a time value and optionally has an source
-      issue ID. For example:
-
-        every 5 days, 10a544
-
-      The first word, "every", is expected to be either "every" or "after".
-
-      The second portion is expected to be a time period. Supported time units
-      are "hour", "day", "week", "month", an "year", along with the plural
-      forms (e.g. "5 days", "8 hours", etc.).
-
-      The final portion is the source issue ID. This is optional. When a source
-      issue ID is given, the new issue is created as a clone of the given
-      issue. When not given, the issue being closed is used for cloning.
-
-      The "every" and "after" keywords allow the user to choose whether the new
-      issue is created based on the creation time ("every") or the completion
-      time ("after") of the issue being closed based.
-
-      Examples:
-
-        every day
-        every 2 days
-        after 2 days
-        every week
-        after 12 hours
-        every 2 weeks, 10a544
-
-    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>'.
--- a/src/pit.nim
+++ b/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
@ -71,46 +72,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

@ -167,6 +190,16 @@ proc parsePropertiesOption(propsOpt: string): TableRef[string, string] =
    if pair.len == 1: result[pair[0]] = "true"
    else: result[pair[0]] = pair[1]

+proc parseExclPropertiesOption(propsOpt: string): TableRef[string, seq[string]] =
+  result = newTable[string, seq[string]]()
+  for propText in propsOpt.split(";"):
+    let pair = propText.split(":", 1)
+    let val =
+      if pair.len == 1: "true"
+      else: pair[1]
+    if result.hasKey(pair[0]): result[pair[0]].add(val)
+    else: result[pair[0]] = @[val]
+
 proc sameDay(a, b: DateTime): bool =
  result = a.year == b.year and a.yearday == b.yearday

@ -253,7 +286,11 @@ proc list(
  if future:
    if today: ctx.writeHeader("Future")

-    for s in [Pending, Todo]:
+    let futureCategories =
+      if showToday: @[Todo]
+      else: @[Pending, Todo]
+
+    for s in futureCategories:
      if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
        let visibleIssues = ctx.issues[s].filterIt(
          showHidden or
@ -269,7 +306,7 @@ when isMainModule:

  let consoleLogger = newConsoleLogger(
    levelThreshold=lvlInfo,
-    fmtStr="$app - $levelname: ")
+    fmtStr="pit - $levelname: ")
  logging.addHandler(consoleLogger)

  # Parse arguments
@ -290,7 +327,9 @@ when isMainModule:
  trace "context initiated"

  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"]:

@ -302,8 +341,25 @@ when isMainModule:

    propertiesOption = some(props)

+  if args["--excl-properties"] or args["--excl-context"]:
+
+    var exclProps =
+      if args["--excl-properties"]:
+        parseExclPropertiesOption($args["--excl-properties"])
+      else: newTable[string,seq[string]]()
+
+    if args["--excl-context"]:
+      if not exclProps.hasKey("context"): exclProps["context"] = @[]
+      let exclContexts = split($args["--excl-context"], ",")
+      exclProps["context"] = exclProps["context"].concat(exclContexts)
+
+    exclPropsOption = some(exclProps)
+
  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 =
@ -321,7 +377,7 @@ 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)
@ -347,9 +403,9 @@ when isMainModule:
      else: edit(ctx.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)
@ -358,7 +414,7 @@ when isMainModule:

  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>"]):
@ -449,6 +505,11 @@ when isMainModule:
      filter.properties = propertiesOption.get
      filterOption = some(filter)

+    # Add property exclusions (if given)
+    if exclPropsOption.isSome:
+      filter.exclProperties = exclPropsOption.get
+      filterOption = some(filter)
+
    # If they supplied text matches, add that to the filter.
    if args["--match"]:
      filter.summaryMatch = some(re("(?i)" & $args["--match"]))
@ -464,8 +525,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
@ -473,6 +538,7 @@ when isMainModule:
       filter.properties["context"] == "all":

      filter.properties.del("context")
+      filter.exclProperties.del("context")

    var listContexts = false
    var statesOption = none(seq[IssueState])
--- a/src/pitpkg/cliconstants.nim
+++ b/src/pitpkg/cliconstants.nim
@ -1,4 +1,4 @@
-const PIT_VERSION* = "4.18.1"
+const PIT_VERSION* = "4.21.0"

 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:

@ -25,9 +25,26 @@ Options:
                            a filter to the issues listed, only allowing those
                            which have all of the given properties.

-  -c, --context <ctxName>   Shorthand for '-p context:<ctxName>'
+  -P, --excl-properties <props>
+                            When used with the list command, exclude issues
+                            that contain properties with the given value. This
+                            parameter is formatted the same as the --properties
+                            parameter: "key:val;key:val"

-  -g, --tags <tags>         Specify tags for an issue.
+  -c, --context <ctx>       Shorthand for '-p context:<ctx>'
+
+  -C, --excl-context <ctx>  Don't show issues from the given context(s).
+                            Multiple contexts can be excluded using a ',' to
+                            separate names. For example: -C ctx1,ctx2
+                            Shorthand for '-P context:<ctx>'
+
+  -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.

@ -48,7 +65,7 @@ Options:

  -y, --yes                 Automatically answer "yes" to any prompts.

-  -C, --config <cfgFile>    Location of the config file (defaults to $HOME/.pitrc)
+  --config <cfgFile>        Location of the config file (defaults to $HOME/.pitrc)

  -E, --echo-args           Echo arguments (for debug purposes).

@ -155,4 +172,4 @@ Issue Properties:

      If present, expected to be a comma-delimited list of text tags. The -g
      option is a short-hand for '-p tags:<tags-value>'.
-"""
+"""
--- a/src/pitpkg/private/libpit.nim
+++ b/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,7 +24,9 @@ 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]]

  PitConfig* = ref object
    tasksDir*: string
@ -114,7 +117,9 @@ proc initFilter*(): IssueFilter =
    fullMatch: none(Regex),
    summaryMatch: none(Regex),
    hasTags: @[],
-    properties: newTable[string, string]())
+    exclTags: @[],
+    properties: newTable[string, string](),
+    exclProperties: newTable[string,seq[string]]())

 proc propsFilter*(props: TableRef[string, string]): IssueFilter =
  if isNil(props):
@ -347,6 +352,12 @@ proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
  for k,v in filter.properties:
    result = result.filterIt(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])
+    )
+
  if filter.completedRange.isSome:
    let range = filter.completedRange.get
    result = result.filterIt(
@ -364,6 +375,9 @@ 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)
+
 ### Configuration utilities
 proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitConfig =
  let pitrcLocations = @[
--- a/src/usage.txt
+++ b/src/usage.txt
@ -1,62 +0,0 @@
-const USAGE* ="""\
-Usage:
-  pit ( new | add) <summary> [<state>] [options]
-  pit list contexts [options]
-  pit list [<stateOrId>...] [options]
-  pit ( start | done | pending | todo-today | todo | suspend ) <id>... [options]
-  pit edit <ref>... [options]
-  pit tag <id>... [options]
-  pit untag <id>... [options]
-  pit reorder <state> [options]
-  pit delegate <id> <delegated-to>
-  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
-
-Options:
-
-  -h, --help                Print this usage and help information.
-
-  -p, --properties <props>  Specify properties. Formatted as "key:val;key:val"
-                            When used with the list command this option applies
-                            a filter to the issues listed, only allowing those
-                            which have all of the given properties.
-
-  -c, --context <ctxName>   Shorthand for '-p context:<ctxName>'
-
-  -g, --tags <tags>         Specify tags for an issue.
-
-  -T, --today               Limit to today's issues.
-
-  -F, --future              Limit to future issues.
-
-  -H, --show-hidden         Show all matching issues, ignoring any 'hide-until'
-                            properties set.
-
-  -m, --match <pattern>     Limit to issues whose summaries match the given
-                            pattern (PCRE regex supported).
-
-  -M, --match-all <pat>     Limit to the issues whose summaries or details
-                            match the given pattern (PCRE regex supported).
-
-  -v, --verbose             Show issue details when listing issues.
-
-  -q, --quiet               Suppress verbose output.
-
-  -y, --yes                 Automatically answer "yes" to any prompts.
-
-  -C, --config <cfgFile>    Location of the config file (defaults to $HOME/.pitrc)
-
-  -E, --echo-args           Echo arguments (for debug purposes).
-
-  -d, --tasks-dir           Path to the tasks directory (defaults to the value
-                            configured in the .pitrc file)
-
-  --term-width <width>      Manually set the terminal width to use.
-
-  --ptk                     Enable PTK integration for this command.
-
-  --debug                   Enable debug-level log output.
-"""
Author	SHA1	Message	Date
Jonathan Bernard	7215b4969b	Re-design output to make skimming easier. - 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.	2022-07-31 20:01:39 -05:00
Jonathan Bernard	c7891de310	Show Pending in either Today's list of the Future list, but not both at the same time.	2022-07-28 10:48:51 -05:00
Jonathan Bernard	a373af0658	Add support for filtering based on property exclusion. For example, allow commands like: # exclude issues from context "abc" pit list -C abc # exclude issues delegated to John Doe pit list -P "delgated-to:John Doe"	2022-07-22 10:39:13 -05:00
Jonathan Bernard	de3ee05680	Change logging format.	2022-01-22 10:31:58 -06:00
Jonathan Bernard	59440d2c9d	Remove unused, old copies of usage and outline text.	2022-01-21 15:01:07 -06:00