Compare commits
4 Commits
Author | SHA1 | Date | |
---|---|---|---|
c7891de310 | |||
a373af0658 | |||
de3ee05680 | |||
59440d2c9d |
@ -1,6 +1,6 @@
|
|||||||
# Package
|
# Package
|
||||||
|
|
||||||
version = "4.18.1"
|
version = "4.20.0"
|
||||||
author = "Jonathan Bernard"
|
author = "Jonathan Bernard"
|
||||||
description = "Personal issue tracker."
|
description = "Personal issue tracker."
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
|
@ -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>'.
|
|
39
src/pit.nim
39
src/pit.nim
@ -167,6 +167,16 @@ proc parsePropertiesOption(propsOpt: string): TableRef[string, string] =
|
|||||||
if pair.len == 1: result[pair[0]] = "true"
|
if pair.len == 1: result[pair[0]] = "true"
|
||||||
else: result[pair[0]] = pair[1]
|
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 =
|
proc sameDay(a, b: DateTime): bool =
|
||||||
result = a.year == b.year and a.yearday == b.yearday
|
result = a.year == b.year and a.yearday == b.yearday
|
||||||
|
|
||||||
@ -253,7 +263,11 @@ proc list(
|
|||||||
if future:
|
if future:
|
||||||
if today: ctx.writeHeader("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:
|
if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
|
||||||
let visibleIssues = ctx.issues[s].filterIt(
|
let visibleIssues = ctx.issues[s].filterIt(
|
||||||
showHidden or
|
showHidden or
|
||||||
@ -269,7 +283,7 @@ when isMainModule:
|
|||||||
|
|
||||||
let consoleLogger = newConsoleLogger(
|
let consoleLogger = newConsoleLogger(
|
||||||
levelThreshold=lvlInfo,
|
levelThreshold=lvlInfo,
|
||||||
fmtStr="$app - $levelname: ")
|
fmtStr="pit - $levelname: ")
|
||||||
logging.addHandler(consoleLogger)
|
logging.addHandler(consoleLogger)
|
||||||
|
|
||||||
# Parse arguments
|
# Parse arguments
|
||||||
@ -290,6 +304,7 @@ when isMainModule:
|
|||||||
trace "context initiated"
|
trace "context initiated"
|
||||||
|
|
||||||
var propertiesOption = none(TableRef[string,string])
|
var propertiesOption = none(TableRef[string,string])
|
||||||
|
var exclPropsOption = none(TableRef[string,seq[string]])
|
||||||
var tagsOption = none(seq[string])
|
var tagsOption = none(seq[string])
|
||||||
|
|
||||||
if args["--properties"] or args["--context"]:
|
if args["--properties"] or args["--context"]:
|
||||||
@ -302,6 +317,20 @@ when isMainModule:
|
|||||||
|
|
||||||
propertiesOption = some(props)
|
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["--tags"]: tagsOption = some(($args["--tags"]).split(",").mapIt(it.strip))
|
||||||
|
|
||||||
## Actual command runners
|
## Actual command runners
|
||||||
@ -449,6 +478,11 @@ when isMainModule:
|
|||||||
filter.properties = propertiesOption.get
|
filter.properties = propertiesOption.get
|
||||||
filterOption = some(filter)
|
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 they supplied text matches, add that to the filter.
|
||||||
if args["--match"]:
|
if args["--match"]:
|
||||||
filter.summaryMatch = some(re("(?i)" & $args["--match"]))
|
filter.summaryMatch = some(re("(?i)" & $args["--match"]))
|
||||||
@ -473,6 +507,7 @@ when isMainModule:
|
|||||||
filter.properties["context"] == "all":
|
filter.properties["context"] == "all":
|
||||||
|
|
||||||
filter.properties.del("context")
|
filter.properties.del("context")
|
||||||
|
filter.exclProperties.del("context")
|
||||||
|
|
||||||
var listContexts = false
|
var listContexts = false
|
||||||
var statesOption = none(seq[IssueState])
|
var statesOption = none(seq[IssueState])
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
const PIT_VERSION* = "4.18.1"
|
const PIT_VERSION* = "4.20.0"
|
||||||
|
|
||||||
const USAGE* = """Usage:
|
const USAGE* = """Usage:
|
||||||
pit ( new | add) <summary> [<state>] [options]
|
pit ( new | add) <summary> [<state>] [options]
|
||||||
@ -25,7 +25,18 @@ Options:
|
|||||||
a filter to the issues listed, only allowing those
|
a filter to the issues listed, only allowing those
|
||||||
which have all of the given properties.
|
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"
|
||||||
|
|
||||||
|
-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.
|
-g, --tags <tags> Specify tags for an issue.
|
||||||
|
|
||||||
@ -48,7 +59,7 @@ Options:
|
|||||||
|
|
||||||
-y, --yes Automatically answer "yes" to any prompts.
|
-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).
|
-E, --echo-args Echo arguments (for debug purposes).
|
||||||
|
|
||||||
|
@ -24,6 +24,7 @@ type
|
|||||||
fullMatch*, summaryMatch*: Option[Regex]
|
fullMatch*, summaryMatch*: Option[Regex]
|
||||||
hasTags*: seq[string]
|
hasTags*: seq[string]
|
||||||
properties*: TableRef[string, string]
|
properties*: TableRef[string, string]
|
||||||
|
exclProperties*: TableRef[string, seq[string]]
|
||||||
|
|
||||||
PitConfig* = ref object
|
PitConfig* = ref object
|
||||||
tasksDir*: string
|
tasksDir*: string
|
||||||
@ -114,7 +115,8 @@ proc initFilter*(): IssueFilter =
|
|||||||
fullMatch: none(Regex),
|
fullMatch: none(Regex),
|
||||||
summaryMatch: none(Regex),
|
summaryMatch: none(Regex),
|
||||||
hasTags: @[],
|
hasTags: @[],
|
||||||
properties: newTable[string, string]())
|
properties: newTable[string, string](),
|
||||||
|
exclProperties: newTable[string,seq[string]]())
|
||||||
|
|
||||||
proc propsFilter*(props: TableRef[string, string]): IssueFilter =
|
proc propsFilter*(props: TableRef[string, string]): IssueFilter =
|
||||||
if isNil(props):
|
if isNil(props):
|
||||||
@ -347,6 +349,12 @@ proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
|
|||||||
for k,v in filter.properties:
|
for k,v in filter.properties:
|
||||||
result = result.filterIt(it.hasProp(k) and it[k] == v)
|
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:
|
if filter.completedRange.isSome:
|
||||||
let range = filter.completedRange.get
|
let range = filter.completedRange.get
|
||||||
result = result.filterIt(
|
result = result.filterIt(
|
||||||
|
@ -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.
|
|
||||||
"""
|
|
Reference in New Issue
Block a user