feat: add support for formatting jsonnet with substation cli#250
Merged
jshlbrd merged 3 commits intobrexhq:mainfrom Oct 4, 2024
Merged
feat: add support for formatting jsonnet with substation cli#250jshlbrd merged 3 commits intobrexhq:mainfrom
jshlbrd merged 3 commits intobrexhq:mainfrom
Conversation
jshlbrd
suggested changes
Oct 3, 2024
Contributor
jshlbrd
left a comment
There was a problem hiding this comment.
This looks nice and straightforward. I tested it on our internal config repo and it formatted 600+ files in under 1 second.
I added a change for the short description to match the style of the other commands, but other than that this looks ready to merge.
jshlbrd
reviewed
Oct 3, 2024
jshlbrd
approved these changes
Oct 4, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This change adds support for running
substation fmtagainst jsonnet and libsonnet files, automatically normalizing the format of substation configurations.Motivation and Context
This change was added to continue making substation more approachable and easy to work with by enhancing the CLI that is used to manage and develop configurations. Right now the CLI supports building and testing. The addition of
substation fmtadds a very small piece of that puzzle which is ensuring that all configuration is formatted the same way - this improves quality of life for teams managing many configs that are written by multiple developers.How Has This Been Tested?
The CLI has been locally built and tested on example jsonnet and libsonnet files to verify functionality.
When running
substation fmt, the output styling mimics that ofgo fmt, for consistency with the stylistic choices insubstation test.Write formatted changes to stdout.
Write formatted changes to the file.
Types of changes
Checklist: