Should I Source Control public/mockServiceWorker.js

[jrock2004]

So I am wondering if I should be putting public/mockServiceWorker.js in source control or should I gitignore it?

[kettanaito]

Hey, @jrock2004. That's a great question.

Our stance on whether you should commit the worker script to your VCS has changed over time. In the past, the worker script was generated only by using the npx msw init command. That's why we used to recommend committing the script so that everybody working on your project would be sure they're using the same worker implementation.

Now, I recommend setting up the msw.workerDirectory property in your "package.json":

{
  "msw": {
    "workerDirectory": "./public"
  }
}

With this property set, the worker script will automatically be generated whenever you install msw. This automatization allows you to treat the worker script as an artifact and omit it from the VCS.

[kettanaito]

Yeah, different package managers, and even versions of the same manager, will respect postinstall differently. I've had some cases during testing where Yarn, I believe, would ignore postinstall script completely for some reason. Glad you've figured it out.

[tmskrtsz]

Yes, that will absolutely be the issue. Our CLI only resolves the root-level package.json:

msw/cli/init.js

Line 54 in 7fb1a32

const packageJsonPath = path.resolve(CWD, 'package.json')

So, if you want this to work in a monorepo, make sure you describe this property in the root-level package.json (alongside the postinstall script).

Is it possible to define multiple "workerDirectory: {}" paths? In my monorepo, there are multiple projects that would need the script.

[kettanaito]

Hi, @tmskrtsz. It's not currently possible but we have a feature request submitted (#1607) and this is one of the things I'd like to add after 2.0 lands later this month. Stay tuned.

[tmskrtsz]

Appreciate the speedy answer!

[alexbjorlig]

Hi @kettanaito

We are using Storybook msw addon. The public directory is not part of version control.
When I try to deploy to Vercel, everything seems to work but I get this error when I open the Storybook: Did you forget to run "npx msw init <PUBLIC_DIR>"?

I tried with this in the install script, npx storybook build && npx msw init public but it does not help. Do you have any idea what I can try to get it up and running?