refactor: reorganize package structure and decouple framework packages (#338)

* refactor: reorganize package structure and decouple framework packages

## Package Structure Reorganization
- Reorganized 55 packages into categorized subdirectories:
  - packages/framework/ - Generic framework (Laya/Cocos compatible)
  - packages/engine/ - ESEngine core modules
  - packages/rendering/ - Rendering modules (WASM dependent)
  - packages/physics/ - Physics modules
  - packages/streaming/ - World streaming
  - packages/network-ext/ - Network extensions
  - packages/editor/ - Editor framework and plugins
  - packages/rust/ - Rust WASM engine
  - packages/tools/ - Build tools and SDK

## Framework Package Decoupling
- Decoupled behavior-tree and blueprint packages from ESEngine dependencies
- Created abstracted interfaces (IBTAssetManager, IBehaviorTreeAssetContent)
- ESEngine-specific code moved to esengine/ subpath exports
- Framework packages now usable with Cocos/Laya without ESEngine

## CI Configuration
- Updated CI to only type-check and lint framework packages
- Added type-check:framework and lint:framework scripts

## Breaking Changes
- Package import paths changed due to directory reorganization
- ESEngine integrations now use subpath imports (e.g., '@esengine/behavior-tree/esengine')

* fix: update es-engine file path after directory reorganization

* docs: update README to focus on framework over engine

* ci: only build framework packages, remove Rust/WASM dependencies

* fix: remove esengine subpath from behavior-tree and blueprint builds

ESEngine integration code will only be available in full engine builds.
Framework packages are now purely engine-agnostic.

* fix: move network-protocols to framework, build both in CI

* fix: update workflow paths from packages/core to packages/framework/core

* fix: exclude esengine folder from type-check in behavior-tree and blueprint

* fix: update network tsconfig references to new paths

* fix: add test:ci:framework to only test framework packages in CI

* fix: only build core and math npm packages in CI

* fix: exclude test files from CodeQL and fix string escaping security issue
This commit is contained in:
YHH
2025-12-26 14:50:35 +08:00
committed by GitHub
parent a84ff902e4
commit 155411e743
1936 changed files with 4147 additions and 11578 deletions

View File

@@ -0,0 +1,49 @@
/**
* {{displayName}} Runtime Module
*
* 运行时模块 - 负责注册组件、服务和系统
*/
import type {
IRuntimeModule,
IComponentRegistry,
SystemContext
} from '@esengine/ecs-components';
import type { IScene, ServiceContainer } from '@esengine/ecs-framework';
export class {{name}}RuntimeModule implements IRuntimeModule {
/**
* 注册组件到组件注册表
*/
registerComponents(registry: IComponentRegistry): void {
// registry.register(MyComponent);
}
/**
* 注册服务到服务容器
*/
registerServices?(services: ServiceContainer): void {
// services.registerSingleton(MyService);
}
/**
* 初始化回调
*/
async onInitialize?(): Promise<void> {
// 执行初始化逻辑
}
/**
* 为场景创建系统
*/
createSystems?(scene: IScene, context: SystemContext): void {
// scene.addSystem(new MySystem());
}
/**
* 系统创建完成后的回调,用于连接跨插件依赖
*/
onSystemsCreated?(scene: IScene, context: SystemContext): void {
// 连接跨插件依赖
}
}

View File

@@ -0,0 +1,36 @@
/**
* {{displayName}} Plugin
*
* 插件定义 - 注册编辑器模块Inspector、工具等
*/
import type { IPlugin, ModuleManifest, IEditorModuleLoader } from '@esengine/editor-core';
import { {{name}}RuntimeModule } from '../{{name}}RuntimeModule';
class {{name}}EditorModule implements IEditorModuleLoader {
async install(): Promise<void> {
// 注册组件 Inspector
// registry.register('MyComponent', MyComponentInspector);
}
async uninstall(): Promise<void> {}
}
const manifest: ModuleManifest = {
id: '@esengine/{{name}}',
name: '@esengine/{{name}}',
displayName: '{{displayName}}',
version: '1.0.0',
description: '{{displayName}} plugin',
category: '{{category}}',
isCore: false,
defaultEnabled: true,
isEngineModule: false,
dependencies: ['engine-core'],
exports: {}
};
export const {{name}}Plugin: IPlugin = {
manifest,
runtimeModule: new {{name}}RuntimeModule(),
editorModule: new {{name}}EditorModule()
};

View File

@@ -0,0 +1,13 @@
/**
* @esengine/{{name}} Editor Module
*
* 编辑器模块 - 包含 Inspector、工具等编辑器专用代码
* Editor module - contains Inspector, tools, and other editor-specific code
*
* This module can safely import React and editor-core packages.
*/
export { {{name}}Plugin } from './{{name}}Plugin';
// Inspectors
// export { MyComponentInspector } from './inspectors/MyComponentInspector';

View File

@@ -0,0 +1,14 @@
/**
* @esengine/{{name}}
*
* {{description}}
*
* 主入口 - 导出所有内容(包括编辑器模块)
* Main entry - exports everything (including editor modules)
*/
// Runtime exports (always available)
export * from './runtime';
// Editor exports (only in editor environment)
export { {{name}}Plugin } from './editor';

View File

@@ -0,0 +1,17 @@
/**
* @esengine/{{name}} Runtime Entry Point
*
* 运行时入口 - 仅导出运行时代码,不包含任何编辑器依赖
* Runtime entry - exports only runtime code without any editor dependencies
*
* IMPORTANT: Do not import React or any editor packages here!
*/
// Components
// export { MyComponent } from './components/MyComponent';
// Systems
// export { MySystem } from './systems/MySystem';
// Runtime Module
export { {{name}}RuntimeModule } from './{{name}}RuntimeModule';