Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: cli option to disable html escaping in output #569

Merged
merged 3 commits into from
Jan 5, 2025

Conversation

Aswinr24
Copy link
Contributor

@Aswinr24 Aswinr24 commented Jan 3, 2025

This PR adds a new --disable-html-escape CLI option to cyclonedx-gomod. When used, it disables HTML escaping in SBOM outputs.
Ensuring raw, human-readable formats without converting special characters (e.g., & to \u0026).

Related Issue:

Closes issue #555

Example Usage:

cyclonedx-gomod mod -licenses -type library -json -disable-html-escape -output bom.json ./cyclonedx-go

@Aswinr24 Aswinr24 requested a review from a team as a code owner January 3, 2025 08:30
@Aswinr24
Copy link
Contributor Author

Aswinr24 commented Jan 3, 2025

Do I need to update any documentation, examples, or other related files to reflect this new -disable-html-escape CLI option? @nscuro

@nscuro
Copy link
Member

nscuro commented Jan 3, 2025

Thanks @Aswinr24, I think this is a sensible solution.

Could you please update the README so the command descriptions include the new flag?

Please also sign-off your commit so the DCO check passes.

@nscuro nscuro added the enhancement New feature or request label Jan 3, 2025
@Aswinr24 Aswinr24 force-pushed the main branch 4 times, most recently from 95a600b to 156b1f8 Compare January 3, 2025 17:58
@Aswinr24
Copy link
Contributor Author

Aswinr24 commented Jan 4, 2025

Hey @nscuro, added docs for the CLI option.
You think this is good to go or any more changes required?

@nscuro nscuro merged commit 4978df5 into CycloneDX:main Jan 5, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants