Compare commits
6 Commits
Author | SHA1 | Date | |
---|---|---|---|
ef16eafd48 | |||
4af0d09356 | |||
071c4b66e5 | |||
57a3af4f2f | |||
08b9df2086 | |||
339e88cddd |
@ -46,7 +46,7 @@ Some other common properties I use are:
|
|||||||
|
|
||||||
- `resolution`: for short notes about why an issue was moved to `done`,
|
- `resolution`: for short notes about why an issue was moved to `done`,
|
||||||
especially if it the action wasn't taken or if it is not completely clear
|
especially if it the action wasn't taken or if it is not completely clear
|
||||||
that this issue was completed.
|
that this issue was completed.
|
||||||
|
|
||||||
## Configuration Options
|
## Configuration Options
|
||||||
|
|
||||||
@ -107,7 +107,7 @@ in the configuration file. All options are optional unless stated otherwise.
|
|||||||
- `defaultContext`: if present all invokations to the CLI will
|
- `defaultContext`: if present all invokations to the CLI will
|
||||||
be in this context. This is like adding a `--context <defaultContext>`
|
be in this context. This is like adding a `--context <defaultContext>`
|
||||||
parameter to every CLI invocation. Any actual `--context` parameter will
|
parameter to every CLI invocation. Any actual `--context` parameter will
|
||||||
override this value.
|
override this value.
|
||||||
|
|
||||||
- `verbose`: Show issue details when listing issues (same as
|
- `verbose`: Show issue details when listing issues (same as
|
||||||
`--verbose` flag).
|
`--verbose` flag).
|
||||||
@ -135,7 +135,4 @@ in the configuration file. All options are optional unless stated otherwise.
|
|||||||
"Personal"; it does not need an alternate display name.
|
"Personal"; it does not need an alternate display name.
|
||||||
|
|
||||||
* `tasksDir` **required**: a file path to the root directory for the issue
|
* `tasksDir` **required**: a file path to the root directory for the issue
|
||||||
repository (same as `--tasks-dir` CLI parameter).
|
repository (same as `--tasks-dir` CLI parameter).
|
||||||
|
|
||||||
- CLI parameter: *cannot be specified via CLI*
|
|
||||||
- config file key: `contexts`
|
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
# Package
|
# Package
|
||||||
|
|
||||||
version = "4.8.0"
|
version = "4.9.4"
|
||||||
author = "Jonathan Bernard"
|
author = "Jonathan Bernard"
|
||||||
description = "Personal issue tracker."
|
description = "Personal issue tracker."
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
@ -10,9 +10,9 @@ bin = @["pit", "pit_api"]
|
|||||||
# Dependencies
|
# Dependencies
|
||||||
|
|
||||||
requires @[
|
requires @[
|
||||||
"nim >= 0.19.0",
|
"nim >= 1.4.0",
|
||||||
"docopt 0.6.8",
|
"docopt 0.6.8",
|
||||||
"jester 0.4.1",
|
"jester 0.5.0",
|
||||||
"uuids 0.1.10",
|
"uuids 0.1.10",
|
||||||
|
|
||||||
"https://git.jdb-labs.com/jdb/nim-cli-utils.git >= 0.6.4",
|
"https://git.jdb-labs.com/jdb/nim-cli-utils.git >= 0.6.4",
|
||||||
@ -22,4 +22,4 @@ requires @[
|
|||||||
]
|
]
|
||||||
|
|
||||||
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/version.nim'"
|
||||||
|
36
src/pit.nim
36
src/pit.nim
@ -1,11 +1,11 @@
|
|||||||
## Personal Issue Tracker CLI interface
|
## Personal Issue Tracker CLI interface
|
||||||
## ====================================
|
## ====================================
|
||||||
|
|
||||||
import cliutils, docopt, json, logging, options, os, sequtils,
|
import algorithm, cliutils, docopt, json, logging, options, os, sequtils,
|
||||||
tables, terminal, times, timeutils, unicode, uuids
|
std/wordwrap, tables, terminal, times, timeutils, unicode, uuids
|
||||||
|
|
||||||
from nre import re
|
from nre import re
|
||||||
import strutils except capitalize, strip, toUpper, toLower
|
import strutils except alignLeft, capitalize, strip, toUpper, toLower
|
||||||
import pitpkg/private/libpit
|
import pitpkg/private/libpit
|
||||||
export libpit
|
export libpit
|
||||||
|
|
||||||
@ -49,7 +49,7 @@ proc initContext(args: Table[string, Value]): CliContext =
|
|||||||
|
|
||||||
proc getIssueContextDisplayName(ctx: CliContext, context: string): string =
|
proc getIssueContextDisplayName(ctx: CliContext, context: string): string =
|
||||||
if not ctx.contexts.hasKey(context):
|
if not ctx.contexts.hasKey(context):
|
||||||
if context.isNilOrWhitespace: return "<default>"
|
if context.isEmptyOrWhitespace: return "<default>"
|
||||||
else: return context.capitalize()
|
else: return context.capitalize()
|
||||||
return ctx.contexts[context]
|
return ctx.contexts[context]
|
||||||
|
|
||||||
@ -67,7 +67,7 @@ proc formatIssue(ctx: CliContext, issue: Issue): string =
|
|||||||
|
|
||||||
|
|
||||||
result &= "--------".withColor(fgBlack, true) & "\n"
|
result &= "--------".withColor(fgBlack, true) & "\n"
|
||||||
if not issue.details.isNilOrWhitespace:
|
if not issue.details.isEmptyOrWhitespace:
|
||||||
result &= issue.details.strip.withColor(fgCyan) & "\n"
|
result &= issue.details.strip.withColor(fgCyan) & "\n"
|
||||||
|
|
||||||
proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
||||||
@ -75,7 +75,7 @@ proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
|||||||
|
|
||||||
result = ""
|
result = ""
|
||||||
|
|
||||||
var showDetails = not issue.details.isNilOrWhitespace and verbose
|
var showDetails = not issue.details.isEmptyOrWhitespace and verbose
|
||||||
|
|
||||||
var prefixLen = 0
|
var prefixLen = 0
|
||||||
var summaryIndentLen = indent.len + 7
|
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 ' '
|
if issue.hasProp("delegated-to"): prefixLen += issue["delegated-to"].len + 2 # space for the ':' and ' '
|
||||||
|
|
||||||
# Wrap and write the summary.
|
# 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]
|
wrappedSummary = wrappedSummary[(prefixLen + summaryIndentLen)..^1]
|
||||||
|
|
||||||
@ -103,7 +103,7 @@ proc formatSectionIssue(ctx: CliContext, issue: Issue, width: int, indent = "",
|
|||||||
|
|
||||||
if issue.hasProp("pending"):
|
if issue.hasProp("pending"):
|
||||||
let startIdx = "Pending: ".len
|
let startIdx = "Pending: ".len
|
||||||
var pendingText = issue["pending"].wordWrap(width - startIdx - summaryIndentLen)
|
var pendingText = issue["pending"].wrapWords(width - startIdx - summaryIndentLen)
|
||||||
.indent(startIdx)
|
.indent(startIdx)
|
||||||
pendingText = ("Pending: " & pendingText[startIdx..^1]).indent(summaryIndentLen)
|
pendingText = ("Pending: " & pendingText[startIdx..^1]).indent(summaryIndentLen)
|
||||||
result &= "\n" & pendingText.withColor(fgCyan)
|
result &= "\n" & pendingText.withColor(fgCyan)
|
||||||
@ -242,7 +242,8 @@ when isMainModule:
|
|||||||
let doc = """
|
let doc = """
|
||||||
Usage:
|
Usage:
|
||||||
pit ( new | add) <summary> [<state>] [options]
|
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 ( start | done | pending | todo-today | todo | suspend ) <id>... [options]
|
||||||
pit edit <ref>...
|
pit edit <ref>...
|
||||||
pit tag <id>... [options]
|
pit tag <id>... [options]
|
||||||
@ -475,11 +476,10 @@ Options:
|
|||||||
var stateOption = none(IssueState)
|
var stateOption = none(IssueState)
|
||||||
var issueIdOption = none(string)
|
var issueIdOption = none(string)
|
||||||
|
|
||||||
if args["<listable>"]:
|
if args["contexts"]: listContexts = true
|
||||||
if $args["<listable>"] == "contexts": listContexts = true
|
elif args["<stateOrId>"]:
|
||||||
else:
|
try: stateOption = some(parseEnum[IssueState]($args["<stateOrId>"]))
|
||||||
try: stateOption = some(parseEnum[IssueState]($args["<listable>"]))
|
except: issueIdOption = some($args["<stateOrId>"])
|
||||||
except: issueIdOption = some($args["<listable>"])
|
|
||||||
|
|
||||||
# List the known contexts
|
# List the known contexts
|
||||||
if listContexts:
|
if listContexts:
|
||||||
@ -490,7 +490,13 @@ Options:
|
|||||||
if issue.hasProp("context") and not uniqContexts.contains(issue["context"]):
|
if issue.hasProp("context") and not uniqContexts.contains(issue["context"]):
|
||||||
uniqContexts.add(issue["context"])
|
uniqContexts.add(issue["context"])
|
||||||
|
|
||||||
for c in uniqContexts: stdout.writeLine(c)
|
let maxLen = foldl(uniqContexts,
|
||||||
|
if a.len > b.len: a
|
||||||
|
else: b
|
||||||
|
).len
|
||||||
|
|
||||||
|
for c in uniqContexts.sorted:
|
||||||
|
stdout.writeLine(c.alignLeft(maxLen+2) & ctx.getIssueContextDisplayName(c))
|
||||||
|
|
||||||
# List a specific issue
|
# List a specific issue
|
||||||
elif issueIdOption.isSome:
|
elif issueIdOption.isSome:
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
import cliutils, docopt, json, logging, langutils, options, os, ospaths,
|
import cliutils, docopt, json, logging, langutils, options, os,
|
||||||
sequtils, strutils, tables, times, timeutils, uuids
|
sequtils, strutils, tables, times, timeutils, uuids
|
||||||
|
|
||||||
from nre import find, match, re, Regex
|
from nre import find, match, re, Regex
|
||||||
@ -49,6 +49,7 @@ proc `[]`*(issue: Issue, key: string): string =
|
|||||||
proc `[]=`*(issue: Issue, key: string, value: string) =
|
proc `[]=`*(issue: Issue, key: string, value: string) =
|
||||||
issue.properties[key] = value
|
issue.properties[key] = value
|
||||||
|
|
||||||
|
## Issue property accessors
|
||||||
proc hasProp*(issue: Issue, key: string): bool =
|
proc hasProp*(issue: Issue, key: string): bool =
|
||||||
return issue.properties.hasKey(key)
|
return issue.properties.hasKey(key)
|
||||||
|
|
||||||
@ -62,6 +63,7 @@ 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
|
||||||
|
|
||||||
|
## Issue filtering
|
||||||
proc initFilter*(): IssueFilter =
|
proc initFilter*(): IssueFilter =
|
||||||
result = IssueFilter(
|
result = IssueFilter(
|
||||||
completedRange: none(tuple[b, e: DateTime]),
|
completedRange: none(tuple[b, e: DateTime]),
|
||||||
@ -120,7 +122,7 @@ proc fromStorageFormat*(id: string, issueTxt: string): Issue =
|
|||||||
|
|
||||||
of ReadingProps:
|
of ReadingProps:
|
||||||
# Ignore empty lines
|
# Ignore empty lines
|
||||||
if line.isNilOrWhitespace: continue
|
if line.isEmptyOrWhitespace: continue
|
||||||
|
|
||||||
# Look for the sentinal to start parsing as detail lines
|
# Look for the sentinal to start parsing as detail lines
|
||||||
if line == "--------":
|
if line == "--------":
|
||||||
@ -147,9 +149,9 @@ proc toStorageFormat*(issue: Issue, withComments = false): string =
|
|||||||
lines.add(issue.summary)
|
lines.add(issue.summary)
|
||||||
if withComments: lines.add("# Properties (\"key:value\" per line):")
|
if withComments: lines.add("# Properties (\"key:value\" per line):")
|
||||||
for key, val in issue.properties:
|
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 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 \"--------\"")
|
if withComments: lines.add("# Details go below the \"--------\"")
|
||||||
lines.add("--------")
|
lines.add("--------")
|
||||||
lines.add(issue.details)
|
lines.add(issue.details)
|
||||||
@ -168,6 +170,7 @@ proc loadIssueById*(tasksDir, id: string): Issue =
|
|||||||
raise newException(KeyError, "cannot find issue for id: " & id)
|
raise newException(KeyError, "cannot find issue for id: " & id)
|
||||||
|
|
||||||
proc store*(issue: Issue, withComments = false) =
|
proc store*(issue: Issue, withComments = false) =
|
||||||
|
discard existsOrCreateDir(issue.filePath.parentDir)
|
||||||
writeFile(issue.filepath, toStorageFormat(issue, withComments))
|
writeFile(issue.filepath, toStorageFormat(issue, withComments))
|
||||||
|
|
||||||
proc store*(tasksDir: string, issue: Issue, state: IssueState, withComments = false) =
|
proc store*(tasksDir: string, issue: Issue, state: IssueState, withComments = false) =
|
||||||
@ -200,7 +203,7 @@ proc loadIssues*(path: string): seq[Issue] =
|
|||||||
toSeq(orderFile.lines)
|
toSeq(orderFile.lines)
|
||||||
.mapIt(it.split(' ')[0])
|
.mapIt(it.split(' ')[0])
|
||||||
.deduplicate
|
.deduplicate
|
||||||
.filterIt(not it.startsWith("> ") and not it.isNilOrWhitespace)
|
.filterIt(not it.startsWith("> ") and not it.isEmptyOrWhitespace)
|
||||||
else: newSeq[string]()
|
else: newSeq[string]()
|
||||||
|
|
||||||
type TaggedIssue = tuple[issue: Issue, ordered: bool]
|
type TaggedIssue = tuple[issue: Issue, ordered: bool]
|
||||||
@ -263,11 +266,11 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
|
|||||||
".pitrc", $getEnv("PITRC"), $getEnv("HOME") & "/.pitrc"]
|
".pitrc", $getEnv("PITRC"), $getEnv("HOME") & "/.pitrc"]
|
||||||
|
|
||||||
var pitrcFilename: string =
|
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
|
warn "pit: could not find .pitrc file: " & pitrcFilename
|
||||||
if isNilOrWhitespace(pitrcFilename):
|
if isEmptyOrWhitespace(pitrcFilename):
|
||||||
pitrcFilename = $getEnv("HOME") & "/.pitrc"
|
pitrcFilename = $getEnv("HOME") & "/.pitrc"
|
||||||
var cfgFile: File
|
var cfgFile: File
|
||||||
try:
|
try:
|
||||||
@ -293,15 +296,13 @@ proc loadConfig*(args: Table[string, Value] = initTable[string, Value]()): PitCo
|
|||||||
for k, v in cfgJson["contexts"]:
|
for k, v in cfgJson["contexts"]:
|
||||||
result.contexts[k] = v.getStr()
|
result.contexts[k] = v.getStr()
|
||||||
|
|
||||||
if isNilOrWhitespace(result.tasksDir):
|
if isEmptyOrWhitespace(result.tasksDir):
|
||||||
raise newException(Exception, "no tasks directory configured")
|
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)
|
raise newException(Exception, "cannot find tasks dir: " & result.tasksDir)
|
||||||
|
|
||||||
# Create our tasks directory structure if needed
|
# Create our tasks directory structure if needed
|
||||||
for s in IssueState:
|
for s in IssueState:
|
||||||
if not existsDir(result.tasksDir / $s):
|
if not dirExists(result.tasksDir / $s):
|
||||||
(result.tasksDir / $s).createDir
|
(result.tasksDir / $s).createDir
|
||||||
|
|
||||||
|
|
||||||
|
@ -1 +1 @@
|
|||||||
const PIT_VERSION* = "4.8.0"
|
const PIT_VERSION* = "4.9.4"
|
Reference in New Issue
Block a user