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

UW-500 - Allow forced conversion between formats #413

Closed
WeirAE opened this issue Feb 23, 2024 · 5 comments
Closed

UW-500 - Allow forced conversion between formats #413

WeirAE opened this issue Feb 23, 2024 · 5 comments
Assignees
Labels
feature Added functionality refactor Refactor tech debt

Comments

@WeirAE
Copy link
Contributor

WeirAE commented Feb 23, 2024

Description
User story: Can you use config realize to translate a config file from one format to another? E.g., I wanted to take an nml file and convert it to .yaml. Could I do that via uw config realize -i foo.nml --input-format nml -o foo.yaml --output-format yaml?

Requirements
YAML should always be accepted as input or output format. Documentation and tests must be updated appropriately

Acceptance Criteria (Definition of Done)
ability to convert supported formats to yaml format is restored
--force flag for overriding the check that allows YAML to convert to other file formats
documentation updated
tests updated

Additional context
Allowing YAML as always accepted supplemental file will be covered in UW-504

@WeirAE WeirAE added feature Added functionality refactor Refactor tech debt labels Feb 23, 2024
@WeirAE WeirAE self-assigned this Feb 23, 2024
@WeirAE
Copy link
Contributor Author

WeirAE commented Feb 23, 2024

Marked as 'refactor' as this behavior was reasonably expected rather than necessarily 'new'

@WeirAE
Copy link
Contributor Author

WeirAE commented Feb 23, 2024

Initial testing shows that YAML is already accepted, tested and documented as universally allowed input, so perhaps --force is not needed, only improved documentation

@WeirAE
Copy link
Contributor Author

WeirAE commented Feb 23, 2024

After further re-checking requirements and testing, YAML as output has some issues in creating a valid YAML from sh/ini or nml dicts. This may again require --force to allow this behavior.
Updating the AC to read:
--force flag for overriding the check to allow all file formats to convert to YAML

@WeirAE
Copy link
Contributor Author

WeirAE commented Feb 23, 2024

Further discussion in group: we will allow YAML as output always, for much the same reason it is a valid input. However, this will be exclusive to YAML explicitly.

@WeirAE
Copy link
Contributor Author

WeirAE commented Feb 29, 2024

Completed by #414

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Added functionality refactor Refactor tech debt
Projects
None yet
Development

No branches or pull requests

1 participant