Skip to content

Commit d196f98

Browse files
authored
docs: move examples to format table
1 parent 9e06ab8 commit d196f98

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

README.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
- [Coverage Report Formats](#coverage-report-formats)
1717
- [Hook](#hook)
1818
- [Debugging](#debugging)
19-
- [Example](#example)
2019
- [Issues](#issues)
2120
- [License](#license)
2221
</details>
@@ -115,12 +114,12 @@ EXAMPLES
115114

116115
The `-f`/`--format` flag allows you to specify the format of the coverage report.
117116

118-
| Flag Option | Description |
119-
|-------------|-------------|
120-
| `sonar` | Generates a SonarQube-compatible coverage report. This is the default option. |
121-
| `clover` | Produces a Clover XML report format, commonly used with Atlassian tools. |
122-
| `lcovonly` | Outputs coverage data in LCOV format, useful for integrating with LCOV-based tools. |
123-
| `cobertura` | Creates a Cobertura XML report, a widely used format for coverage reporting. |
117+
| Flag Option | Description | Example |
118+
|-------------|-------------| -------------|
119+
| `sonar` | Generates a SonarQube-compatible coverage report. This is the default option. | [sonar example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_sonar.xml) |
120+
| `clover` | Produces a Clover XML report format, commonly used with Atlassian tools. | [Clover example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_clover.xml) |
121+
| `lcovonly` | Outputs coverage data in LCOV format, useful for integrating with LCOV-based tools. | [LCovOnly example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_lcov.info) |
122+
| `cobertura` | Creates a Cobertura XML report, a widely used format for coverage reporting. | [Cobertura example](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_cobertura.xml) |
124123

125124
## Hook
126125

@@ -184,15 +183,6 @@ Any ENOENT failures indicate that the plugin had issues finding one of the packa
184183
Error (1): ENOENT: no such file or directory: {packageDirPath}
185184
```
186185

187-
## Example
188-
189-
This [code coverage JSON file](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_no_file_exts.json) created during a Salesforce CLI deployment can be transformed into:
190-
191-
- [SonarQube format](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_sonar.xml)
192-
- [Cobertura format](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_cobertura.xml)
193-
- [Clover format](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_clover.xml)
194-
- [LCovOnly format](https://raw.githubusercontent.com/mcarvin8/apex-code-coverage-transformer/main/test/deploy_coverage_baseline_lcov.info)
195-
196186
## Issues
197187

198188
If you encounter any issues, please create an issue in the repository's [issue tracker](https://github.com/mcarvin8/apex-code-coverage-transformer/issues). Please also create issues to suggest any new features.

0 commit comments

Comments
 (0)