fix: resolve CI test failures and update test configuration
This commit is contained in:
201
README.md
201
README.md
@@ -1,146 +1,145 @@
|
||||
# GitPulse - Developer Productivity Analyzer
|
||||
# Dependency Freshness Checker CLI
|
||||
|
||||
GitPulse is a CLI tool that analyzes local git repositories to generate developer productivity reports. It provides commit frequency analysis, code churn tracking, contributor statistics, refactoring detection, and a beautiful terminal dashboard. Perfect for freelancers, consultants, and teams who want to understand their development patterns without external services.
|
||||
A CLI tool that monitors outdated dependencies across multiple package managers (npm, pip, go, cargo) with security vulnerability context.
|
||||
|
||||
## Features
|
||||
|
||||
- **Commit Frequency Analysis**: Track commit patterns over time with daily, weekly, and monthly statistics
|
||||
- **Code Churn Tracking**: Monitor lines added/removed and identify high-churn files
|
||||
- **Contributor Statistics**: Calculate per-developer metrics including commits, changes, and activity patterns
|
||||
- **Refactoring Detection**: Identify file renames and potential refactoring activity
|
||||
- **JSON/CSV Export**: Export analysis results for external processing and reporting
|
||||
- **Interactive Dashboard**: Visual terminal UI with charts and metrics (coming soon)
|
||||
- **Time Period Filtering**: Analyze commits for specific time ranges using flexible date filters
|
||||
- **Configuration**: Customizable settings via configuration file
|
||||
- **Multi-package manager support**: Parse and analyze dependency files for npm, pip, go, and cargo
|
||||
- **Security CVE scanning**: Bundled CVE knowledge base with severity levels
|
||||
- **Interactive terminal UI**: Color-coded output using Rich
|
||||
- **CI/CD integration**: JSON output and proper exit codes
|
||||
- **Configuration system**: YAML-based configuration
|
||||
- **Upgrade recommendations**: Suggest minimal safe upgrades
|
||||
|
||||
## Installation
|
||||
|
||||
### From Source
|
||||
|
||||
```bash
|
||||
git clone https://github.com/gitpulse/gitpulse.git
|
||||
cd gitpulse
|
||||
cargo build --release
|
||||
cargo install --path .
|
||||
pip install depcheck
|
||||
```
|
||||
|
||||
### From Cargo
|
||||
Or from source:
|
||||
|
||||
```bash
|
||||
cargo install gitpulse
|
||||
```
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Analyze the current repository (last 30 days)
|
||||
gitpulse analyze
|
||||
|
||||
# Analyze with specific time period
|
||||
gitpulse analyze --since 7d
|
||||
gitpulse analyze --since 2024-01-01 --until 2024-01-31
|
||||
|
||||
# Export to JSON
|
||||
gitpulse analyze --json > report.json
|
||||
|
||||
# Export to CSV
|
||||
gitpulse export --format csv --output contributors.csv
|
||||
pip install -e .
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Analyze Command
|
||||
### Basic Usage
|
||||
|
||||
The `analyze` command generates a comprehensive analysis report:
|
||||
Scan the current directory for outdated dependencies:
|
||||
|
||||
```bash
|
||||
gitpulse analyze [OPTIONS]
|
||||
|
||||
Options:
|
||||
-s, --since <PERIOD> Time period (e.g., 7d, 2w, 1m, 1y)
|
||||
-u, until <DATE> End date for analysis
|
||||
-c, --commits <N> Analyze last N commits
|
||||
--include-merges Include merge commits
|
||||
--no-churn Skip code churn analysis
|
||||
--no-refactor Skip refactoring detection
|
||||
--json Output in JSON format
|
||||
--history Show commit history
|
||||
--top <N> Limit to top N contributors
|
||||
-o, --output <PATH> Output file path (for JSON/CSV)
|
||||
depcheck scan
|
||||
```
|
||||
|
||||
### Export Command
|
||||
|
||||
Export analysis results in various formats:
|
||||
Scan a specific file:
|
||||
|
||||
```bash
|
||||
gitpulse export --format json --output report.json
|
||||
gitpulse export --format csv --output contributors.csv
|
||||
depcheck scan package.json
|
||||
depcheck scan requirements.txt
|
||||
```
|
||||
|
||||
### Dashboard Command
|
||||
### Options
|
||||
|
||||
Launch the interactive terminal dashboard (coming soon):
|
||||
- `--json`: Output in JSON format
|
||||
- `--ci`: CI/CD mode with proper exit codes
|
||||
- `--fail-level`: Set severity threshold for failures (critical, high, medium, low)
|
||||
- `--exclude-dev`: Exclude dev dependencies
|
||||
- `--verbose`: Enable verbose output
|
||||
- `--quiet`: Suppress non-essential output
|
||||
|
||||
```bash
|
||||
gitpulse dashboard
|
||||
```
|
||||
### Exit Codes
|
||||
|
||||
- `0`: All dependencies are fresh
|
||||
- `1`: Outdated or vulnerable dependencies found
|
||||
- `2`: Error occurred during scan
|
||||
|
||||
## Configuration
|
||||
|
||||
GitPulse uses a configuration file located at `~/.config/gitpulse/config.toml`:
|
||||
Create a `.depcheck.yaml` file in your project root:
|
||||
|
||||
```toml
|
||||
[analysis]
|
||||
default_time_period = "30 days"
|
||||
max_contributors = 50
|
||||
include_merges = false
|
||||
refactoring_detection = true
|
||||
```yaml
|
||||
ignore_patterns:
|
||||
- "test/"
|
||||
- "example/"
|
||||
|
||||
[display]
|
||||
theme = "dark"
|
||||
chart_height = 10
|
||||
compact_tables = false
|
||||
show_sparklines = true
|
||||
ignore_packages:
|
||||
- "@types/*"
|
||||
|
||||
[export]
|
||||
default_format = "json"
|
||||
include_timestamps = true
|
||||
indent_json = true
|
||||
fail_level: medium
|
||||
|
||||
output:
|
||||
format: terminal
|
||||
verbose: false
|
||||
|
||||
include_dev: true
|
||||
|
||||
package_managers:
|
||||
- npm
|
||||
- pip
|
||||
```
|
||||
|
||||
## Environment Variables
|
||||
Configuration is also read from `~/.config/depcheck/.depcheck.yaml`.
|
||||
|
||||
- `GITPULSE_CONFIG`: Path to custom config file
|
||||
- `GITPULSE_THEME`: Override dashboard theme (dark/light)
|
||||
- `GITPULSE_NO_COLOR`: Disable colored output
|
||||
## CI/CD Integration
|
||||
|
||||
## Building from Source
|
||||
### GitHub Actions Example
|
||||
|
||||
```yaml
|
||||
- name: Check dependencies
|
||||
run: depcheck scan --ci --fail-level high
|
||||
```
|
||||
|
||||
### GitLab CI Example
|
||||
|
||||
```yaml
|
||||
dependency_check:
|
||||
script:
|
||||
- depcheck scan --ci --json > dependency-report.json
|
||||
artifacts:
|
||||
paths:
|
||||
- dependency-report.json
|
||||
```
|
||||
|
||||
## Supported Package Managers
|
||||
|
||||
| Package Manager | Files |
|
||||
|----------------|-------|
|
||||
| npm | package.json |
|
||||
| pip | requirements.txt, pyproject.toml |
|
||||
| go | go.mod |
|
||||
| cargo | Cargo.toml |
|
||||
|
||||
## Security
|
||||
|
||||
The tool includes a bundled CVE database with known vulnerabilities for common packages. It checks your dependencies against this database and reports any matches with severity levels.
|
||||
|
||||
## Development
|
||||
|
||||
### Running Tests
|
||||
|
||||
```bash
|
||||
# Development build
|
||||
cargo build
|
||||
|
||||
# Release build with optimizations
|
||||
cargo build --release
|
||||
|
||||
# Run tests
|
||||
cargo test
|
||||
|
||||
# Run with logging
|
||||
RUST_LOG=debug cargo run -- analyze
|
||||
pytest -q --cov=src --cov-report=term
|
||||
pytest -q tests/integration/
|
||||
```
|
||||
|
||||
## Contributing
|
||||
### Project Structure
|
||||
|
||||
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
|
||||
```
|
||||
depcheck/
|
||||
├── src/depcheck/
|
||||
│ ├── parsers/ # Package manager parsers
|
||||
│ ├── analyzers/ # CVE and version analyzers
|
||||
│ ├── reporters/ # Output formatters
|
||||
│ ├── config.py # Configuration handling
|
||||
│ └── cli.py # CLI entry point
|
||||
├── tests/
|
||||
│ ├── unit/ # Unit tests
|
||||
│ └── integration/ # Integration tests
|
||||
└── data/ # Bundled CVE database
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
GitPulse is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- Built with [clap](https://github.com/clap-rs/clap) for CLI
|
||||
- Uses [git2](https://github.com/rust-lang/git2-rs) for git operations
|
||||
- Terminal UI powered by [ratatui](https://github.com/ratatui/ratatui)
|
||||
MIT License
|
||||
|
||||
Reference in New Issue
Block a user