fix(types): allow "false" in integrations options (#543)

Author: rchl

jest.config.ts

@@ -1,8 +1,12 @@
 import type { JestConfigWithTsJest } from 'ts-jest'
+import { JS_EXT_TO_TREAT_AS_ESM, TS_EXT_TO_TREAT_AS_ESM } from 'ts-jest'
 
 const jestConfig: JestConfigWithTsJest = {
-  preset: 'ts-jest/presets/js-with-ts-esm',
+  extensionsToTreatAsEsm: [...JS_EXT_TO_TREAT_AS_ESM, ...TS_EXT_TO_TREAT_AS_ESM],
   testEnvironment: 'node',
+  transform: {
+    '^.+\\.m?[tj]sx?$': ['ts-jest', { useESM: true, tsconfig: './test/tsconfig-jest.json' }],
+  },
   // Crashes on CI - https://github.com/facebook/jest/issues/10662
   // collectCoverage: true,
   // collectCoverageFrom: [

package.json

@@ -41,9 +41,21 @@
     "lint:fixture": "eslint --ext .vue,.js --no-ignore 'test/fixture/*/.nuxt/sentry.*'",
     "release": "release-it",
     "test:fixture": "NODE_OPTIONS=--experimental-vm-modules jest --runInBand",
-    "test": "yarn prepack && yarn lint && yarn test:fixture && yarn lint:fixture",
+    "test": "yarn prepack && yarn test:fixture && yarn lint:fixture && yarn typecheck",
+    "typecheck": "tsc",
     "coverage": "codecov"
   },
+  "lint-staged": {
+    "*.{js,ts,vue}": [
+      "eslint"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged && npm run typecheck",
+      "post-merge": "yarn"
+    }
+  },
   "dependencies": {
     "@sentry/integrations": "^7.45.0",
     "@sentry/node": "^7.45.0",
@@ -66,17 +78,20 @@
     "@sentry/tracing": "7.45.0",
     "@sentry/webpack-plugin": "1.20.0",
     "@types/hash-sum": "1.0.0",
-    "@types/jest": "29.5.0",
+    "@types/jest": "29.4.3",
     "@types/lodash.mergewith": "4.6.7",
     "@types/node": "16.18.19",
+    "@types/request-promise-native": "^1.0.18",
     "codecov": "3.8.3",
     "eslint": "8.36.0",
     "eslint-plugin-jest": "27.2.1",
     "globby": "11.1.0",
     "hookable": "5.5.2",
-    "jest": "29.5.0",
+    "husky": "4.3.8",
+    "jest": "29.4.3",
+    "lint-staged": "13.2.0",
     "nuxt": "2.16.3",
-    "playwright-chromium": "1.32.0",
+    "playwright-chromium": "1.32.1",
     "release-it": "15.9.3",
     "sass": "1.60.0",
     "sentry-testkit": "5.0.5",

src/types/configuration.d.ts

@@ -8,7 +8,7 @@ import { SentryCliPluginOptions } from '@sentry/webpack-plugin'
 import { Integrations as NodeIntegrations, NodeOptions, Handlers } from '@sentry/node'
 
 type IntegrationsConfig<T extends Record<keyof T, IntegrationClass<unknown>>> = Partial<{
-    [K in keyof T]: ConstructorParameters<T[K]>[0] | Record<string, never>
+    [K in keyof T]: ConstructorParameters<T[K]>[0] | Record<string, never> | false
 }>
 
 type ClientIntegrations = IntegrationsConfig<typeof BrowserIntegrations & typeof PluggableIntegrations>

test/fixture/default/nuxt.config.cjs

@@ -11,13 +11,14 @@ const config = {
     resourceHints: false,
   },
   modules: [
-    SentryModule,
+    /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),
   ],
   sentry: {
     dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',
     clientIntegrations: {
       // Integration from @Sentry/browser package.
       TryCatch: { eventTarget: false },
+      ReportingObserver: false,
     },
     customClientIntegrations: '~/config/custom-client-integrations.js',
     tracing: true,

test/fixture/lazy/nuxt.config.cjs

@@ -9,7 +9,7 @@ const config = {
     resourceHints: false,
   },
   modules: [
-    SentryModule,
+    /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),
   ],
   sentry: {
     lazy: true,

test/fixture/with-lazy-config/nuxt.config.cjs

@@ -9,7 +9,7 @@ const config = {
     resourceHints: false,
   },
   modules: [
-    SentryModule,
+    /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),
   ],
   sentry: {
     dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',

test/tsconfig-jest.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "checkJs": false,
+  },
+}

tsconfig.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     "allowJs": true,
     "baseUrl": ".",
-    "checkJs": false,
+    "checkJs": true,
     "esModuleInterop": true,
     "lib": [
       "ESNext",
@@ -15,12 +15,15 @@
     "strict": true,
     "types": [
       "jest",
+      "node",
     ],
   },
   "include": [
     "./src/",
+    "./test/",
   ],
   "exclude": [
+    "./dist",
     "./node_modules/",
     "./src/templates/plugin.*.js",
   ]