Skip to content

Commit 0eb6c91

Browse files
authored
docs: readme updates
1 parent 3abee03 commit 0eb6c91

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ sf plugins install [email protected]
3333

3434
## Who is the Plugin For?
3535

36-
This plugin is intended for users who deploy their Apex classes and triggers from any Salesforce DX project (`sfdx-project.json` file). You should be running this plugin somewhere inside your Salesforce DX project. This plugin searches for your repository's `sfdx-project.json` file to know which package directories to search into.
36+
This plugin is intended for users who deploy their Apex classes and triggers from any Salesforce DX project (`sfdx-project.json` file). You should be running this plugin somewhere inside your Salesforce DX project. This plugin searches for your project's `sfdx-project.json` file to know which package directories to search into.
3737

3838
This plugin will work regardless of your testing strategy (running all tests, running specified tests, running all local tests). The files in the original coverage JSON has to be found in one of the package directories to be added to the final report. This ensures external tools like SonarQube can match files in the coverage report to a file in the project.
3939

@@ -100,7 +100,7 @@ GLOBAL FLAGS
100100
--json Format output as json.
101101
102102
DESCRIPTION
103-
Transform the Apex code coverage JSON file created by the Salesforce CLI deploy and test command into SonarQube, Clover, LCovOnly, or Cobertura format.
103+
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.
104104
105105
EXAMPLES
106106
$ sf acc-transformer transform -j "coverage.json" -r "coverage.xml" -f "sonar"
@@ -145,7 +145,7 @@ The `.apexcodecovtransformer.config.json` follows this structure:
145145
- `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.
146146
- `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.
147147
- `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.
148-
- `format` is optional and should be the intended output format for the code coverage file created by this plugin. Options are "sonar", "clover", "lcovonly", or "cobertura". If this isn't provided, it will default to "sonar".
148+
- `format` is optional and should be the intended coverage report format created by this plugin. If this isn't provided, it will default to "sonar".
149149

150150
If the `.apexcodecovtransformer.config.json` file isn't found, the hook will be skipped.
151151

0 commit comments

Comments
 (0)