GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-08 11:11:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

indexFn -> createIndex, as per https://github.com/storybookjs/storybook/pull/24075

Browse Source
This commit is contained in:
Jeppe Reinhold 2023-09-08 10:23:03 +02:00 committed by Kyle Gach
parent a49d41b5c1
commit db17655fac
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/api/main-config-indexers.md
View File

@ -40,7 +40,7 @@ Type:
```ts ```ts
{ {
test: RegExp; test: RegExp;
indexFn: (fileName: string, options: IndexerOptions) => Promise<IndexInput[]>; createIndex: (fileName: string, options: IndexerOptions) => Promise<IndexInput[]>;
} }
``` ```
@ -54,7 +54,7 @@ Type: `RegExp`
A regular expression run against file names included in the [`stories`](./main-config-stories.md) configuration that should match all files to be handled by this indexer. A regular expression run against file names included in the [`stories`](./main-config-stories.md) configuration that should match all files to be handled by this indexer.
### `indexFn` ### `createIndex`
(Required) (Required)
@ -192,7 +192,7 @@ import type { StorybookConfig, Indexer } from '@storybook/your-framework';
const combosIndexer: Indexer = { const combosIndexer: Indexer = {
test: /\.stories\.[tj]sx?$/, test: /\.stories\.[tj]sx?$/,
indexFn: async (fileName, { makeTitle }) => { createIndex: async (fileName, { makeTitle }) => {
// 👇 Grab title from fileName // 👇 Grab title from fileName
const title = fileName.match(/\/(.*)\.stories/)[1]; const title = fileName.match(/\/(.*)\.stories/)[1];
@ -330,7 +330,7 @@ import path from 'path';
const jsonFixtureIndexer: Indexer = { const jsonFixtureIndexer: Indexer = {
test: /jsonstories\.[tj]sx?$/, test: /jsonstories\.[tj]sx?$/,
indexFn: async (fileName) => { createIndex: async (fileName) => {
// JSON files in the current directory // JSON files in the current directory
const jsonFiles = (await fs.readdir(path.dirname(fileName))) const jsonFiles = (await fs.readdir(path.dirname(fileName)))
.filter(f => f.endsWith('.json')) .filter(f => f.endsWith('.json'))
@ -402,7 +402,7 @@ import { parseCombos } from '../utils';
const combosIndexer: Indexer = { const combosIndexer: Indexer = {
test: /\.combos\.[tj]sx?$/, test: /\.combos\.[tj]sx?$/,
indexFn: async (fileName) => { createIndex: async (fileName) => {
const code = await fs.readFile(fileName); const code = await fs.readFile(fileName);
const combos = parseCombos(code); const combos = parseCombos(code);

4
docs/snippets/common/main-config-indexers.js.mdx
View File

@ -13,9 +13,9 @@ export default {
experimental_indexers: async (existingIndexers) => { experimental_indexers: async (existingIndexers) => {
const customIndexer = { const customIndexer = {
test: /\.custom-stories\.[tj]sx?$/, test: /\.custom-stories\.[tj]sx?$/,
indexFn: // See API and examples below... createIndex: // See API and examples below...
}; };
return [...existingIndexers, customIndexer]; return [...existingIndexers, customIndexer];
}, },
}; };
``` ```

4
docs/snippets/common/main-config-indexers.ts.mdx
View File

@ -15,11 +15,11 @@ const config: StorybookConfig = {
experimental_indexers: async (existingIndexers) => { experimental_indexers: async (existingIndexers) => {
const customIndexer = { const customIndexer = {
test: /\.custom-stories\.[tj]sx?$/, test: /\.custom-stories\.[tj]sx?$/,
indexFn: // See API and examples below... createIndex: // See API and examples below...
}; };
return [...existingIndexers, customIndexer]; return [...existingIndexers, customIndexer];
}, },
}; };
export default config export default config
``` ```