npm - nitor - Versions diffs - 1.6.0 → 1.7.0 - Mend

nitor 1.6.0 → 1.7.0

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 (23) hide show

package/docs/REVIEW.md DELETED Viewed

@@ -1,185 +0,0 @@
-# Review Command Guide
-## Overview
-The `review` command performs AI-powered code review on merge requests. It analyzes the code changes and provides intelligent feedback and suggestions.
-## Usage
-### Basic Syntax
-```bash
-nitor review -project <project short name> -mergeId <merge id> -repository <repository name>
-```
-### Short Form
-```bash
-nitor review -p <project short name> -mId <merge id> -r <repository name>
-```
-## Options
-| Option         | Short   | Description        | Required |
-| -------------- | ------- | ------------------ | -------- |
-| `--project`    | `-p`    | Project short name | Optional |
-| `--mergeId`    | `-mId`  | Merge request ID   | Yes      |
-| `--repository` | `-r`    | Repository name    | Yes      |
-| `--help`       | `-help` | Show help          | -        |
-## Examples
-### Review Portal Merge Request
-```bash
-nitor review -p portal -mId 123 -r portalClient
-```
-### Review Gateway Backend MR
-```bash
-nitor review -repository gatewayBackend -mergeId 456
-```
-### Review PHR Client Changes
-```bash
-nitor review -r phrClient -mId 789
-```
-## Supported Repositories
-- **centralAuth** - Central authentication service
-- **configService** - Configuration service
-- **gatewayBackend** - Gateway backend service
-- **gatewayClient** - Gateway client application
-- **gatewayDeployment** - Gateway deployment configs
-- **healthRecords** - Health records service
-- **mpi** - Master Patient Index
-- **phrAdminBackend** - PHR admin backend
-- **phrAdminClient** - PHR admin client
-- **phrBackend** - PHR backend service
-- **phrClient** - PHR client application
-- **phrDeployment** - PHR deployment configs
-- **portalAutomation** - Portal automation tests
-- **portalBackend** - Portal backend service
-- **portalClient** - Portal client application
-- **portalDeployment** - Portal deployment configs
-- **terminologyService** - Terminology service
-## Review Process
-The AI review will:
-1. Fetch the merge request details
-2. Analyze code changes and diffs
-3. Check for:
-   - Code quality issues
-   - Potential bugs
-   - Security vulnerabilities
-   - Best practice violations
-   - Performance concerns
-4. Generate detailed feedback
-5. Provide improvement suggestions
-## What Gets Reviewed
-### Code Quality
-- Code structure and organization
-- Naming conventions
-- Code duplication
-- Complexity analysis
-### Security
-- Authentication/authorization issues
-- Input validation
-- SQL injection risks
-- XSS vulnerabilities
-- Sensitive data exposure
-### Performance
-- Inefficient algorithms
-- Database query optimization
-- Memory leaks
-- Resource management
-### Best Practices
-- Design patterns
-- Error handling
-- Logging practices
-- Documentation
-## Understanding Review Output
-The review will provide:
-- **Issues Found** - List of problems detected
-- **Severity Levels** - Critical, High, Medium, Low
-- **Suggestions** - Recommended fixes and improvements
-- **Code Examples** - Better alternatives when applicable
-## Prerequisites
-Before running a review:
-- Merge request must exist
-- You need access to the repository
-- AI service must be configured
-## Troubleshooting
-### Review Fails to Start
-1. **Check merge request ID:**
-   ```bash
-   # Verify the MR ID is correct
-   ```
-2. **Verify repository name:**
-   Ensure the repository name matches exactly from the supported list
-3. **Check permissions:**
-   Confirm you have access to the repository
-### No Feedback Generated
-If review completes but provides no feedback:
-- The changes might be minimal
-- Code might already follow best practices
-- Check if the MR has any code changes
-### API Errors
-If you encounter API errors:
-- Verify your API credentials are configured
-- Check network connectivity
-- Ensure the AI service is available
-## Configuration
-The review command requires:
-- GitLab/GitHub access token
-- AI service API key (Google Generative AI)
-- Proper repository permissions
-## Getting Help
-To see all available options:
-```bash
-nitor review -help
-```
-## Related Commands
-- `nitor create-branch` - Create feature branches
-- `nitor merge` - Merge branches
-- `nitor refactor` - Refactor text/code

package/docs/TIME_ENTRY.md DELETED Viewed

@@ -1,422 +0,0 @@
-# Time Entry Commands Guide
-## Overview
-The time-entry commands in Nitor help you track and manage your work hours, sync with Zoho Sprints, and integrate with GitLab activities.
-## Available Commands
-- `nitor time-init` - Initialize time entry configuration
-- `nitor time-switch` - Switch between default projects
-- `nitor time-add` - Add a new time entry
-- `nitor time-update` - Update existing time entry
-- `nitor time-delete` - Delete a time entry
-- `nitor time-stats` - View daily status of time entries
-- `nitor time-entries` - View time entries by date
-- `nitor time-zoho` - Sync time entries to Zoho
-- `nitor time-gitlab` - Get GitLab activities
-- `nitor time-merge` - View merge request status for tasks
-## Setup
-### Initial Configuration
-Before using time-entry commands, you need to initialize the configuration:
-```bash
-nitor time-init
-```
-This will prompt you to enter:
-- Zoho Sprints credentials
-- Default project settings
-- GitLab integration details
-### Switch Projects
-To switch between configured projects:
-```bash
-nitor time-switch
-```
-## Usage
-### Add Time Entry
-Add a new time entry for your work:
-```bash
-nitor time-add
-```
-The command will interactively prompt you for:
-- Task ID
-- Hours worked
-- Date
-- Description
-### Update Time Entry
-Update an existing time entry:
-```bash
-nitor time-update
-```
-You'll be prompted to:
-- Select the entry to update
-- Modify hours, date, or description
-### Delete Time Entry
-Remove a time entry:
-```bash
-nitor time-delete
-```
-Select the entry you want to delete from the list.
-### View Status
-Check your daily time entry status:
-```bash
-nitor time-stats
-```
-This shows:
-- Total hours logged today
-- Tasks worked on
-- Time distribution
-You can also view status for a specific date:
-```bash
-nitor time-stats -date 2024-11-15
-```
-### View Entries
-Display time entries for a specific date range:
-```bash
-nitor time-entries
-```
-View entries for a specific date:
-```bash
-nitor time-entries -date 2024-11-15
-```
-View entries for a date range:
-```bash
-nitor time-entries -from 2024-11-01 -to 2024-11-15
-```
-### Sync to Zoho
-Sync your local time entries to Zoho Sprints:
-```bash
-nitor time-zoho
-```
-This will:
-1. Validate all time entries
-2. Upload to Zoho Sprints
-3. Report sync status
-### GitLab Activities
-Fetch your GitLab activities:
-```bash
-nitor time-gitlab
-```
-This retrieves:
-- Commits
-- Merge requests
-- Comments
-- Code reviews
-You can filter by date:
-```bash
-nitor time-gitlab -date 2024-11-15
-```
-### Merge Request Status
-View merge request status for your tasks:
-```bash
-nitor time-merge
-```
-This displays:
-- Task ID
-- MR IID (Internal ID)
-- Status (open, merged, closed)
-- Assignee
-- Title
-- URL
-## Configuration
-Time entry commands require environment variables in your `.env` file:
-### Zoho Configuration
-```bash
-ZOHO_URI=your_zoho_url
-ZOHO_USERID=your_user_id
-ZOHO_COOKIE="your_cookie"
-ZOHO_TOKEN="your_token"
-ZOHO_SESSION_ID=your_session_id
-ZOHO_PORTAL_ID=your_portal_id
-ZOHO_SOURCE="your_source"
-ZOHO_CUSTOMVIEW_ID=your_customview_id
-ZOHO_PROJECTS='{"project1":{"value":"id","label":"Name"}}'
-ZOHO_TEAM=your_team_id
-ZOHO_DEFAULT_PROJECT_ID=default_project_id
-```
-### GitLab Configuration
-```bash
-GITLAB_API_URL=https://gitlab.com/api/v4
-GITLAB_PROJECT_ID=your_project_id
-GITLAB_TOKEN=your_gitlab_token
-```
-## Workflow Examples
-### Daily Time Tracking
-```bash
-# Start your day
-nitor time-stats
-# Add time entries as you work
-nitor time-add
-# Check status throughout the day
-nitor time-stats
-# End of day - sync to Zoho
-nitor time-zoho
-```
-### Weekly Review
-```bash
-# View all entries for the week
-nitor time-entries -from 2024-11-11 -to 2024-11-15
-# Check merge request status
-nitor time-merge
-# Review GitLab activities
-nitor time-gitlab
-```
-### Project Switch
-```bash
-# Switch to different project
-nitor time-switch
-# Add time for new project
-nitor time-add
-```
-## Best Practices
-### Regular Tracking
-- Add time entries throughout the day
-- Don't wait until end of day
-- Be specific in descriptions
-### Accurate Hours
-- Round to nearest 0.25 hours
-- Include all work activities
-- Account for meetings and reviews
-### Daily Sync
-- Sync to Zoho at end of each day
-- Verify entries before syncing
-- Check for any errors
-### Task Association
-- Always link time to specific tasks
-- Use correct task IDs from Zoho
-- Keep task descriptions clear
-## Troubleshooting
-### Configuration Issues
-If time commands fail:
-1. **Check configuration:**
-   ```bash
-   nitor time-init
-   ```
-2. **Verify environment variables:**
-   - Ensure `.env` file exists
-   - Check all required variables are set
-   - Validate credentials
-### Sync Failures
-If Zoho sync fails:
-1. **Check credentials:**
-   - Verify Zoho token is valid
-   - Ensure session hasn't expired
-   - Update cookie if needed
-2. **Validate entries:**
-   - Check all entries have task IDs
-   - Verify hours are reasonable
-   - Ensure dates are valid
-### GitLab Integration Issues
-If GitLab commands fail:
-1. **Verify token:**
-   ```bash
-   echo $GITLAB_TOKEN
-   ```
-2. **Check API access:**
-   - Ensure token has correct permissions
-   - Verify project ID is correct
-   - Test API connectivity
-### Missing Data
-If entries don't appear:
-1. **Check date filters:**
-   - Verify date format (YYYY-MM-DD)
-   - Ensure date range is correct
-2. **Verify storage:**
-   - Check local data files
-   - Ensure write permissions
-## Data Storage
-Time entries are stored locally.
-## Security
-### Credentials
-- Never commit `.env` file
-- Keep tokens secure
-- Rotate credentials regularly
-### Data Privacy
-- Local data is stored unencrypted
-- Sync only over HTTPS
-- Review permissions regularly
-## Getting Help
-For specific command help:
-```bash
-nitor time-add -help
-nitor time-stats -help
-nitor time-entries -help
-```
-## Related Commands
-- `nitor version` - Check Nitor version
-- `nitor help` - View all commands
-- `nitor completion` - Setup autocomplete
-## Tips
-### Keyboard Shortcuts
-After setting up autocomplete:
-```bash
-nitor time-<Tab>  # Shows all time commands
-```
-### Quick Status Check
-Create an alias for quick status:
-```bash
-alias ts='nitor time-stats'
-alias ta='nitor time-add'
-alias tz='nitor time-zoho'
-```
-### Daily Reminder
-Set up a cron job to remind you to log time:
-```bash
-# Remind at 5 PM to log time
-0 17 * * * notify-send "Time Entry" "Don't forget to log your time!"
-```
-## Migration from timectl
-If you were using the standalone `timectl` command:
-### Command Mapping
-| Old Command       | New Command          |
-| ----------------- | -------------------- |
-| `timectl init`    | `nitor time-init`    |
-| `timectl switch`  | `nitor time-switch`  |
-| `timectl add`     | `nitor time-add`     |
-| `timectl update`  | `nitor time-update`  |
-| `timectl delete`  | `nitor time-delete`  |
-| `timectl status`  | `nitor time-stats`   |
-| `timectl entries` | `nitor time-entries` |
-| `timectl zoho`    | `nitor time-zoho`    |
-| `timectl gitlab`  | `nitor time-gitlab`  |
-| `timectl merge`   | `nitor time-merge`   |
-### Configuration
-Your existing time-entry configuration and data will work with Nitor. No migration needed!
-## Support
-For issues or questions:
-- GitHub: https://github.com/codebynithin/nitor
-- Email: mails2nithin@gmail.com