Skip to content

Commit

Permalink
docs: update messages for cobertura
Browse files Browse the repository at this point in the history
  • Loading branch information
mcarvin8 authored Dec 17, 2024
1 parent 004c450 commit 011e0e4
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,19 +68,23 @@ USAGE
$ sf acc-transformer transform -j <value> -x <value> -f <value> [--json]
FLAGS
-j, --coverage-json=<value> Path to the code coverage JSON file created by the Salesforce CLI deployment or test command.
-x, --xml=<value> [default: "coverage.xml"] Path to code coverage XML file that will be created by this plugin.
-f, --format=<value> [default: "sonar"] Output format for the code coverage format.
Valid options are "sonar" or "cobertura".
-j, --coverage-json=<value> Path to the code coverage JSON file created by the Salesforce CLI deploy or test command.
-x, --xml=<value> Path to the code coverage XML file that will be created by this plugin.
[default: "coverage.xml"]
-f, --format=<value> Output format for the code coverage format.
Valid options are "sonar" or "cobertura".
[default: "sonar"]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
This plugin will convert the code coverage JSON file created by the Salesforce CLI during Apex deployments and test runs into SonarQube or Cobertura format.
Transform the Apex code coverage JSON file created by the Salesforce CLI deploy and test command into SonarQube or Cobertura format.
EXAMPLES
$ sf acc-transformer transform -j "coverage.json" -x "coverage.xml" -f "sonar"
$ sf acc-transformer transform -j "coverage.json" -x "coverage.xml" -f "cobertura"
```

## Hook
Expand Down
11 changes: 6 additions & 5 deletions messages/transformer.transform.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
# summary

Transforms the Code Coverage JSON into the Generic Test Coverage Format (XML).
Transforms the Code Coverage JSON into SonarQube or Cobertura format.

# description

This plugin will convert the code coverage JSON file created by the Salesforce CLI during Apex deployments and test runs into an XML accepted by tools like SonarQube.
Transform the Apex code coverage JSON file created by the Salesforce CLI deploy and test command into SonarQube or Cobertura format.

# examples

- `sf acc-transformer transform -j "coverage.json" -x "coverage.xml"`
- `sf acc-transformer transform -j "coverage.json" -x "coverage.xml" -f "sonar"`
- `sf acc-transformer transform -j "coverage.json" -x "coverage.xml" -f "cobertura"`

# flags.coverage-json.summary

Path to the code coverage JSON file created by the Salesforce CLI deployment or test command.
Path to the code coverage JSON file created by the Salesforce CLI deploy or test command.

# flags.xml.summary

Path to code coverage XML file that will be created by this plugin.
Path to the code coverage XML file that will be created by this plugin.

# flags.format.summary

Expand Down

0 comments on commit 011e0e4

Please sign in to comment.