jira-daily-report 0.1.103 → 0.1.104

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.
Files changed (3) hide show
  1. package/README-vscode.md +180 -0
  2. package/README.md +27 -156
  3. package/package.json +2 -1
package/README-vscode.md ADDED
@@ -0,0 +1,180 @@
1
+ # Jira Daily Report Extension
2
+
3
+ A VS Code extension that generates daily standup reports from your Jira Server and integrates with Tempo time tracking.
4
+
5
+ **🌐 Website**: [https://v0-jira-daily-report.vercel.app/](https://v0-jira-daily-report.vercel.app/)
6
+
7
+ ## Requirements
8
+
9
+ - VS Code 1.80.0 or later
10
+ - Jira Server access with API token
11
+ - Tempo time tracking (optional)
12
+
13
+ ## Installation
14
+
15
+ ### Method 1: From VS Code Marketplace
16
+ 1. Open VS Code
17
+ 2. Go to Extensions (`Ctrl+Shift+X`)
18
+ 3. Search for "jira-daily-report"
19
+ 4. Click Install
20
+
21
+ ### Method 2: Quick Install
22
+ 1. Open VS Code
23
+ 2. Press `Ctrl+P` (Quick Open)
24
+ 3. Type: `ext install thuanvo.jira-daily-report`
25
+ 4. Press Enter
26
+
27
+ ### Method 3: Manual Installation
28
+ 1. Download from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=thuanvo.jira-daily-report)
29
+ 2. Install the .vsix file in VS Code
30
+
31
+ ## Configuration
32
+
33
+ Before using the extension, configure your Jira settings:
34
+
35
+ 1. Open VS Code Settings (`Ctrl+,`)
36
+ 2. Search for "jira daily report"
37
+ 3. Configure the following:
38
+ - **Jira Server URL**: Your Jira instance (e.g., `https://yourcompany.atlassian.net/`)
39
+ - **Username**: Your Jira username (email)
40
+ - **API Token**: [Get your Jira API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html)
41
+ - **Tempo API Token**: [Get your Tempo API token](https://apidocs.tempo.io/#section/Authentication) (optional)
42
+ - **Who Am I**: Select "Developer" or "QC"
43
+ - **Auto Clipboard**: Enable to automatically copy reports to clipboard
44
+
45
+ ## Features
46
+
47
+ ### 1. Generate Jira Daily Report
48
+
49
+ Creates a daily standup report with your tasks, time tracking, and blockers.
50
+
51
+ **How to use:**
52
+ 1. Press `Ctrl+Shift+P` to open Command Palette
53
+ 2. Type: `Generate Jira Daily Report`
54
+ 3. Press Enter
55
+
56
+ **Or use keyboard shortcut:** `Ctrl+Shift+R` (Windows/Linux) or `Cmd+Shift+R` (Mac)
57
+
58
+ **What it does:**
59
+ - Fetches your current Jira tasks (Open, In Progress, Selected for Development)
60
+ - Retrieves time tracking data from Tempo
61
+ - Generates formatted report with:
62
+ - Yesterday's completed work
63
+ - Today's planned tasks
64
+ - Blockers and impediments
65
+ - Time tracking summary
66
+
67
+ ### 2. Open Ticket
68
+
69
+ Opens any Jira ticket in your browser quickly.
70
+
71
+ **How to use:**
72
+ 1. Press `Ctrl+Shift+P` to open Command Palette
73
+ 2. Type: `Open Ticket`
74
+ 3. Press Enter
75
+ 4. Enter ticket key (e.g., `B2B-1079`)
76
+ 5. Ticket opens in your default browser
77
+
78
+ **Or use keyboard shortcut:** `Ctrl+Shift+O` (Windows/Linux) or `Cmd+Shift+O` (Mac)
79
+
80
+ **What it does:**
81
+ - Prompts for ticket key
82
+ - Opens the ticket in your default browser
83
+ - Quick way to view ticket details, comments, attachments
84
+
85
+ ### 3. Jira Quick Action
86
+
87
+ Main feature that combines time logging and status changes in one command using hashtag syntax.
88
+
89
+ **How to use:**
90
+ 1. Press `Ctrl+Shift+P` to open Command Palette
91
+ 2. Type: `Jira Quick Action`
92
+ 3. Press Enter
93
+ 4. Enter command with hashtag syntax (see examples below)
94
+
95
+ **Or use keyboard shortcut:** `Ctrl+Shift+J` (Windows/Linux) or `Cmd+Shift+J` (Mac)
96
+
97
+ **Hashtag Syntax Examples:**
98
+ ```
99
+ # Log time and change status
100
+ B2B-1079 #time 2h #under-review
101
+
102
+ # Change status only
103
+ B2B-1079 #under-review
104
+
105
+ # Log time only
106
+ B2B-1079 #time 2h
107
+
108
+ # Order doesn't matter
109
+ #time 2h B2B-1079 #in-progress
110
+
111
+ # Use aliases
112
+ B2B-1079 #time 1.5h #dev # dev = selected for development
113
+ B2B-1079 #review # review = under-review
114
+ ```
115
+
116
+ **Supported Time Formats:**
117
+ - `2h` (2 hours)
118
+ - `1.5h` (1.5 hours)
119
+ - `30m` (30 minutes)
120
+ - `1h 30m` (1 hour 30 minutes)
121
+
122
+ **Supported Status Changes:**
123
+ - `#open` → Open
124
+ - `#selected` or `#dev` → Selected for Development
125
+ - `#in-progress` or `#wip` → In Progress
126
+ - `#under-review` or `#review` → Under Review
127
+ - `#ready-for-testing` or `#testing` → Ready for Testing
128
+
129
+ **What it does:**
130
+ 1. Validates ticket format and syntax
131
+ 2. Logs time directly to Tempo (if `#time` specified)
132
+ 3. Changes ticket status via Jira API (if status specified)
133
+ 4. Shows detailed results with success/failure information
134
+
135
+ ### 4. My Jira Tickets
136
+
137
+ Browse your current tickets and perform quick actions.
138
+
139
+ **How to use:**
140
+ 1. Press `Ctrl+Shift+P` to open Command Palette
141
+ 2. Type: `My Jira Tickets`
142
+ 3. Press Enter
143
+ 4. Select a ticket from the list
144
+ 5. Choose an action for the selected ticket
145
+
146
+ **Or use keyboard shortcut:** `Ctrl+Shift+T` (Windows/Linux) or `Cmd+Shift+T` (Mac)
147
+
148
+ **What it shows:**
149
+ - **In Progress tickets** (marked with 🔥 for high priority)
150
+ - **Selected for Development tickets**
151
+ - Quick actions for each ticket (log time, change status, etc.)
152
+
153
+ **What it does:**
154
+ - Displays your current work in a organized list
155
+ - Provides quick access to ticket actions
156
+ - Integrates with Jira Quick Action for seamless workflow
157
+
158
+ ## Keyboard Shortcuts Summary
159
+
160
+ - **`Ctrl+Shift+R`** - Generate Jira Daily Report
161
+ - **`Ctrl+Shift+O`** - Open Ticket in Browser
162
+ - **`Ctrl+Shift+J`** - Jira Quick Action
163
+ - **`Ctrl+Shift+T`** - My Jira Tickets
164
+
165
+ *On Mac, use `Cmd` instead of `Ctrl`*
166
+
167
+ ## Additional Resources
168
+
169
+ - **Website**: [https://v0-jira-daily-report.vercel.app/](https://v0-jira-daily-report.vercel.app/)
170
+ - **GitHub Repository**: [https://github.com/voxuanthuan/daily-report](https://github.com/voxuanthuan/daily-report)
171
+ - **Issues & Feature Requests**: [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues)
172
+ - **Keyboard Shortcuts Reference**: [KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)
173
+
174
+ ## Support
175
+
176
+ For help with setup, troubleshooting, or feature requests, please visit our [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues) page.
177
+
178
+ ## License
179
+
180
+ [MIT](./License.md)
package/README.md CHANGED
@@ -1,180 +1,51 @@
1
- # Jira Daily Report Extension
1
+ # Jira Daily Report
2
2
 
3
- A VS Code extension that generates daily standup reports from your Jira Server and integrates with Tempo time tracking.
3
+ Generate daily standup reports from Jira and Tempo time tracking - available as both a CLI tool and VS Code extension.
4
4
 
5
- **🌐 Website**: [https://v0-jira-daily-report.vercel.app/](https://v0-jira-daily-report.vercel.app/)
6
-
7
- ## Requirements
8
-
9
- - VS Code 1.80.0 or later
10
- - Jira Server access with API token
11
- - Tempo time tracking (optional)
12
5
 
13
6
  ## Installation
14
7
 
15
- ### Method 1: From VS Code Marketplace
16
- 1. Open VS Code
17
- 2. Go to Extensions (`Ctrl+Shift+X`)
18
- 3. Search for "jira-daily-report"
19
- 4. Click Install
20
-
21
- ### Method 2: Quick Install
22
- 1. Open VS Code
23
- 2. Press `Ctrl+P` (Quick Open)
24
- 3. Type: `ext install thuanvo.jira-daily-report`
25
- 4. Press Enter
26
-
27
- ### Method 3: Manual Installation
28
- 1. Download from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=thuanvo.jira-daily-report)
29
- 2. Install the .vsix file in VS Code
30
-
31
- ## Configuration
32
-
33
- Before using the extension, configure your Jira settings:
34
-
35
- 1. Open VS Code Settings (`Ctrl+,`)
36
- 2. Search for "jira daily report"
37
- 3. Configure the following:
38
- - **Jira Server URL**: Your Jira instance (e.g., `https://yourcompany.atlassian.net/`)
39
- - **Username**: Your Jira username (email)
40
- - **API Token**: [Get your Jira API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html)
41
- - **Tempo API Token**: [Get your Tempo API token](https://apidocs.tempo.io/#section/Authentication) (optional)
42
- - **Who Am I**: Select "Developer" or "QC"
43
- - **Auto Clipboard**: Enable to automatically copy reports to clipboard
44
-
45
- ## Features
46
-
47
- ### 1. Generate Jira Daily Report
48
-
49
- Creates a daily standup report with your tasks, time tracking, and blockers.
50
-
51
- **How to use:**
52
- 1. Press `Ctrl+Shift+P` to open Command Palette
53
- 2. Type: `Generate Jira Daily Report`
54
- 3. Press Enter
55
-
56
- **Or use keyboard shortcut:** `Ctrl+Shift+R` (Windows/Linux) or `Cmd+Shift+R` (Mac)
57
-
58
- **What it does:**
59
- - Fetches your current Jira tasks (Open, In Progress, Selected for Development)
60
- - Retrieves time tracking data from Tempo
61
- - Generates formatted report with:
62
- - Yesterday's completed work
63
- - Today's planned tasks
64
- - Blockers and impediments
65
- - Time tracking summary
66
-
67
- ### 2. Open Ticket
68
-
69
- Opens any Jira ticket in your browser quickly.
70
-
71
- **How to use:**
72
- 1. Press `Ctrl+Shift+P` to open Command Palette
73
- 2. Type: `Open Ticket`
74
- 3. Press Enter
75
- 4. Enter ticket key (e.g., `B2B-1079`)
76
- 5. Ticket opens in your default browser
8
+ ### CLI Tool (npm)
77
9
 
78
- **Or use keyboard shortcut:** `Ctrl+Shift+O` (Windows/Linux) or `Cmd+Shift+O` (Mac)
10
+ ```bash
11
+ # Global installation (recommended for CLI usage)
12
+ pnpm install -g jira-daily-report
79
13
 
80
- **What it does:**
81
- - Prompts for ticket key
82
- - Opens the ticket in your default browser
83
- - Quick way to view ticket details, comments, attachments
84
-
85
- ### 3. Jira Quick Action
86
-
87
- Main feature that combines time logging and status changes in one command using hashtag syntax.
88
-
89
- **How to use:**
90
- 1. Press `Ctrl+Shift+P` to open Command Palette
91
- 2. Type: `Jira Quick Action`
92
- 3. Press Enter
93
- 4. Enter command with hashtag syntax (see examples below)
94
-
95
- **Or use keyboard shortcut:** `Ctrl+Shift+J` (Windows/Linux) or `Cmd+Shift+J` (Mac)
96
-
97
- **Hashtag Syntax Examples:**
14
+ # Or use with npx
15
+ npx jira-daily-report generate
98
16
  ```
99
- # Log time and change status
100
- B2B-1079 #time 2h #under-review
101
17
 
102
- # Change status only
103
- B2B-1079 #under-review
104
-
105
- # Log time only
106
- B2B-1079 #time 2h
107
-
108
- # Order doesn't matter
109
- #time 2h B2B-1079 #in-progress
110
-
111
- # Use aliases
112
- B2B-1079 #time 1.5h #dev # dev = selected for development
113
- B2B-1079 #review # review = under-review
114
- ```
115
18
 
116
- **Supported Time Formats:**
117
- - `2h` (2 hours)
118
- - `1.5h` (1.5 hours)
119
- - `30m` (30 minutes)
120
- - `1h 30m` (1 hour 30 minutes)
19
+ - **Jira API Token**: Get from https://id.atlassian.com/manage-profile/security/api-tokens
20
+ - **Tempo API Token**: Get from https://{your-domain}.atlassian.net/plugins/servlet/ac/io.tempo.jira/tempo-app#!/configuration/api-integration
121
21
 
122
- **Supported Status Changes:**
123
- - `#open` → Open
124
- - `#selected` or `#dev` → Selected for Development
125
- - `#in-progress` or `#wip` → In Progress
126
- - `#under-review` or `#review` → Under Review
127
- - `#ready-for-testing` or `#testing` → Ready for Testing
22
+ **Or use environment variables:**
128
23
 
129
- **What it does:**
130
- 1. Validates ticket format and syntax
131
- 2. Logs time directly to Tempo (if `#time` specified)
132
- 3. Changes ticket status via Jira API (if status specified)
133
- 4. Shows detailed results with success/failure information
24
+ ```bash
25
+ # Add to your shell profile (.bashrc, .zshrc, .bash_profile)
134
26
 
135
- ### 4. My Jira Tickets
27
+ export JIRA_SERVER="https://your-domain.atlassian.net/"
28
+ export JIRA_USERNAME="thuanvo@example.com"
29
+ export JIRA_API_TOKEN="your-jira-api-token"
30
+ export TEMPO_API_TOKEN="your-tempo-api-token"
31
+ export WHO_AM_I="Developer" # or "QC"
136
32
 
137
- Browse your current tickets and perform quick actions.
138
-
139
- **How to use:**
140
- 1. Press `Ctrl+Shift+P` to open Command Palette
141
- 2. Type: `My Jira Tickets`
142
- 3. Press Enter
143
- 4. Select a ticket from the list
144
- 5. Choose an action for the selected ticket
145
-
146
- **Or use keyboard shortcut:** `Ctrl+Shift+T` (Windows/Linux) or `Cmd+Shift+T` (Mac)
147
-
148
- **What it shows:**
149
- - **In Progress tickets** (marked with 🔥 for high priority)
150
- - **Selected for Development tickets**
151
- - Quick actions for each ticket (log time, change status, etc.)
152
-
153
- **What it does:**
154
- - Displays your current work in a organized list
155
- - Provides quick access to ticket actions
156
- - Integrates with Jira Quick Action for seamless workflow
33
+ # Reload your shell configuration
34
+ source ~/.zshrc # or ~/.bashrc
35
+ ```
157
36
 
158
- ## Keyboard Shortcuts Summary
37
+ ### 3. Generate Your Report
38
+ ## CLI Commands
159
39
 
160
- - **`Ctrl+Shift+R`** - Generate Jira Daily Report
161
- - **`Ctrl+Shift+O`** - Open Ticket in Browser
162
- - **`Ctrl+Shift+J`** - Jira Quick Action
163
- - **`Ctrl+Shift+T`** - My Jira Tickets
40
+ ### `jira-report generate`
164
41
 
165
- *On Mac, use `Cmd` instead of `Ctrl`*
166
42
 
167
- ## Additional Resources
43
+ ## Requirements
168
44
 
169
- - **Website**: [https://v0-jira-daily-report.vercel.app/](https://v0-jira-daily-report.vercel.app/)
170
- - **GitHub Repository**: [https://github.com/voxuanthuan/daily-report](https://github.com/voxuanthuan/daily-report)
171
- - **Issues & Feature Requests**: [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues)
172
- - **Keyboard Shortcuts Reference**: [KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)
45
+ - Node.js >= 16.0.0
46
+ - Jira Server access with API token
173
47
 
174
48
  ## Support
175
49
 
176
50
  For help with setup, troubleshooting, or feature requests, please visit our [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues) page.
177
51
 
178
- ## License
179
-
180
- [MIT](./License.md)
package/package.json CHANGED
@@ -2,7 +2,7 @@
2
2
  "name": "jira-daily-report",
3
3
  "displayName": "jira-daily-report",
4
4
  "description": "Generate Jira daily standup reports - VS Code extension and CLI tool",
5
- "version": "0.1.103",
5
+ "version": "0.1.104",
6
6
  "publisher": "thuanvo",
7
7
  "author": {
8
8
  "name": "Thuan Vo",
@@ -143,6 +143,7 @@
143
143
  "images/",
144
144
  "CLI.md",
145
145
  "README.md",
146
+ "README-vscode.md",
146
147
  "LICENSE"
147
148
  ],
148
149
  "scripts": {