feat!: generated file naming syntax #135
Merged
Conversation
This file contains 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
BREAKING CHANGE: Generated files will no longer be saved on the root of the project by default, they will be encapsulated inside of a `.storyblok` folder.
BREAKING CHANGE: generated file naming syntax is now standard between all the commands, following the structure `<filename>.<suffix>.json`. Both filename and suffix are customizable and by default would be the command name and the spaceId respectively. Ex: `components.12345.json`
alvarosabu
added
feature
edodusi
reviewed
Nov 27, 2024
edodusi
requested changes
Nov 28, 2024
edodusi
approved these changes
Dec 2, 2024
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.
The current implementation applies the flags
--filenamedifferently and has different naming conventions for generated files depending on the commandThis PR introduces another breaking change requested by clients which solves the situation by establishing a common format for generated files:
Where:
<filename>is the name of the file. Customizable by the user with the--filenameflag<suffix>is an optional suffix to differentiate the files. By default is going to be thespaceIdand is customizable by the user with the--suffixflag<extension>is the file extension. By default isjson(Not configurable)Example:
Will generate the languages in the following path
.storyblok/languages/my-languages.dev.jsonIf you would like to use a timestamp as the suffix you can use:
storyblok pull-languages --space=12345 --filename=my-languages --suffix="$(date +%s)"Warning
The
--filenamewill be ignored in the case that--separate-filesis used on the commands that supports it.