Skip to content

vue: add jest testing hints on imports #2568

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.

Sign up for GitHub

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

Merged
lucas-koehler merged 3 commits into from
May 5, 2026
+29 −0
Merged

vue: add jest testing hints on imports #2568

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27df868
vue: add jest testing hints on imports and add exports to package.json
lucas-koehler Apr 16, 2026
fe0d531
remove explicit "exports" from vue package.json again
lucas-koehler Apr 16, 2026
b072bf9
review: adapt wording and add note to renderer packages
lucas-koehler May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions packages/vue/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,27 @@ const myComponent = defineComponent({
The injected `jsonforms` object is not meant to be modified directly.
Instead it should be modified via the provided `dispatch` and by changing the props of the `json-forms` component.

### Testing with Jest / Vitest

When testing custom renderers with Jest or Vitest using CJS transforms, `vue` must be imported **before** `@jsonforms/vue` in your renderer files.
This is due to the CJS bundle eagerly evaluating Vue component definitions at `require()` time, which can cause issues when Jest's module resolution processes imports sequentially.
Copy link
Copy Markdown
Member

@sdirix sdirix Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit generic. The cause seems to be that we call defineComponent at module load so vue needs to be initialized first. Do other component libraries have the same issue?


```ts
// Correct - import vue before @jsonforms/vue
import { defineComponent } from 'vue';
import { rendererProps, useJsonFormsControl } from '@jsonforms/vue';
```

```ts
// May cause errors in tests:
// "Property 'controlWrapper' was accessed during render but is not defined on instance"
Copy link
Copy Markdown
Member

@sdirix sdirix Apr 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The quoted error references controlWrapper, which comes from the Vuetify bindings. The generic Vue README does not seem like the correct place for this.

import { rendererProps, useJsonFormsControl } from '@jsonforms/vue';
import { defineComponent } from 'vue';
```

This only affects test environments using CJS module transforms.
Browser builds using Webpack, Vite, or other ESM-aware bundlers are not affected.

## License

The JSON Forms project is licensed under the MIT License. See the [LICENSE file](https://github.com/eclipsesource/jsonforms/blob/master/LICENSE) for more information.
Expand Down
Loading