Structify

🚀 Struct <p align=" align="center"> <img src="https://caps.vercel.app/api?type=waving0:0F40:256100:60A&height=220&header&text=StructTool&font&fontColor=animation=fadeIn&Y=38&desc=One%20CLI.%20Endless%20Possibilities.&descAlignY=60&=22"/> </div <a href=".com/Ashish/Structify"> ="https://readme-svg.demol?font=Fira+=600&sizeduration=300=1000&colorB82F6&&vCenter=true&900&lines=Project+Scaffolding++Production-ReadyInteractive+CLI+%7C+Enterprise+Architecture;Validation+%7C+Rollback+Safety+%7C+Ready" alt="Typing /> </a> > <p align="交互式 CLI、 企业级架构、验证、回滚安全性和 AI 就绪工具生成生产就绪的应用程序。 </p> <div align="center"> <table width="100%"> <tr> <td align="center" width="25%">⚡<br><b>交互式 CLI</b><br>_{引导式设置，零配置头疼}</td> <td align="center" width="25%">🏗️<br><b>企业架构</b><br>_{经过战斗测试的项目结构}</td> <td align="center" width="25%">🛡️<br><b>验证和回滚</b><br>_{默认安全，随时撤销}</td> <td align="center" width="25%">🤖<br><b>AI 就绪</b><br>_{为 AI 辅助开发做好结构准备}</td> </tr> </table> </div> <br> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Blue%20book/3D/blue_book_3d.png" width="34" align="center"> 概述 </h2> # ✨ 什么是 Structify 工具？ **Structify 工具** 是一个专业、开源的项目脚手架平台和命令行界面（CLI），它自动创建生产就绪的软件架构。 与其手动创建文件夹、安装包、配置 TypeScript、ESLint、Prettier、数据库、ORM、Docker、CI/CD 管道和项目结构，不如让 Structify 工具通过现代交互式 CLI 生成所有内容。 目标很简单： > **花更少的时间配置项目，花更多的时间构建软件。** Structify 工具强调： - ⚡ 快速的项目初始化 - 🏗️ 生产就绪的架构 - 🔒 确定性和安全的生成 - 🔍 内置验证和诊断 - 🤖 AI 就绪工具 - 📦 模块化和可扩展的设计 **Structify** 是一个企业级、开源的项目脚手架平台，通过智能、交互式的命令行界面（CLI）为开发者提供生成**生产就绪的应用程序架构**的能力。 与其花费数小时配置项目结构、TypeScript、包管理器、代码检查工具、格式化工具、数据库、ORM、Docker、CI/CD 管道、测试框架和样板文件，Structify 自动化了整个设置过程，同时遵循现代工程最佳实践。 Structify 建立在模块化生成引擎周围，结合了**交互式项目创建**、**企业模板**、**蓝图驱动架构**、**智能验证**、**回滚保护**和**AI 就绪工作流**，形成了一个统一的开发者体验。每个生成的项目都是确定性的、可复制的、可配置的，并旨在从个人应用程序扩展到企业级系统。 无论您是构建 **前端应用程序**、**REST API**、**全栈平台**、**微服务**、**CLI 工具**还是 **AI 驱动的应用程序**，Structify 都提供了一个一致的、可维护的和生产就绪的基础——让您可以专注于构建功能，而不是配置基础设施。 </td> </tr> </table> # 🎯 为什么选择 Structify 工具？ 每个新项目通常都需要开发者： - 创建文件夹结构 - 安装数十个依赖项 - 配置 TypeScript - 设置 ESLint 和 Prettier - 配置数据库 - 设置 ORM - 创建 Docker 文件 - 配置 CI/CD - 组织可扩展的架构 - 编写样板代码 Structify 工具通过在几秒钟内生成一个完整的生产就绪基础，消除了这些重复性任务。 <br/> <table align="center"> <tr> <td align="center"> <a href="https://www.npmjs.com/package/structify-tool"> <img src="https://skillicons.dev/icons?i=npm" height="56" alt="NPM"/> </a> </td> <td align="center"> <a href="https://github.com/Ashish6298/Structify"> <img src="https://skillicons.dev/icons?i=github" height="56" alt="GitHub"/> </a> </td> <td align="center"> <img src="https://skillicons.dev/icons?i=nodejs" height="56" alt="Node.js"/> </td> <td align="center"> <img src="https://skillicons.dev/icons?i=windows" height="56" alt="Windows"/> </td> <td align="center"> <img src="https://skillicons.dev/icons?i=linux" height="56" alt="Linux"/> </td> <td align="center"> <img src="https://skillicons.dev/icons?i=apple" height="56" alt="macOS"/> </td> </tr> </table> <table align="center"> <tr> <td align="center" width="160"> <img width="42" src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Package/3D/package_3d.png"/> <b>最新版本</b> <img src="https://img.shields.io/npm/v/structify-tool?style=flat-square&logo=npm&logoColor=white"/> </td> <td align="center" width="160"> <img width="42" src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Star/3D/star_3d.png"/> <b>GitHub 星星</b> <img src="https://img.shields.io/github/stars/Ashish6298/Structify?style=flat-square"/> </td> <td align="center" width="160"> <img width="42" src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Shield/3D/shield_3d.png"/> <b>MIT 许可证</b> <img src="https://img.shields.io/github/license/Ashish6298/Structify?style=flat-square"/> </td> <td align="center" width="160"> <img width="42" src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Gear/3D/gear_3d.png"/> <b>Node.js</b> <img src="https://img.shields.io/badge/18%2B-Supported-339933?style=flat-square&logo=node.js&logoColor=white"/> </td> </tr> </table> </br> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Blue%20book/3D/blue_book_3d.png" width="34"> 什么是 Structify？ </h2> **Structify** 是一个企业级、开源的**项目脚手架平台**和**开发者生产力 CLI**，旨在通过消除重复的项目设置，帮助开发者更快地构建现代应用程序。 与其手动创建文件夹结构、安装依赖项、配置 TypeScript、ESLint、Prettier、Docker、数据库、ORM、测试框架、CI/CD 管道和无数样板文件，Structify 通过单个智能命令自动化了整个初始化过程。 Structify 由模块化生成引擎驱动，结合了**交互式项目创建**、**企业就绪模板**、**蓝图驱动架构**、**智能验证**、**回滚保护**和**AI 就绪工作流**，以生成可扩展、维护和一致的项目基础。 无论您是构建 **前端应用程序**、**后端 API**、**全栈平台**、**微服务**、**CLI 实用程序**还是 **AI 驱动的解决方案**，Structify 都提供了一个可靠的起点——让开发者花更少的时间配置基础设施，花更多的时间构建优秀的软件。 <br/> | 🚀 关键亮点 | | :------------------------------------------------------------ | | ⚡ 数秒内生成生产就绪的项目 | | 🏗️ 企业级项目架构 | | 🛡️ 具有自动回滚保护的确定性执行 | | 📋 具有智能验证的交互式 CLI | | 🧩 模块化、可扩展和蓝图驱动的架构 | | 🤖 内置 AI 和模型上下文协议（MCP）支持 | | 🌍 Windows、Linux 和 macOS 的跨平台支持 | </td> </tr> </table> <br> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Warning/3D/warning_3d.png" width="34"> 问题 </h2> 每个新项目都应该从构建优秀的软件开始——而不是花费数小时重复相同的设置任务。 然而，开发者经常在编写第一行业务逻辑之前花费宝贵的时间手动配置开发环境。从创建目录结构到配置工具，初始设置过程是重复的、容易出错的，并且在项目和团队之间不一致。 <br/> | ❌ 传统项目设置 | | :-------------------------------------------------------- | | 📁 手动创建项目文件夹和架构 | | 📦 安装和管理依赖项 | | ⚙️ 配置 TypeScript、ESLint 和 Prettier | | 🐳 创建 Docker 和容器配置 | | 🗄️ 设置数据库、ORM 和环境变量 | | 🧪 配置测试框架和代码质量工具 | | 🚀 创建 CI/CD 管道和 GitHub Actions | | 📄 编写重复的样板文件和配置 | | 🔧 在多个项目中保持一致性 | <br/> 大多数现有的脚手架工具仅生成基本模板或关注单个框架。开发者仍然需要手动配置身份验证、数据库、Docker、测试、代码检查、格式化、CI/CD、项目架构和其他生产必需品。 结果是 **重复工作数小时、项目结构不一致、配置漂移和开发周期变慢**，在有意义的功能开发甚至开始之前。 </td> </tr> </table> <br> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Light%20bulb/3D/light_bulb_3d.png" width="34"> 解决方案 </h2> Structify 将项目初始化从重复、耗时的过程转变为快速、智能和全自动的开发者体验。 与其手动拼凑文件夹、依赖项、配置文件、开发工具和基础设施，Structify 使用经过验证的架构模式和行业最佳实践，通过单个交互式命令生成**生产就绪的基础**。 每个项目都通过确定性执行引擎生成，该引擎在进行更改之前验证每个操作，确保可靠、可复制和企业级的成果，而不牺牲灵活性或开发者控制权。 <br/> | 🚀 Structify 有何不同 | | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 🔍 **透明** — 通过确定性执行计划预览每个操作，然后再生成任何文件。 | | 🎯 **可预测** — 执行干燥运行并获得可复制的结果，使每个生成过程可靠且一致。 | | 🛡️ **回滚安全** — 事务性文件操作在生成过程中出现错误时自动还原项目。 | | 🏗️ **框架无关** — 使用统一的生成引擎跨多个框架、架构和技术栈生成项目。 | | 🧩 **可扩展** — 围绕模块化生成器、模板、蓝图、插件和注册表构建，以实现最大灵活性。 | | 🤖 **AI 就绪** — 包括内置的 **模型上下文协议（MCP）** 服务器，使 AI 助手能够智能地理解和生成项目<br/> 无论您个人项目、构建企业应用程序还是为团队创建可重用的项目模板，Structify 都提供了一个**一致**、**可、**可和**生产就绪**的基础——这样您就可以花更少的时间配置更多的时间交付</td> </tr> </table> <br> <table align="center"100%"> <tr> <h2> ="https://raw/microsoft/fluent/main/assets/S3D/s3d.png" width="34"> </h2> Structify 不仅仅是一个项目生成器——它是一个完整的**开发者生产力，将项目、架构规划和 AI 辅助线化为一个体验。 <br width="100%"> <td width="50%" valign="top"> 🚀 项目生成 生成引擎几秒钟内构建生产就项目。 - 就绪的项目架 - 交互式和的生成 - 预设和基于蓝图的架构 确定性执行计划 - 👀 干燥运行预览模式 - 🛡️ 自动回滚保护 - ✅ 智能项目验证 </td> <td width="50%" valign="top"> ### 🔍 项目健康 在整个生命周期中保持每个项目健康。 - 🔎 项目验证 - 🩺 内置医生- 🛠️建议 - 检查 -漂移检测 - ⬆️ </td> </tr> <tr width="50="top"> ###️ 企业平台 团队和可扩展架构而设计。 - 🧱 企业模板引擎 - 📦 蓝图架构 - 🔄 变量解析引擎 - 🏢 工作区生成 - 🧩器 - 🗂️ 注册表架构 - 📑和合并引擎 📊 诊断框架td> <td width="50%" valign="### 💻 开发者体验 旨在最大提高开发者生产力 📦 npm流 - 🟦 TypeScript-first 架构 - 📄 机器可读的 - ⚙️ CI/CD 友好命令 🌍 Windows、Linux 和 macOS 支持 - 🚀 确定性的执行 </td> </tr> <tr> <td colspan="### 🤖 AI Structify 适用于下一代 AI 开发。 - 内置 **模型上下文协议（MCP）** 服务器 - 🧠 AI 兼容的项目检查 - 📋 AI 辅助生成规划 - 🔍 AI 驱动的诊断 - 上下文流 - 🔗 与 AI 编码助手原生集成 </td> </tr> </table> <br/> ### 🌟 亮点 | 功能 | 已 :------------------------------: | 🚀 生产就绪的脚手架 | ✅ | | 🛡️ 回滚保护 | ✅ | | 📋 交互式 CLI | ✅ | | 🧩 蓝图架构 | ✅ | | 🏗️ 企业模板 | ✅ | | 🔍 项目 ✅ | | 🤖 内置 MCP 服务器 | ✅ | | 🌍 跨平台支持 | ✅ | | ⚡ 干燥运行执行 | ✅ | | 📦 模块化插件系统 | ✅ | </td> </tr> </table> <br> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/File%20folder/3D/filed.png"34"> 项目结构 </h2> 遵循一个模块化的**单架构**，旨在实现可扩展性性和可扩展性工作区都有责任，允许添加新的生成器、模板、插件和开发者工具而不会影响核心平台。 <br/> ```text Structify │ ├── apps/ │ ├── cli/ # 交互式命令行界面 │ └── mcp-server/ # 模型上下文协议CP）服务器 ├── packages/ │ ├── core/ 生成引擎、计划器、验证器和│ └── # 共享程序 │ ├── docs/ 、规范和指南 │ └── scripts/ # 构建、发布和自动化脚本 ``` <br/> ### 📂 工作区概览 | 目录 | 用途 | | :-------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------- | | **`apps/cli`** | 交互式命令行工具，负责项目生成、验证、检查和诊断。 | | **`apps/mcp-server`** | 通过 **模型上下文协议（MCP）** 提供 AI 集成，实现智能项目理解和自动化。 | | **`packages/core`** | 包含 Structify 的核心生成引擎、模板系统、规划引擎、蓝图架构、验证管道和回滚机制。 | | **`packages/logger`** | 跨整个平台一致使用的共享日志工具。 | | **`docs`** | 存放架构文档、命令行指南、规格说明书、路线图和技术参考。 | | **`scripts`** | 用于开发、测试、打包、发布和维护任务的自动化脚本。 | <br/> 模块化工作区架构确保每个组件保持 **独立**、**可重用** 和 **易于扩展**，使 Structify 适用于个人开发者和企业级团队。 <br> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Package/3D/package_3d.png" width="34"> 安装和快速开始 </h2> 使用 Structify 仅需几秒钟。全局安装它以在系统任何地方使用命令行工具，或使用 **npx** 无需安装即可运行。 ### 📦 全局安装 ## 🚀 极简努力，卓越成果 ### ⚡ 无需安装即可运行 ## 🔒 确定且安全 ### 🚀 创建您的第一个项目 使用交互式命令行工具生成全新、生产就绪的项目。 ## 🧩 模块化架构 每个生成引擎都是隔离的，使未来框架和生成器易于添加。 ## 🤖 AI 就绪 <br/> ### 🛠 常用命令行命令 | 命令 | 描述 | | :----------------------------------- | :--------------------------------------------------- | | `structify init my-project` | 使用交互式生成器创建新项目 | | `structify generate my-project` | 从模板和蓝图生成项目 | | `structify verify-project` | 验证项目结构和配置 | | `structify doctor` | 运行诊断并识别潜在问题 | | `structify inspect` | 检查项目架构和元数据 | | `structify repair --dry-run` | 预览自动修复而不修改文件 | <br/> ### 💡 典型工作流程 ```text 安装 Structify │ ▼ 创建新项目 │ ▼ 交互式配置 │ ▼ 生成项目结构 │ ▼ 验证和检查 │ ▼ 开始构建 🚀 ``` <br/> Structify 自动处理项目脚手架、依赖管理、配置生成、验证和项目初始化，允许您在 **几分钟内从想法变为开发状态**。 </td> </tr> </table> <br> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Building%20construction/3D/building_construction_3d.png" width="34"> 设计原则 </h2> Structify 围绕一组核心工程原则构建，优先考虑 **开发者生产力**、**软件质量**、**可预测性** 和 **长期可维护性**。每个功能和架构决策都遵循这些基础价值观。 <br/> <table width="100%"> <tr> <td width="33%" valign="top"> ### ⚡ 极简努力，最大化生产力 花更少的时间配置项目，花更多的时间构建功能。 Structify 自动化重复设置任务，并在几秒钟内生成生产就绪的基础设施，使开发者能够以极简的努力从想法变为实现。 </td> <td width="33%" valign="top"> ### 🛡️ 确定且可靠 每个操作都应该是透明、可预测和安全的。 Structify 在执行前验证每个步骤，支持 dry-run 规划，并通过事务操作保护工作区，自动回滚。 </td> <td width="33%" valign="top"> ### 🧩 有观点，但可扩展 强有力的默认设置，但不限制灵活性。 企业级模板、蓝图、插件和模块化生成器提供优秀的开箱体验，同时保持完全可定制以适应不同的工作流程和技术栈。 </td> </tr> </table> ### 🌟 核心哲学 | 原则 | 承诺 | | :---------------- | :----------------------------------------------------------------------------------------------- | | ⚡ 生产力优先 | 消除重复的项目设置和样板代码。 | | 🛡️ 可靠性 | 确定性执行，带有验证和回滚保护。 | | 🏗️ 可扩展性 | 设计用于适应从个人应用到企业平台的项目。 | | 🧩 可扩展性 | 模块化架构，带有模板、蓝图和插件。 | | 🤖 AI 就绪 | 构建时支持通过 MCP 进行 AI 辅助开发。 | | 🌍 一致性 | 在每个环境中生成可预测、可维护和生产就绪的项目结构。 | </td> </tr> </table> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Blue%20book/3D/blue_book_3d.png" width="34"> 文档 </h2> Structify 包含全面的文档，涵盖平台的每个方面——从架构和项目生成到命令行工具使用、验证、AI 集成和未来路线图规划。无论您是首次用户、贡献者还是企业团队，文档都旨在帮助您快速提高生产力。 <table width="100%"> <tr> <td width="50%" valign="top"> ### 📚 快速入门 - 🚀 安装指南 - 💻 命令行工具指南 - ⚡ 快速开始 - 📖 命令行工具命令 - 🔧 配置参考 </td> <td width="50%" valign="top"> ### 🏗️ 架构 - 🧱 架构指南 - 📦 项目结构 - 🗂️ 项目图 - 🌐 虚拟文件图 - 🔌 包管理器适配器 </td> </tr> <tr> <td width="50%" valign="top"> ### 🛠️ 开发者资源 - 📋 清单规范 - 🧩 蓝图系统 - ⚙️ 模板引擎 - 📑 规划引擎 - 🤖 MCP 集成 </td> <td width="50%" valign="top"> ### 📈 报告和路线图 - ✅ 验证报告 - 🔍 诊断 - 🗺️ 项目路线图 - 🚀 即将推出的功能 - 🤝 贡献指南 </td> </tr> </table> **💡 提示：** 所有文档均位于 **`docs/`** 目录中，并随着 Structify 的每个新版本不断更新。 </td> </tr> </table> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Handshake/3D/handshake_3d.png" width="34"> 贡献 </h2> Structify 是一个开放源代码项目，旨在为开发者服务，由开发者创建。无论您是修复错误、改进文档、提出新功能、优化性能还是贡献新模板和蓝图，每一份贡献都帮助使 Structify 对整个社区更好。 我们欢迎 **错误报告**、**功能请求**、**文档改进**、**代码贡献** 和 **架构讨论**。在打开拉取请求之前，请查看贡献指南并确保您的更改符合项目的编码标准和设计原则。 ### 🚀 贡献方式 - 🐞 报告错误和意外行为 - 💡 建议新功能和增强功能 - 📖 改进文档和示例 - 🛠️ 提交错误修复和性能改进 - 🧩 创建模板、蓝图和插件 - 🤝 审查拉取请求并帮助其他贡献者 > **每一次贡献——无论大小——都帮助 Structify 变得更好，造福全球的开发者。 ❤️** </td> </tr> </table> <br/> <table align="center" width="100%"> <tr> <td> <h2> <img src="https://raw.githubusercontent.com/microsoft/fluentui-emoji/main/assets/Scroll/3D/scroll_3d.png" width="34"> 许可证 </h2> Structify 在 **MIT 许可证** 下发布，给予您自由使用、修改、分发和基于该项目进行构建的权利，无论是用于个人还是商业目的，同时保留原始许可证。 有关完整的许可证信息，请参阅此仓库中包含的 **LICENSE** 文件。 </td> </tr> </table> <br/> <div align="left"> ## 💙 为开发者而建 > _"伟大的软件始于伟大的基础。"_ Structify 旨在消除重复的项目设置，自动化现代开发工作流程，并帮助开发者花费 **更少的时间配置项目**，而花费 **更多的时间构建卓越的软件**。 ### ⭐ 如果 Structify 对您有帮助，请考虑支持该项目！ 给仓库一个 ⭐，与 fellow 开发者分享，或贡献使 Structify 变得更好。 <br/> <img src="https://capsule-render.vercel.app/api?type=waving&color=0:2563EB,50:3B82F6,100:60A5FA&height=120&section=footer&animation=fadeIn"/> </div>