Allow consumers to disable skipLibCheck by adding `// @ts-ignore` to imports for dependencies that might not ever be added?

[700software]

Hi! 👋

Firstly, thanks for your work on this project! 🙂

Today I used patch-package to patch @sentry/nextjs@8.13.0 for the project I'm working on.

Here is the diff that solved my problem:

diff --git a/node_modules/@sentry/nextjs/build/types/config/types.d.ts b/node_modules/@sentry/nextjs/build/types/config/types.d.ts
index 48a1953..f9386d2 100644
--- a/node_modules/@sentry/nextjs/build/types/config/types.d.ts
+++ b/node_modules/@sentry/nextjs/build/types/config/types.d.ts
@@ -1,5 +1,6 @@
 import type { GLOBAL_OBJ } from '@sentry/utils';
 import type { SentryWebpackPluginOptions } from '@sentry/webpack-plugin';
+// @ts-ignore
 import type { DefinePlugin, WebpackPluginInstance } from 'webpack';
 export type { WebpackPluginInstance };
 export type ExportedNextConfig = NextConfigObject | NextConfigFunction;

This issue body was partially generated by patch-package.

[s1gr1d]

Hello, thanks for raising this!
Can you elaborate the problem you had before adding // @ts-ignore?

[700software]

In our project we changed our tsconfig.json skipLibCheck from true (default) to false

The reason we did this was to get red underlines and type check errors in typos in our .d.ts files since we use those extensively for internal types, and especially complex type transformations. (The reason we name our internal files .d.ts instead of .ts is not to export them, but just to provide clarity to the broader team that there is no runtime code in those files.)

With skipLibCheck we couldn't get checks in those files.

Now that skipLibCheck is turned off, we have noticed a handful of libraries, including yours will block our app from type-checking/building.

Some of these we fixed by bumping our React version or @types/node version.

But for sentry (and a few others) we saw no fix because your types.d.ts file imports a dependency we don't use: webpack.

Error: node_modules/@sentry/nextjs/build/types/config/types.d.ts(3,58): error TS2307: Cannot find module 'webpack' or its corresponding type declarations.

So my proposal is to add // @ts-ignore to "optional dependency imports" if you want to support skipLibCheck: false consumers.

However if you don't want to support this use case I totally understand and you may close the issue. I can just continue using patch-package.

[Lms24]

Hi @700software thanks for explaining! I have to admit this is the first time that we're hearing about this import from webpack being a problem. We'd like to help you out as much as possible but I'm afraid adding a ts-ignore to this import might in turn have type checking implications on our end which I'd like to avoid.

But for sentry (and a few others) we saw no fix because your types.d.ts file imports a dependency we don't use: webpack.

This confuses me a bit: If you're using NextJS I'm fairly sure that you will have webpack as a dependency. It's probably not listed in your package.json but its a transitive dependency of NextJS since it relies on webpack. At least to my knowledge. I'm curious to learn more here :)