CLI: Fix detection of type: module when initializing storybook

[IanVS]

Issue: storybookjs/builder-vite#441

What I did

I found that the commonJs option being set by initiate through auto-detection of the package.json type: module since #16184 was not actually being used, therefore ESM projects were not being created with main.cjs, causing the error linked above.

Vite recently changed their bootstrap to create projects with "type": "module" in their package.json, which brought this to light.

How to test

• Is this testable with Jest or Chromatic screenshots?
• Does this need a new example in the kitchen sink apps?
• Does this need an update to the documentation?

The vite-based end-to-end tests should start to pass again.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 653a9ff. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 1 target

• nx run-many --target=prepare --all --parallel=2 --max-parallel=15 -- --optimized

---

Sent with 💌 from NxCloud.

[yannbf]

Awesome @IanVS! Thank you so much for this fix.

I wonder if the usage of the commonJs flag should cease to exist in Storybook 7.0.0 though. Once we merge future/base into next, which is planned this week, then I believe this would not be a problem anymore 🤔

[IanVS]

Sure that makes sense, but I think 7.0 is still a ways off and it would be great to get things working for new vite storybook projects in the meantime I think.

Another thing to consider is using .mjs in 7.0 if the config files are written in esm. I don't think esbuild-register requires it, but it would be more technically correct, I think. Or, we could keep detecting the type from the package.json, and set the extension correctly based on that.

[ahnpnl]

Can we also add an option to CLI to generate storybook with TypeScript config: main.ts, preview.ts? (separate PR 😃)

[IanVS]

@ahnpnl there are plans to do just that, for the next version of SB. :)