Generate Options

preset

default

undefined

Support Status

Specify the name of the framework.

WARNING

At this time, some special naming and writing is required for story generation. (This will be improved in future updates.)

Preset	Support Status
react	✅
vue	🚧
lit	✅
svelte	📝
angular	🚧
custom	📝

✅: Supported
🚧: Work in progress
❌: Not supported
📝: Not yet implemented

Example

autoStoryGenerator.vite({
  preset: "react",
})

imports

Specify the directory(s) where the component(s) for which you wish to generate a Story are located.

default

undefined

Example

autoStoryGenerator.vite({
  imports: ["src/components/**/*.tsx"],
})

ignores

The directories to ignore.

default

undefined

Example

autoStoryGenerator.vite({
  ignores: ["src/components/IgnoreComponent/IgnoredComponent.tsx"],
})

prettierConfigPath

prettier is executed when stories are generated and when stories are updated. You can have that set up.

default

undefined

Example

autoStoryGenerator.vite({
  prettierConfigPath: resolve(__dirname, "../.prettierrc"),
})

isGenerateStoriesFileAtBuild

Automatic generation for all component files only once at build time (run dev, run build)

default

false

Example

autoStoryGenerator.vite({
  isGenerateStoriesFileAtBuild: true,
})