jira-dashboard 0.1.2 → 0.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -1
- package/dist/cli.js +512 -154
- package/dist/cli.js.map +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -56,13 +56,45 @@ Or write `~/.config/jira-dashboard/config.json` (environment variables win):
|
|
|
56
56
|
"email": "you@example.com",
|
|
57
57
|
"apiToken": "…",
|
|
58
58
|
"issuesJql": "assignee = currentUser() AND statusCategory != Done AND status NOT IN (\"Cancelled\", \"Closed\", \"Backlog\") ORDER BY updated DESC",
|
|
59
|
-
"worklogDays": 14
|
|
59
|
+
"worklogDays": 14,
|
|
60
|
+
"holidayCountry": "UA",
|
|
61
|
+
"holidayRegion": null
|
|
60
62
|
}
|
|
61
63
|
```
|
|
62
64
|
|
|
63
65
|
`issuesJql` is worth customising: status names vary per site, and some boards model the backlog
|
|
64
66
|
by sprint rather than by status — in that case append `AND sprint IS NOT EMPTY`.
|
|
65
67
|
|
|
68
|
+
### Non-working days
|
|
69
|
+
|
|
70
|
+
`holidayCountry` is an ISO-3166 alpha-2 code (`UA`, `PL`, `US`, …). Its statutory holidays are
|
|
71
|
+
fetched from [date.nager.at](https://date.nager.at) and cached in
|
|
72
|
+
`~/.config/jira-dashboard/holidays.json`; changing the country invalidates that cache, and each
|
|
73
|
+
year is refreshed after 30 days. Both keys can be overridden with `JIRA_HOLIDAY_COUNTRY` and
|
|
74
|
+
`JIRA_HOLIDAY_REGION`. If the fetch fails the dashboard falls back to the cache and starts
|
|
75
|
+
regardless.
|
|
76
|
+
|
|
77
|
+
Many holidays are provincial or state-level rather than nationwide — Canada's Civic Holiday on
|
|
78
|
+
the first Monday of August, for instance. Those are **shown rather than skipped**, but dimmed and
|
|
79
|
+
marked `~` instead of `*`, listing the regions that observe them; they do not excuse an empty
|
|
80
|
+
timesheet. Set `holidayRegion` (`"CA-ON"`, `"US-CA"`, …) and the ones covering your region become
|
|
81
|
+
full days off:
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
Mon 03 Aug~🎉 0.0h (Civic Holiday / British Columbia Day … · CA-ON, …) # region unset
|
|
85
|
+
Mon 03 Aug*🎉 0.0h (Civic Holiday) # holidayRegion CA-ON
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Personal leave goes in `~/.config/jira-dashboard/days-off.json`, which you maintain by hand:
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
["2026-08-10", { "date": "2026-08-11", "label": "moving day" }]
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Both kinds of day show up in magenta in the two left panels — holidays marked `*🎉`, days off `·`,
|
|
95
|
+
holidays observed only in other regions dimmed and marked `~🎉` — and an empty day off is never
|
|
96
|
+
coloured red, so what is left in red is what still needs hours.
|
|
97
|
+
|
|
66
98
|
## Keys
|
|
67
99
|
|
|
68
100
|
| Key | Action |
|
|
@@ -75,6 +107,7 @@ by sprint rather than by status — in that case append `AND sprint IS NOT EMPTY
|
|
|
75
107
|
| `Tab` / `Shift+Tab` | Cycle panels (worklogs → tickets → preview) |
|
|
76
108
|
| Click | Select a ticket / focus a panel |
|
|
77
109
|
| Wheel | Scroll the panel under the cursor |
|
|
110
|
+
| `t` | Toggle the full ticket tree (show epics/stories that are not assigned to you) |
|
|
78
111
|
| `r` | Reload both panels |
|
|
79
112
|
| `q` / `Esc` / `Ctrl+C` | Quit |
|
|
80
113
|
|