feat(nuxt): Add warning when Netlify build is discovered #13868
Conversation
| consoleSandbox(() => { | ||
| const serverDir = nitro.options.output.serverDir; | ||
|
|
||
| if (serverDir.includes('.netlify')) { |
There was a problem hiding this comment.
Maybe, just maybe, it's more robust to check for !!process.env.NETLIFY: https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
There was a problem hiding this comment.
That would only show the warning in the Netlify console, right? I think it's also useful to have this warning locally when people choose to use the netlify build preset. But I can add a || !!process.env.NETLIFY.
| if (serverDir.includes('.netlify')) { | ||
| // eslint-disable-next-line no-console | ||
| console.warn( | ||
| '[Sentry] Warning: The Sentry SDK discovered a Netlify build. The server-side Sentry support with ESM is experimental and may not work as expected. Please check out the docs for how to use Sentry on different deployment providers: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/', |
There was a problem hiding this comment.
idk, maybe:
| '[Sentry] Warning: The Sentry SDK discovered a Netlify build. The server-side Sentry support with ESM is experimental and may not work as expected. Please check out the docs for how to use Sentry on different deployment providers: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/', | |
| '[Sentry] Warning: The Sentry SDK detected a build running on Netlify. The Sentry Nuxt SDK support for ESM is currently experimental and requires additional setup. Please check out the docs for how to use Sentry on Netlify: https://docs.sentry.io/platforms/javascript/guides/nuxt/deployment-provider-setup/', |
There was a problem hiding this comment.
I think "with ESM" is more fitting because when you extend it, it would be "with ECMAScript Module syntax" and "for" sounds a bit off in this context. I did a quick search and I got more results with "with":
Edit: Okay, thinking about it "for" sound okay too when you look more at "support for" 😅
There was a problem hiding this comment.
I am no English major but I think you have support "for" something and not "with" something. It's less about the word "ESM".
There was a problem hiding this comment.
It's "for" :) You're right @lforst, it's "support for" you could say "with the support of..." but that's a different meaning.
There was a problem hiding this comment.
It would also be great if we could detect when users actually set up everything correctly for the respective platform and not show the warning in that case.
There was a problem hiding this comment.
Hmm...one thing we could do is getting the NODE_OPTIONS variable and check if the file path is correct.
Depending on this (because of the link in the warning): getsentry/sentry-docs#11486