jira-daily-report 0.1.98

package/CLI.md

@@ -0,0 +1,296 @@
+# Jira Daily Report - CLI Documentation
+
+The Jira Daily Report tool now supports both VS Code extension and command-line interface (CLI) usage!
+
+## Installation
+
+### Global Installation (Recommended for CLI)
+```bash
+npm install -g jira-daily-report
+```
+
+### Local Installation
+```bash
+npm install jira-daily-report
+# Use via: npx jira-report
+```
+
+## Quick Start
+
+### 1. Initialize Configuration
+```bash
+jira-report config init
+```
+
+This creates a `.jira-report.json` file in your current directory with the following template:
+```json
+{
+  "jiraServer": "https://your-domain.atlassian.net/",
+  "username": "your-email@example.com",
+  "apiToken": "your-jira-api-token",
+  "jiraTempoToken": "your-tempo-api-token",
+  "whoAmI": "Developer",
+  "autoClipboard": true
+}
+```
+
+### 2. Configure Your Credentials
+
+**Option A: Edit Config File**
+Edit `.jira-report.json` and add your credentials:
+- **Jira API Token**: Get from https://id.atlassian.com/manage-profile/security/api-tokens
+- **Tempo API Token**: Get from https://apidocs.tempo.io/#section/Authentication
+
+**Option B: Use Environment Variables**
+```bash
+export JIRA_SERVER="https://your-domain.atlassian.net/"
+export JIRA_USERNAME="your-email@example.com"
+export JIRA_API_TOKEN="your-jira-api-token"
+export TEMPO_API_TOKEN="your-tempo-api-token"
+export WHO_AM_I="Developer"  # or "QC"
+```
+
+### 3. Generate Your Report
+```bash
+jira-report generate
+```
+
+## CLI Commands
+
+### `jira-report generate`
+Generate daily standup report
+
+**Options:**
+- `-o, --output <file>` - Save report to file instead of console
+- `-f, --format <type>` - Output format: `text` (default), `json`, or `markdown`
+- `-c, --clipboard` - Copy report to clipboard (requires clipboardy package)
+- `-s, --silent` - Suppress info messages
+- `--no-cache` - Disable caching
+
+**Examples:**
+```bash
+# Basic usage - outputs to console
+jira-report generate
+
+# Save to file
+jira-report generate -o report.txt
+
+# Generate JSON format
+jira-report generate -f json -o report.json
+
+# Copy to clipboard
+jira-report generate -c
+
+# Silent mode (only show report)
+jira-report generate -s
+```
+
+### `jira-report config`
+Manage configuration files
+
+**Subcommands:**
+
+#### `jira-report config init`
+Initialize a new config file
+
+**Options:**
+- `-g, --global` - Create config in home directory (`~/.jira-report.json`)
+
+**Examples:**
+```bash
+# Create local config
+jira-report config init
+
+# Create global config
+jira-report config init --global
+```
+
+#### `jira-report config show`
+Display current configuration with masked secrets
+
+**Example:**
+```bash
+jira-report config show
+```
+
+Output:
+```
+Current Configuration:
+──────────────────────────────────────────────────
+Jira Server:    https://company.atlassian.net/
+Username:       john@example.com
+API Token:      ABCD****WXYZ
+Tempo Token:    1234****5678
+User Type:      Developer
+Auto Clipboard: true
+
+Config File Locations:
+✓ /home/user/project/.jira-report.json
+✗ /home/user/.jira-report.json
+
+Environment variables take precedence over config files.
+```
+
+## Configuration Priority
+
+Configuration is loaded in the following order (highest priority first):
+
+1. **Environment Variables** (highest priority)
+   - `JIRA_SERVER`
+   - `JIRA_USERNAME`
+   - `JIRA_API_TOKEN`
+   - `TEMPO_API_TOKEN`
+   - `WHO_AM_I`
+   - `AUTO_CLIPBOARD`
+
+2. **Local Project Config**
+   - `./.jira-report.json` (current directory)
+
+3. **User Home Config** (lowest priority)
+   - `~/.jira-report.json`
+
+## Configuration Options
+
+| Option | Required | Description | Default |
+|--------|----------|-------------|---------|
+| `jiraServer` | Yes | Jira instance URL | - |
+| `username` | Yes | Jira username (email) | - |
+| `apiToken` | Yes | Jira API token | - |
+| `jiraTempoToken` | Yes | Tempo API token | - |
+| `whoAmI` | No | User type: "Developer" or "QC" | "Developer" |
+| `autoClipboard` | No | Auto-copy to clipboard | `true` |
+| `enableTimesheetIntegration` | No | Enable timesheet features | `true` |
+| `timesheetDateFormat` | No | Date format for timesheets | "YYYY-MM-DD" |
+
+## Output Formats
+
+### Text Format (Default)
+Human-readable format suitable for Slack/Teams messages:
+```
+Hi everyone,
+Yesterday (22/10)
+- PROJ-123: Implemented user authentication
+- PROJ-124: Fixed login bug
+
+Today
+- PROJ-125: Add password reset feature
+
+No blockers
+
+-------------------------------------------------------------
+To Do List
+🟥 - PROJ-126: Fix critical bug
+🟩 - PROJ-127: New feature request
+```
+
+### JSON Format
+Structured data for integrations:
+```json
+{
+  "greeting": "Hi everyone",
+  "yesterday": [
+    "PROJ-123: Implemented user authentication",
+    "PROJ-124: Fixed login bug"
+  ],
+  "today": [
+    "PROJ-125: Add password reset feature"
+  ],
+  "blockers": "No blockers",
+  "todoList": [
+    "🟥 - PROJ-126: Fix critical bug",
+    "🟩 - PROJ-127: New feature request"
+  ],
+  "worklog": "..."
+}
+```
+
+### Markdown Format
+Same as text but optimized for markdown rendering
+
+## Advanced Usage
+
+### Multiple Environments
+Maintain different configs for different projects:
+
+```bash
+# Project A
+cd ~/projects/project-a
+jira-report config init
+jira-report generate
+
+# Project B
+cd ~/projects/project-b
+jira-report config init
+jira-report generate
+```
+
+### CI/CD Integration
+```bash
+# In your CI script
+export JIRA_SERVER="$JIRA_SERVER_SECRET"
+export JIRA_USERNAME="$JIRA_USERNAME_SECRET"
+export JIRA_API_TOKEN="$JIRA_API_TOKEN_SECRET"
+export TEMPO_API_TOKEN="$TEMPO_API_TOKEN_SECRET"
+
+jira-report generate -f json -o report.json --no-cache
+```
+
+### Scheduled Reports
+Add to crontab for daily reports:
+```bash
+# Generate report every weekday at 9 AM
+0 9 * * 1-5 jira-report generate -o ~/daily-reports/$(date +\%Y-\%m-\%d).txt
+```
+
+## Troubleshooting
+
+### "Configuration 'xxx' is required but not set"
+- Ensure you've run `jira-report config init` and filled in all required fields
+- Or set the corresponding environment variables
+
+### "Failed to copy to clipboard"
+- Install optional dependency: `npm install -g clipboardy`
+- Or use `-o` flag to save to file instead
+
+### API Token Issues
+- Verify tokens are correct and haven't expired
+- Jira API Token: https://id.atlassian.com/manage-profile/security/api-tokens
+- Tempo API Token: https://apidocs.tempo.io/#section/Authentication
+
+### Network/Firewall Issues
+- Ensure you can access your Jira instance from the command line
+- Check proxy settings if behind corporate firewall
+
+## Differences from VS Code Extension
+
+| Feature | VS Code Extension | CLI |
+|---------|-------------------|-----|
+| Configuration | VS Code settings | Config file or env vars |
+| Output | Output panel + clipboard | Console, file, or clipboard |
+| Interactive prompts | Yes | No (command-line only) |
+| Quick actions | Yes | Not yet implemented |
+| Timesheet parsing | Yes | Not yet implemented |
+
+## Getting API Tokens
+
+### Jira API Token
+1. Go to https://id.atlassian.com/manage-profile/security/api-tokens
+2. Click "Create API token"
+3. Give it a descriptive name (e.g., "Daily Report CLI")
+4. Copy the token immediately (you can't see it again)
+
+### Tempo API Token
+1. Log in to your Jira instance
+2. Go to Tempo > Settings > Data Access > API Integration
+3. Create a new token
+4. Copy and save the token
+
+## Support
+
+For issues, feature requests, or contributions:
+- GitHub: https://github.com/voxuanthuan/daily-report
+- Issues: https://github.com/voxuanthuan/daily-report/issues
+
+## License
+
+See LICENSE file in the repository.

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Thuanvo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,180 @@
+# Jira Daily Report Extension
+
+A VS Code extension that generates daily standup reports from your Jira Server and integrates with Tempo time tracking.
+
+**🌐 Website**: [https://v0-jira-daily-report.vercel.app/](https://v0-jira-daily-report.vercel.app/)
+
+## Requirements
+
+- VS Code 1.80.0 or later
+- Jira Server access with API token
+- Tempo time tracking (optional)
+
+## Installation
+
+### Method 1: From VS Code Marketplace
+1. Open VS Code
+2. Go to Extensions (`Ctrl+Shift+X`)
+3. Search for "jira-daily-report"
+4. Click Install
+
+### Method 2: Quick Install
+1. Open VS Code
+2. Press `Ctrl+P` (Quick Open)
+3. Type: `ext install thuanvo.jira-daily-report`
+4. Press Enter
+
+### Method 3: Manual Installation
+1. Download from [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=thuanvo.jira-daily-report)
+2. Install the .vsix file in VS Code
+
+## Configuration
+
+Before using the extension, configure your Jira settings:
+
+1. Open VS Code Settings (`Ctrl+,`)
+2. Search for "jira daily report"
+3. Configure the following:
+   - **Jira Server URL**: Your Jira instance (e.g., `https://yourcompany.atlassian.net/`)
+   - **Username**: Your Jira username (email)
+   - **API Token**: [Get your Jira API token](https://confluence.atlassian.com/cloud/api-tokens-938839638.html)
+   - **Tempo API Token**: [Get your Tempo API token](https://apidocs.tempo.io/#section/Authentication) (optional)
+   - **Who Am I**: Select "Developer" or "QC"
+   - **Auto Clipboard**: Enable to automatically copy reports to clipboard
+
+## Features
+
+### 1. Generate Jira Daily Report
+
+Creates a daily standup report with your tasks, time tracking, and blockers.
+
+**How to use:**
+1. Press `Ctrl+Shift+P` to open Command Palette
+2. Type: `Generate Jira Daily Report`
+3. Press Enter
+
+**Or use keyboard shortcut:** `Ctrl+Shift+R` (Windows/Linux) or `Cmd+Shift+R` (Mac)
+
+**What it does:**
+- Fetches your current Jira tasks (Open, In Progress, Selected for Development)
+- Retrieves time tracking data from Tempo
+- Generates formatted report with:
+  - Yesterday's completed work
+  - Today's planned tasks
+  - Blockers and impediments
+  - Time tracking summary
+
+### 2. Open Ticket
+
+Opens any Jira ticket in your browser quickly.
+
+**How to use:**
+1. Press `Ctrl+Shift+P` to open Command Palette
+2. Type: `Open Ticket`
+3. Press Enter
+4. Enter ticket key (e.g., `B2B-1079`)
+5. Ticket opens in your default browser
+
+**Or use keyboard shortcut:** `Ctrl+Shift+O` (Windows/Linux) or `Cmd+Shift+O` (Mac)
+
+**What it does:**
+- Prompts for ticket key
+- Opens the ticket in your default browser
+- Quick way to view ticket details, comments, attachments
+
+### 3. Jira Quick Action
+
+Main feature that combines time logging and status changes in one command using hashtag syntax.
+
+**How to use:**
+1. Press `Ctrl+Shift+P` to open Command Palette
+2. Type: `Jira Quick Action`
+3. Press Enter
+4. Enter command with hashtag syntax (see examples below)
+
+**Or use keyboard shortcut:** `Ctrl+Shift+J` (Windows/Linux) or `Cmd+Shift+J` (Mac)
+
+**Hashtag Syntax Examples:**
+```
+# Log time and change status
+B2B-1079 #time 2h #under-review
+
+# Change status only
+B2B-1079 #under-review
+
+# Log time only
+B2B-1079 #time 2h
+
+# Order doesn't matter
+#time 2h B2B-1079 #in-progress
+
+# Use aliases
+B2B-1079 #time 1.5h #dev    # dev = selected for development
+B2B-1079 #review             # review = under-review
+```
+
+**Supported Time Formats:**
+- `2h` (2 hours)
+- `1.5h` (1.5 hours)
+- `30m` (30 minutes)
+- `1h 30m` (1 hour 30 minutes)
+
+**Supported Status Changes:**
+- `#open` → Open
+- `#selected` or `#dev` → Selected for Development
+- `#in-progress` or `#wip` → In Progress
+- `#under-review` or `#review` → Under Review
+- `#ready-for-testing` or `#testing` → Ready for Testing
+
+**What it does:**
+1. Validates ticket format and syntax
+2. Logs time directly to Tempo (if `#time` specified)
+3. Changes ticket status via Jira API (if status specified)
+4. Shows detailed results with success/failure information
+
+### 4. My Jira Tickets
+
+Browse your current tickets and perform quick actions.
+
+**How to use:**
+1. Press `Ctrl+Shift+P` to open Command Palette
+2. Type: `My Jira Tickets`
+3. Press Enter
+4. Select a ticket from the list
+5. Choose an action for the selected ticket
+
+**Or use keyboard shortcut:** `Ctrl+Shift+T` (Windows/Linux) or `Cmd+Shift+T` (Mac)
+
+**What it shows:**
+- **In Progress tickets** (marked with 🔥 for high priority)
+- **Selected for Development tickets**
+- Quick actions for each ticket (log time, change status, etc.)
+
+**What it does:**
+- Displays your current work in a organized list
+- Provides quick access to ticket actions
+- Integrates with Jira Quick Action for seamless workflow
+
+## Keyboard Shortcuts Summary
+
+- **`Ctrl+Shift+R`** - Generate Jira Daily Report
+- **`Ctrl+Shift+O`** - Open Ticket in Browser
+- **`Ctrl+Shift+J`** - Jira Quick Action
+- **`Ctrl+Shift+T`** - My Jira Tickets
+
+*On Mac, use `Cmd` instead of `Ctrl`*
+
+## Additional Resources
+
+- **Website**: [https://v0-jira-daily-report.vercel.app/](https://v0-jira-daily-report.vercel.app/)
+- **GitHub Repository**: [https://github.com/voxuanthuan/daily-report](https://github.com/voxuanthuan/daily-report)
+- **Issues & Feature Requests**: [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues)
+- **Keyboard Shortcuts Reference**: [KEYBOARD_SHORTCUTS.md](KEYBOARD_SHORTCUTS.md)
+
+## Support
+
+For help with setup, troubleshooting, or feature requests, please visit our [GitHub Issues](https://github.com/voxuanthuan/daily-report/issues) page.
+
+## License
+
+[MIT](./License.md)