adjust types and tracing configuration

Author: rchl

.eslintrc.js

@@ -27,6 +27,7 @@ module.exports = {
         '@nuxtjs/eslint-config-typescript',
       ],
       rules: {
+        'comma-dangle': 'off',
         'constructor-super': 'off', // ts(2335) & ts(2377)
         'getter-return': 'off', // ts(2378)
         'import/named': 'off',
@@ -54,6 +55,7 @@ module.exports = {
         '@typescript-eslint/adjacent-overload-signatures': 'error',
         '@typescript-eslint/ban-ts-comment': 'error',
         '@typescript-eslint/ban-types': 'error',
+        '@typescript-eslint/comma-dangle': ['error', 'always-multiline'],
         '@typescript-eslint/explicit-module-boundary-types': 'warn',
         'no-array-constructor': 'off',
         '@typescript-eslint/member-delimiter-style': ['error', { multiline: { delimiter: 'none', requireLast: false } }],

docs/content/en/guide/setup.md

@@ -49,9 +49,15 @@ Then, add `@nuxtjs/sentry` to the `modules` section of `nuxt.config.js`:
 }
 ```
 
+<alert type="info">
+
+  For Typescript or type-checked JavaScript projects, you might have to install the `@sentry/tracing` package even when not using the tracing functionality. In that case, the package can be installed as a dev-only dependency.
+
+</alert>
+
 ## Types
 
-For typescript projects, add `@nuxtjs/sentry` to tsconfig types array
+In Typescript or type-checked JavaScript projects, add `@nuxtjs/sentry` to the `types` array in `tsconfig.json` to enable module types.
 
 ```json [tsconfig.json]
 {
@@ -65,4 +71,4 @@ For typescript projects, add `@nuxtjs/sentry` to tsconfig types array
 
 ## Configuration
 
-See [Options](/sentry/options) for a list of available options
+See [Options](/sentry/options) for a list of available options.

docs/content/en/sentry/options.md

@@ -316,13 +316,11 @@ export default function () {
   {
     tracesSampleRate: 1.0,
     trackComponents: true
-    hooks: [ 'mount', 'update' ],
-    timeout: 2000,
     browserTracing: {}
   }
   ```
 - Sentry documentation strongly recommends reducing the `tracesSampleRate` value; it should be between 0.0 and 1.0 (percentage of requests to capture)
-- Available browserTracing options can be found [here](https://docs.sentry.io/platforms/javascript/guides/vue/performance/instrumentation/automatic-instrumentation/#configuration-options)
+- See available [browserTracing options](https://docs.sentry.io/platforms/javascript/guides/vue/performance/instrumentation/automatic-instrumentation/#configuration-options)
 
 ### config
 

lib/core/options.js

@@ -98,8 +98,6 @@ function resolveTracingOptions (options, config) {
   const tracingOptions = merge(
     {
       tracesSampleRate: 1,
-      hooks: ['mount', 'update'],
-      timeout: 2000,
       trackComponents: true,
       browserTracing: {},
     },

types/sentry.d.ts

@@ -1,8 +1,9 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { IncomingMessage, ServerResponse } from 'http'
 import { Options as WebpackOptions } from 'webpack'
+import { BrowserTracing } from '@sentry/tracing'
 import { Options as SentryOptions } from '@sentry/types'
-import type { Options as SentryVueOptions } from '@sentry/vue/types/types'
+import { Options as SentryVueOptions, TracingOptions as SentryVueTracingOptions } from '@sentry/vue/types/types'
 import { SentryCliPluginOptions } from '@sentry/webpack-plugin'
 import { Handlers } from '@sentry/node'
 
@@ -22,24 +23,8 @@ export interface LazyConfiguration {
     webpackPreload?: boolean
 }
 
-declare type Operation = 'activate' | 'create' | 'destroy' | 'mount' | 'update'
-export interface TracingConfiguration {
-    tracesSampleRate?: number
-    /**
-     * Decides whether to track components by hooking into its lifecycle methods.
-     * Can be either set to `boolean` to enable/disable tracking for all of them.
-     * Or to an array of specific component names (case-sensitive).
-     */
-    trackComponents: boolean | string[]
-    /** How long to wait until the tracked root activity is marked as finished and sent of to Sentry */
-    timeout: number
-    /**
-     * List of hooks to keep track of during component lifecycle.
-     * Available hooks: 'activate' | 'create' | 'destroy' | 'mount' | 'update'
-     * Based on https://vuejs.org/v2/api/#Options-Lifecycle-Hooks
-     */
-    hooks: Operation[]
-    tracePropagationTargets: (string|RegExp)[]
+export interface TracingConfiguration extends Partial<SentryVueTracingOptions>, Pick<SentryOptions, 'tracesSampleRate'> {
+    browserTracing?: Partial<BrowserTracing['options']>
 }
 
 export interface ModuleConfiguration {