storybookjs/storybook

[Bug]: experimental_indexers ignores importPath

Open

#25554 opened on Jan 10, 2024

View on GitHub
 (15 comments) (0 reactions) (1 assignee)TypeScript (89,909 stars) (10,058 forks)batch import
buggood first issuehelp wantedsev:S3story index

Description

Describe the bug

In the experimental indexer docs it says that an indexer can specify an importPath to a target CSF file, but doing so has no effect. Looking at the source code it looks like the importPath returned from an indexer is not used and instead the input source to the indexer will always be used as the importPath.

To Reproduce

https://github.com/storybookjs/storybook/blob/e942e71e1f5281f9197faab6d61625b0ac8cecfd/code/lib/core-server/src/utils/StoryIndexGenerator.ts#L302

System

Storybook Environment Info:

  System:
    OS: macOS 14.2.1
    CPU: (10) arm64 Apple M1 Pro
    Shell: 5.1.16 - /opt/homebrew/bin/bash
  Binaries:
    Node: 20.10.0 - ~/.nvm/versions/node/v20.10.0/bin/node
    Yarn: 4.0.2 - ~/.nvm/versions/node/v20.10.0/bin/yarn <----- active
    npm: 10.2.3 - ~/.nvm/versions/node/v20.10.0/bin/npm
  Browsers:
    Chrome: 120.0.6099.109
    Edge: 120.0.2210.121
    Safari: 17.2.1

Additional context

No response

Contributor guide

Tech stack
typescriptnodejs
Domain
backendtooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicsUnderstanding of Storybook's indexer concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The bug is that experimental indexers ignore the importPath specified in the indexer configuration, and instead always use the input source as the importPath. The relevant code is in StoryIndexGenerator.ts around line 302. To fix this, examine how the indexer's returned importPath is handled and ensure it is used instead of the input source. Check the indexer documentation and the type definitions for experimental indexers to understand the expected behavior. Look at the function that processes indexers and verify where the importPath from the result is applied. The fix likely involves updating the logic to use the returned importPath when present.