Document how to get all Storybook Story IDs

[henrymoulton]

Is your feature request related to a problem? Please describe.

I'm looking into Visual Testing with React Native and want to be able to get all Storybook Story IDs from the Storybook.

From what I can understand there's a way of doing this on Web with extract: https://github.com/storybookjs/storybook/blob/master/lib/cli/src/extract.ts

However that requires building the storybook on web.

Describe the solution you'd like

Some documentation on how to best extract all Story IDs or perhaps more information about how to interact with Storybook Server.

https://github.com/oblador/loki edits Stories which enables Visual Testing, documentation to enable writing alternatives to Loki would be great!

Describe alternatives you've considered

I've also considered reading all the Story files and extracting the ids through using Regex to match on storiesOf and .add

Are you able to assist bring the feature to reality?

yes can do PRs, just need some discussion about what maintainers think is the best approach.

[dannyhw]

when you say you want story id's what specifically do you mean?

[henrymoulton]

Every story has a StoryID, I'd like to be able to access them.

[henrymoulton]

It looks like the Client API has the ability to do this

https://github.com/storybookjs/storybook/blob/v5.3.21/lib/client-api/src/story_store.test.ts#L137

[dannyhw]

so I was looking at the code and the id is created using the toId function in the csf package

var toId = function toId(kind, name) {
  return "".concat(sanitizeSafe(kind, 'kind'), "--").concat(sanitizeSafe(name, 'name'));
};

see: node_modules/@storybook/csf/dist/index.js

or the source on github
https://github.com/ComponentDriven/csf/blob/next/src/index.ts

As to how you would get the id's as a user, I will check that for you and respond soon.

[dannyhw]

The @storybook/csf package provide the toId function as an export so that can be used to get storyId's. Would that be acceptable? Or would it be better for storybook/react-native to re-export that function?