k6-modern-reporter 1.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Samin Azhan
+
+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,182 @@
+# k6-modern-reporter
+
+A modern, beautiful HTML report generator for k6 performance tests with an interactive UI, responsive design, and comprehensive metrics visualization.
+
+## Features
+
+✨ **Modern UI Design**
+
+- Gradient backgrounds and smooth animations
+- Responsive layout that works on all devices
+- Interactive tabbed interface
+- Professional color scheme with intuitive visual indicators
+
+📊 **Comprehensive Metrics**
+
+- Performance overview with key statistics
+- Detailed HTTP request metrics (duration, waiting, connecting, TLS, etc.)
+- Data transfer statistics (sent/received)
+- Request success/failure rates
+- P90, P95, and percentile breakdowns
+
+✅ **Test Validation**
+
+- Visual check results with pass/fail counts
+- Threshold status and validation results
+- Overall test status indicator
+- Detailed error tracking
+
+🎯 **Customizable Reports**
+
+- Custom titles and subtitles
+- HTTP method display
+- Additional test information sections
+- Debug mode for troubleshooting
+
+## Installation
+
+1. Run `npm i k6-modern-reporter` into your k6 project
+2. Import `htmlReport` in your script:
+
+```javascript
+import { htmlReport } from 'k6-modern-reporter';
+```
+
+## Usage
+
+### Basic Setup
+
+Example of a k6 test script:
+
+```typescript
+import http from 'k6/http';
+import { check } from 'k6';
+import { htmlReport } from 'k6-modern-reporter';
+
+export const options = {
+    scenarios: {
+        shared_iteration: {
+            executor: 'shared-iterations',
+            vus: 50,
+            iterations: 100,
+            maxDuration: '60s',
+        }
+    },
+    thresholds: {
+        'http_req_failed': ['rate==0.00'],
+        'http_req_duration': ['p(95)<1000'],
+        'checks': ['rate==1.00'],
+    },
+};
+
+export default function () {
+    const response = http.get("https://httpbin.org/get");
+    
+    check(response, {
+        'Response status 200': (r) => r.status === 200,
+    });
+}
+
+// Generate the HTML report
+export function handleSummary(data) {
+    const reportFileName = `./test-report-${new Date().toJSON().split(':').join('-')}.html`;
+    return {
+        [reportFileName]: htmlReport(data)
+    };
+}
+```
+
+## Report Layout
+
+The generated HTML report includes the following sections, accessible via interactive tabs:
+
+### 📈 Overview Tab (Default)
+
+![K6 Report Overview](assets/overview.jpeg)
+
+#### Performance Overview
+
+- Total Requests counter
+- Success Rate percentage
+- Failed Requests count
+- Overall Test Status (PASS/FAIL indicator)
+
+#### Data Transfer
+
+- Bytes received across all requests
+- Bytes sent across all requests
+- Avg request size
+- Total data transferred
+
+### 📊 Metrics Tab
+
+![K6 Report Overview](assets/metrics.jpeg)
+
+Detailed HTTP request metrics table showing:
+
+- **http_req_duration**: Total request time (Avg, Min, Median, Max, P90, P95)
+- **http_req_waiting**: Server processing time
+- **http_req_connecting**: TCP connection establishment time
+- **http_req_tls_handshaking**: TLS/SSL handshake time
+- **http_req_receiving**: Response download time
+- **http_req_sending**: Request upload time
+
+Color-coded values:
+
+- 🟢 **Green**: Good performance metrics
+- 🔴 **Red**: Poor performance metrics
+
+### ✅ Checks Tab
+
+![K6 Report Overview](assets/checks.jpeg)
+
+Displays all test checks organized by groups with:
+
+- Check name and description
+- Pass count (green badge)
+- Fail count (red badge)
+- Pass/Fail rate percentage
+
+### 🎯 Thresholds Tab
+
+![K6 Report Overview](assets/thresholds.jpeg)
+
+Shows threshold validation results:
+
+- Threshold condition (e.g., `p(95)<1000`, `rate==0.00`)
+- Actual value achieved
+- Pass/Fail status with color coding
+
+### 📝 Testing it out locally
+
+Ideally have an empty directory named `reports`.
+
+## Running Tests
+
+```bash
+npm test
+```
+
+## API Reference
+
+### `htmlReport(data, options)`
+
+Generates and returns a complete HTML document as a string.
+
+**Parameters:**
+
+- `data` (Object): The k6 test results data object containing metrics, checks, and thresholds
+- `options` (Object): Configuration options
+  - `title` (string): Main report title - defaults to current timestamp
+  - `subtitle` (string): Subtitle or endpoint description
+  - `httpMethod` (string): HTTP method used (GET, POST, PUT, DELETE, etc.)
+  - `additionalInfo` (Object): Key-value pairs of custom test information
+  - `debug` (boolean): If true, logs raw k6 data to console
+
+**Returns:**
+
+- (string): Complete HTML document
+
+## License
+
+MIT License. See LICENSE file for details.