From f8024b73123cb4c1fcefcf8551cc5dc6f091aaeb Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Wed, 31 Jan 2024 13:00:41 +0100 Subject: [PATCH] feat(vue): Deprecate `new VueIntegration()` `vueIntegration()` is already exported, but we didn't deprecate the class yet. --- packages/vue/src/index.ts | 6 +++++- packages/vue/src/integration.ts | 2 ++ packages/vue/test/integration/VueIntegration.test.ts | 4 ++-- packages/vue/test/integration/init.test.ts | 3 +-- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/packages/vue/src/index.ts b/packages/vue/src/index.ts index d89359530043..030324af9430 100644 --- a/packages/vue/src/index.ts +++ b/packages/vue/src/index.ts @@ -4,4 +4,8 @@ export { init } from './sdk'; export { vueRouterInstrumentation } from './router'; export { attachErrorHandler } from './errorhandler'; export { createTracingMixins } from './tracing'; -export { vueIntegration, VueIntegration } from './integration'; +export { + vueIntegration, + // eslint-disable-next-line deprecation/deprecation + VueIntegration, +} from './integration'; diff --git a/packages/vue/src/integration.ts b/packages/vue/src/integration.ts index 5065e1486400..8150ea6b95d6 100644 --- a/packages/vue/src/integration.ts +++ b/packages/vue/src/integration.ts @@ -35,6 +35,8 @@ export const vueIntegration = defineIntegration(_vueIntegration); /** * Initialize Vue error & performance tracking. + * + * @deprecated Use `vueIntegration()` instead. */ // eslint-disable-next-line deprecation/deprecation export const VueIntegration = convertIntegrationFnToClass( diff --git a/packages/vue/test/integration/VueIntegration.test.ts b/packages/vue/test/integration/VueIntegration.test.ts index 08af038676d0..aeea0ebf1451 100644 --- a/packages/vue/test/integration/VueIntegration.test.ts +++ b/packages/vue/test/integration/VueIntegration.test.ts @@ -36,7 +36,7 @@ describe('Sentry.VueIntegration', () => { }); // This would normally happen through client.addIntegration() - const integration = new Sentry.VueIntegration({ app }); + const integration = Sentry.vueIntegration({ app }); integration['setup']?.(Sentry.getClient() as Client); app.mount(el); @@ -58,7 +58,7 @@ describe('Sentry.VueIntegration', () => { app.mount(el); // This would normally happen through client.addIntegration() - const integration = new Sentry.VueIntegration({ app }); + const integration = Sentry.vueIntegration({ app }); integration['setup']?.(Sentry.getClient() as Client); expect(warnings).toEqual([ diff --git a/packages/vue/test/integration/init.test.ts b/packages/vue/test/integration/init.test.ts index 6a117427e2c8..c0652ad37485 100644 --- a/packages/vue/test/integration/init.test.ts +++ b/packages/vue/test/integration/init.test.ts @@ -1,6 +1,5 @@ import { createApp } from 'vue'; -import { VueIntegration } from '../../src/integration'; import type { Options } from '../../src/types'; import * as Sentry from './../../src'; @@ -104,7 +103,7 @@ Update your \`Sentry.init\` call with an appropriate config option: }); function runInit(options: Partial): void { - const integration = new VueIntegration(); + const integration = Sentry.vueIntegration(); Sentry.init({ dsn: PUBLIC_DSN,