Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
393be347c9 | |||
f8fed9d937 | |||
ef16eafd48 | |||
4af0d09356 | |||
071c4b66e5 | |||
57a3af4f2f | |||
08b9df2086 |
@ -136,6 +136,3 @@ in the configuration file. All options are optional unless stated otherwise.
|
||||
|
||||
* `tasksDir` **required**: a file path to the root directory for the issue
|
||||
repository (same as `--tasks-dir` CLI parameter).
|
||||
|
||||
- CLI parameter: *cannot be specified via CLI*
|
||||
- config file key: `contexts`
|
||||
|
@ -1,6 +1,6 @@
|
||||
# Package
|
||||
|
||||
version = "4.9.0"
|
||||
version = "4.11.0"
|
||||
author = "Jonathan Bernard"
|
||||
description = "Personal issue tracker."
|
||||
license = "MIT"
|
||||
@ -10,9 +10,9 @@ bin = @["pit", "pit_api"]
|
||||
# Dependencies
|
||||
|
||||
requires @[
|
||||
"nim >= 0.19.0",
|
||||
"nim >= 1.4.0",
|
||||
"docopt 0.6.8",
|
||||
"jester 0.4.1",
|
||||
"jester 0.5.0",
|
||||
"uuids 0.1.10",
|
||||
|
||||
"https://git.jdb-labs.com/jdb/nim-cli-utils.git >= 0.6.4",
|
||||
|
43
src/pit.nim
43
src/pit.nim
@ -1,8 +1,8 @@
|
||||
## Personal Issue Tracker CLI interface
|
||||
## ====================================
|
||||
|
||||
import cliutils, docopt, json, logging, options, os, sequtils,
|
||||
tables, terminal, times, timeutils, unicode, uuids
|
||||
import algorithm, cliutils, docopt, json, logging, options, os, sequtils,
|
||||
std/wordwrap, tables, terminal, times, timeutils, unicode, uuids
|
||||
|
||||
from nre import re
|
||||
import strutils except alignLeft, capitalize, strip, toUpper, toLower
|
||||
@ -49,7 +49,7 @@ proc initContext(args: Table[string, Value]): CliContext =
|
||||
|
||||
proc getIssueContextDisplayName(ctx: CliContext, context: string): string =
|
||||
if not ctx.contexts.hasKey(context):
|
||||
if context.isNilOrWhitespace: return "<default>"
|
||||
if context.isEmptyOrWhitespace: return "<default>"
|
||||
else: return context.capitalize()
|
||||
return ctx.contexts[context]
|
||||
|
||||
@ -67,7 +67,7 @@ proc formatIssue(ctx: CliContext, issue: Issue): string =
|
||||
|
||||
|
||||
result &= "--------".withColor(fgBlack, true) & "\n"
|
||||
if not issue.details.isNilOrWhitespace:
|
||||
if not issue.details.isEmptyOrWhitespace:
|
||||
result &= issue.details.strip.withColor(fgCyan) & "\n"
|
||||
|
||||
proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
||||
@ -75,7 +75,7 @@ proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
||||
|
||||
result = ""
|
||||
|
||||
var showDetails = not issue.details.isNilOrWhitespace and verbose
|
||||
var showDetails = not issue.details.isEmptyOrWhitespace and verbose
|
||||
|
||||
var prefixLen = 0
|
||||
var summaryIndentLen = indent.len + 7
|
||||
@ -83,7 +83,7 @@ proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
||||
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).wordWrap(width - summaryIndentLen).indent(summaryIndentLen)
|
||||
var wrappedSummary = ("+".repeat(prefixLen) & issue.summary).wrapWords(width - summaryIndentLen).indent(summaryIndentLen)
|
||||
|
||||
wrappedSummary = wrappedSummary[(prefixLen + summaryIndentLen)..^1]
|
||||
|
||||
@ -103,7 +103,7 @@ proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
||||
|
||||
if issue.hasProp("pending"):
|
||||
let startIdx = "Pending: ".len
|
||||
var pendingText = issue["pending"].wordWrap(width - startIdx - summaryIndentLen)
|
||||
var pendingText = issue["pending"].wrapWords(width - startIdx - summaryIndentLen)
|
||||
.indent(startIdx)
|
||||
pendingText = ("Pending: " & pendingText[startIdx..^1]).indent(summaryIndentLen)
|
||||
result &= "\n" & pendingText.withColor(fgCyan)
|
||||
@ -199,6 +199,10 @@ proc list(ctx: CliContext, filter: Option[IssueFilter], state: Option[IssueState
|
||||
if state.isSome:
|
||||
ctx.loadIssues(state.get)
|
||||
if filter.isSome: ctx.filterIssues(filter.get)
|
||||
if state.get == 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.get], state.get, "", verbose)
|
||||
return
|
||||
|
||||
@ -221,13 +225,6 @@ proc list(ctx: CliContext, filter: Option[IssueFilter], state: Option[IssueState
|
||||
if ctx.issues.hasKey(s) and ctx.issues[s].len > 0:
|
||||
stdout.write ctx.formatSection(ctx.issues[s], s, indent, verbose)
|
||||
|
||||
if ctx.issues.hasKey(Done):
|
||||
let doneIssues = ctx.issues[Done].filterIt(
|
||||
it.hasProp("completed") and
|
||||
sameDay(getTime().local, it.getDateTime("completed")))
|
||||
if doneIssues.len > 0:
|
||||
stdout.write ctx.formatSection(doneIssues, Done, indent, verbose)
|
||||
|
||||
# Future items
|
||||
if future:
|
||||
if today: ctx.writeHeader("Future")
|
||||
@ -242,7 +239,8 @@ when isMainModule:
|
||||
let doc = """
|
||||
Usage:
|
||||
pit ( new | add) <summary> [<state>] [options]
|
||||
pit list [<listable>] [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]
|
||||
@ -465,6 +463,10 @@ Options:
|
||||
filter.properties["context"] = ctx.defaultContext.get
|
||||
filterOption = some(filter)
|
||||
|
||||
if args["--tags"]:
|
||||
filter.hasTags = ($args["--tags"]).split(',')
|
||||
filterOption = some(filter)
|
||||
|
||||
# Finally, if the "context" is "all", don't filter on context
|
||||
if filter.properties.hasKey("context") and
|
||||
filter.properties["context"] == "all":
|
||||
@ -475,11 +477,10 @@ Options:
|
||||
var stateOption = none(IssueState)
|
||||
var issueIdOption = none(string)
|
||||
|
||||
if args["<listable>"]:
|
||||
if $args["<listable>"] == "contexts": listContexts = true
|
||||
else:
|
||||
try: stateOption = some(parseEnum[IssueState]($args["<listable>"]))
|
||||
except: issueIdOption = some($args["<listable>"])
|
||||
if args["contexts"]: listContexts = true
|
||||
elif args["<stateOrId>"]:
|
||||
try: stateOption = some(parseEnum[IssueState]($args["<stateOrId>"]))
|
||||
except: issueIdOption = some($args["<stateOrId>"])
|
||||
|
||||
# List the known contexts
|
||||
if listContexts:
|
||||
@ -495,7 +496,7 @@ Options:
|
||||
else: b
|
||||
).len
|
||||
|
||||
for c in uniqContexts:
|
||||
for c in uniqContexts.sorted:
|
||||
stdout.writeLine(c.alignLeft(maxLen+2) & ctx.getIssueContextDisplayName(c))
|
||||
|
||||
# List a specific issue
|
||||
|
@ -22,6 +22,7 @@ type
|
||||
IssueFilter* = ref object
|
||||
completedRange*: Option[tuple[b, e: DateTime]]
|
||||
fullMatch*, summaryMatch*: Option[Regex]
|
||||
hasTags*: seq[string]
|
||||
properties*: TableRef[string, string]
|
||||
|
||||
PitConfig* = ref object
|
||||
@ -69,6 +70,7 @@ proc initFilter*(): IssueFilter =
|
||||
completedRange: none(tuple[b, e: DateTime]),
|
||||
fullMatch: none(Regex),
|
||||
summaryMatch: none(Regex),
|
||||
hasTags: @[],
|
||||
properties: newTable[string, string]())
|
||||
|
||||
proc propsFilter*(props: TableRef[string, string]): IssueFilter =
|
||||
@ -91,6 +93,10 @@ proc fullMatchFilter*(pattern: string): IssueFilter =
|
||||
result = initFilter()
|
||||
result.fullMatch = some(re("(?i)" & pattern))
|
||||
|
||||
proc hasTagsFilter*(tags: seq[string]): IssueFilter =
|
||||
result = initFilter()
|
||||
result.hasTags = tags
|
||||
|
||||
proc groupBy*(issues: seq[Issue], propertyKey: string): TableRef[string, seq[Issue]] =
|
||||
result = newTable[string, seq[Issue]]()
|
||||
for i in issues:
|
||||
@ -122,7 +128,7 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
|
||||
|
||||
of ReadingProps:
|
||||
# Ignore empty lines
|
||||
if line.isNilOrWhitespace: continue
|
||||
if line.isEmptyOrWhitespace: continue
|
||||
|
||||
# Look for the sentinal to start parsing as detail lines
|
||||
if line == "--------":
|
||||
@ -149,9 +155,9 @@ proc toStorageFormat*(issue: Issue, withComments = false): string =
|
||||
lines.add(issue.summary)
|
||||
if withComments: lines.add("# Properties (\"key:value\" per line):")
|
||||
for key, val in issue.properties:
|
||||
if not val.isNilOrWhitespace: lines.add(key & ": " & val)
|
||||
if not val.isEmptyOrWhitespace: lines.add(key & ": " & val)
|
||||
if issue.tags.len > 0: lines.add("tags: " & issue.tags.join(","))
|
||||
if not isNilOrWhitespace(issue.details) or withComments:
|
||||
if not isEmptyOrWhitespace(issue.details) or withComments:
|
||||
if withComments: lines.add("# Details go below the \"--------\"")
|
||||
lines.add("--------")
|
||||
lines.add(issue.details)
|
||||
@ -170,6 +176,7 @@ proc loadIssueById*(tasksDir, id: string): Issue =
|
||||
raise newException(KeyError, "cannot find issue for id: " & id)
|
||||
|
||||
proc store*(issue: Issue, withComments = false) =
|
||||
discard existsOrCreateDir(issue.filePath.parentDir)
|
||||
writeFile(issue.filepath, toStorageFormat(issue, withComments))
|
||||
|
||||
proc store*(tasksDir: string, issue: Issue, state: IssueState, withComments = false) =
|
||||
@ -202,7 +209,7 @@ proc loadIssues*(path: string): seq[Issue] =
|
||||
toSeq(orderFile.lines)
|
||||
.mapIt(it.split(' ')[0])
|
||||
.deduplicate
|
||||
.filterIt(not it.startsWith("> ") and not it.isNilOrWhitespace)
|
||||
.filterIt(not it.startsWith("> ") and not it.isEmptyOrWhitespace)
|
||||
else: newSeq[string]()
|
||||
|
||||
type TaggedIssue = tuple[issue: Issue, ordered: bool]
|
||||
@ -258,6 +265,9 @@ proc filter*(issues: seq[Issue], filter: IssueFilter): seq[Issue] =
|
||||
let p = filter.fullMatch.get
|
||||
result = result.filterIt( it.summary.find(p).isSome or it.details.find(p).isSome)
|
||||
|
||||
for tag in filter.hasTags:
|
||||
result = result.filterIt(it.tags.find(tag) >= 0)
|
||||
|
||||
### Configuration utilities
|
||||
proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitConfig =
|
||||
let pitrcLocations = @[
|
||||
@ -265,11 +275,11 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
|
||||
".pitrc", $getEnv("PITRC"), $getEnv("HOME") & "/.pitrc"]
|
||||
|
||||
var pitrcFilename: string =
|
||||
foldl(pitrcLocations, if len(a) > 0: a elif existsFile(b): b else: "")
|
||||
foldl(pitrcLocations, if len(a) > 0: a elif fileExists(b): b else: "")
|
||||
|
||||
if not existsFile(pitrcFilename):
|
||||
if not fileExists(pitrcFilename):
|
||||
warn "pit: could not find .pitrc file: " & pitrcFilename
|
||||
if isNilOrWhitespace(pitrcFilename):
|
||||
if isEmptyOrWhitespace(pitrcFilename):
|
||||
pitrcFilename = $getEnv("HOME") & "/.pitrc"
|
||||
var cfgFile: File
|
||||
try:
|
||||
@ -295,15 +305,13 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
|
||||
for k, v in cfgJson["contexts"]:
|
||||
result.contexts[k] = v.getStr()
|
||||
|
||||
if isNilOrWhitespace(result.tasksDir):
|
||||
if isEmptyOrWhitespace(result.tasksDir):
|
||||
raise newException(Exception, "no tasks directory configured")
|
||||
|
||||
if not existsDir(result.tasksDir):
|
||||
if not dirExists(result.tasksDir):
|
||||
raise newException(Exception, "cannot find tasks dir: " & result.tasksDir)
|
||||
|
||||
# Create our tasks directory structure if needed
|
||||
for s in IssueState:
|
||||
if not existsDir(result.tasksDir / $s):
|
||||
if not dirExists(result.tasksDir / $s):
|
||||
(result.tasksDir / $s).createDir
|
||||
|
||||
|
||||
|
@ -1 +1 @@
|
||||
const PIT_VERSION* = "4.9.0"
|
||||
const PIT_VERSION* = "4.11.0"
|
Reference in New Issue
Block a user