deps: add missing peerDep

[m1heng]

add webpack as peerDependency as webpack is used in index.d.ts for typing

sentry-webpack-plugin/index.d.ts

Line 1 in 4e85f79

import { Compiler, WebpackPluginInstance } from 'webpack';

[kamilogorek]

Thanks

[rchl]

I'm not sure about that change... Not sure if when the usage of a dependency is only within types then that warrants a peer dependency.

This forces NPM to install the webpack dependency in projects that use @sentry/webpack-plugin. And if the @sentry/webpack-plugin is a production dependency then webpack is also installed in production, adding to the weight of the artifact.

Types are not really a requirement for using this package, thus I'm not sure if this is really a correct change.

You could say that if I don't want webpack included in production then I should not install @sentry/webpack-plugin as a production dependency. But what about the case when using @nuxtjs/sentry package? It currently comes with @sentry/webpack-plugin as a production dependency. Another option would be to mark @sentry/webpack-plugin as a peer dependency there too but then I would have again the same problem there -- since the @nuxtjs/sentry is a production dependency then both @sentry/webpack-plugin and webpack would be installed as a production dependencies.

I'm not sure what are the typical conventions in those kind of scenarios but something feels off about this change due to how NPM handles such cases.

[rchl]

I guess I could also add an argument that Webpack 4 doesn't come with types (the types are provided through @types/webpack) so when using version 4, it's not even necessary to have it installed.

I would opt for reverting this change and instead maybe mentioning this in the documentation since the situation is complicated with webpack.

[kamilogorek]

Sounds reasonable, however, it would be still somewhat useful to provide this information to the end user.
One way to do this would be to use peerDependenciesMeta and mark webpack as optional. WDYT?

[rchl]

Based on my past experience, I don't think that would work. The npm would still install the dependency as a production one. It would just not complain if it failed installing.

[AbhiPrasad]

Based on my past experience, I don't think that would work. The npm would still install the dependency as a production one. It would just not complain if it failed installing.

As per npm/rfcs#221 (comment), setting optional: true will make sure the peer dependency does not get automatically installed.

I am in favour of using peerDependenciesMeta with optional true here.

[rchl]

I'm all for trying and would be glad if it worked .

[kamilogorek]

Releasing as 1.18.6 (will be out once getsentry/publish#825 is approved)

[rchl]

As I expected, this didn't really help my case.

NPM now treats the webpack dependencies as devOptional rather than dev:

But all of those are still installed on installing only production dependencies (npm ci --production).

[rchl]

Note that webpack dependency exists in the project since it's a Nuxt project so it comes with webpack. I guess it wouldn't be a problem if webpack would not be present in the first place.