简介

electron-egg 框架基于三个核心包构建：

• ee-core — 框架核心，提供 100+ API，覆盖应用生命周期、通信、存储、任务等功能。支持 CJS + ESM 双模块格式。
• ee-bin — CLI 构建工具，负责开发编排、打包、加密、平台打包和资源管理。
• ee-go — Go 语言支持库，用于构建与 Electron 前端协同运行的跨进程后端。

导入格式

ee-core / ee-bin (CJS + ESM)

ee-core 和 ee-bin 同时输出 CommonJS 和 ES Module 格式，可根据项目需求选择：

// ESM（推荐用于 TypeScript 项目）
import { ElectronEgg } from 'ee-core';
import { getConfig } from 'ee-core/config';

// CJS（推荐用于传统 Electron 项目）
const { ElectronEgg } = require('ee-core');
const { getConfig } = require('ee-core/config');

建议

对于 Electron 主进程项目，CJS 是默认且推荐的格式（bundleConfig.format: 'cjs'）。ESM 要求所有业务代码（控制器、服务、配置）兼容 ESM 格式。

ee-go

import "github.com/wallace5303/ee-go/eapp"
import "github.com/wallace5303/ee-go/econfig"

模块文档

包名	说明	文档
ee-core	框架核心 — 生命周期、配置、通信、存储、任务、工具、进程状态	ee-core API
ee-bin	CLI 工具 — 开发、构建、加密、打包、图标、更新器	ee-bin API
ee-go	Go 后端 — eapp、econfig、ehttp、elog、eos、etask	ee-go API

ee-core 模块映射

模块	导出路径	主要 API
app	ee-core / ee-core/app	ElectronEgg、EventBus、生命周期事件
config	ee-core/config	getConfig、setConfig、getAppInfo
const	ee-core / ee-core/const	Processes、SocketIO、Events、Receiver
controller	ee-core/controller	loadController、getControllers
cross	ee-core/cross	Cross、cross.run、cross.kill
core	ee-core/core	FileLoader、Timing、loadFile
electron	ee-core/electron	electronApp、createMainWindow、loadServer
exception	ee-core/exception	loadException
loader	ee-core/loader	loadFile、requireFile、execFile、resolveModule
log	ee-core/log	logger、coreLogger、createLog
message	ee-core/message	ChildMessage、childMessage
socket	ee-core/socket	SocketServer、HttpServer、IpcServer
storage	ee-core/storage	SqliteStorage
jobs	ee-core/jobs	ChildJob、ChildPoolJob、LoadBalancer
utils	ee-core/utils	extend、is、helper、json、port、ip
ps	ee-core/ps	env、paths、进程类型检查
types	ee-core/types	TypeScript 类型定义

ee-bin 命令映射

命令	说明
dev	启动开发模式
build	构建前端 + Electron + 平台打包
start	生产模式预览
exec	执行自定义命令
move	复制资源
encrypt	代码加密
clean	清除加密输出
icon	生成应用图标
updater	生成增量更新包
ohos	鸿蒙资源提取

配置

所有 ee-bin 命令读取 ./cmd/bin.js。详见配置类型和默认值。