Compare commits
10 Commits
Author | SHA1 | Date | |
---|---|---|---|
a373af0658 | |||
de3ee05680 | |||
59440d2c9d | |||
6226ff21c5 | |||
71e035fdbe | |||
df854f864c | |||
7bccd83e23 | |||
b25d2be164 | |||
e0ab3cb401 | |||
d93c0cf348 |
@ -1,6 +1,6 @@
|
|||||||
# Package
|
# Package
|
||||||
|
|
||||||
version = "4.12.0"
|
version = "4.19.0"
|
||||||
author = "Jonathan Bernard"
|
author = "Jonathan Bernard"
|
||||||
description = "Personal issue tracker."
|
description = "Personal issue tracker."
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
@ -19,8 +19,8 @@ requires @[
|
|||||||
"https://git.jdb-software.com/jdb/nim-lang-utils.git >= 0.4.0",
|
"https://git.jdb-software.com/jdb/nim-lang-utils.git >= 0.4.0",
|
||||||
"https://git.jdb-software.com/jdb/nim-time-utils.git >= 0.4.0",
|
"https://git.jdb-software.com/jdb/nim-time-utils.git >= 0.4.0",
|
||||||
"https://git.jdb-software.com/jdb/nim-data-uri.git >= 1.0.0",
|
"https://git.jdb-software.com/jdb/nim-data-uri.git >= 1.0.0",
|
||||||
"https://git.jdb-software.com/jdb/update-nim-package-version"
|
"https://git.jdb-software.com/jdb/update-nim-package-version >= 0.2.0"
|
||||||
]
|
]
|
||||||
|
|
||||||
task updateVersion, "Update the version of this package.":
|
task updateVersion, "Update the version of this package.":
|
||||||
exec "update_nim_package_version pit 'src/pitpkg/version.nim'"
|
exec "update_nim_package_version pit 'src/pitpkg/cliconstants.nim'"
|
218
src/pit.nim
218
src/pit.nim
@ -7,10 +7,9 @@ import algorithm, cliutils, data_uri, docopt, json, logging, options, os,
|
|||||||
from nre import re
|
from nre import re
|
||||||
import strutils except alignLeft, capitalize, strip, toUpper, toLower
|
import strutils except alignLeft, capitalize, strip, toUpper, toLower
|
||||||
import pitpkg/private/libpit
|
import pitpkg/private/libpit
|
||||||
|
import pitpkg/cliconstants
|
||||||
export libpit
|
export libpit
|
||||||
|
|
||||||
include "pitpkg/version.nim"
|
|
||||||
|
|
||||||
type
|
type
|
||||||
CliContext = ref object
|
CliContext = ref object
|
||||||
cfg*: PitConfig
|
cfg*: PitConfig
|
||||||
@ -149,6 +148,10 @@ proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
|
|||||||
proc loadIssues(ctx: CliContext, state: IssueState) =
|
proc loadIssues(ctx: CliContext, state: IssueState) =
|
||||||
ctx.issues[state] = loadIssues(ctx.tasksDir / $state)
|
ctx.issues[state] = loadIssues(ctx.tasksDir / $state)
|
||||||
|
|
||||||
|
proc loadOpenIssues(ctx: CliContext) =
|
||||||
|
ctx.issues = newTable[IssueState, seq[Issue]]()
|
||||||
|
for state in [Current, TodoToday, Todo, Pending, Todo]: ctx.loadIssues(state)
|
||||||
|
|
||||||
proc loadAllIssues(ctx: CliContext) =
|
proc loadAllIssues(ctx: CliContext) =
|
||||||
ctx.issues = newTable[IssueState, seq[Issue]]()
|
ctx.issues = newTable[IssueState, seq[Issue]]()
|
||||||
for state in IssueState: ctx.loadIssues(state)
|
for state in IssueState: ctx.loadIssues(state)
|
||||||
@ -164,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
|
||||||
|
|
||||||
@ -192,26 +205,40 @@ proc edit(issue: Issue) =
|
|||||||
let editedIssue = loadIssue(issue.filepath)
|
let editedIssue = loadIssue(issue.filepath)
|
||||||
editedIssue.store()
|
editedIssue.store()
|
||||||
except:
|
except:
|
||||||
fatal "pit: updated issue is invalid (ignoring edits): \n\t" &
|
fatal "updated issue is invalid (ignoring edits): \n\t" &
|
||||||
getCurrentExceptionMsg()
|
getCurrentExceptionMsg()
|
||||||
issue.store()
|
issue.store()
|
||||||
|
|
||||||
proc list(ctx: CliContext, filter: Option[IssueFilter], state: Option[IssueState], showToday, showFuture, verbose: bool) =
|
proc list(
|
||||||
|
ctx: CliContext,
|
||||||
|
filter: Option[IssueFilter],
|
||||||
|
states: Option[seq[IssueState]],
|
||||||
|
showToday, showFuture,
|
||||||
|
showHidden = false,
|
||||||
|
verbose: bool) =
|
||||||
|
|
||||||
if state.isSome:
|
if states.isSome:
|
||||||
ctx.loadIssues(state.get)
|
trace "listing issues for " & $states.get
|
||||||
if filter.isSome: ctx.filterIssues(filter.get)
|
for state in states.get:
|
||||||
if state.get == Done and showToday:
|
ctx.loadIssues(state)
|
||||||
ctx.issues[Done] = ctx.issues[Done].filterIt(
|
if filter.isSome: ctx.filterIssues(filter.get)
|
||||||
it.hasProp("completed") and
|
|
||||||
sameDay(getTime().local, it.getDateTime("completed")))
|
# Show Done for just today if requested
|
||||||
stdout.write ctx.formatSection(ctx.issues[state.get], state.get, "", verbose)
|
if state == Done and showToday:
|
||||||
|
ctx.issues[Done] = ctx.issues[Done].filterIt(
|
||||||
|
it.hasProp("completed") and
|
||||||
|
sameDay(getTime().local, it.getDateTime("completed")))
|
||||||
|
|
||||||
|
stdout.write ctx.formatSection(ctx.issues[state], state, "", verbose)
|
||||||
|
trace "listing complete"
|
||||||
return
|
return
|
||||||
|
|
||||||
ctx.loadAllIssues()
|
ctx.loadOpenIssues()
|
||||||
if filter.isSome: ctx.filterIssues(filter.get)
|
if filter.isSome:
|
||||||
|
ctx.filterIssues(filter.get)
|
||||||
|
trace "filtered issues"
|
||||||
|
|
||||||
let today = showToday and [Current, TodoToday].anyIt(
|
let today = showToday and [Current, TodoToday, Pending].anyIt(
|
||||||
ctx.issues.hasKey(it) and ctx.issues[it].len > 0)
|
ctx.issues.hasKey(it) and ctx.issues[it].len > 0)
|
||||||
|
|
||||||
let future = showFuture and [Pending, Todo].anyIt(
|
let future = showFuture and [Pending, Todo].anyIt(
|
||||||
@ -223,9 +250,14 @@ proc list(ctx: CliContext, filter: Option[IssueFilter], state: Option[IssueState
|
|||||||
if today:
|
if today:
|
||||||
if future: ctx.writeHeader("Today")
|
if future: ctx.writeHeader("Today")
|
||||||
|
|
||||||
for s in [Current, TodoToday]:
|
for s in [Current, TodoToday, Pending]:
|
||||||
if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
|
if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
|
||||||
stdout.write ctx.formatSection(ctx.issues[s], s, indent, verbose)
|
let visibleIssues = ctx.issues[s].filterIt(
|
||||||
|
showHidden or
|
||||||
|
not (it.hasProp("hide-until") and
|
||||||
|
it.getDateTime("hide-until") > getTime().local))
|
||||||
|
|
||||||
|
stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
|
||||||
|
|
||||||
# Future items
|
# Future items
|
||||||
if future:
|
if future:
|
||||||
@ -233,81 +265,42 @@ proc list(ctx: CliContext, filter: Option[IssueFilter], state: Option[IssueState
|
|||||||
|
|
||||||
for s in [Pending, Todo]:
|
for s in [Pending, Todo]:
|
||||||
if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
|
if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
|
||||||
stdout.write ctx.formatSection(ctx.issues[s], s, indent, verbose)
|
let visibleIssues = ctx.issues[s].filterIt(
|
||||||
|
showHidden or
|
||||||
|
not (it.hasProp("hide-until") and
|
||||||
|
it.getDateTime("hide-until") > getTime().local))
|
||||||
|
|
||||||
|
stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
|
||||||
|
|
||||||
|
trace "listing complete"
|
||||||
|
|
||||||
when isMainModule:
|
when isMainModule:
|
||||||
|
|
||||||
try:
|
try:
|
||||||
let doc = """
|
|
||||||
Usage:
|
|
||||||
pit ( new | add) <summary> [<state>] [options]
|
|
||||||
pit list contexts
|
|
||||||
pit list [<stateOrId>] [options]
|
|
||||||
pit ( start | done | pending | todo-today | todo | suspend ) <id>... [options]
|
|
||||||
pit edit <ref>...
|
|
||||||
pit tag <id>... [options]
|
|
||||||
pit untag <id>... [options]
|
|
||||||
pit reorder <state>
|
|
||||||
pit delegate <id> <delegated-to>
|
|
||||||
pit ( delete | rm ) <id>...
|
|
||||||
pit add-binary-property <id> <propName> <propSource>
|
|
||||||
pit get-binary-property <id> <propName> <propDest>
|
|
||||||
|
|
||||||
Options:
|
let consoleLogger = newConsoleLogger(
|
||||||
|
levelThreshold=lvlInfo,
|
||||||
-h, --help Print this usage information.
|
fmtStr="pit - $levelname: ")
|
||||||
|
logging.addHandler(consoleLogger)
|
||||||
-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.
|
|
||||||
|
|
||||||
-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.
|
|
||||||
"""
|
|
||||||
|
|
||||||
logging.addHandler(newConsoleLogger())
|
|
||||||
|
|
||||||
# Parse arguments
|
# Parse arguments
|
||||||
let args = docopt(doc, version = PIT_VERSION)
|
let args = docopt(USAGE, version = PIT_VERSION)
|
||||||
|
|
||||||
|
if args["--debug"]:
|
||||||
|
consoleLogger.levelThreshold = lvlDebug
|
||||||
|
|
||||||
if args["--echo-args"]: stderr.writeLine($args)
|
if args["--echo-args"]: stderr.writeLine($args)
|
||||||
|
|
||||||
if args["--help"]:
|
if args["help"]:
|
||||||
stderr.writeLine(doc)
|
stderr.writeLine(USAGE & "\n")
|
||||||
|
stderr.writeLine(ONLINE_HELP)
|
||||||
quit()
|
quit()
|
||||||
|
|
||||||
let ctx = initContext(args)
|
let ctx = initContext(args)
|
||||||
|
|
||||||
|
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"]:
|
||||||
@ -320,6 +313,20 @@ Options:
|
|||||||
|
|
||||||
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
|
||||||
@ -403,17 +410,25 @@ Options:
|
|||||||
if propertiesOption.isSome:
|
if propertiesOption.isSome:
|
||||||
for k,v in propertiesOption.get:
|
for k,v in propertiesOption.get:
|
||||||
issue[k] = v
|
issue[k] = v
|
||||||
if targetState == Done: issue["completed"] = getTime().local.formatIso8601
|
if targetState == Done:
|
||||||
|
issue["completed"] = getTime().local.formatIso8601
|
||||||
|
if issue.hasProp("recurrence") and issue.getRecurrence.isSome:
|
||||||
|
let nextIssue = ctx.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
|
||||||
|
ctx.tasksDir.store(nextIssue, Todo)
|
||||||
|
info "created the next recurrence:"
|
||||||
|
stdout.writeLine ctx.formatIssue(nextIssue)
|
||||||
|
|
||||||
|
|
||||||
issue.changeState(ctx.tasksDir, targetState)
|
issue.changeState(ctx.tasksDir, targetState)
|
||||||
|
|
||||||
if ctx.triggerPtk or args["--ptk"]:
|
if ctx.triggerPtk or args["--ptk"]:
|
||||||
if targetState == Current:
|
if targetState == Current:
|
||||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"][0]))
|
let issue = ctx.tasksDir.loadIssueById($(args["<id>"][0]))
|
||||||
var cmd = "ptk start"
|
var cmd = "ptk start"
|
||||||
if issue.tags.len > 0 or issue.properties.hasKey("context"):
|
if issue.tags.len > 0 or issue.hasProp("context"):
|
||||||
let tags = concat(
|
let tags = concat(
|
||||||
issue.tags,
|
issue.tags,
|
||||||
if issue.properties.hasKey("context"): @[issue.properties["context"]]
|
if issue.hasProp("context"): @[issue.properties["context"]]
|
||||||
else: @[]
|
else: @[]
|
||||||
)
|
)
|
||||||
cmd &= " -g \"" & tags.join(",") & "\""
|
cmd &= " -g \"" & tags.join(",") & "\""
|
||||||
@ -423,6 +438,13 @@ Options:
|
|||||||
elif targetState == Done or targetState == Pending:
|
elif targetState == Done or targetState == Pending:
|
||||||
discard execShellCmd("ptk stop")
|
discard execShellCmd("ptk stop")
|
||||||
|
|
||||||
|
elif args["hide-until"]:
|
||||||
|
|
||||||
|
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
||||||
|
issue.setDateTime("hide-until", parseDate($args["<date>"]))
|
||||||
|
|
||||||
|
issue.store()
|
||||||
|
|
||||||
elif args["delegate"]:
|
elif args["delegate"]:
|
||||||
|
|
||||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
||||||
@ -452,6 +474,11 @@ Options:
|
|||||||
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"]))
|
||||||
@ -476,15 +503,16 @@ Options:
|
|||||||
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 stateOption = none(IssueState)
|
var statesOption = none(seq[IssueState])
|
||||||
var issueIdOption = none(string)
|
var issueIdsOption = none(seq[string])
|
||||||
|
|
||||||
if args["contexts"]: listContexts = true
|
if args["contexts"]: listContexts = true
|
||||||
elif args["<stateOrId>"]:
|
elif args["<stateOrId>"]:
|
||||||
try: stateOption = some(parseEnum[IssueState]($args["<stateOrId>"]))
|
try: statesOption = some(args["<stateOrId>"].mapIt(parseEnum[IssueState]($it)))
|
||||||
except: issueIdOption = some($args["<stateOrId>"])
|
except: issueIdsOption = some(args["<stateOrId>"].mapIt($it))
|
||||||
|
|
||||||
# List the known contexts
|
# List the known contexts
|
||||||
if listContexts:
|
if listContexts:
|
||||||
@ -504,16 +532,22 @@ Options:
|
|||||||
stdout.writeLine(c.alignLeft(maxLen+2) & ctx.getIssueContextDisplayName(c))
|
stdout.writeLine(c.alignLeft(maxLen+2) & ctx.getIssueContextDisplayName(c))
|
||||||
|
|
||||||
# List a specific issue
|
# List a specific issue
|
||||||
elif issueIdOption.isSome:
|
elif issueIdsOption.isSome:
|
||||||
let issue = ctx.tasksDir.loadIssueById(issueIdOption.get)
|
for issueId in issueIdsOption.get:
|
||||||
stdout.writeLine ctx.formatIssue(issue)
|
let issue = ctx.tasksDir.loadIssueById(issueId)
|
||||||
|
stdout.writeLine ctx.formatIssue(issue)
|
||||||
|
|
||||||
# List all issues
|
# List all issues
|
||||||
else:
|
else:
|
||||||
|
trace "listing all issues"
|
||||||
let showBoth = args["--today"] == args["--future"]
|
let showBoth = args["--today"] == args["--future"]
|
||||||
ctx.list(filterOption, stateOption, showBoth or args["--today"],
|
ctx.list(
|
||||||
showBoth or args["--future"],
|
filter = filterOption,
|
||||||
ctx.verbose)
|
states = statesOption,
|
||||||
|
showToday = showBoth or args["--today"],
|
||||||
|
showFuture = showBoth or args["--future"],
|
||||||
|
showHidden = args["--show-hidden"],
|
||||||
|
verbose = ctx.verbose)
|
||||||
|
|
||||||
elif args["add-binary-property"]:
|
elif args["add-binary-property"]:
|
||||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
||||||
@ -543,6 +577,6 @@ Options:
|
|||||||
finally: close(propOut)
|
finally: close(propOut)
|
||||||
|
|
||||||
except:
|
except:
|
||||||
fatal "pit: " & getCurrentExceptionMsg()
|
fatal getCurrentExceptionMsg()
|
||||||
#raise getCurrentException()
|
#raise getCurrentException()
|
||||||
quit(QuitFailure)
|
quit(QuitFailure)
|
||||||
|
@ -5,8 +5,7 @@ import asyncdispatch, cliutils, docopt, jester, json, logging, options, sequtils
|
|||||||
import nre except toSeq
|
import nre except toSeq
|
||||||
|
|
||||||
import pitpkg/private/libpit
|
import pitpkg/private/libpit
|
||||||
|
import pitpkg/cliconstants
|
||||||
include "pitpkg/version.nim"
|
|
||||||
|
|
||||||
type
|
type
|
||||||
PitApiCfg* = object
|
PitApiCfg* = object
|
||||||
@ -40,10 +39,10 @@ template checkAuth(cfg: PitApiCfg) =
|
|||||||
var authed {.inject.} = false
|
var authed {.inject.} = false
|
||||||
|
|
||||||
try:
|
try:
|
||||||
if not request.headers.hasKey("Authorization"):
|
if not headers(request).hasKey("Authorization"):
|
||||||
raiseEx "No auth token."
|
raiseEx "No auth token."
|
||||||
|
|
||||||
let headerVal = request.headers["Authorization"]
|
let headerVal = headers(request)["Authorization"]
|
||||||
if not headerVal.startsWith("Bearer "):
|
if not headerVal.startsWith("Bearer "):
|
||||||
raiseEx "Invalid Authentication type (only 'Bearer' is supported)."
|
raiseEx "Invalid Authentication type (only 'Bearer' is supported)."
|
||||||
|
|
||||||
|
169
src/pitpkg/cliconstants.nim
Normal file
169
src/pitpkg/cliconstants.nim
Normal file
@ -0,0 +1,169 @@
|
|||||||
|
const PIT_VERSION* = "4.19.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.
|
||||||
|
|
||||||
|
-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.
|
||||||
|
|
||||||
|
-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.
|
||||||
|
|
||||||
|
--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.
|
||||||
|
"""
|
||||||
|
|
||||||
|
const ONLINE_HELP* = """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>'.
|
||||||
|
"""
|
@ -1,7 +1,7 @@
|
|||||||
import cliutils, docopt, json, logging, langutils, options, os,
|
import cliutils, docopt, json, logging, langutils, options, os,
|
||||||
sequtils, strutils, tables, times, timeutils, uuids
|
sequtils, strformat, strutils, tables, times, timeutils, uuids
|
||||||
|
|
||||||
from nre import find, match, re, Regex
|
import nre except toSeq
|
||||||
|
|
||||||
type
|
type
|
||||||
Issue* = ref object
|
Issue* = ref object
|
||||||
@ -24,15 +24,35 @@ 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
|
||||||
contexts*: TableRef[string, string]
|
contexts*: TableRef[string, string]
|
||||||
cfg*: CombinedConfig
|
cfg*: CombinedConfig
|
||||||
|
|
||||||
|
Recurrence* = object
|
||||||
|
cloneId*: Option[string]
|
||||||
|
interval*: TimeInterval
|
||||||
|
isFromCompletion*: bool
|
||||||
|
|
||||||
const DONE_FOLDER_FORMAT* = "yyyy-MM"
|
const DONE_FOLDER_FORMAT* = "yyyy-MM"
|
||||||
|
|
||||||
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 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]+))?"
|
||||||
|
|
||||||
|
let traceStartTime = cpuTime()
|
||||||
|
var lastTraceTime = traceStartTime
|
||||||
|
|
||||||
|
proc trace*(msg: string, diffFromLast = false) =
|
||||||
|
let curTraceTime = cpuTime()
|
||||||
|
|
||||||
|
if diffFromLast:
|
||||||
|
debug &"{(curTraceTime - lastTraceTime) * 1000:6.2f}ms {msg}"
|
||||||
|
else:
|
||||||
|
debug &"{cpuTime() - traceStartTime:08.4f} {msg}"
|
||||||
|
|
||||||
|
lastTraceTime = curTraceTime
|
||||||
|
|
||||||
proc displayName*(s: IssueState): string =
|
proc displayName*(s: IssueState): string =
|
||||||
case s
|
case s
|
||||||
@ -64,6 +84,30 @@ proc getDateTime*(issue: Issue, key: string, default: DateTime): DateTime =
|
|||||||
proc setDateTime*(issue: Issue, key: string, dt: DateTime) =
|
proc setDateTime*(issue: Issue, key: string, dt: DateTime) =
|
||||||
issue.properties[key] = dt.formatIso8601
|
issue.properties[key] = dt.formatIso8601
|
||||||
|
|
||||||
|
proc getRecurrence*(issue: Issue): Option[Recurrence] =
|
||||||
|
if not issue.hasProp("recurrence"): return none[Recurrence]()
|
||||||
|
|
||||||
|
let m = issue["recurrence"].match(RECURRENCE_PATTERN)
|
||||||
|
|
||||||
|
if not m.isSome:
|
||||||
|
warn "not a valid recurrence value: '" & issue["recurrence"] & "'"
|
||||||
|
return none[Recurrence]()
|
||||||
|
|
||||||
|
let c = nre.toSeq(m.get.captures)
|
||||||
|
let timeVal = if c[2].isSome: c[2].get.parseInt
|
||||||
|
else: 1
|
||||||
|
return some(Recurrence(
|
||||||
|
isFromCompletion: c[0].get == "after",
|
||||||
|
interval:
|
||||||
|
case c[4].get:
|
||||||
|
of "hour": hours(timeVal)
|
||||||
|
of "day": days(timeVal)
|
||||||
|
of "week": weeks(timeVal)
|
||||||
|
of "month": months(timeVal)
|
||||||
|
of "year": years(timeVal)
|
||||||
|
else: weeks(1),
|
||||||
|
cloneId: c[6]))
|
||||||
|
|
||||||
## Issue filtering
|
## Issue filtering
|
||||||
proc initFilter*(): IssueFilter =
|
proc initFilter*(): IssueFilter =
|
||||||
result = IssueFilter(
|
result = IssueFilter(
|
||||||
@ -71,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):
|
||||||
@ -105,6 +150,23 @@ proc groupBy*(issues: seq[Issue], propertyKey: string): TableRef[string, seq[Iss
|
|||||||
result[key].add(i)
|
result[key].add(i)
|
||||||
|
|
||||||
|
|
||||||
|
## Parse and format dates
|
||||||
|
const DATE_FORMATS = [
|
||||||
|
"MM/dd",
|
||||||
|
"MM-dd",
|
||||||
|
"yyyy-MM-dd",
|
||||||
|
"yyyy/MM/dd",
|
||||||
|
"yyyy-MM-dd'T'hh:mm:ss"
|
||||||
|
]
|
||||||
|
proc parseDate*(d: string): DateTime =
|
||||||
|
var errMsg = ""
|
||||||
|
for df in DATE_FORMATS:
|
||||||
|
try: return d.parse(df)
|
||||||
|
except:
|
||||||
|
errMsg &= "\n\tTried " & df & " with " & d
|
||||||
|
continue
|
||||||
|
raise newException(ValueError, "Unable to parse input as a date: " & d & errMsg)
|
||||||
|
|
||||||
## Parse and format issues
|
## Parse and format issues
|
||||||
proc fromStorageFormat*(id: string, issueTxt: string): Issue =
|
proc fromStorageFormat*(id: string, issueTxt: string): Issue =
|
||||||
type ParseState = enum ReadingSummary, ReadingProps, ReadingDetails
|
type ParseState = enum ReadingSummary, ReadingProps, ReadingDetails
|
||||||
@ -204,6 +266,8 @@ proc storeOrder*(issues: seq[Issue], path: string) =
|
|||||||
proc loadIssues*(path: string): seq[Issue] =
|
proc loadIssues*(path: string): seq[Issue] =
|
||||||
let orderFile = path / "order.txt"
|
let orderFile = path / "order.txt"
|
||||||
|
|
||||||
|
trace "loading issues under " & path
|
||||||
|
|
||||||
let orderedIds =
|
let orderedIds =
|
||||||
if fileExists(orderFile):
|
if fileExists(orderFile):
|
||||||
toSeq(orderFile.lines)
|
toSeq(orderFile.lines)
|
||||||
@ -219,6 +283,7 @@ proc loadIssues*(path: string): seq[Issue] =
|
|||||||
if extractFilename(path).match(ISSUE_FILE_PATTERN).isSome():
|
if extractFilename(path).match(ISSUE_FILE_PATTERN).isSome():
|
||||||
unorderedIssues.add((loadIssue(path), false))
|
unorderedIssues.add((loadIssue(path), false))
|
||||||
|
|
||||||
|
trace "loaded " & $unorderedIssues.len & " issues", true
|
||||||
result = @[]
|
result = @[]
|
||||||
|
|
||||||
# Add all ordered issues in order
|
# Add all ordered issues in order
|
||||||
@ -233,6 +298,8 @@ proc loadIssues*(path: string): seq[Issue] =
|
|||||||
if taggedIssue.ordered: continue
|
if taggedIssue.ordered: continue
|
||||||
result.add(taggedIssue.issue)
|
result.add(taggedIssue.issue)
|
||||||
|
|
||||||
|
trace "ordered the loaded issues", true
|
||||||
|
|
||||||
# Finally, save current order
|
# Finally, save current order
|
||||||
result.storeOrder(path)
|
result.storeOrder(path)
|
||||||
|
|
||||||
@ -244,6 +311,37 @@ proc changeState*(issue: Issue, tasksDir: string, newState: IssueState) =
|
|||||||
|
|
||||||
proc delete*(issue: Issue) = removeFile(issue.filepath)
|
proc delete*(issue: Issue) = removeFile(issue.filepath)
|
||||||
|
|
||||||
|
proc nextRecurrence*(tasksDir: string, rec: Recurrence, defaultIssue: Issue): Issue =
|
||||||
|
let baseIssue = if rec.cloneId.isSome: tasksDir.loadIssueById(rec.cloneId.get)
|
||||||
|
else: defaultIssue
|
||||||
|
|
||||||
|
let newProps = newTable[string,string]()
|
||||||
|
for k, v in baseIssue.properties:
|
||||||
|
if k != "completed": newProps[k] = v
|
||||||
|
newProps["prev-recurrence"] = $baseIssue.id
|
||||||
|
|
||||||
|
result = Issue(
|
||||||
|
id: genUUID(),
|
||||||
|
summary: baseIssue.summary,
|
||||||
|
properties: newProps,
|
||||||
|
tags: baseIssue.tags)
|
||||||
|
|
||||||
|
let now = getTime().local
|
||||||
|
|
||||||
|
let startDate =
|
||||||
|
if rec.isFromCompletion:
|
||||||
|
if baseIssue.hasProp("completed"): baseIssue.getDateTime("completed")
|
||||||
|
else: now
|
||||||
|
else:
|
||||||
|
if baseIssue.hasProp("created"): baseIssue.getDateTime("created")
|
||||||
|
else: now
|
||||||
|
|
||||||
|
# walk the calendar until the next recurrence that is after the current time.
|
||||||
|
var nextTime = startDate + rec.interval
|
||||||
|
while now > nextTime: nextTime += rec.interval
|
||||||
|
|
||||||
|
result.setDateTime("hide-until", nextTime)
|
||||||
|
|
||||||
## Utilities for working with issue collections.
|
## Utilities for working with issue collections.
|
||||||
proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
|
proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
|
||||||
result = issues
|
result = issues
|
||||||
@ -251,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(
|
||||||
@ -278,14 +382,14 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
|
|||||||
foldl(pitrcLocations, if len(a) > 0: a elif fileExists(b): b else: "")
|
foldl(pitrcLocations, if len(a) > 0: a elif fileExists(b): b else: "")
|
||||||
|
|
||||||
if not fileExists(pitrcFilename):
|
if not fileExists(pitrcFilename):
|
||||||
warn "pit: could not find .pitrc file: " & pitrcFilename
|
warn "could not find .pitrc file: " & pitrcFilename
|
||||||
if isEmptyOrWhitespace(pitrcFilename):
|
if isEmptyOrWhitespace(pitrcFilename):
|
||||||
pitrcFilename = $getEnv("HOME") & "/.pitrc"
|
pitrcFilename = $getEnv("HOME") & "/.pitrc"
|
||||||
var cfgFile: File
|
var cfgFile: File
|
||||||
try:
|
try:
|
||||||
cfgFile = open(pitrcFilename, fmWrite)
|
cfgFile = open(pitrcFilename, fmWrite)
|
||||||
cfgFile.write("{\"tasksDir\": \"/path/to/tasks\"}")
|
cfgFile.write("{\"tasksDir\": \"/path/to/tasks\"}")
|
||||||
except: warn "pit: could not write default .pitrc to " & pitrcFilename
|
except: warn "could not write default .pitrc to " & pitrcFilename
|
||||||
finally: close(cfgFile)
|
finally: close(cfgFile)
|
||||||
|
|
||||||
var cfgJson: JsonNode
|
var cfgJson: JsonNode
|
||||||
|
@ -1 +0,0 @@
|
|||||||
const PIT_VERSION* = "4.12.0"
|
|
Reference in New Issue
Block a user