microsoft / microsoft/fluentui

[Bug]: react-storybook-addon-export-to-sandbox never finds its own registration on Windows

Offen Anfängerfreundlich
#36,653 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
20.3k
Forks
2.9k
Ø Merge
2 T. 9 Std.
Gemergte PRs (30 T.)
46

Beschreibung

Area

storybook

Environment
OS: Windows 11
node v22.12.0
@fluentui/react-storybook-addon-export-to-sandbox 0.3.1
Current Behavior

packages/react-components/react-storybook-addon-export-to-sandbox/src/webpack.ts locates its own
registration by matching the registered preset name against:

const addonFilePattern = /react-storybook-addon-export-to-sandbox\/[a-z/]+.[jt]s$/;

The pattern accepts forward slashes only. On Windows the registered preset name is an absolute
path with backslashes (e.g. …\react-storybook-addon-export-to-sandbox\temp\preset.ts), so the
pattern matches nothing. The addon options are then silently dropped, and the full-source babel
plugin crashes downstream on an undefined importMappings.

The failure is platform-specific and silent right up to the crash: on Linux CI nothing has ever been
wrong, which is why it has survived.

Expected Behavior

The addon finds its registration and receives its options on every platform the repo supports for
local development.

Reproduction

Run any Storybook in this repo that registers the addon, on Windows. The branch demonstrating both
the failure and the fix is available on request.

Steps to reproduce
  1. On Windows, yarn start a Storybook target that registers
    @fluentui/react-storybook-addon-export-to-sandbox.
  2. Observe the full-source babel plugin throwing on undefined importMappings.
  3. Instrument addonFilePattern — it matches nothing, because the preset name is backslash-separated.
Discovery context

Found while standing up a new Storybook target on a Windows checkout during work on a styling layer
over @fluentui/react-headless-components-preview. Nothing about the finding is specific to that
work — any contributor developing on Windows hits it the first time they run a Storybook that
registers this addon.

Proposed fix

Accept either separator:

const addonFilePattern = /react-storybook-addon-export-to-sandbox[\\/][a-z\\/]+.[jt]s$/;

One line, with a comment explaining why both separators are there so it is not "tidied" back.

A working implementation is included in PR #[WINDMOD-PR-NUMBER] (part of commit 510b8c5d21);
happy to split it into a standalone PR against this issue — it is genuinely independent of
everything else in that PR.

Suggested severity

Medium - Has workaround (develop on Linux/WSL, or disable the addon).

Products/sites affected

Local Storybook development on Windows.

Are you willing to submit a PR to fix?

yes

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne in packages/react-components/react-storybook-addon-export-to-sandbox/src/webpack.ts und untersuche addonFilePattern sowie, wie der Name des registrierten Presets abgeglichen wird. Führe ein Storybook-Ziel aus, das das Addon unter Windows registriert; fertig ist die Arbeit, wenn die Registrierung gefunden wird, die Optionen erhalten bleiben und der nachgelagerte Absturz durch undefined importMappings nicht mehr auftritt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
react, typescript
Bereich
build-system, tooling
Issue-Typ
Bug
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Aktiv
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
85/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.