feat(cli): add a disclaimer on how the manifest options will behave when published #338
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
demetriusfeijoo
commented
Jan 17, 2024
| @@ -228,14 +231,10 @@ export const confirmOptionsUpdate = async ( | |||
| return | |||
| } | |||
|
|
|||
| if (options.length > 0) { | |||
There was a problem hiding this comment.
I removed this console.log from here and created a new method (lookForManifestOptions()) for printing the options and the disclaimer because this method here is only called during updating time and I thought would be nice to add the disclaimer also during creation time.
What do you think, @eunjae-lee?
eunjae-lee
reviewed
Jan 18, 2024
| @@ -85,7 +85,10 @@ export const upsertFieldPlugin: UpsertFieldPluginFunc = async (args) => { | |||
|
|
|||
| const storyblokClient = StoryblokClient({ token, scope }) | |||
|
|
|||
| lookForManifestOptions(manifest?.options) | |||
There was a problem hiding this comment.
Suggested change
| lookForManifestOptions(manifest?.options) | |
| printManifestOptions(manifest?.options) |
What do you think? It's just printing out information. It's not finding and returning something from something.
Co-authored-by: Eunjae Lee <hey@eunjae.dev>
|
I made the requested adjustments, @eunjae-lee 🙌 Let me know what do you think about them. |
demetriusfeijoo
deleted the
EXT-2170-update-the-cli-to-inform-options-values-wont-be-shared
branch
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.
What?
Improve the printed messages regarding options found in a manifest file and add a disclaimer on what to expect about the behavior of these options when the plugin gets attached to a Field.
Why?
It can be common for users to think that the option values (found in a manifest file) will be shared with a real Field when the plugin gets attached to it, but, it isn't the way it happens.
To avoid sensitive data from getting leaked with other users, all the option values reside accessible only during development time (through the Field Plugin Editor or the Sandbox), and as soon as the field plugin gets attached to a real Field, only the option names are fetched and listed to the user to fulfill.
JIRA: EXT-2170
Creation with no options:
Creation with options:
Update with no options:
Update with options:
