You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
This PR introduces the ability to mock, keeping, or exclude parts of the nuxtApp object, as returned from the useNuxtApp composable.
Additional context
A number of tools used in Nuxt components rely on data passed through the nuxtApp object. Among them are @nuxtjs/i18n and @nuxtjs/apollo. For the i18n scenario, current versions of the module do not work at all with Histoire and the HstNuxt plugin. For the apollo scenario, common mocking strategies depend on apollo actually trying to fetch - so the fetch can be intercepted. This doesn't work either.
Instead of taking the big bang approach, and just letting everything through - this approach is an attempt to give the developer a choice of what to include, exclude or mock.
This introduces options for HstNuxt, so the developer can pick and choose.
This fixes#703 (and provides an example for Histoire + Nuxt3 + @nuxtjs/i18n - as well as tests for same).
There is another PR that solves some of the same problems (#710). However, for design system uses - I find that the addition of mocking is useful.
What is the purpose of this pull request?
Bug fix
New Feature
Documentation update
Other
Before submitting the PR, please make sure you do the following
If it's a new feature, provide a convincing reason to add it. Ideally, you should open a suggestion issue first and have it approved before working on it.
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 PR introduces the ability to mock, keeping, or exclude parts of the
nuxtApp
object, as returned from theuseNuxtApp
composable.Additional context
A number of tools used in Nuxt components rely on data passed through the nuxtApp object. Among them are @nuxtjs/i18n and @nuxtjs/apollo. For the i18n scenario, current versions of the module do not work at all with Histoire and the HstNuxt plugin. For the apollo scenario, common mocking strategies depend on apollo actually trying to fetch - so the fetch can be intercepted. This doesn't work either.
Instead of taking the big bang approach, and just letting everything through - this approach is an attempt to give the developer a choice of what to include, exclude or mock.
This introduces options for HstNuxt, so the developer can pick and choose.
This fixes #703 (and provides an example for Histoire + Nuxt3 + @nuxtjs/i18n - as well as tests for same).
There is another PR that solves some of the same problems (#710). However, for design system uses - I find that the addition of mocking is useful.
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
fixes #123
).