histoire-dev / histoire-dev/histoire

When using storyMatch in histoire.config, Sibling markdown are not imported

Open
#680 0 comments 0 reactions 0 assignees View on GitHub
to triage
Dominant language
TypeScript
Stars
3.6k
Forks
212
PR merge metrics
No merged PRs in 30d

Description

### Describe the bug

When using storyMatch in histoire.config, Sibling markdown are not imported

### Reproduction

1. add directories to the histoire.config storyMatch like
` storyMatch: [
'**/*.story.vue',
'../../packages/src/**/*.story.vue'],`
2. have a story and a sibling markdown file
3. run story:dev
4. sibling markdowns will not be rendered.

### System Info

```shell
System:
OS: macOS 13.5.2
CPU: (10) arm64 Apple M1 Pro
Memory: 98.75 MB / 32.00 GB
Shell: 5.9 - /bin/zsh
Binaries:
Node: 20.11.0 - ~/.nvm/versions/node/v20.11.0/bin/node
npm: 8.19.4 - ~/development/shop-frontends/node_modules/.bin/npm
Browsers:
Brave Browser: 112.1.50.121
Chrome: 121.0.6167.160
Firefox: 121.0
Safari: 16.6
npmPackages:
@histoire/plugin-nuxt: 0.17.10 => 0.17.10
@histoire/plugin-vue: 0.17.9 => 0.17.9
@vitejs/plugin-vue: 4.4.0 => 4.4.0
histoire: 0.17.9 => 0.17.9
vite: 4.4.9 => 4.4.9
```

### Used Package Manager

npm

### Validations

- [X] Follow our [Code of Conduct](https://github.com/histoire-dev/histoire/blob/main/CODE_OF_CONDUCT.md)
- [X] Read the [Contributing Guidelines](https://github.com/histoire-dev/histoire/blob/main/CONTRIBUTING.md).
- [X] Read the [docs](https://histoire.dev/guide/).
- [X] Check that there isn't [already an issue](https://github.com/histoire-dev/histoire/issues) that reports the same bug to avoid creating a duplicate.
- [X] Check that this is a concrete bug. For Q&A open a [GitHub Discussion](https://github.com/histoire-dev/histoire/discussions).
- [X] The provided reproduction is a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the issue with the shown histoire.config storyMatch entries and story:dev command. Trace how matching stories discovers sibling Markdown files, then verify that those files are rendered alongside the stories when the fix is complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vite
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.