takuma-ru / auto-story-generator

Automatic real-time story file generation from React, Vue, and Lit component files

@takuma-ru/auto-story-generator

Description

Automatic real-time story file generation from React, Vue, Angular and Lit component files

Getting Started

1. Install the package

npm i @takuma-ru/auto-story-generator

2. Add config

Add settings to main.ts in Storybook (./storybook/main.ts)

For React, Vite

import type { StorybookConfig } from "@storybook/react-vite";

import { mergeConfig } from "vite";

import autoStoryGenerator from "@takuma-ru/auto-story-generator";

const config: StorybookConfig = {
  viteFinal: async (config) =>
    mergeConfig(config, {
      plugins: [
        autoStoryGenerator.vite({
          preset: "react",
          imports: ["src/components/**/*.tsx"],
        }),
      ],
    }),
};

export default config;

Supported Frameworks

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

Framework	Supported
React	✅
Vue	🚧
Lit	✅
Angular	🚧
Svelte	📝
Custom	📝