BunCover CLI

A cross-platform CLI tool for collecting, analyzing, and reporting test coverage data for Bun projects. BunCover helps you track and improve your test coverage with real-time reporting and historical data analysis.

Features

• 🚀 Real-time Coverage Analysis: Instantly analyze test coverage as you run your tests
• 📊 Detailed Reports: Get comprehensive coverage reports including:
  • Function coverage percentage
  • Line coverage percentage
  • Uncovered line numbers
  • File-by-file breakdown
• 🔄 Source Code Synchronization: Automatically sync your source code for better coverage visualization
• 🌐 Secure Authentication: Token-based authentication for secure access
• 📱 Cross-Platform: Supports Linux, macOS, and Windows

Installation

Using npm:

npm install -g @qualipsolutions/buncover

Using yarn:

yarn global add @qualipsolutions/buncover

Using pnpm:

pnpm add -g @qualipsolutions/buncover

Using bun:

bun install -g @qualipsolutions/buncover

Usage Guide

1. Authentication

First, authenticate with your BunCover account:

# Login with your token
buncover login --token <your_token>

2. Project Setup

Configure your project for coverage reporting:

# Set up with a specific project ID
buncover run --project-id <project_id>

# Or use the configuration file (see below)

3. Running Tests with Coverage

# Run tests and collect coverage
buncover run

# Run with additional Bun test arguments
buncover run -- --timeout 5000

# Run tests for specific files
buncover run -- test/auth/*.test.js

4. Source Code Synchronization

Enable source code synchronization for better coverage visualization:

# Sync all project files
buncover sync --run

# Sync specific files or directories
buncover sync --file src/main.js --run

# Preview files that would be synced
buncover sync # without --run flag

5. Coverage Server

Start a local server for real-time coverage visualization:

# Start server with default settings
buncover serve

# Specify custom directory
buncover serve --dir ./src

# Use specific project ID
buncover serve --project-id <project_id>

Configuration

Configuration File (buncover.json)

{
  "log_level": "info",
  "project_id": "your_project_id",
  "allow_source_code": true,
  "include_patterns": [
    "src/**/*.js",
    "lib/**/*.ts"
  ]
}

Configuration Options

• log_level (string): Output verbosity

  • error: Errors only
  • warn: Warnings and errors
  • info: General information (default)
  • debug: Detailed debugging information
  • trace: All possible information

• project_id (string): Your project identifier

• allow_source_code (boolean): Enable/disable source code synchronization

• include_patterns (array): Glob patterns for files to include in coverage

Requirements

• Node.js ≥ 18.0.0
• Bun runtime installed

Support

Supported Platforms

• Linux
• macOS
• Windows

Getting Help

For support inquiries and access to BunCover, please contact:

• Email: [email protected]
• Website: https://www.buncover.dev

Copyright

© 2024 BunCover. All rights reserved.

This software is proprietary and confidential. Unauthorized copying, transferring or reproduction of this software, via any medium is strictly prohibited. The software is provided under a license agreement with BunCover and contains valuable trade secrets and intellectual property.