apex-code-coverage-transformer 2.13.4 → 2.14.0

package/CHANGELOG.md

@@ -5,6 +5,13 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [2.14.0](https://github.com/mcarvin8/apex-code-coverage-transformer/compare/v2.13.4...v2.14.0) (2025-10-27)
+
+
+### Features
+
+* add json-summary, simplecov, and opencover coverage formats ([#231](https://github.com/mcarvin8/apex-code-coverage-transformer/issues/231)) ([9da086f](https://github.com/mcarvin8/apex-code-coverage-transformer/commit/9da086f212cbdd98184f8c873792b8da882815db))
+
 ## [2.13.4](https://github.com/mcarvin8/apex-code-coverage-transformer/compare/v2.13.3...v2.13.4) (2025-10-27)
 
 

package/README.md

@@ -12,6 +12,7 @@
   <summary>Table of Contents</summary>
 
 - [Install](#install)
+- [Quick Start](#quick-start)
 - [Usage](#usage)
   - [Salesforce CLI](#salesforce-cli)
   - [SFDX Hardis](#sfdx-hardis)
@@ -19,6 +20,11 @@
 - [Command](#command)
   - [`sf acc-transformer transform`](#sf-acc-transformer-transform)
 - [Coverage Report Formats](#coverage-report-formats)
+- [CI/CD Integration Examples](#cicd-integration-examples)
+  - [Codecov](#codecov)
+  - [SonarQube](#sonarqube)
+  - [GitHub Actions](#github-actions)
+  - [GitLab CI](#gitlab-ci)
 - [Hook](#hook)
 - [Troubleshooting](#troubleshooting)
 - [Issues](#issues)
@@ -26,7 +32,7 @@
 - [License](#license)
 </details>
 
-Transform the Salesforce Apex code coverage JSON files created during deployments and test runs into other [formats](#coverage-report-formats) accepted by SonarQube, GitHub, GitLab, Azure, Bitbucket, etc.
+Transform the Salesforce Apex code coverage JSON files created during deployments and test runs into other [formats](#coverage-report-formats) accepted by SonarQube, Codecov, GitHub, GitLab, Azure, Bitbucket, etc.
 
 > If there's a coverage format not yet supported by this plugin, feel free to provide a pull request or issue for the coverage format.
 
@@ -36,6 +42,51 @@ Transform the Salesforce Apex code coverage JSON files created during deployment
 sf plugins install apex-code-coverage-transformer@x.y.z
 ```
 
+## Quick Start
+
+1. **Generate Salesforce code coverage in JSON format**:
+
+   **Option A - Run Apex tests directly**:
+
+   ```bash
+   sf apex run test --code-coverage --output-dir "coverage"
+   ```
+
+   **Option B - Deploy/validate with coverage**:
+
+   ```bash
+   sf project deploy start --coverage-formatters json --results-dir "coverage"
+   # or for validation
+   sf project deploy validate --coverage-formatters json --results-dir "coverage"
+   ```
+
+2. **Transform the coverage to your desired format**:
+
+   **For test command** (creates `coverage/test-result-codecoverage.json`):
+
+   ```bash
+   # For SonarQube
+   sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "sonar"
+
+   # For Codecov
+   sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "cobertura"
+
+   # For multiple formats at once
+   sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -f "sonar" -f "cobertura" -f "jacoco"
+   ```
+
+   **For deploy command** (creates `coverage/coverage/coverage.json`):
+
+   ```bash
+   # For SonarQube
+   sf acc-transformer transform -j "coverage/coverage/coverage.json" -r "coverage.xml" -f "sonar"
+
+   # For Codecov
+   sf acc-transformer transform -j "coverage/coverage/coverage.json" -r "coverage.xml" -f "cobertura"
+   ```
+
+3. **Upload to your coverage tool** (see [CI/CD Integration Examples](#cicd-integration-examples) for platform-specific instructions).
+
 ## Usage
 
 This plugin is designed for users deploying Apex or running Apex tests within Salesforce DX projects (`sfdx-project.json`). It transforms Salesforce CLI JSON coverage reports into formats recognized by external tools.
@@ -126,6 +177,18 @@ EXAMPLES
 
     $ sf acc-transformer transform -j "coverage.json" -r "coverage.info" -f "lcovonly"
 
+  Transform the JSON into JSON Summary format:
+
+    $ sf acc-transformer transform -j "coverage.json" -r "coverage.json" -f "json-summary"
+
+  Transform the JSON into SimpleCov format:
+
+    $ sf acc-transformer transform -j "coverage.json" -r "coverage.json" -f "simplecov"
+
+  Transform the JSON into OpenCover format:
+
+    $ sf acc-transformer transform -j "coverage.json" -r "coverage.xml" -f "opencover"
+
   Transform the JSON into Sonar format, ignoring Apex in the "force-app" directory:
 
     $ sf acc-transformer transform -j "coverage.json" -i "force-app"
@@ -137,14 +200,218 @@ The `-f`/`--format` flag allows you to specify the format of the transformed cov
 
 You can provide multiple `--format` flags in a single command to create multiple reports. If multiple `--format` flags are provided, each output report will have the format appended to the name. For example, if `--output-report` is set `coverage.xml` and you supply `--format sonar --format cobertura` to the command, the output reports will be `coverage-sonar.xml` and `coverage-cobertura.xml`.
 
-| Flag Option                                                                                                                  | Description                                                                                |
-| ---------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
-| [sonar](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/sonar_baseline.xml)         | Generates a SonarQube-compatible coverage report. This is the default option.              |
-| [clover](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/clover_baseline.xml)       | Produces a Clover XML report format, commonly used with Atlassian tools.                   |
-| [lcovonly](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/lcov_baseline.info)      | Outputs coverage data in LCOV format, useful for integrating with LCOV-based tools.        |
-| [cobertura](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/cobertura_baseline.xml) | Creates a Cobertura XML report, a widely used format for coverage reporting.               |
-| [jacoco](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/jacoco_baseline.xml)       | Creates a JaCoCo XML report, the standard for Java projects.                               |
-| [json](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/json_baseline.json)          | Generates a Istanbul JSON report compatible with Node.js tooling and coverage visualizers. |
+| Format                                                                                                                              | Description                                                                                | Compatible Platforms/Tools                                 |
+| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
+| [sonar](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/sonar_baseline.xml)                | Generates a SonarQube-compatible coverage report. This is the default option.              | SonarQube, SonarCloud                                      |
+| [cobertura](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/cobertura_baseline.xml)        | Creates a Cobertura XML report, a widely used format for coverage reporting.               | **Codecov**, Azure DevOps, Jenkins, GitLab, GitHub Actions |
+| [jacoco](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/jacoco_baseline.xml)              | Creates a JaCoCo XML report, the standard for Java projects.                               | **Codecov**, Jenkins, Maven, Gradle                        |
+| [lcovonly](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/lcov_baseline.info)             | Outputs coverage data in LCOV format, useful for integrating with LCOV-based tools.        | Codecov, Coveralls, GitHub Actions                         |
+| [clover](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/clover_baseline.xml)              | Produces a Clover XML report format, commonly used with Atlassian tools.                   | Bamboo, Bitbucket, Jenkins                                 |
+| [json](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/json_baseline.json)                 | Generates a Istanbul JSON report compatible with Node.js tooling and coverage visualizers. | Istanbul/NYC, Codecov, custom tools                        |
+| [json-summary](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/json-summary_baseline.json) | Generates a concise JSON summary ideal for badges, PR comments, and quick analysis.        | GitHub Actions, GitLab CI, Custom Dashboards               |
+| [simplecov](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/simplecov_baseline.json)       | Generates SimpleCov JSON format compatible with Ruby coverage tools.                       | Codecov, SimpleCov, Ruby Tools                             |
+| [opencover](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/baselines/opencover_baseline.xml)        | Generates OpenCover XML format for .NET and Azure DevOps integration.                      | Azure DevOps, Visual Studio, Codecov, JetBrains Tools      |
+
+## CI/CD Integration Examples
+
+### Codecov
+
+Codecov accepts multiple formats including Cobertura, JaCoCo, and LCOV. Cobertura is recommended for its wide compatibility.
+
+**Using Codecov CLI**:
+
+```bash
+# Generate Salesforce coverage
+sf apex run test --code-coverage --output-dir "coverage"
+
+# Transform to Cobertura format
+sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "cobertura"
+
+# Upload to Codecov
+codecovcli upload-process --file coverage.xml
+```
+
+**Using Codecov GitHub Action**:
+
+```yaml
+name: Salesforce CI with Codecov
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Salesforce CLI
+        run: npm install -g @salesforce/cli
+
+      - name: Install Coverage Transformer Plugin
+        run: sf plugins install apex-code-coverage-transformer
+
+      - name: Authenticate to Salesforce
+        run: sf org login sfdx-url --sfdx-url-file ${{ secrets.SFDX_AUTH_URL }} --alias ci-org
+
+      - name: Run Apex Tests
+        run: sf apex run test --code-coverage --output-dir coverage --target-org ci-org
+
+      - name: Transform Coverage to Cobertura
+        run: sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "cobertura"
+
+      - name: Upload to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.xml
+          flags: apex
+          token: ${{ secrets.CODECOV_TOKEN }}
+```
+
+### SonarQube
+
+SonarQube requires its own Generic Coverage format (Sonar format).
+
+**SonarQube Scanner Example**:
+
+```bash
+# Generate and transform coverage
+sf apex run test --code-coverage --output-dir "coverage"
+sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "sonar"
+
+# Run SonarQube scanner
+sonar-scanner \
+  -Dsonar.projectKey=your-project-key \
+  -Dsonar.sources=force-app \
+  -Dsonar.tests=force-app \
+  -Dsonar.test.inclusions=**/*Test.cls \
+  -Dsonar.apex.coverage.reportPath=coverage.xml \
+  -Dsonar.host.url=https://sonarqube.example.com \
+  -Dsonar.login=$SONAR_TOKEN
+```
+
+**SonarCloud GitHub Action**:
+
+```yaml
+name: SonarCloud Analysis
+
+on: [push, pull_request]
+
+jobs:
+  sonarcloud:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Salesforce CLI
+        run: npm install -g @salesforce/cli
+
+      - name: Install Coverage Transformer Plugin
+        run: sf plugins install apex-code-coverage-transformer
+
+      - name: Authenticate to Salesforce
+        run: sf org login sfdx-url --sfdx-url-file ${{ secrets.SFDX_AUTH_URL }} --alias ci-org
+
+      - name: Run Apex Tests
+        run: sf apex run test --code-coverage --output-dir coverage --target-org ci-org
+
+      - name: Transform Coverage to Sonar Format
+        run: sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "sonar"
+
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          args: >
+            -Dsonar.projectKey=your-project-key
+            -Dsonar.organization=your-org
+            -Dsonar.sources=force-app
+            -Dsonar.tests=force-app
+            -Dsonar.test.inclusions=**/*Test.cls
+            -Dsonar.apex.coverage.reportPath=coverage.xml
+```
+
+### GitHub Actions
+
+GitHub Actions can display coverage using various formats. Use Cobertura or LCOV for best compatibility.
+
+**With Coverage Report Action**:
+
+```yaml
+name: Salesforce CI with Coverage Report
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Salesforce CLI
+        run: npm install -g @salesforce/cli
+
+      - name: Install Coverage Transformer Plugin
+        run: sf plugins install apex-code-coverage-transformer
+
+      - name: Authenticate to Salesforce
+        run: sf org login sfdx-url --sfdx-url-file ${{ secrets.SFDX_AUTH_URL }} --alias ci-org
+
+      - name: Run Apex Tests
+        run: sf apex run test --code-coverage --output-dir coverage --target-org ci-org
+
+      - name: Transform Coverage to Cobertura
+        run: sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "cobertura"
+
+      - name: Code Coverage Report
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: coverage.xml
+          badge: true
+          format: markdown
+          output: both
+
+      - name: Add Coverage PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: github.event_name == 'pull_request'
+        with:
+          recreate: true
+          path: code-coverage-results.md
+```
+
+### GitLab CI
+
+GitLab supports Cobertura format natively for coverage visualization.
+
+**`.gitlab-ci.yml` Example**:
+
+```yaml
+stages:
+  - test
+
+apex-tests:
+  stage: test
+  image: node:20
+  before_script:
+    - npm install -g @salesforce/cli
+    - sf plugins install apex-code-coverage-transformer
+    - echo $SFDX_AUTH_URL | sf org login sfdx-url --sfdx-url-stdin --alias ci-org
+  script:
+    - sf apex run test --code-coverage --output-dir coverage --target-org ci-org
+    - sf acc-transformer transform -j "coverage/test-result-codecoverage.json" -r "coverage.xml" -f "cobertura"
+  coverage: '/TOTAL.*\s+(\d+%)$/'
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+    paths:
+      - coverage/
+    expire_in: 30 days
+```
 
 ## Hook
 

package/lib/handlers/BaseHandler.d.ts

@@ -0,0 +1,51 @@
+import { CoverageHandler, SonarCoverageObject, CoberturaCoverageObject, CloverCoverageObject, LcovCoverageObject, JaCoCoCoverageObject, IstanbulCoverageObject, JsonSummaryCoverageObject, SimpleCovCoverageObject, OpenCoverCoverageObject } from '../utils/types.js';
+/**
+ * Abstract base class for coverage handlers providing common utilities.
+ * Reduces code duplication across different format handlers.
+ */
+export declare abstract class BaseHandler implements CoverageHandler {
+    /**
+     * Calculate line coverage metrics from a lines record.
+     *
+     * @param lines - Record of line numbers to hit counts
+     * @returns Coverage metrics including totals and rates
+     */
+    protected calculateCoverage(lines: Record<string, number>): {
+        totalLines: number;
+        coveredLines: number;
+        uncoveredLines: number;
+        lineRate: number;
+    };
+    /**
+     * Extract line numbers by coverage status.
+     *
+     * @param lines - Record of line numbers to hit counts
+     * @param covered - True to get covered lines, false for uncovered
+     * @returns Sorted array of line numbers
+     */
+    protected extractLinesByStatus(lines: Record<string, number>, covered: boolean): number[];
+    /**
+     * Get covered and uncovered line numbers from a lines record.
+     *
+     * @param lines - Record of line numbers to hit counts
+     * @returns Object with covered and uncovered line arrays
+     */
+    protected getCoveredAndUncovered(lines: Record<string, number>): {
+        covered: number[];
+        uncovered: number[];
+    };
+    /**
+     * Sort array of objects by their path property.
+     * Handles various path property names (@path, @filename, @name).
+     *
+     * @param items - Array of objects to sort
+     * @returns Sorted array
+     */
+    protected sortByPath<T extends {
+        '@path'?: string;
+        '@filename'?: string;
+        '@name'?: string;
+    }>(items: T[]): T[];
+    abstract processFile(filePath: string, fileName: string, lines: Record<string, number>): void;
+    abstract finalize(): SonarCoverageObject | CoberturaCoverageObject | CloverCoverageObject | LcovCoverageObject | JaCoCoCoverageObject | IstanbulCoverageObject | JsonSummaryCoverageObject | SimpleCovCoverageObject | OpenCoverCoverageObject;
+}

package/lib/handlers/BaseHandler.js

@@ -0,0 +1,63 @@
+'use strict';
+/**
+ * Abstract base class for coverage handlers providing common utilities.
+ * Reduces code duplication across different format handlers.
+ */
+export class BaseHandler {
+    /**
+     * Calculate line coverage metrics from a lines record.
+     *
+     * @param lines - Record of line numbers to hit counts
+     * @returns Coverage metrics including totals and rates
+     */
+    // eslint-disable-next-line class-methods-use-this
+    calculateCoverage(lines) {
+        const uncoveredLines = Object.values(lines).filter((hits) => hits === 0).length;
+        const coveredLines = Object.values(lines).filter((hits) => hits > 0).length;
+        const totalLines = uncoveredLines + coveredLines;
+        const lineRate = totalLines > 0 ? coveredLines / totalLines : 0;
+        return { totalLines, coveredLines, uncoveredLines, lineRate };
+    }
+    /**
+     * Extract line numbers by coverage status.
+     *
+     * @param lines - Record of line numbers to hit counts
+     * @param covered - True to get covered lines, false for uncovered
+     * @returns Sorted array of line numbers
+     */
+    // eslint-disable-next-line class-methods-use-this
+    extractLinesByStatus(lines, covered) {
+        return Object.entries(lines)
+            .filter(([, hits]) => (covered ? hits > 0 : hits === 0))
+            .map(([line]) => Number(line))
+            .sort((a, b) => a - b);
+    }
+    /**
+     * Get covered and uncovered line numbers from a lines record.
+     *
+     * @param lines - Record of line numbers to hit counts
+     * @returns Object with covered and uncovered line arrays
+     */
+    getCoveredAndUncovered(lines) {
+        return {
+            covered: this.extractLinesByStatus(lines, true),
+            uncovered: this.extractLinesByStatus(lines, false),
+        };
+    }
+    /**
+     * Sort array of objects by their path property.
+     * Handles various path property names (@path, @filename, @name).
+     *
+     * @param items - Array of objects to sort
+     * @returns Sorted array
+     */
+    // eslint-disable-next-line class-methods-use-this
+    sortByPath(items) {
+        return items.sort((a, b) => {
+            const pathA = a['@path'] ?? a['@filename'] ?? a['@name'] ?? '';
+            const pathB = b['@path'] ?? b['@filename'] ?? b['@name'] ?? '';
+            return pathA.localeCompare(pathB);
+        });
+    }
+}
+//# sourceMappingURL=BaseHandler.js.map

package/lib/handlers/BaseHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseHandler.js","sourceRoot":"","sources":["../../src/handlers/BaseHandler.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAeb;;;GAGG;AACH,MAAM,OAAgB,WAAW;IAC/B;;;;;OAKG;IACH,kDAAkD;IACxC,iBAAiB,CAAC,KAA6B;QAMvD,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;QAChF,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC;QAC5E,MAAM,UAAU,GAAG,cAAc,GAAG,YAAY,CAAC;QACjD,MAAM,QAAQ,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;QAEhE,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,cAAc,EAAE,QAAQ,EAAE,CAAC;IAChE,CAAC;IAED;;;;;;OAMG;IACH,kDAAkD;IACxC,oBAAoB,CAAC,KAA6B,EAAE,OAAgB;QAC5E,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;aACzB,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;aACvD,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;aAC7B,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACO,sBAAsB,CAAC,KAA6B;QAI5D,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,IAAI,CAAC;YAC/C,SAAS,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,KAAK,CAAC;SACnD,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,kDAAkD;IACxC,UAAU,CAAyE,KAAU;QACrG,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACzB,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YAC/D,OAAO,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC;CAcF"}

package/lib/handlers/HandlerRegistry.d.ts

@@ -0,0 +1,90 @@
+import { CoverageHandler } from '../utils/types.js';
+/**
+ * Registration information for a coverage format handler.
+ */
+export type HandlerRegistration = {
+    /** Format identifier (e.g., 'sonar', 'cobertura') */
+    name: string;
+    /** Human-readable description of the format */
+    description: string;
+    /** File extension for this format (e.g., '.xml', '.json', '.info') */
+    fileExtension: string;
+    /** Factory function to create a new handler instance */
+    handler: () => CoverageHandler;
+    /** List of platforms/tools compatible with this format */
+    compatibleWith?: string[];
+};
+/**
+ * Registry for coverage format handlers.
+ * Provides a centralized system for registering and retrieving format handlers.
+ *
+ * @example
+ * ```typescript
+ * // Register a handler
+ * HandlerRegistry.register({
+ *   name: 'myformat',
+ *   description: 'My custom format',
+ *   fileExtension: '.xml',
+ *   handler: () => new MyFormatHandler(),
+ * });
+ *
+ * // Retrieve a handler
+ * const handler = HandlerRegistry.get('myformat');
+ * ```
+ */
+export declare class HandlerRegistry {
+    private static handlers;
+    /**
+     * Register a new format handler.
+     *
+     * @param registration - Handler registration information
+     * @throws Error if a handler with the same name is already registered
+     */
+    static register(registration: HandlerRegistration): void;
+    /**
+     * Get a handler instance for the specified format.
+     *
+     * @param format - Format identifier
+     * @returns New handler instance
+     * @throws Error if format is not supported
+     */
+    static get(format: string): CoverageHandler;
+    /**
+     * Get list of all registered format names.
+     *
+     * @returns Array of format identifiers
+     */
+    static getAvailableFormats(): string[];
+    /**
+     * Get file extension for a format.
+     *
+     * @param format - Format identifier
+     * @returns File extension including the dot (e.g., '.xml')
+     */
+    static getExtension(format: string): string;
+    /**
+     * Get description for a format.
+     *
+     * @param format - Format identifier
+     * @returns Human-readable description
+     */
+    static getDescription(format: string): string;
+    /**
+     * Get compatible platforms for a format.
+     *
+     * @param format - Format identifier
+     * @returns Array of compatible platform names
+     */
+    static getCompatiblePlatforms(format: string): string[];
+    /**
+     * Check if a format is registered.
+     *
+     * @param format - Format identifier
+     * @returns True if format is registered
+     */
+    static has(format: string): boolean;
+    /**
+     * Clear all registered handlers (primarily for testing).
+     */
+    static clear(): void;
+}

package/lib/handlers/HandlerRegistry.js

@@ -0,0 +1,103 @@
+'use strict';
+/**
+ * Registry for coverage format handlers.
+ * Provides a centralized system for registering and retrieving format handlers.
+ *
+ * @example
+ * ```typescript
+ * // Register a handler
+ * HandlerRegistry.register({
+ *   name: 'myformat',
+ *   description: 'My custom format',
+ *   fileExtension: '.xml',
+ *   handler: () => new MyFormatHandler(),
+ * });
+ *
+ * // Retrieve a handler
+ * const handler = HandlerRegistry.get('myformat');
+ * ```
+ */
+export class HandlerRegistry {
+    static handlers = new Map();
+    /**
+     * Register a new format handler.
+     *
+     * @param registration - Handler registration information
+     * @throws Error if a handler with the same name is already registered
+     */
+    static register(registration) {
+        if (this.handlers.has(registration.name)) {
+            throw new Error(`Handler for format '${registration.name}' is already registered`);
+        }
+        this.handlers.set(registration.name, registration);
+    }
+    /**
+     * Get a handler instance for the specified format.
+     *
+     * @param format - Format identifier
+     * @returns New handler instance
+     * @throws Error if format is not supported
+     */
+    static get(format) {
+        const registration = this.handlers.get(format);
+        if (!registration) {
+            const available = this.getAvailableFormats().join(', ');
+            throw new Error(`Unsupported format: ${format}. Available formats: ${available}`);
+        }
+        return registration.handler();
+    }
+    /**
+     * Get list of all registered format names.
+     *
+     * @returns Array of format identifiers
+     */
+    static getAvailableFormats() {
+        return Array.from(this.handlers.keys()).sort();
+    }
+    /**
+     * Get file extension for a format.
+     *
+     * @param format - Format identifier
+     * @returns File extension including the dot (e.g., '.xml')
+     */
+    static getExtension(format) {
+        const registration = this.handlers.get(format);
+        return registration?.fileExtension ?? '.xml';
+    }
+    /**
+     * Get description for a format.
+     *
+     * @param format - Format identifier
+     * @returns Human-readable description
+     */
+    static getDescription(format) {
+        const registration = this.handlers.get(format);
+        return registration?.description ?? '';
+    }
+    /**
+     * Get compatible platforms for a format.
+     *
+     * @param format - Format identifier
+     * @returns Array of compatible platform names
+     */
+    static getCompatiblePlatforms(format) {
+        const registration = this.handlers.get(format);
+        return registration?.compatibleWith ?? [];
+    }
+    /**
+     * Check if a format is registered.
+     *
+     * @param format - Format identifier
+     * @returns True if format is registered
+     */
+    static has(format) {
+        return this.handlers.has(format);
+    }
+    /**
+     * Clear all registered handlers (primarily for testing).
+     */
+    static clear() {
+        this.handlers.clear();
+    }
+}
+//# sourceMappingURL=HandlerRegistry.js.map

package/lib/handlers/HandlerRegistry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HandlerRegistry.js","sourceRoot":"","sources":["../../src/handlers/HandlerRegistry.ts"],"names":[],"mappings":"AAAA,YAAY,CAAC;AAoBb;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,eAAe;IAClB,MAAM,CAAC,QAAQ,GAAG,IAAI,GAAG,EAA+B,CAAC;IAEjE;;;;;OAKG;IACI,MAAM,CAAC,QAAQ,CAAC,YAAiC;QACtD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,uBAAuB,YAAY,CAAC,IAAI,yBAAyB,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,GAAG,CAAC,MAAc;QAC9B,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,SAAS,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACxD,MAAM,IAAI,KAAK,CAAC,uBAAuB,MAAM,wBAAwB,SAAS,EAAE,CAAC,CAAC;QACpF,CAAC;QACD,OAAO,YAAY,CAAC,OAAO,EAAE,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,mBAAmB;QAC/B,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,MAAc;QACvC,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,OAAO,YAAY,EAAE,aAAa,IAAI,MAAM,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,cAAc,CAAC,MAAc;QACzC,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,OAAO,YAAY,EAAE,WAAW,IAAI,EAAE,CAAC;IACzC,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,sBAAsB,CAAC,MAAc;QACjD,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC/C,OAAO,YAAY,EAAE,cAAc,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,GAAG,CAAC,MAAc;QAC9B,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,KAAK;QACjB,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IACxB,CAAC"}