fail fast/eslint plugin that checks for window

[kentcdodds]

Summary

I wish I could say I never make this mistake, but I make it pretty often. The error message I get when building is:

error Building static HTML failed for path "/workshops/asynchronous-java-script"
See our docs page on debugging HTML builds for help https://gatsby.app/debug-html
  11 |   const {event, discount} = props
  12 |   const [titoWidgetReady, setWidgetReady] = React.useState(
> 13 |     window.hasOwnProperty('TitoWidget'),
     |     ^
  14 |   )
  15 |
  16 |   React.useEffect(() => {

  WebpackError: ReferenceError: window is not defined

The problem is I'm referencing window in the render method. This works fine in dev, but it doesn't work when running gatsby build.

Motivation

I know that it's my problem. But it'd be cool if gatsby develop would give me a warning if it detected something that wont work for the build. There could be other situations, but I know that at least referencing browser-only globals in the render method doesn't work during the build but works during develop and I don't realize something's wrong until it breaks in CI.

So I'd really appreciate some sort of gatsby eslint plugin (like suggested in #7687) or (even better) an error in develop for anything that would fail in build.

[DSchau]

@kentcdodds this would be super slick, and agreed, I've seen people suffer through a broken build while they iron out usages of globals in SSR environment.

Giving actionable feedback prior to failing in build is key here. I've never written an eslint plugin, but this certainly seems like something that could be doable--so we'll take a look and prioritize appropriately!

Thanks for the idea!

[sidharthachatterjee]

Watching jsx-eslint/eslint-plugin-react#2057 closely

[gatsbot]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

Thanks for being a part of the Gatsby community! 💪💜

[gatsbot]

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks again for being part of the Gatsby community!

[LekoArts]

We have solved this with SSR in Development now: #28138