Compare commits
21 Commits
Author | SHA1 | Date | |
---|---|---|---|
e955cd5b24 | |||
4176dfea3a | |||
587e3c4509 | |||
f6a97c384a | |||
0c3d73dc2b | |||
9a0bf35882 | |||
be7c099b7b | |||
d04797460c | |||
8cf0bf5d98 | |||
ddad90ddef | |||
34ce2b61b9 | |||
661d5959c6 | |||
6665f09b7b | |||
bcb1c7c17c | |||
b0e3f5a9d8 | |||
fee4ba70a6 | |||
171adbb59d | |||
d01d6e37f4 | |||
b98596574d | |||
ea9f8ea7ac | |||
ae4a943e82 |
2
.mise.toml
Normal file
2
.mise.toml
Normal file
@ -0,0 +1,2 @@
|
||||
[tools]
|
||||
nim = "2.2.0"
|
20
pit.nimble
20
pit.nimble
@ -1,28 +1,30 @@
|
||||
# Package
|
||||
|
||||
version = "4.21.1"
|
||||
version = "4.27.0"
|
||||
author = "Jonathan Bernard"
|
||||
description = "Personal issue tracker."
|
||||
license = "MIT"
|
||||
srcDir = "src"
|
||||
bin = @["pit", "pit_api"]
|
||||
installExt = @["nim"]
|
||||
bin = @["pit"]
|
||||
|
||||
# Dependencies
|
||||
|
||||
requires @[
|
||||
"nim >= 1.4.0",
|
||||
"docopt >= 0.6.8",
|
||||
"jester >= 0.5.0",
|
||||
"uuids >= 0.1.10"
|
||||
"docopt >= 0.7.1",
|
||||
"jester >= 0.6.0",
|
||||
"uuids >= 0.1.10",
|
||||
"zero_functional"
|
||||
]
|
||||
|
||||
# Dependencies from git.jdb-software.com/nim-jdb/packages
|
||||
# Dependencies from git.jdb-software.com/jdb/nim-packages
|
||||
requires @[
|
||||
"cliutils >= 0.6.4",
|
||||
"cliutils >= 0.9.1",
|
||||
"langutils >= 0.4.0",
|
||||
"timeutils >= 0.4.0",
|
||||
"timeutils >= 0.5.4",
|
||||
"data_uri > 1.0.0",
|
||||
"https://git.jdb-software.com/jdb/update-nim-package-version >= 0.2.0"
|
||||
"update_nim_package_version >= 0.2.0"
|
||||
]
|
||||
|
||||
task updateVersion, "Update the version of this package.":
|
||||
|
175
src/pit.nim
175
src/pit.nim
@ -1,8 +1,8 @@
|
||||
## Personal Issue Tracker CLI interface
|
||||
## ====================================
|
||||
|
||||
import std/algorithm, std/logging, std/options, std/os, std/sequtils,
|
||||
std/wordwrap, std/tables, std/terminal, std/times, std/unicode
|
||||
import std/[algorithm, logging, options, os, sequtils, wordwrap, tables,
|
||||
terminal, times, unicode]
|
||||
import cliutils, data_uri, docopt, json, timeutils, uuids
|
||||
|
||||
from nre import re
|
||||
@ -16,7 +16,6 @@ type
|
||||
cfg*: PitConfig
|
||||
contexts*: TableRef[string, string]
|
||||
defaultContext*: Option[string]
|
||||
tasksDir*: string
|
||||
issues*: TableRef[IssueState, seq[Issue]]
|
||||
termWidth*: int
|
||||
triggerPtk*, verbose*: bool
|
||||
@ -43,7 +42,6 @@ proc initContext(args: Table[string, Value]): CliContext =
|
||||
else: some(cliJson["defaultContext"].getStr()),
|
||||
verbose: parseBool(cliCfg.getVal("verbose", "false")) and not args["--quiet"],
|
||||
issues: newTable[IssueState, seq[Issue]](),
|
||||
tasksDir: pitCfg.tasksDir,
|
||||
termWidth: parseInt(cliCfg.getVal("termWidth", "80")),
|
||||
triggerPtk: cliJson.getOrDefault("triggerPtk").getBool(false))
|
||||
|
||||
@ -53,7 +51,7 @@ proc getIssueContextDisplayName(ctx: CliContext, context: string): string =
|
||||
else: return context.capitalize()
|
||||
return ctx.contexts[context]
|
||||
|
||||
proc formatIssue(ctx: CliContext, issue: Issue): string =
|
||||
proc formatIssue*(issue: Issue): string =
|
||||
result = ($issue.id).withColor(fgBlack, true) & "\n"&
|
||||
issue.summary.withColor(fgWhite) & "\n"
|
||||
|
||||
@ -72,10 +70,27 @@ proc formatIssue(ctx: CliContext, issue: Issue): string =
|
||||
|
||||
result &= termReset
|
||||
|
||||
proc formatSectionIssue(
|
||||
ctx: CliContext,
|
||||
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,
|
||||
width: int = 80,
|
||||
indent = "",
|
||||
verbose = false): string =
|
||||
|
||||
@ -137,12 +152,15 @@ proc formatSectionIssue(
|
||||
|
||||
result &= termReset
|
||||
|
||||
proc formatSectionIssueList(ctx: CliContext, issues: seq[Issue], width: int,
|
||||
indent: string, verbose: bool): string =
|
||||
proc formatSectionIssueList*(
|
||||
issues: seq[Issue],
|
||||
width: int = 80,
|
||||
indent: string = "",
|
||||
verbose: bool = false): string =
|
||||
|
||||
result = ""
|
||||
for i in issues:
|
||||
var issueText = ctx.formatSectionIssue(i, width, indent, verbose)
|
||||
var issueText = formatSectionIssue(i, width, indent, verbose)
|
||||
result &= issueText & "\n"
|
||||
|
||||
proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
|
||||
@ -163,21 +181,20 @@ proc formatSection(ctx: CliContext, issues: seq[Issue], state: IssueState,
|
||||
indent & ctx.getIssueContextDisplayName(context) & ":" &
|
||||
termReset & "\n\n"
|
||||
|
||||
result &= ctx.formatSectionIssueList(ctxIssues, innerWidth - 2, indent & " ", verbose)
|
||||
result &= formatSectionIssueList(ctxIssues, innerWidth - 2, indent & " ", verbose)
|
||||
result &= "\n"
|
||||
|
||||
else: result &= ctx.formatSectionIssueList(issues, innerWidth, indent, verbose)
|
||||
else: result &= formatSectionIssueList(issues, innerWidth, indent, verbose)
|
||||
|
||||
proc loadIssues(ctx: CliContext, state: IssueState) =
|
||||
ctx.issues[state] = loadIssues(ctx.tasksDir / $state)
|
||||
ctx.issues[state] = loadIssues(ctx.cfg.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) =
|
||||
ctx.issues = newTable[IssueState, seq[Issue]]()
|
||||
for state in IssueState: ctx.loadIssues(state)
|
||||
ctx.issues = ctx.cfg.tasksDir.loadAllIssues()
|
||||
|
||||
proc filterIssues(ctx: CliContext, filter: IssueFilter) =
|
||||
for state, issueList in ctx.issues:
|
||||
@ -214,7 +231,7 @@ proc reorder(ctx: CliContext, state: IssueState) =
|
||||
|
||||
# load the issues to make sure the order file contains all issues in the state.
|
||||
ctx.loadIssues(state)
|
||||
discard os.execShellCmd(EDITOR & " '" & (ctx.tasksDir / $state / "order.txt") & "' </dev/tty >/dev/tty")
|
||||
discard os.execShellCmd(EDITOR & " '" & (ctx.cfg.tasksDir / $state / "order.txt") & "' </dev/tty >/dev/tty")
|
||||
|
||||
proc edit(issue: Issue) =
|
||||
|
||||
@ -227,7 +244,7 @@ proc edit(issue: Issue) =
|
||||
# Try to parse the newly-edited issue to make sure it was successful.
|
||||
let editedIssue = loadIssue(issue.filepath)
|
||||
editedIssue.store()
|
||||
except:
|
||||
except CatchableError:
|
||||
fatal "updated issue is invalid (ignoring edits): \n\t" &
|
||||
getCurrentExceptionMsg()
|
||||
issue.store()
|
||||
@ -236,7 +253,8 @@ proc list(
|
||||
ctx: CliContext,
|
||||
filter: Option[IssueFilter],
|
||||
states: Option[seq[IssueState]],
|
||||
showToday, showFuture,
|
||||
showToday = false,
|
||||
showFuture = false,
|
||||
showHidden = false,
|
||||
verbose: bool) =
|
||||
|
||||
@ -252,7 +270,15 @@ proc list(
|
||||
it.hasProp("completed") and
|
||||
sameDay(getTime().local, it.getDateTime("completed")))
|
||||
|
||||
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
|
||||
|
||||
@ -280,8 +306,14 @@ proc list(
|
||||
not (it.hasProp("hide-until") and
|
||||
it.getDateTime("hide-until") > getTime().local))
|
||||
|
||||
if isatty(stdout):
|
||||
stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
|
||||
|
||||
else:
|
||||
stdout.writeLine visibleIssues
|
||||
.mapIt(formatPlainIssueSummary(it))
|
||||
.join("\n")
|
||||
|
||||
# Future items
|
||||
if future:
|
||||
if today: ctx.writeHeader("Future")
|
||||
@ -297,8 +329,14 @@ proc list(
|
||||
not (it.hasProp("hide-until") and
|
||||
it.getDateTime("hide-until") > getTime().local))
|
||||
|
||||
if isatty(stdout):
|
||||
stdout.write ctx.formatSection(visibleIssues, s, indent, verbose)
|
||||
|
||||
else:
|
||||
stdout.writeLine visibleIssues
|
||||
.mapIt(formatPlainIssueSummary(it))
|
||||
.join("\n")
|
||||
|
||||
trace "listing complete"
|
||||
|
||||
when isMainModule:
|
||||
@ -380,9 +418,9 @@ when isMainModule:
|
||||
if tagsOption.isSome: tagsOption.get
|
||||
else: newSeq[string]())
|
||||
|
||||
ctx.tasksDir.store(issue, state)
|
||||
ctx.cfg.tasksDir.store(issue, state)
|
||||
|
||||
stdout.writeLine ctx.formatIssue(issue)
|
||||
stdout.writeLine formatIssue(issue)
|
||||
|
||||
elif args["reorder"]:
|
||||
ctx.reorder(parseEnum[IssueState]($args["<state>"]))
|
||||
@ -390,17 +428,31 @@ when isMainModule:
|
||||
elif args["edit"]:
|
||||
for editRef in @(args["<ref>"]):
|
||||
|
||||
let propsOption =
|
||||
if args["--properties"]:
|
||||
some(parsePropertiesOption($args["--properties"]))
|
||||
else: none(TableRef[string, string])
|
||||
|
||||
var stateOption = none(IssueState)
|
||||
|
||||
try: stateOption = some(parseEnum[IssueState](editRef))
|
||||
except: discard
|
||||
except CatchableError: discard
|
||||
|
||||
if stateOption.isSome:
|
||||
let state = stateOption.get
|
||||
ctx.loadIssues(state)
|
||||
for issue in ctx.issues[state]: edit(issue)
|
||||
for issue in ctx.issues[state]:
|
||||
if propsOption.isSome:
|
||||
for k,v in propsOption.get:
|
||||
issue[k] = v
|
||||
edit(issue)
|
||||
|
||||
else: edit(ctx.tasksDir.loadIssueById(editRef))
|
||||
else:
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById(editRef)
|
||||
if propertiesOption.isSome:
|
||||
for k,v in propertiesOption.get:
|
||||
issue[k] = v
|
||||
edit(issue)
|
||||
|
||||
elif args["tag"]:
|
||||
if tagsOption.isNone: raise newException(Exception, "no tags given")
|
||||
@ -408,7 +460,7 @@ when isMainModule:
|
||||
let newTags = tagsOption.get
|
||||
|
||||
for id in @(args["<id>"]):
|
||||
var issue = ctx.tasksDir.loadIssueById(id)
|
||||
var issue = ctx.cfg.tasksDir.loadIssueById(id)
|
||||
issue.tags = deduplicate(issue.tags & newTags)
|
||||
issue.store()
|
||||
|
||||
@ -418,7 +470,7 @@ when isMainModule:
|
||||
else: @[]
|
||||
|
||||
for id in @(args["<id>"]):
|
||||
var issue = ctx.tasksDir.loadIssueById(id)
|
||||
var issue = ctx.cfg.tasksDir.loadIssueById(id)
|
||||
if tagsToRemove.len > 0:
|
||||
issue.tags = issue.tags.filter(
|
||||
proc (tag: string): bool = not tagsToRemove.anyIt(it == tag))
|
||||
@ -437,24 +489,24 @@ when isMainModule:
|
||||
elif args["suspend"]: targetState = Dormant
|
||||
|
||||
for id in @(args["<id>"]):
|
||||
var issue = ctx.tasksDir.loadIssueById(id)
|
||||
var issue = ctx.cfg.tasksDir.loadIssueById(id)
|
||||
if propertiesOption.isSome:
|
||||
for k,v in propertiesOption.get:
|
||||
issue[k] = v
|
||||
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)
|
||||
let nextIssue = ctx.cfg.tasksDir.nextRecurrence(issue.getRecurrence.get, issue)
|
||||
ctx.cfg.tasksDir.store(nextIssue, TodoToday)
|
||||
info "created the next recurrence:"
|
||||
stdout.writeLine ctx.formatIssue(nextIssue)
|
||||
stdout.writeLine formatIssue(nextIssue)
|
||||
|
||||
|
||||
issue.changeState(ctx.tasksDir, targetState)
|
||||
issue.changeState(ctx.cfg.tasksDir, targetState)
|
||||
|
||||
if ctx.triggerPtk or args["--ptk"]:
|
||||
if targetState == Current:
|
||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"][0]))
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"][0]))
|
||||
var cmd = "ptk start"
|
||||
if issue.tags.len > 0 or issue.hasProp("context"):
|
||||
let tags = concat(
|
||||
@ -464,21 +516,21 @@ 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")
|
||||
|
||||
elif args["hide-until"]:
|
||||
|
||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
|
||||
issue.setDateTime("hide-until", parseDate($args["<date>"]))
|
||||
|
||||
issue.store()
|
||||
|
||||
elif args["delegate"]:
|
||||
|
||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
|
||||
issue["delegated-to"] = $args["<delegated-to>"]
|
||||
|
||||
issue.store()
|
||||
@ -486,7 +538,7 @@ when isMainModule:
|
||||
elif args["delete"] or args["rm"]:
|
||||
for id in @(args["<id>"]):
|
||||
|
||||
let issue = ctx.tasksDir.loadIssueById(id)
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById(id)
|
||||
|
||||
if not args["--yes"]:
|
||||
stderr.write("Delete '" & issue.summary & "' (y/n)? ")
|
||||
@ -541,13 +593,19 @@ when isMainModule:
|
||||
filter.exclProperties.del("context")
|
||||
|
||||
var listContexts = false
|
||||
var listTags = false
|
||||
var statesOption = none(seq[IssueState])
|
||||
var issueIdsOption = none(seq[string])
|
||||
|
||||
if args["contexts"]: listContexts = true
|
||||
elif args["tags"]: listTags = true
|
||||
elif args["<stateOrId>"]:
|
||||
try: statesOption = some(args["<stateOrId>"].mapIt(parseEnum[IssueState]($it)))
|
||||
except: issueIdsOption = some(args["<stateOrId>"].mapIt($it))
|
||||
try:
|
||||
statesOption =
|
||||
some(args["<stateOrId>"].
|
||||
mapIt(parseEnum[IssueState]($it)))
|
||||
except CatchableError:
|
||||
issueIdsOption = some(args["<stateOrId>"].mapIt($it))
|
||||
|
||||
# List the known contexts
|
||||
if listContexts:
|
||||
@ -566,11 +624,26 @@ when isMainModule:
|
||||
for c in uniqContexts.sorted:
|
||||
stdout.writeLine(c.alignLeft(maxLen+2) & ctx.getIssueContextDisplayName(c))
|
||||
|
||||
elif listTags:
|
||||
var uniqTags = newseq[string]()
|
||||
if statesOption.isSome:
|
||||
for state in statesOption.get: ctx.loadIssues(state)
|
||||
else: ctx.loadAllIssues()
|
||||
|
||||
if filterOption.isSome: ctx.filterIssues(filterOption.get)
|
||||
|
||||
for state, issueList in ctx.issues:
|
||||
for issue in issueList:
|
||||
for tag in issue.tags:
|
||||
if not uniqTags.contains(tag): uniqTags.add(tag)
|
||||
|
||||
stdout.writeLine(uniqTags.sorted.join("\n"))
|
||||
|
||||
# List a specific issue
|
||||
elif issueIdsOption.isSome:
|
||||
for issueId in issueIdsOption.get:
|
||||
let issue = ctx.tasksDir.loadIssueById(issueId)
|
||||
stdout.writeLine ctx.formatIssue(issue)
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById(issueId)
|
||||
stdout.writeLine formatIssue(issue)
|
||||
|
||||
# List all issues
|
||||
else:
|
||||
@ -585,7 +658,7 @@ when isMainModule:
|
||||
verbose = ctx.verbose)
|
||||
|
||||
elif args["add-binary-property"]:
|
||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
|
||||
|
||||
let propIn =
|
||||
if $(args["<propSource>"]) == "-": stdin
|
||||
@ -597,7 +670,7 @@ when isMainModule:
|
||||
issue.store()
|
||||
|
||||
elif args["get-binary-property"]:
|
||||
let issue = ctx.tasksDir.loadIssueById($(args["<id>"]))
|
||||
let issue = ctx.cfg.tasksDir.loadIssueById($(args["<id>"]))
|
||||
|
||||
if not issue.hasProp($(args["<propName>"])):
|
||||
raise newException(Exception,
|
||||
@ -611,7 +684,23 @@ when isMainModule:
|
||||
try: write(propOut, decodeDataUri(issue[$(args["<propName>"])]))
|
||||
finally: close(propOut)
|
||||
|
||||
except:
|
||||
elif args["show-dupes"]:
|
||||
ctx.loadAllIssues()
|
||||
|
||||
var idsToPaths = newTable[string, var seq[string]]()
|
||||
for (state, issues) in pairs(ctx.issues):
|
||||
for issue in issues:
|
||||
let issueId = $issue.id
|
||||
|
||||
if idsToPaths.hasKey(issueId): idsToPaths[issueId].add(issue.filepath)
|
||||
else: idsToPaths[issueId] = @[issue.filepath]
|
||||
|
||||
for (issueId, issuePaths) in pairs(idsToPaths):
|
||||
if issuePaths.len < 2: continue
|
||||
stdout.writeLine(issueId & ":\p " & issuePaths.join("\p ") & "\p\p")
|
||||
|
||||
except CatchableError:
|
||||
fatal getCurrentExceptionMsg()
|
||||
debug getCurrentException().getStackTrace()
|
||||
#raise getCurrentException()
|
||||
quit(QuitFailure)
|
||||
|
@ -1,5 +1,11 @@
|
||||
## Personal Issue Tracker API Interface
|
||||
## ====================================
|
||||
#
|
||||
# **NOTE** This is currently not being built as it no longer works under Nim
|
||||
# 2.x due to the inability to call system calls (invoke pit via cli) in a
|
||||
# gc-safe manner. It should be rewritten to use the functionality exposed by
|
||||
# libpit directly rather than calling the pit cli executable. Unfortunately
|
||||
# this would require a non-trivial rewrite.
|
||||
|
||||
import asyncdispatch, cliutils, docopt, jester, json, logging, options, sequtils, strutils
|
||||
import nre except toSeq
|
||||
|
@ -1,8 +1,9 @@
|
||||
const PIT_VERSION* = "4.21.1"
|
||||
const PIT_VERSION* = "4.27.0"
|
||||
|
||||
const USAGE* = """Usage:
|
||||
pit ( new | add) <summary> [<state>] [options]
|
||||
pit list contexts [options]
|
||||
pit list tags [options]
|
||||
pit list [<stateOrId>...] [options]
|
||||
pit ( start | done | pending | todo-today | todo | suspend ) <id>... [options]
|
||||
pit edit <ref>... [options]
|
||||
@ -14,6 +15,7 @@ const USAGE* = """Usage:
|
||||
pit ( delete | rm ) <id>... [options]
|
||||
pit add-binary-property <id> <propName> <propSource> [options]
|
||||
pit get-binary-property <id> <propName> <propDest> [options]
|
||||
pit show-dupes
|
||||
pit help [options]
|
||||
|
||||
Options:
|
||||
@ -100,7 +102,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
|
||||
|
||||
@ -109,12 +113,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
|
||||
@ -122,17 +130,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
|
||||
@ -143,7 +157,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".
|
||||
|
||||
|
@ -1,8 +1,9 @@
|
||||
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 std/[json, logging, options, os, strformat, strutils, tables, times]
|
||||
import cliutils, docopt, langutils, uuids, zero_functional
|
||||
|
||||
import nre except toSeq
|
||||
import timeutils except `>`
|
||||
from sequtils import deduplicate, toSeq
|
||||
|
||||
type
|
||||
Issue* = ref object
|
||||
@ -11,6 +12,7 @@ type
|
||||
summary*, details*: string
|
||||
properties*: TableRef[string, string]
|
||||
tags*: seq[string]
|
||||
state*: IssueState
|
||||
|
||||
IssueState* = enum
|
||||
Current = "current",
|
||||
@ -39,6 +41,7 @@ type
|
||||
isFromCompletion*: bool
|
||||
|
||||
const DONE_FOLDER_FORMAT* = "yyyy-MM"
|
||||
const ISO8601_MS = "yyyy-MM-dd'T'HH:mm:ss'.'fffzzz"
|
||||
|
||||
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]+))?"
|
||||
@ -165,7 +168,7 @@ proc parseDate*(d: string): DateTime =
|
||||
var errMsg = ""
|
||||
for df in DATE_FORMATS:
|
||||
try: return d.parse(df)
|
||||
except:
|
||||
except CatchableError:
|
||||
errMsg &= "\n\tTried " & df & " with " & d
|
||||
continue
|
||||
raise newException(ValueError, "Unable to parse input as a date: " & d & errMsg)
|
||||
@ -201,12 +204,13 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
|
||||
continue
|
||||
|
||||
|
||||
let parts = line.split({':'}, 1).mapIt(it.strip())
|
||||
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`
|
||||
if parts[0] == "tags": result.tags = parts[1].split({','}).mapIt(it.strip())
|
||||
if parts[0] == "tags":
|
||||
result.tags = parts[1].split({','}) --> map(it.strip())
|
||||
else: result[parts[0]] = parts[1]
|
||||
|
||||
of ReadingDetails:
|
||||
@ -216,12 +220,17 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
|
||||
|
||||
proc toStorageFormat*(issue: Issue, withComments = false): string =
|
||||
var lines: seq[string] = @[]
|
||||
|
||||
if withComments: lines.add("# Summary (one line):")
|
||||
lines.add(issue.summary)
|
||||
|
||||
if withComments: lines.add("# Properties (\"key:value\" per line):")
|
||||
issue.properties["last-updated"] = now().format(ISO8601_MS)
|
||||
for key, val in issue.properties:
|
||||
if not val.isEmptyOrWhitespace: lines.add(key & ": " & val)
|
||||
|
||||
if issue.tags.len > 0: lines.add("tags: " & issue.tags.join(","))
|
||||
|
||||
if not isEmptyOrWhitespace(issue.details) or withComments:
|
||||
if withComments: lines.add("# Details go below the \"--------\"")
|
||||
lines.add("--------")
|
||||
@ -234,6 +243,11 @@ proc loadIssue*(filePath: string): Issue =
|
||||
result = fromStorageFormat(splitFile(filePath).name, readFile(filePath))
|
||||
result.filepath = filePath
|
||||
|
||||
let parentDirName = filePath.splitFile().dir.splitFile().name
|
||||
let issueState = IssueState.items.toSeq --> find($it == parentDirName)
|
||||
if issueState.isSome: result.state = issueState.get
|
||||
else: result.state = IssueState.Done
|
||||
|
||||
proc loadIssueById*(tasksDir, id: string): Issue =
|
||||
for path in walkDirRec(tasksDir):
|
||||
if path.splitFile.name.startsWith(id):
|
||||
@ -273,10 +287,10 @@ proc loadIssues*(path: string): seq[Issue] =
|
||||
|
||||
let orderedIds =
|
||||
if fileExists(orderFile):
|
||||
toSeq(orderFile.lines)
|
||||
.mapIt(it.split(' ')[0])
|
||||
.deduplicate
|
||||
.filterIt(not it.startsWith("> ") and not it.isEmptyOrWhitespace)
|
||||
(orderFile.lines.toSeq -->
|
||||
map(it.split(' ')[0]).
|
||||
filter(not it.startsWith("> ") and not it.isEmptyOrWhitespace)).
|
||||
deduplicate()
|
||||
else: newSeq[string]()
|
||||
|
||||
type TaggedIssue = tuple[issue: Issue, ordered: bool]
|
||||
@ -306,11 +320,24 @@ proc loadIssues*(path: string): seq[Issue] =
|
||||
# Finally, save current order
|
||||
result.storeOrder(path)
|
||||
|
||||
proc loadIssues*(tasksDir: string, state: IssueState): seq[Issue] =
|
||||
loadIssues(tasksDir / $state)
|
||||
|
||||
proc loadAllIssues*(tasksDir: string): TableRef[IssueState, seq[Issue]] =
|
||||
result = newTable[IssueState, seq[Issue]]()
|
||||
for state in IssueState: result[state] = tasksDir.loadIssues(state)
|
||||
|
||||
proc changeState*(issue: Issue, tasksDir: string, newState: IssueState) =
|
||||
var dbgInfo = "[$#] changing state: $# → $#" %
|
||||
[ ($issue.id)[0..<6], $issue.state, $newState ]
|
||||
|
||||
let oldFilepath = issue.filepath
|
||||
if newState == Done: issue.setDateTime("completed", getTime().local)
|
||||
tasksDir.store(issue, newState)
|
||||
if oldFilePath != issue.filepath: removeFile(oldFilepath)
|
||||
dbgInfo &= "\n\told path: $#\n\tnew path: $#" % [oldFilePath, issue.filepath]
|
||||
issue.state = newState
|
||||
debug dbgInfo
|
||||
|
||||
proc delete*(issue: Issue) = removeFile(issue.filepath)
|
||||
|
||||
@ -325,6 +352,7 @@ proc nextRecurrence*(tasksDir: string, rec: Recurrence, defaultIssue: Issue): Is
|
||||
|
||||
result = Issue(
|
||||
id: genUUID(),
|
||||
state: baseIssue.state,
|
||||
summary: baseIssue.summary,
|
||||
properties: newProps,
|
||||
tags: baseIssue.tags)
|
||||
@ -347,47 +375,55 @@ proc nextRecurrence*(tasksDir: string, rec: Recurrence, defaultIssue: Issue): Is
|
||||
|
||||
## Utilities for working with issue collections.
|
||||
proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
|
||||
result = issues
|
||||
var f: seq[Issue] = issues
|
||||
|
||||
for k,v in filter.properties:
|
||||
result = result.filterIt(it.hasProp(k) and it[k] == v)
|
||||
f = f --> filter(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])
|
||||
)
|
||||
f = f --> filter(not (it.hasProp(k) and v.contains(it[k])))
|
||||
|
||||
if filter.completedRange.isSome:
|
||||
let range = filter.completedRange.get
|
||||
result = result.filterIt(
|
||||
f = f --> filter(
|
||||
not it.hasProp("completed") or
|
||||
it.getDateTime("completed").between(range.b, range.e))
|
||||
|
||||
if filter.summaryMatch.isSome:
|
||||
let p = filter.summaryMatch.get
|
||||
result = result.filterIt(it.summary.find(p).isSome)
|
||||
f = f --> filter(it.summary.find(p).isSome)
|
||||
|
||||
if filter.fullMatch.isSome:
|
||||
let p = filter.fullMatch.get
|
||||
result = result.filterIt( it.summary.find(p).isSome or it.details.find(p).isSome)
|
||||
f = f -->
|
||||
filter(it.summary.find(p).isSome or it.details.find(p).isSome)
|
||||
|
||||
for tag in filter.hasTags:
|
||||
result = result.filterIt(it.tags.find(tag) >= 0)
|
||||
for tagLent in filter.hasTags:
|
||||
let tag = tagLent
|
||||
f = f --> filter(it.tags.find(tag) >= 0)
|
||||
|
||||
for exclTag in filter.exclTags:
|
||||
result = result.filterIt(it.tags.find(exclTag) < 0)
|
||||
for exclTagLent in filter.exclTags:
|
||||
let exclTag = exclTagLent
|
||||
f = f --> filter(it.tags.find(exclTag) < 0)
|
||||
|
||||
return f # not using result because zero_functional doesn't play nice with it
|
||||
|
||||
proc find*(
|
||||
issues: TableRef[IssueState, seq[Issue]],
|
||||
filter: IssueFilter
|
||||
): seq[Issue] =
|
||||
|
||||
result = @[]
|
||||
for stateIssues in issues.values: result &= stateIssues.filter(filter)
|
||||
|
||||
### Configuration utilities
|
||||
proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitConfig =
|
||||
let pitrcLocations = @[
|
||||
if args["--config"]: $args["--config"] else: "",
|
||||
".pitrc", $getEnv("PITRC"), $getEnv("HOME") & "/.pitrc"]
|
||||
var pitrcFilename: string
|
||||
|
||||
var pitrcFilename: string =
|
||||
foldl(pitrcLocations, if len(a) > 0: a elif fileExists(b): b else: "")
|
||||
|
||||
if not fileExists(pitrcFilename):
|
||||
try:
|
||||
pitrcFilename = findConfigFile(".pitrc",
|
||||
if args["--config"]: @[$args["--config"]] else: @[])
|
||||
except ValueError:
|
||||
warn "could not find .pitrc file: " & pitrcFilename
|
||||
if isEmptyOrWhitespace(pitrcFilename):
|
||||
pitrcFilename = $getEnv("HOME") & "/.pitrc"
|
||||
@ -395,24 +431,18 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
|
||||
try:
|
||||
cfgFile = open(pitrcFilename, fmWrite)
|
||||
cfgFile.write("{\"tasksDir\": \"/path/to/tasks\"}")
|
||||
except: warn "could not write default .pitrc to " & pitrcFilename
|
||||
except CatchableError: warn "could not write default .pitrc to " & pitrcFilename
|
||||
finally: close(cfgFile)
|
||||
|
||||
var cfgJson: JsonNode
|
||||
try: cfgJson = parseFile(pitrcFilename)
|
||||
except: raise newException(IOError,
|
||||
"unable to read config file: " & pitrcFilename &
|
||||
"\x0D\x0A" & getCurrentExceptionMsg())
|
||||
|
||||
let cfg = CombinedConfig(docopt: args, json: cfgJson)
|
||||
debug "loading config from '$#'" % [pitrcFilename]
|
||||
let cfg = initCombinedConfig(pitrcFilename, args)
|
||||
|
||||
result = PitConfig(
|
||||
cfg: cfg,
|
||||
contexts: newTable[string,string](),
|
||||
tasksDir: cfg.getVal("tasks-dir", ""))
|
||||
|
||||
if cfgJson.hasKey("contexts"):
|
||||
for k, v in cfgJson["contexts"]:
|
||||
for k, v in cfg.getJson("contexts", newJObject()):
|
||||
result.contexts[k] = v.getStr()
|
||||
|
||||
if isEmptyOrWhitespace(result.tasksDir):
|
||||
|
Reference in New Issue
Block a user