Skip to content

docs: Fix Solid, SolidStart, and NestJS README snippets #24571

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nicohrubec wants to merge 1 commit into
base: develop
Choose a base branch
from
+3 −3
Open

docs: Fix Solid, SolidStart, and NestJS README snippets #24571

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/nestjs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ after each cron job run.

```typescript
import { Cron } from '@nestjs/schedule';
import { SentryCron, MonitorConfig } from '@sentry/nestjs';
import { SentryCron } from '@sentry/nestjs';

@sentry sentry Bot Sep 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The @sentry/nestjs README example incorrectly imports MonitorConfig from @sentry/nestjs, which will cause a TypeScript compilation error.
Severity: MEDIUM

Suggested Fix

Remove MonitorConfig from the import statement from '@sentry/nestjs'. The correct type import from '@sentry/core' is already included in the code snippet.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: packages/nestjs/README.md#L136

Potential issue: The code example in the `@sentry/nestjs` README includes
`MonitorConfig` in the import statement from `@sentry/nestjs`. However, `MonitorConfig`
is not a public export of the `@sentry/nestjs` package. TypeScript users who copy this
code snippet will encounter a compilation error because the type cannot be found in the
specified module. The correct import for this type is from `@sentry/core`, which is
already present in the example on the following line.

Did we get this right? 👍 / 👎 to inform future reviews.

import type { MonitorConfig } from '@sentry/core';

const monitorConfig: MonitorConfig = {
Expand Down
2 changes: 1 addition & 1 deletion packages/solid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Sentry.init({
tracesSampleRate: 1.0, // Capture 100% of the transactions
});

const SentryRouter = Sentry.withSentryRouterRouting(Router);
const SentryRouter = withSentryRouterRouting(Router);

@sentry sentry Bot Sep 21, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: The @sentry/solid README example incorrectly calls withSentryRouterRouting as a method on the Sentry namespace, which will cause a runtime TypeError.
Severity: HIGH

Suggested Fix

Update the README example to call withSentryRouterRouting(Router) directly, and ensure the import statement correctly imports it as a named export from '@sentry/solid/solidrouter'.

Prompt for AI Agent 
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.

Location: packages/solid/README.md#L42

Potential issue: The example code in the `@sentry/solid` README for setting up router
integration demonstrates an incorrect usage of `withSentryRouterRouting`. It shows
`Sentry.withSentryRouterRouting(Router)`, but `withSentryRouterRouting` is a named
export from the `@sentry/solid/solidrouter` module, not a property on the `Sentry`
namespace object. Users copying this code snippet will encounter a `TypeError:
Sentry.withSentryRouterRouting is not a function` at runtime, preventing the integration
from working.

Did we get this right? 👍 / 👎 to inform future reviews.


render(
() => (
Expand Down
2 changes: 1 addition & 1 deletion packages/solidstart/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ higher order component, which will enable Sentry to reach your router context.
import { withSentryRouterRouting } from '@sentry/solidstart/solidrouter';
import { Route, Router } from '@solidjs/router';

const SentryRouter = Sentry.withSentryRouterRouting(Router);
const SentryRouter = withSentryRouterRouting(Router);

render(
() => (
Expand Down
Loading