Project Icon

storybook-genie

高效将 React 组件转换为 Storybook 故事的命令行工具

Storybook Genie 是一款命令行工具,可将包含 React 组件的文件转换为 Storybook 故事,用户可以选择 GPT 模型、设置自定义模板和更改默认路径。通过简单的配置和安装,只需在终端中运行命令,即可快速生成 '.story.js' 文件。工具依赖少,易于使用和集成。

项目介绍:Storybook Genie

概述

Storybook Genie 是一个命令行接口工具,专门用于将包含 React 组件的文件转换为 Storybook stories。这个工具可以大大简化开发者在 Storybook 中创建组件呈现的过程。

功能特色

  • 选择偏好的 GPT 模型:用户可以选择自己偏好的 GPT 模型进行使用。
  • 文件选择输入:支持文件选择,以便用户可以方便地选择要转换的组件文件。
  • JavaScript 美化:确保生成的代码格式优美、可读性高。
  • 使用自定义故事模板:用户可以通过自定义模板来创建符合自己需求的故事。
  • 更改默认路径:支持更改默认的组件搜索路径。
  • 较少的依赖项:减少安装和运行过程中的依赖,保证工具的轻量和高效。

安装方法

要安装 Storybook Genie 包,只需运行以下命令:

npm install storybook-genie

配置要求

在使用该工具之前,用户需要将 OpenAI 的 API 密钥设置为环境变量。在 Unix 系统上,可以通过以下方式设置:

export OPENAI_API_KEY=$YOUR_API_KEY

在 Windows 系统上,可以通过以下方式设置:

set OPENAI_API_KEY=$YOUR_API_KEY

使用方式

用户可以在项目的根目录创建 storybook-genie.config.json 文件,并添加如下代码,设置默认模型和路径:

{
  "defaultModel": "gpt-4",
  "defaultPath": "./components"
}

用户也可以在 storybook-genie.template.js/ts 文件中设置默认的故事模板。

要使用 Storybook Genie,只需运行以下命令:

npx storybook-genie

生成器将会在同一文件夹中创建一个 ".story.js" 文件。

快速上手

以下是快速开始使用 Storybook Genie 的步骤:

  1. 克隆仓库:

    git clone https://github.com/eduardconstantin/storybook-genie.git
    
  2. 安装依赖:

    npm install
    
  3. .env 文件中输入你的 OPENAI API 密钥。

  4. 运行 CLI:

    npm run start
    

系统会提示用户选择一个文件,按下回车后,生成器会在同一文件夹中创建一个 ".story.js" 文件。

贡献

欢迎开发者的反馈和贡献,以帮助提高代码质量和整体应用的效果。在提交问题或合并请求之前,请阅读我们的贡献指南。我们衷心感谢每一位参与者!

许可证

本项目采用 MIT 许可证 - 详细信息请查看 LICENSE 文件。

项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

吐司

探索Tensor.Art平台的独特AI模型,免费访问各种图像生成与AI训练工具,从Stable Diffusion等基础模型开始,轻松实现创新图像生成。体验前沿的AI技术,推动个人和企业的创新发展。

Project Cover

SubCat字幕猫

SubCat字幕猫APP是一款创新的视频播放器,它将改变您观看视频的方式!SubCat结合了先进的人工智能技术,为您提供即时视频字幕翻译,无论是本地视频还是网络流媒体,让您轻松享受各种语言的内容。

Project Cover

美间AI

美间AI创意设计平台,利用前沿AI技术,为设计师和营销人员提供一站式设计解决方案。从智能海报到3D效果图,再到文案生成,美间让创意设计更简单、更高效。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号