Migrate to Vue 3.0 #230

- Migrate from "Vue 2.X" to "Vue 3.X"
- Migrate from "Vue Test Utils v1" to "Vue Test Utils v2"

Changes in detail:

- Change `inserted` to `mounted`.
- Change `::v-deep` to `:deep`.
- Change to Vue 3.0 `v-modal` syntax.
- Remove old Vue 2.0 transition name, keep the ones for Vue 3.0.
- Use new global mounting API `createApp`.
- Change `destroy` to `unmount`.
- Bootstrapping:
  - Move `provide`s for global dependencies to a bootsrapper from
    `App.vue`.
  - Remove `productionTip` setting (not in Vue 3).
  - Change `IVueBootstrapper` for simplicity and Vue 3 compatible API.
  - Add missing tests.
- Remove `.text` access on `VNode` as it's now internal API of Vue.
- Import `CSSProperties` from `vue` instead of `jsx` package.
- Shims:
  - Remove unused `shims-tsx.d.ts`.
  - Remove `shims-vue.d.ts` that's missing in quickstart template.
- Unit tests:
  - Remove old typing workaround for mounting components.
  - Rename `propsData` to `props`.
  - Remove unneeded `any` cast workarounds.
  - Move stubs and `provide`s under `global` object.

Other changes:

- Add `dmg-license` dependency explicitly due to failing electron builds
  on macOS (electron-userland/electron-builder#6520,
  electron-userland/electron-builder#6489). This was a side-effect of
  updating dependencies for this commit.
This commit is contained in:
undergroundwires
2023-11-01 13:39:39 +01:00
parent 4995e49c46
commit ca81f68ff1
53 changed files with 775 additions and 1072 deletions

View File

@@ -1,6 +1,6 @@
import { describe, it, expect } from 'vitest';
import {
Wrapper, shallowMount,
VueWrapper, shallowMount,
mount,
} from '@vue/test-utils';
import { nextTick, defineComponent } from 'vue';
@@ -92,11 +92,11 @@ describe('ToggleSwitch.vue', () => {
const { checkboxWrapper } = getCheckboxElement(wrapper);
// act
await checkboxWrapper.setChecked(newCheckValue);
await checkboxWrapper.setValue(newCheckValue);
await nextTick();
// assert
expect(wrapper.emitted().input).to.deep.equal([[newCheckValue]]);
expect(wrapper.emitted('update:modelValue')).to.deep.equal([[newCheckValue]]);
});
});
});
@@ -122,11 +122,11 @@ describe('ToggleSwitch.vue', () => {
const { checkboxWrapper } = getCheckboxElement(wrapper);
// act
await checkboxWrapper.setChecked(value);
await checkboxWrapper.setValue(value);
await nextTick();
// assert
expect(wrapper.emitted().input).to.equal(undefined);
expect(wrapper.emitted('update:modelValue')).to.deep.equal(undefined);
});
});
});
@@ -145,7 +145,6 @@ describe('ToggleSwitch.vue', () => {
await nextTick();
// assert
expect(switchWrapper.exists());
const receivedEvents = parentWrapper.emitted(parentClickEventName);
expect(receivedEvents).to.equal(undefined);
});
@@ -161,14 +160,13 @@ describe('ToggleSwitch.vue', () => {
await nextTick();
// assert
expect(switchWrapper.exists());
const receivedEvents = parentWrapper.emitted(parentClickEventName);
expect(receivedEvents).to.have.lengthOf(1);
});
});
});
function getCheckboxElement(wrapper: Wrapper<Vue>) {
function getCheckboxElement(wrapper: VueWrapper) {
const checkboxWrapper = wrapper.find(DOM_INPUT_TOGGLE_CHECKBOX_SELECTOR);
const checkboxElement = checkboxWrapper.element as HTMLInputElement;
return {
@@ -184,9 +182,9 @@ function mountComponent(options?: {
readonly stopClickPropagation?: boolean,
}
}) {
const wrapper = shallowMount(ToggleSwitch as unknown, {
propsData: {
value: options?.properties?.modelValue,
const wrapper = shallowMount(ToggleSwitch, {
props: {
modelValue: options?.properties?.modelValue,
label: options?.properties?.label ?? 'test-label',
stopClickPropagation: options?.properties?.stopClickPropagation,
},
@@ -225,9 +223,11 @@ function mountToggleSwitchParent(options?: {
},
});
const wrapper = mount(
parentComponent as unknown,
parentComponent,
{
stubs: { ToggleSwitch: false },
global: {
stubs: { ToggleSwitch: false },
},
},
);
return {

View File

@@ -64,7 +64,7 @@ describe('useKeyboardInteractionState', () => {
const { listeners, windowStub } = createWindowStub();
// act
const { wrapper } = mountWrapperComponent(windowStub);
wrapper.destroy();
wrapper.unmount();
await nextTick();
// assert
expect(listeners.keydown).to.have.lengthOf(0);

View File

@@ -77,9 +77,11 @@ function mountWrapperComponent(nodeWatcher: WatchSource<ReadOnlyTreeNode | undef
template: '<div></div>',
}),
{
provide: {
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
global: {
provide: {
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
},
},
},
);

View File

@@ -68,9 +68,11 @@ function mountWrapperComponent(treeWatcher: WatchSource<TreeRoot | undefined>) {
template: '<div></div>',
}),
{
provide: {
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
global: {
provide: {
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
},
},
},
);

View File

@@ -334,9 +334,11 @@ class UseNodeStateChangeAggregatorBuilder {
template: '<div></div>',
}),
{
provide: {
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => this.events.get(),
global: {
provide: {
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => this.events.get(),
},
},
},
);

View File

@@ -170,8 +170,10 @@ function mountWrapperComponent() {
},
template: '<div></div>',
}, {
provide: {
[InjectionKeys.useCollectionState as symbol]: () => useStateStub.get(),
global: {
provide: {
[InjectionKeys.useCollectionState as symbol]: () => useStateStub.get(),
},
},
});

View File

@@ -60,11 +60,13 @@ function mountWrapperComponent(scenario?: {
},
template: '<div></div>',
}, {
provide: {
[InjectionKeys.useCollectionState as symbol]:
() => useStateStub.get(),
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
global: {
provide: {
[InjectionKeys.useCollectionState as symbol]:
() => useStateStub.get(),
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
},
},
});

View File

@@ -146,11 +146,13 @@ function mountWrapperComponent(options?: {
},
template: '<div></div>',
}, {
provide: {
[InjectionKeys.useCollectionState as symbol]:
() => useStateStub.get(),
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
global: {
provide: {
[InjectionKeys.useCollectionState as symbol]:
() => useStateStub.get(),
[InjectionKeys.useAutoUnsubscribedEvents as symbol]:
() => new UseAutoUnsubscribedEventsStub().get(),
},
},
});

View File

@@ -104,8 +104,10 @@ function mountWrapperComponent(categoryIdWatcher: WatchSource<number | undefined
},
template: '<div></div>',
}, {
provide: {
[InjectionKeys.useCollectionState as symbol]: () => useStateStub.get(),
global: {
provide: {
[InjectionKeys.useCollectionState as symbol]: () => useStateStub.get(),
},
},
});