takuma-ru / auto-story-generator Goto Github PK

View Code? Open in Web Editor NEW

34.0 1.0 2.0 1.12 MB

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

Home Page: https://auto-story-generator.takumaru.dev

License: ISC License

JavaScript 9.24% TypeScript 90.76%

auto generator lit react storybook storybook-addon vue

auto-story-generator's Introduction

@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	📝

auto-story-generator's People

Contributors

Stargazers

Watchers

Forkers

boxpistols geetakrishna65

auto-story-generator's Issues

🛠️ Prop検知パターン追加

Is your feature request related to a problem? Please describe

Describe the solution you'd like

#5 (comment)

Describe alternatives you've considered

Additional context

:bug: `isGenerateStoriesFileAtBuild` does not work correctly on windows

Describe the bug

isGenerateStoriesFileAtBuild does not work correctly on windows

To Reproduce

No response

Terminal Info

OS:
Browser:
Version:
Library version:

Additional context

No response

:bug: GitHub Release CI修正

Describe the bug

get-package-info の修正

To Reproduce

get-package-info から情報を取得できる

Terminal Info

OS:
Browser:
Version:
Library version:

Additional context

No response

🛠️ Transfers processing of getAllFilePaths to glob

Describe the improve feature

Transfers processing of getAllFilePaths to glob

Additional context

No response

🛠️ If a component is implemented with export default, output the import portion appropriately

Describe the improve feature

If a component is implemented with export default, output the import portion appropriately

Additional context

No response

📝 Reactに関するドキュメントページの更新

Issue Type.

Add
Update
Fixes

Please describe your request in detail.

以前よりも多くの記法に対応したため、その説明を書く

Other Background

:sparkles: Generate story files for all component files at storybook startup

Describe the NEW feature

Add an option to generate story files for all component files at storybook startup.
This feature will be done after #45 is implemented.

Additional context

No response

:sparkles: Next用デモの作成

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context

:bug: File generation with file names like `.ce.ts` fails

Describe the bug

File generation with file names like .ce.ts fails

To Reproduce

No response

Terminal Info

OS:
Browser:
Version:
Library version: 0.2.3

Additional context

No response

:bug: Sometimes paths are taken as backslash in Windows

Describe the bug (required)

Some path operations fail because process.cwd() is taken as a backslash path.

To Reproduce (required)

Run in Wondows11

Expected behavior (required)

Pass operation succeeds

Screenshots

Terminal Info (please complete the following information):

OS: Winsows11
Browser:
Browser version:
Library version:

Additional context

🛠️ Update release flow

Describe the improve feature

🛠️ Update release flow

Additional context

No response

:sparkles: Support Vue

Describe the NEW feature

vue.js support

Additional context

No response

🛠️ Common processing when errors occur

Describe the improve feature

Instead of using consola. to display errors, use commonized functions and constants to manage error content

Additional context

No response

:sparkles: Support Angular

Describe the NEW feature

Make Angular support based on #15

(I want to put GeetaKrishna65 in the contributor's name and would like to ask GeetaKrishna65 to do some of the implementation.)

Additional context

No response

✨ Story生成時にフォーマットさせる

:bug: globs do not load properly

Describe the bug

globs do not load properly

To Reproduce

file:///........./node_modules/.pnpm/@[email protected]/node_modules/@takuma-ru/auto-story-generator/dist/index.js:24
import glob2 from "glob";
       ^^^^^
SyntaxError: The requested module 'glob' does not provide an export named 'default'

Terminal Info

OS:
Browser:
Version:
Library version: 0.3.0

Additional context

No response

🛠️ When a Prop does not exist, generate a story file with no Prop instead of an error

Describe the improve feature

When a Prop does not exist, generate a story file with no Prop instead of an error

Additional context

No response

:sparkles: Multiple asynchronous processing of file generation using Worker

Describe the NEW feature

Multiple asynchronous processing of file generation using Worker

Mounting Method

RxJS

Additional context

No response

:bug: Error when specifying a path that does not exist in imports

Describe the bug

Error when specifying a path that does not exist in imports

To Reproduce

asg.webpack({
  preset: "react",
  imports: ["src/components/**/*.tsx", "src/XXXX/**/*.tsx" /* <- non-existent path */],
})

Terminal Info

OS:
Browser:
Version:
Library version:

Additional context

No response

:sparkles: Automated release note creationaction creation

Is your feature request related to a problem? Please describe

Automated release note creationaction creation

Describe the solution you'd like

Describe alternatives you've considered

Additional context

:bug: When creating union props, there are no double quotes in the value set to args

Describe the bug

When creating union props, there are no double quotes in the value set to args.

To Reproduce

No response

Terminal Info

OS:
Browser:
Version:
Library version:

Additional context

No response

🛠️ Update release flow

Describe the improve feature

Update publish-package.yml

Additional context

No response

♻️ Review file structure

Describe the improve feature

Review the structure of files and functions due to the increased complexity of the processing flow

Additional context

No response

:sparkles: Logo addition

Describe the NEW feature

Logo addition

Additional context

No response

:bug: Failure release action

Describe the bug

Failure release action

To Reproduce

No response

Terminal Info

OS:
Browser:
Version:
Library version:

Additional context

No response

:sparkles: Creation of PR Templates

Is your feature request related to a problem? Please describe

Creation of PR Templates

Describe the solution you'd like

Describe alternatives you've considered

Additional context

📝 FAQページの追加

Issue Type.

Add
Update
Fixes

Please describe your request in detail.

よくある質問を書く

Other Background

🛠️ Add ignores option

Describe the improve feature

Option.ignores: string[]

Additional context

No response

:bug: When the AST fails, the process drops out

Describe the bug

When the AST fails, the process drops out.

To Reproduce

No response

Terminal Info

OS:
Browser:
Version:
Library version:

Additional context

No response

🛠️ Adding search functionality to documents

Describe the improve feature

Adding search functionality to documents
https://vitepress.dev/reference/default-theme-search#local-search

Additional context

No response

:bug: If `arg` or `argType` does not exist in the Stories file, an error occurs and the procedure is terminated.

Describe the bug

If arg or argType does not exist in the Stories file, an error occurs and the procedure is terminated.

To Reproduce

No response

Terminal Info

OS:
Browser:
Version:
Library version:

Additional context

No response

:sparkles: Implement your own release process

Describe the NEW feature

I can't fix the release-it behavior.
Implement your own release process

Additional context

No response

:sparkles: Building a development runtime environment.

Describe the NEW feature

Building a development runtime environment.

Additional context

No response

:sparkles: Update Issue Templates

Is your feature request related to a problem? Please describe

Update Issue Templates

Describe the solution you'd like

Describe alternatives you've considered

Additional context

♻️ Unification of variable names

Describe the improve feature

Unification of variable names.

Additional context

No response

:bug: File changes are not detected under Webpack environment

Describe the bug (required)

File changes are not detected under Webpack environment

To Reproduce (required)

demo/next/

Expected behavior (required)

Component change detection in the webpack environment as well as in the vite environment.