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

Command-line argument to enable pretty-print OSCAL-CLI output #268

Open
3 tasks
Rene2mt opened this issue Mar 19, 2024 · 0 comments
Open
3 tasks

Command-line argument to enable pretty-print OSCAL-CLI output #268

Rene2mt opened this issue Mar 19, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@Rene2mt
Copy link

Rene2mt commented Mar 19, 2024

User Story:

As an OSCAL content developer, I want OSCAL-CLI to provide a command-line argument to ensure generated XML, JSON and YAML output (e.g., resolved profile catalogs) are "pretty-print" formatted so it is more readable and doesn't generate large amounts of content differences when using comparison utilities.

Goals:

As an example, currently, a generated resolved profile catalog us unformatted and looks like this:
image

An external utility must be used to format the output so it looks like this:
image

FedRAMP is considering using the OSCAL-CLI in its CI/CD pipeline to generate certain OSCAL content (e.g., resolved profile catalogs, JSON and YAML versions of OSCAL documents). Having a built-in "pretty-print" capability will eliminate additional formatting step with an external utilities when generating OSCAL content that needs to be readable.

Dependencies:

TBD

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.
@Rene2mt Rene2mt added the enhancement New feature or request label Mar 19, 2024
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
Status: Needs Triage
Development

No branches or pull requests

1 participant