electron-egg

何时使用此 skill

在用户希望执行以下操作时使用此 skill：

• 在项目中安装并设置 Electron EGG
• 创建 Electron 桌面应用程序
• 使用 Electron EGG 核心功能
• 配置 Electron EGG
• 处理主进程与渲染进程之间的通信
• 使用 Electron EGG API 方法
• 构建和打包 Electron 应用程序
• 排查 Electron EGG 问题

如何使用此 skill

此 skill 的组织结构与 Electron EGG 官方文档一致（https://www.kaka996.com/、https://www.kaka996.com/pages/987b1c/、https://www.kaka996.com/pages/a99b72/）。使用 Electron EGG 时：

1. 确定主题，根据用户的请求选择：

   • 安装/安装 → examples/guide/installation.md
   • 快速开始/快速开始 → examples/guide/quick-start.md
   • 功能特性/功能特性 → examples/features/
   • API/API 文档 → api/

2. 从 examples/ 目录加载合适的示例文件：

   指南（使用文档）：

   • examples/guide/intro.md - Electron EGG 简介
   • examples/guide/installation.md - 安装指南
   • examples/guide/quick-start.md - 快速入门指南
   • examples/guide/project-structure.md - 项目结构
   • examples/guide/configuration.md - 配置
   • examples/guide/build.md - 构建和打包

   功能特性（功能特性）：

   • examples/features/main-process.md - 主进程
   • examples/features/renderer-process.md - 渲染进程
   • examples/features/ipc-communication.md - IPC 通信
   • examples/features/window-management.md - 窗口管理
   • examples/features/menu.md - 菜单
   • examples/features/tray.md - 系统托盘
   • examples/features/auto-updater.md - 自动更新程序
   • examples/features/plugin-system.md - 插件系统

3. 遵循相应示例文件中的具体说明，了解语法、结构和最佳实践

   重要提示：

   • Electron EGG 基于 Electron 和 Egg.js 构建
   • 主进程与渲染进程分离
   • 进程间通过 IPC 通信
   • 每个示例文件都包含关键概念、代码示例和要点

4. 必要时参考 api/ 目录中的 API 文档：

   • api/main-api.md - 主进程 API
   • api/renderer-api.md - 渲染进程 API
   • api/ipc-api.md - IPC API
   • api/window-api.md - 窗口 API
   • api/config-api.md - 配置 API

   API 文件：

   • api/main-api.md - Application 类、BrowserWindow、ipcMain、app 方法
   • api/renderer-api.md - ipcRenderer、contextBridge、DOM API
   • api/ipc-api.md - IPC 通信方法和事件
   • api/window-api.md - 窗口创建和管理
   • api/config-api.md - 配置选项和环境变量

5. 使用 templates/ 目录中的模板：

   • templates/installation.md - 安装模板
   • templates/project-setup.md - 项目设置模板
   • templates/configuration.md - 配置模板

1. 了解 Electron EGG

Electron EGG 是基于 Electron 和 Egg.js 的桌面应用程序开发框架，提供完整的开发工具链和最佳实践。

关键概念：

• Electron：跨平台桌面应用程序框架
• Egg.js：Node.js 企业应用程序框架
• 主进程：应用程序主进程
• 渲染进程：UI 渲染进程
• IPC：进程间通信
• 插件系统：可扩展的插件架构

2. 安装

使用 npm：

npm install electron-egg

使用 yarn：

yarn add electron-egg

使用 pnpm：

pnpm add electron-egg

3. 基本设置

// main.js
const { Application } = require('electron-egg')

const app = new Application({
  // Configuration
})

app.start()

文档映射（与官方文档一一对应）

• examples/ → https://www.kaka996.com/pages/987b1c/
• api/ → https://www.kaka996.com/pages/a99b72/

示例和模板

此技能包含详细示例，其组织结构与官方文档一致。所有示例均位于 examples/ 目录中（参见上方映射）。

使用示例：

• 根据用户的请求确定主题
• 从上方映射中加载相应的示例文件
• 遵循该文件中的说明、语法和最佳实践
• 根据具体用例调整代码示例

使用模板：

• 参考 templates/ 目录中的常用脚手架模板
• 根据具体需求和编码风格调整模板

API 参考

详细的 API 文档位于 api/ 目录中，其组织结构与官方 Electron EGG API 文档一致（https://www.kaka996.com/pages/a99b72/）：

主进程 API（api/main-api.md）

• Application 类及其方法
• BrowserWindow 的创建和管理
• ipcMain IPC 处理
• 应用程序生命周期钩子

渲染进程 API（api/renderer-api.md）

• ipcRenderer IPC 通信
• 用于安全公开 API 的 contextBridge
• 渲染进程中可用的 DOM API
• 事件处理

IPC API（api/ipc-api.md）

• IPC 通信方法（ipcMain、ipcRenderer）
• 消息发送和接收
• 异步和同步 IPC
• 事件处理和通道

窗口 API（api/window-api.md）

• BrowserWindow 的创建和选项
• 窗口管理方法
• 窗口事件
• 窗口生命周期

配置 API（api/config-api.md）

• 配置文件结构
• 应用信息配置
• 窗口配置
• 插件配置
• 环境变量

使用 API 参考：

1. 确定需要帮助的 API
2. 从 api/ 目录中加载相应的 API 文件
3. 查找 API 签名、参数、返回类型和示例
4. 参考链接的示例文件，了解详细用法
5. 所有 API 文件都包含指向 examples/ 目录中相关示例文件的链接

最佳实践

1. 进程分离：保持主进程和渲染进程代码分离
2. 使用 IPC：使用 IPC 进行进程间通信
3. 处理错误：妥善处理两个进程中的错误
4. 安全性：遵循 Electron 安全最佳实践
5. 性能：优化应用程序性能
6. 构建配置：正确配置构建和打包
7. 插件系统：使用插件系统实现可扩展性

资源

• 官方文档：https://www.kaka996.com/
• 使用指南：https://www.kaka996.com/pages/987b1c/
• API 文档：https://www.kaka996.com/pages/a99b72/
• Gitee 仓库：https://gitee.com/dromara/electron-egg

关键词

Electron EGG、electron-egg、Electron、Egg.js、桌面应用、桌面应用、主进程、渲染进程、IPC、进程间通信、窗口管理、菜单、系统托盘、自动更新、插件系统、主进程、渲染进程、进程间通信、窗口管理、菜单、系统托盘、自动更新器、插件系统