diff --git a/README.md b/README.md index e7c4066..83b26e1 100644 --- a/README.md +++ b/README.md @@ -68,19 +68,23 @@ USAGE $ sf acc-transformer transform -j -x -f [--json] FLAGS - -j, --coverage-json= Path to the code coverage JSON file created by the Salesforce CLI deployment or test command. - -x, --xml= [default: "coverage.xml"] Path to code coverage XML file that will be created by this plugin. - -f, --format= [default: "sonar"] Output format for the code coverage format. - Valid options are "sonar" or "cobertura". + -j, --coverage-json= Path to the code coverage JSON file created by the Salesforce CLI deploy or test command. + -x, --xml= Path to the code coverage XML file that will be created by this plugin. + [default: "coverage.xml"] + -f, --format= 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 diff --git a/messages/transformer.transform.md b/messages/transformer.transform.md index 239eeef..2634c91 100644 --- a/messages/transformer.transform.md +++ b/messages/transformer.transform.md @@ -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