apex-code-coverage-transformer 2.11.0 → 2.11.2

package/CHANGELOG.md

@@ -5,12 +5,26 @@
 
 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.11.2](https://github.com/mcarvin8/apex-code-coverage-transformer/compare/v2.11.1...v2.11.2) (2025-05-06)
+
+
+### Bug Fixes
+
+* **deps:** bump @oclif/core from 4.2.10 to 4.3.0 ([e02c2c4](https://github.com/mcarvin8/apex-code-coverage-transformer/commit/e02c2c4e85636a1d64da1783d39db3a46b118bc2))
+
+## [2.11.1](https://github.com/mcarvin8/apex-code-coverage-transformer/compare/v2.11.0...v2.11.1) (2025-03-25)
+
+
+### Bug Fixes
+
+* **deps:** bump @salesforce/core from 8.8.5 to 8.8.6 ([3cdbe52](https://github.com/mcarvin8/apex-code-coverage-transformer/commit/3cdbe52bfee45d34d8d355f61451529f9fadaeb3))
+* **deps:** bump @salesforce/sf-plugins-core from 12.2.0 to 12.2.1 ([60d3f72](https://github.com/mcarvin8/apex-code-coverage-transformer/commit/60d3f72719fad96d46a55c02e616ab81e2f8d686))
+
 ## [2.11.0](https://github.com/mcarvin8/apex-code-coverage-transformer/compare/v2.10.0...v2.11.0) (2025-03-07)
 
 
 ### Features
 
-* include ignore package directories flag in hook ([fded594](https://github.com/mcarvin8/apex-code-coverage-transformer/commit/fded594ccb229035aecfa426da972c5819a212a5))
 * include ignore package directories flag in hook ([a7294a4](https://github.com/mcarvin8/apex-code-coverage-transformer/commit/a7294a47a85141d4b1d0e21854ac14d4f19b9e14))
 
 

package/README.md

@@ -1,4 +1,4 @@
-# Apex Code Coverage Transformer
+# `apex-code-coverage-transformer`
 
 [![NPM](https://img.shields.io/npm/v/apex-code-coverage-transformer.svg?label=apex-code-coverage-transformer)](https://www.npmjs.com/package/apex-code-coverage-transformer) [![Downloads/week](https://img.shields.io/npm/dw/apex-code-coverage-transformer.svg)](https://npmjs.org/package/apex-code-coverage-transformer) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/LICENSE.md)
 
@@ -23,7 +23,7 @@
 
 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.
 
-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.
+> 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.
 
 ## Install
 
@@ -65,14 +65,12 @@ This plugin can be used after running the below [sfdx-hardis](https://github.com
 
 Both hardis commands will create the code coverage JSON to transform here: `hardis-report/apex-coverage-results.json`.
 
-### Fixes and Enhancements
+## Fixes and Enhancements
 
 - **Maps Apex file names** in the original coverage report (e.g., `no-map/AccountTriggerHandler`) to their corresponding relative file paths in the Salesforce DX project (e.g., `force-app/main/default/classes/AccountTriggerHandler.cls`).
 - **Normalizes coverage reports** across both deploy and test commands, improving compatibility with external tools.
 - **Adds additional coverage formats** not available in the default Salesforce CLI deploy and test commands.
-- **"Fixes" inaccuracies** in Salesforce CLI deploy command coverage reports, such as:
-  - Out-of-range covered lines (e.g., line 100 reported as "covered" in a 98-line Apex class).
-  - Incorrect total line counts (e.g., 120 lines reported for a 100-line Apex class).
+- **"Fixes" inaccuracies** in Salesforce CLI deploy command coverage reports, such as out-of-range covered lines (e.g., line 100 reported as "covered" in a 98-line Apex class) and incorrect total line counts (e.g., 120 lines reported for a 100-line Apex class).
   - To address these inaccuracies, the plugin includes a **re-numbering function** that only applies to deploy coverage reports. This function reassigns out-of-range `covered` lines to unused lines, ensuring reports are accepted by external tools.
   - The `uncovered` lines are always correctly reported by the deploy command.
   - Once Salesforce resolves the issue with the API that affects deploy command coverage reports, the re-numbering function will be removed in a future **breaking** release.
@@ -89,7 +87,7 @@ The `apex-code-coverage-transformer` has 1 command:
 
 ```
 USAGE
-  $ sf acc-transformer transform -j <value> -r <value> -f <value> -i <value> [--json]
+  $ sf acc-transformer transform -j <value> [-r <value>] [-f <value>] [-i <value>] [--json]
 
 FLAGS
   -j, --coverage-json=<value>             Path to the code coverage JSON file created by the Salesforce CLI deploy or test command.
@@ -104,9 +102,6 @@ FLAGS
 GLOBAL FLAGS
   --json  Format output as json.
 
-DESCRIPTION
-  Transform the Apex code coverage JSON file created by the Salesforce CLI deploy and test command into other formats accepted by SonarQube, GitHub, GitLab, Azure, Bitbucket, etc.
-
 EXAMPLES
   Transform the JSON into Sonar format:
 
@@ -133,17 +128,17 @@ EXAMPLES
 
 The `-f`/`--format` flag allows you to specify the format of the transformed coverage report.
 
-| Flag Option | Description                                                                         | Example                                                                                                               |
-| ----------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| `sonar`     | Generates a SonarQube-compatible coverage report. This is the default option.       | [example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/sonar_baseline.xml)     |
-| `clover`    | Produces a Clover XML report format, commonly used with Atlassian tools.            | [example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/clover_baseline.xml)    |
-| `lcovonly`  | Outputs coverage data in LCOV format, useful for integrating with LCOV-based tools. | [example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/lcov_baseline.info)     |
-| `cobertura` | Creates a Cobertura XML report, a widely used format for coverage reporting.        | [example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/cobertura_baseline.xml) |
-| `jacoco`    | Creates a JaCoCo XML report, the standard for Java projects.                        | [example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/jacoco_baseline.xml)    |
+| Flag Option                                                                                                             | Description                                                                         |
+| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
+| [sonar](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/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/test/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/test/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/test/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/test/jacoco_baseline.xml)       | Creates a JaCoCo XML report, the standard for Java projects.                        |
 
 ## Hook
 
-To enable automatic transformation after the below `sf` commands complete, create `.apexcodecovtransformer.config.json` in your project’s root directory.
+To enable automatic transformation after the below `sf` commands complete, create a `.apexcodecovtransformer.config.json` in your project’s root directory.
 
 - `sf project deploy [start/validate/report/resume]`
 - `sf apex run test`
@@ -154,29 +149,29 @@ To enable automatic transformation after the below `sf` commands complete, creat
 - `sf hardis org test apex`
   - only if `sfdx-hardis` is installed
 
-You can copy the sample [Salesforce CLI .apexcodecovtransformer.config.json](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/defaults/salesforce-cli/.apexcodecovtransformer.config.json), which assumes you are running the Salesforce CLI commands and specifying the `--results-dir`/`--output-dir` directory as "coverage". Update this sample with your desired output report path and format.
-
-You can copy the sample [SFDX Hardis .apexcodecovtransformer.config.json](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/defaults/sfdx-hardis/.apexcodecovtransformer.config.json), which assumes you are running the SFDX Hardis commands. Update this sample with your desired output report path and format.
+You can copy & update the sample [Salesforce CLI .apexcodecovtransformer.config.json](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/defaults/salesforce-cli/.apexcodecovtransformer.config.json), which assumes you are running the Salesforce CLI commands and specifying the `--results-dir`/`--output-dir` directory as "coverage".
 
-The `.apexcodecovtransformer.config.json` follows this structure:
+You can copy & update the sample [SFDX Hardis .apexcodecovtransformer.config.json](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/defaults/sfdx-hardis/.apexcodecovtransformer.config.json), which assumes you are running the SFDX Hardis commands.
 
-- `deployCoverageJsonPath` is required to use the hook after deploy commands and should be the path to the code coverage JSON created by the Salesforce CLI/SFDX Hardis deploy command. Recommend using a relative path.
-- `testCoverageJsonPath` is required to use the hook after test commands and should be the path to the code coverage JSON created by the Salesforce CLI/SFDX Hardis test command. Recommend using a relative path.
-- `outputReportPath` is optional and should be the path to the code coverage file created by this plugin. Recommend using a relative path. If this isn't provided, it will default to `coverage.[xml/info]` in the working directory.
-- `format` is optional and should be the intended coverage report [format](#coverage-report-formats) created by this plugin. If this isn't provided, it will default to "sonar".
-- `ignorePackageDirectories` is optional and should be a comma-separated string of package directories to ignore when looking for matching files in the coverage report. Package directories should match how they appear in the `sfdx-project.json` file.
+**`.apexcodecovtransformer.config.json` structure**
 
-If `.apexcodecovtransformer.config.json` is missing, the hook will not run.
+| JSON Key                   | Required                               | Description                                                                                   |
+| -------------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------- |
+| `deployCoverageJsonPath`   | Yes (for deploy command)               | Code coverage JSON created by the Salesforce CLI deploy commands.                             |
+| `testCoverageJsonPath`     | Yes (for test command)                 | Code coverage JSON created by the Salesforce CLI test commands.                               |
+| `outputReportPath`         | No (defaults to `coverage.[xml/info]`) | Transformed code coverage report path.                                                        |
+| `format`                   | No (defaults to `sonar`)               | Transformed code coverage report [format](#coverage-report-formats).                          |
+| `ignorePackageDirectories` | No                                     | Comma-separated string of package directories to ignore when looking for matching Apex files. |
 
 ## Troubleshooting
 
-Any file in the coverage JSON that isn't found in any package directory will result in this warning and will not be added to the transformed report:
+If a file listed in the coverage JSON cannot be found in any package directory, a warning is displayed, and the file will not be included in the transformed report:
 
 ```
 Warning: The file name AccountTrigger was not found in any package directory.
 ```
 
-If none of the files listed in the coverage JSON were found in a package directory, the plugin will print an additional warning stating no files were processed. In this case, the transformed report generated will be an empty file.
+If **none** of the files in the coverage JSON are found in a package directory, the plugin will print an additional warning, and the generated report will be empty:
 
 ```
 Warning: The file name AccountTrigger was not found in any package directory.
@@ -184,22 +179,22 @@ Warning: The file name AccountProfile was not found in any package directory.
 Warning: None of the files listed in the coverage JSON were processed. The coverage report will be empty.
 ```
 
-The code coverage JSON files created by the Salesforce CLI deploy and test commands follow different formats. If the code coverage JSON file provided does not match 1 of the 2 expected coverage data types, the plugin will fail with:
+Salesforce CLI generates code coverage JSONs in two different structures (deploy and test command formats). If the provided coverage JSON does not match one of these expected structures, the plugin will fail with:
 
 ```
 Error (1): The provided JSON does not match a known coverage data format from the Salesforce deploy or test command.
 ```
 
-If the `sfdx-project.json` file was not found in your project's root folder, the plugin will fail with:
+If `sfdx-project.json` file is missing from the project root, the plugin will fail with:
 
 ```
 Error (1): sfdx-project.json not found in any parent directory.
 ```
 
-Any ENOENT failures indicate that the plugin had issues finding one of the package directories in the `sfdx-project.json` file:
+If a package directory listed in `sfdx-project.json` cannot be found, the plugin will encounter a **ENOENT** error:
 
 ```
-Error (1): ENOENT: no such file or directory: {packageDirPath}
+Error (1): ENOENT: no such file or directory: {packageDir}
 ```
 
 ## Issues