![\"\"/](\"/preview.png\")
\n![\"\"/](\"/preview-dark.png\")
\n\n[Sentry Module](https://github.com/nuxt-community/sentry-module) for [Nuxt 2](https://v2.nuxt.com/).\n\n## Features\n\nThe module enables error logging through [Sentry](https://sentry.io/).\n\n## More Resources\n\n* [GitHub](https://github.com/nuxt-community/sentry-module)\n* [Releases](https://github.com/nuxt-community/sentry-module/releases)\n* [MIT Licence](https://github.com/nuxt-community/sentry-module/blob/master/LICENSE)\n"
},
{
"path": "docs/content/settings.json",
"content": "{\n \"title\": \"Sentry module\",\n \"url\": \"https://sentry.nuxtjs.org\",\n \"logo\": {\n \"light\": \"/logo-light.svg\",\n \"dark\": \"/logo-dark.svg\"\n },\n \"github\": \"nuxt-community/sentry-module\",\n \"twitter\": \"@nuxt_js\"\n}"
},
{
"path": "docs/nuxt.config.js",
"content": "import theme from '@nuxt/content-theme-docs'\n\nexport default theme({\n docs: {\n primaryColor: '#ae9dff',\n },\n modules: [\n '@nuxtjs/redirect-module',\n ],\n redirect: {\n onDecodeError: (_error, _req, _res, next) => next(),\n rules: [\n {\n from: '^/guide/setup',\n to: '/getting-started/setup',\n statusCode: 301,\n },\n {\n from: '^/sentry/lazy-loading',\n to: '/getting-started/lazy-loading',\n statusCode: 301,\n },\n {\n from: '^/sentry/options',\n to: '/configuration/options',\n statusCode: 301,\n },\n {\n from: '^/sentry/runtime-config',\n to: '/configuration/runtime-config',\n statusCode: 301,\n },\n ],\n },\n})\n"
},
{
"path": "docs/package.json",
"content": "{\n \"name\": \"docs\",\n \"version\": \"1.0.0\",\n \"private\": true,\n \"scripts\": {\n \"dev\": \"nuxt\",\n \"build\": \"nuxt build\",\n \"start\": \"nuxt start\",\n \"generate\": \"nuxt generate\",\n \"postinstall\": \"patch-package\"\n\n },\n \"dependencies\": {\n \"@nuxt/content-theme-docs\": \"0.11.1\",\n \"@nuxt/types\": \"^2.18.1\",\n \"@nuxtjs/redirect-module\": \"^0.3.1\",\n \"nuxt\": \"2.18.1\",\n \"patch-package\": \"^8.0.0\"\n }\n}\n"
},
{
"path": "docs/patches/@nuxtjs+tailwindcss+3.4.3.patch",
"content": "diff --git a/node_modules/@nuxtjs/tailwindcss/lib/module.js b/node_modules/@nuxtjs/tailwindcss/lib/module.js\nindex c935c0b..0352b28 100644\n--- a/node_modules/@nuxtjs/tailwindcss/lib/module.js\n+++ b/node_modules/@nuxtjs/tailwindcss/lib/module.js\n@@ -56,17 +56,19 @@ module.exports = async function (moduleOptions) {\n */\n const { postcss } = nuxt.options.build\n \n- postcss.preset.stage = 1 // see https://tailwindcss.com/docs/using-with-preprocessors#future-css-features\n- postcss.plugins = postcss.plugins || {}\n+ postcss.postcssOptions = postcss.postcssOptions || {}\n+ postcss.postcssOptions.preset = postcss.postcssOptions.preset || {}\n+ postcss.postcssOptions.preset.stage = 1 // see https://tailwindcss.com/docs/using-with-preprocessors#future-css-features\n+ postcss.postcssOptions.plugins = postcss.postcssOptions.plugins || {}\n \n // Let modules extend the tailwind config\n await nuxt.callHook('tailwindcss:config', tailwindConfig)\n \n /* istanbul ignore if */\n- if (Array.isArray(postcss.plugins)) {\n+ if (Array.isArray(postcss.postcssOptions.plugins)) {\n logger.error('Array syntax for postcss plugins is not supported with v3. Please use the object syntax: https://nuxtjs.org/guides/configuration-glossary/configuration-build#postcss')\n- } else if (typeof postcss.plugins === 'object') {\n- postcss.plugins.tailwindcss = tailwindConfig\n+ } else if (typeof postcss.postcssOptions.plugins === 'object') {\n+ postcss.postcssOptions.plugins.tailwindcss = tailwindConfig\n }\n \n /*\n"
},
{
"path": "eslint.config.mjs",
"content": "import base from 'eslint-config-rchl-base'\nimport typescript from 'eslint-config-rchl-typescript'\nimport vue from 'eslint-config-rchl-vue'\n\n/** @type {import('eslint').Linter.Config[]} */\nexport default [\n {\n ignores: [\n '**/.nuxt/',\n '**/dist/',\n '**/templates/',\n 'node_modules/',\n ],\n },\n ...base,\n ...typescript,\n ...vue,\n {\n rules: {\n '@stylistic/indent': [\n 'error', 2, {\n SwitchCase: 1,\n },\n ],\n '@stylistic/semi': ['error', 'never'],\n '@stylistic/space-before-function-paren': ['error', 'always'],\n },\n },\n {\n files: ['**/*.ts', '**/*.tsx'],\n rules: {\n '@stylistic/ts/indent': [\n 'error', 2, {\n SwitchCase: 1,\n FunctionDeclaration: { parameters: 'first' },\n FunctionExpression: { parameters: 'first' },\n CallExpression: { arguments: 'first' },\n },\n ],\n '@stylistic/ts/member-delimiter-style': [\n 'error', {\n multiline: {\n delimiter: 'none',\n },\n },\n ],\n '@stylistic/ts/semi': ['error', 'never'],\n '@stylistic/ts/space-before-function-paren': ['error', 'always'],\n },\n },\n {\n files: ['**/*.vue'],\n rules: {\n 'vue/html-indent': ['error', 2],\n 'vue/script-indent': ['error', 2, { switchCase: 1 }],\n },\n },\n {\n files: ['**/.nuxt/*.js'],\n rules: {\n '@stylistic/comma-spacing': 'off',\n '@stylistic/key-spacing': 'off',\n '@stylistic/object-curly-spacing': 'off',\n '@stylistic/quote-props': 'off',\n '@stylistic/quotes': 'off',\n },\n },\n]\n"
},
{
"path": "netlify.toml",
"content": "# https://docs.netlify.com/configure-builds/file-based-configuration\n\n[build]\n base = \"docs\"\n command = \"yarn generate\"\n publish = \"dist\"\n"
},
{
"path": "package.json",
"content": "{\n \"name\": \"@nuxtjs/sentry\",\n \"version\": \"8.0.8\",\n \"description\": \"Sentry module for Nuxt.js\",\n \"repository\": \"nuxt-community/sentry-module\",\n \"license\": \"MIT\",\n \"contributors\": [\n {\n \"name\": \"Diederik van den Burger \n
\n\n\n\n"
},
{
"path": "size-check/lazy/nuxt.config.cjs",
"content": "const SentryModule = require('../..')\n\n/** @type {import('@nuxt/types').NuxtConfig} */\nconst config = {\n rootDir: __dirname,\n telemetry: false,\n modules: [\n /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),\n ],\n sentry: {\n dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',\n lazy: true,\n },\n}\n\nmodule.exports = config\n"
},
{
"path": "size-check/lazy/pages/index.vue",
"content": "\n Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "size-check/lazy+tracing/nuxt.config.cjs",
"content": "const SentryModule = require('../..')\n\n/** @type {import('@nuxt/types').NuxtConfig} */\nconst config = {\n rootDir: __dirname,\n telemetry: false,\n modules: [\n /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),\n ],\n sentry: {\n dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',\n lazy: true,\n tracing: true,\n },\n}\n\nmodule.exports = config\n"
},
{
"path": "size-check/lazy+tracing/pages/index.vue",
"content": "\n Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "size-check/package.json",
"content": "{\n \"private\": true,\n \"scripts\": {\n \"build\": \"npm-run-all --parallel build:*\",\n \"build:base\": \"nuxt build -c ./base/nuxt.config\",\n \"build:replay\": \"nuxt build -c ./replay/nuxt.config\",\n \"build:tracing\": \"nuxt build -c ./tracing/nuxt.config\",\n \"build:lazy\": \"nuxt build -c ./lazy/nuxt.config\",\n \"build:lazy+tracing\": \"nuxt build -c ./lazy+tracing/nuxt.config\",\n \"build:typescript\": \"nuxt build -c ./typescript/nuxt.config\"\n }\n}\n"
},
{
"path": "size-check/replay/nuxt.config.cjs",
"content": "const SentryModule = require('../..')\n\n/** @type {import('@nuxt/types').NuxtConfig} */\nconst config = {\n rootDir: __dirname,\n telemetry: false,\n modules: [\n /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),\n ],\n sentry: {\n dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',\n clientIntegrations: {\n // Integration from @Sentry/browser package.\n TryCatch: { eventTarget: false },\n Replay: {},\n },\n\n },\n}\n\nmodule.exports = config\n"
},
{
"path": "size-check/replay/pages/index.vue",
"content": "\n Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "size-check/tracing/nuxt.config.cjs",
"content": "const SentryModule = require('../..')\n\n/** @type {import('@nuxt/types').NuxtConfig} */\nconst config = {\n rootDir: __dirname,\n telemetry: false,\n modules: [\n /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),\n ],\n sentry: {\n dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',\n tracing: true,\n },\n}\n\nmodule.exports = config\n"
},
{
"path": "size-check/tracing/pages/index.vue",
"content": "\n Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "size-check/typescript/config/server.config.ts",
"content": "import type { ModuleOptions } from '../../../src/types'\n\nexport default function (): ModuleOptions['serverConfig'] {\n return {\n beforeSend (event, _hint) {\n event.extra = {\n foo: '1',\n }\n return event\n },\n }\n}\n"
},
{
"path": "size-check/typescript/nuxt.config.ts",
"content": "import { fileURLToPath } from 'node:url'\nimport initJiti from 'jiti'\nimport type { NuxtConfig } from '@nuxt/types'\n\nconst jiti = initJiti(fileURLToPath(import.meta.url))\n\nconst config: NuxtConfig = {\n rootDir: __dirname,\n telemetry: false,\n buildModules: [\n '@nuxt/typescript-build',\n ],\n modules: [\n jiti.resolve('../..'),\n ],\n sentry: {\n dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',\n },\n typescript: {\n typeCheck: false,\n },\n}\n\nexport default config\n"
},
{
"path": "size-check/typescript/pages/index.vue",
"content": "\n Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "size-check/typescript/tsconfig.json",
"content": "{\n \"extends\": \"../../tsconfig.json\",\n \"compilerOptions\": {\n \"types\": [\n \"@nuxt/typescript-build\",\n ]\n },\n}\n"
},
{
"path": "src/hooks.ts",
"content": "import { fileURLToPath } from 'url'\nimport { resolve } from 'path'\nimport { defu } from 'defu'\nimport type { ConsolaInstance } from 'consola'\nimport type { Configuration as WebpackConfig } from 'webpack'\nimport type { SentryWebpackPluginOptions } from '@sentry/webpack-plugin'\nimport type { Options } from '@sentry/types'\nimport * as Sentry from '@sentry/node'\nimport { addPluginTemplate, addTemplate, addWebpackPlugin } from './kit-shim'\nimport type { Nuxt } from './kit-shim'\nimport type { ModuleConfiguration } from './types/configuration'\nimport { clientSentryEnabled, serverSentryEnabled, canInitialize } from './utils'\nimport { resolveRelease, ResolvedClientOptions, resolveClientOptions, ResolvedServerOptions, resolveServerOptions } from './options'\nimport type { SentryHandlerProxy } from './options'\n\nconst RESOLVED_RELEASE_FILENAME = 'sentry.release.config.mjs'\n\nexport async function buildHook (nuxt: Nuxt, moduleOptions: ModuleConfiguration, logger: ConsolaInstance): PromiseServer-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "test/fixture/lazy/config/custom-client-integrations.js",
"content": "/**\n * @param {import('@nuxt/types').Context} _context\n * @return {PromiseServer-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "test/fixture/typescript/api/index.ts",
"content": "import type { ServerMiddleware } from '@nuxt/types'\n\nexport default Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n Works {{ isSentryReady ? 'and is' : 'but is not' }} ready!\n\n
\n\n\n\n"
},
{
"path": "test/fixture/typescript/pages/index.vue",
"content": "\n Integrations
\n\n Dedupe: {{ clientDedupeDisabled ? 'DISABLED' : 'ENABLED' }}\n
\n\n Modules: {{ serverModulesDisabled ? 'DISABLED' : 'ENABLED' }}\n
\n\n
\n\n\n\n"
},
{
"path": "test/fixture/typescript/tsconfig.json",
"content": "{\n \"extends\": \"../../tsconfig.json\",\n \"compilerOptions\": {\n \"types\": [\n \"@nuxt/typescript-build\",\n ]\n },\n}\n"
},
{
"path": "test/fixture/with-lazy-config/nuxt.config.cjs",
"content": "const SentryModule = require('../../..')\n\n/** @type {import('@nuxt/types').NuxtConfig} */\nconst config = {\n rootDir: __dirname,\n telemetry: false,\n dev: false,\n render: {\n resourceHints: false,\n },\n modules: [\n /** @type {import('@nuxt/types').Module} */(/** @type {unknown} */(SentryModule)),\n ],\n sentry: {\n dsn: 'https://fe8b7df6ea7042f69d7a97c66c2934f7@sentry.io.nuxt/1429779',\n config: {},\n lazy: {\n mockApiMethods: [\n 'captureMessage',\n ],\n injectLoadHook: true,\n chunkName: 'my-chunk',\n webpackPreload: true,\n webpackPrefetch: true,\n },\n },\n}\n\nmodule.exports = config\n"
},
{
"path": "test/fixture/with-lazy-config/pages/index.vue",
"content": "\n Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n {{ clientSentryPresent ? 'Works!' : '$sentry object is missing!' }}\n\n \n
\n\n
\n\n\n\n"
},
{
"path": "test/fixture/with-lazy-config/pages/mounted.vue",
"content": "\n Server-side
\n {{ serverSentryPresent ? 'Works!' : '$sentry object is missing!' }}\nClient-side
\n Works {{ isSentryReady ? 'and is' : 'but is not' }} ready!\n\n
\n\n\n\n"
},
{
"path": "test/lazy.test.ts",
"content": "import { fileURLToPath } from 'url'\nimport { dirname } from 'path'\nimport { describe, afterAll, beforeAll, test, expect } from 'vitest'\nimport type { Browser } from 'playwright-chromium'\nimport sentryTestkit from 'sentry-testkit'\nimport { setup, url } from '@nuxtjs/module-test-utils'\nimport type { Nuxt } from '../src/kit-shim'\nimport { $$, createBrowser, loadConfig } from './utils'\n\nconst __filename = fileURLToPath(import.meta.url)\nconst __dirname = dirname(__filename)\n\nconst { localServer } = sentryTestkit.default()\nconst TEST_DSN = 'http://acacaeaccacacacabcaacdacdacadaca@sentry.io/000001'\n\ndescribe('Smoke test (lazy)', () => {\n let nuxt: Nuxt\n let browser: Browser\n\n beforeAll(async () => {\n await localServer.start(TEST_DSN)\n const dsn = localServer.getDsn() ?? undefined\n nuxt = (await setup(loadConfig(__dirname, 'lazy', { sentry: { dsn } }, { merge: true }))).nuxt\n browser = await createBrowser()\n })\n\n afterAll(async () => {\n if (browser) {\n await browser.close()\n }\n await nuxt.close()\n await localServer.stop()\n })\n\n test('builds, runs and there are no errors', async () => {\n const page = await browser.newPage()\n\n const errors: string[] = []\n page.on('pageerror', (error) => {\n errors.push(error.message)\n })\n\n const consoleMessages: string[] = []\n page.on('console', (message) => {\n consoleMessages.push(message.text())\n })\n\n await page.goto(url('/'))\n\n // process.sentry is not initialized in webpack context in tests.\n // expect(await $$('#server-side', page)).toBe('Works!')\n expect(await $$('#client-side', page)).toBe('Works and is ready!')\n expect(errors).toEqual([])\n expect(consoleMessages).toEqual(['Sentry is ready'])\n })\n})\n"
},
{
"path": "test/options.test.ts",
"content": "import { describe, test, expect } from 'vitest'\nimport { defu } from 'defu'\nimport { PartialModuleConfiguration } from '../src/types/configuration'\nimport { ResolvedClientOptions, ResolvedServerOptions, resolveClientOptions, resolveServerOptions } from '../src/options'\nimport { nuxtCtx, Nuxt, NuxtModule, useLogger } from '../src/kit-shim'\nimport { ModuleConfiguration } from '../src/types'\nimport SentryModule from '../src/module'\n\nconst DUMMY_LOGGER = useLogger('nuxt:sentry:test')\nconst DUMMY_NUXT = {\n options: {\n dev: false,\n buildDir: '',\n },\n} as Nuxt\n// Set mocked Nuxt in context.\nnuxtCtx.value = DUMMY_NUXT\n\nasync function createOptions (options: PartialModuleConfiguration): Promise