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
GitHub
@@ -0,0 +1,62 @@
|
||||
{
|
||||
"name": "{{fullName}}",
|
||||
"version": "1.0.0",
|
||||
"description": "{{description}}",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.js"
|
||||
},
|
||||
"./runtime": {
|
||||
"types": "./dist/runtime.d.ts",
|
||||
"import": "./dist/runtime.js"
|
||||
},
|
||||
"./editor": {
|
||||
"types": "./dist/editor/index.d.ts",
|
||||
"import": "./dist/editor/index.js"
|
||||
},
|
||||
"./plugin.json": "./plugin.json"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"plugin.json"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"build:watch": "tsup --watch",
|
||||
"clean": "rimraf dist",
|
||||
"type-check": "tsc --noEmit"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@esengine/ecs-framework": "{{depVersion}}",
|
||||
"@esengine/ecs-components": "{{depVersion}}",
|
||||
"@esengine/editor-core": "{{depVersion}}",
|
||||
"react": "^18.3.1"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"@esengine/editor-core": {
|
||||
"optional": true
|
||||
},
|
||||
"react": {
|
||||
"optional": true
|
||||
}
|
||||
},
|
||||
"devDependencies": {
|
||||
"@esengine/build-config": "{{depVersion}}",
|
||||
"@types/react": "^18.3.12",
|
||||
"rimraf": "^5.0.5",
|
||||
"tsup": "^8.0.0",
|
||||
"typescript": "^5.8.3"
|
||||
},
|
||||
"keywords": [
|
||||
"ecs",
|
||||
"esengine",
|
||||
"plugin"
|
||||
],
|
||||
"author": "",
|
||||
"license": "MIT"
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"id": "{{fullName}}",
|
||||
"name": "{{displayName}}",
|
||||
"version": "1.0.0",
|
||||
"category": "{{category}}",
|
||||
"enabledByDefault": true,
|
||||
"isEnginePlugin": false,
|
||||
"modules": [
|
||||
{
|
||||
"name": "{{pascalName}}Runtime",
|
||||
"type": "runtime",
|
||||
"entry": "./src/runtime.ts"
|
||||
},
|
||||
{
|
||||
"name": "{{pascalName}}Editor",
|
||||
"type": "editor",
|
||||
"entry": "./src/editor/index.ts"
|
||||
}
|
||||
],
|
||||
"components": [],
|
||||
"dependencies": []
|
||||
}
|
||||
@@ -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 {
|
||||
// 连接跨插件依赖
|
||||
}
|
||||
}
|
||||
@@ -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()
|
||||
};
|
||||
@@ -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';
|
||||
@@ -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';
|
||||
@@ -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';
|
||||
@@ -0,0 +1,23 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"module": "ES2020",
|
||||
"moduleResolution": "bundler",
|
||||
"lib": ["ES2020", "DOM"],
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"jsx": "react-jsx",
|
||||
"resolveJsonModule": true,
|
||||
"experimentalDecorators": true,
|
||||
"emitDecoratorMetadata": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"lib": ["ES2020", "DOM"],
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"noEmit": true,
|
||||
"jsx": "react-jsx",
|
||||
"resolveJsonModule": true,
|
||||
"experimentalDecorators": true,
|
||||
"emitDecoratorMetadata": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
import { pluginPreset } from '@esengine/build-config/presets/tsup';
|
||||
|
||||
export default defineConfig({
|
||||
...pluginPreset(),
|
||||
tsconfig: 'tsconfig.build.json'
|
||||
});
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"name": "{{fullName}}",
|
||||
"version": "1.0.0",
|
||||
"description": "{{description}}",
|
||||
"type": "module",
|
||||
"main": "dist/index.js",
|
||||
"module": "dist/index.js",
|
||||
"types": "dist/index.d.ts",
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"import": "./dist/index.js"
|
||||
}
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"scripts": {
|
||||
"build": "tsup",
|
||||
"build:watch": "tsup --watch",
|
||||
"clean": "rimraf dist",
|
||||
"type-check": "tsc --noEmit"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@esengine/ecs-framework": "{{depVersion}}"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@esengine/build-config": "{{depVersion}}",
|
||||
"rimraf": "^5.0.5",
|
||||
"tsup": "^8.0.0",
|
||||
"typescript": "^5.8.3"
|
||||
},
|
||||
"keywords": [
|
||||
"ecs"
|
||||
],
|
||||
"author": "",
|
||||
"license": "MIT"
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
/**
|
||||
* @esengine/{{name}}
|
||||
*
|
||||
* {{description}}
|
||||
*/
|
||||
|
||||
// Export your public API here
|
||||
export {};
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"module": "ES2020",
|
||||
"moduleResolution": "bundler",
|
||||
"lib": ["ES2020", "DOM"],
|
||||
"outDir": "./dist",
|
||||
"rootDir": "./src",
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"declaration": true,
|
||||
"declarationMap": true,
|
||||
"resolveJsonModule": true,
|
||||
"experimentalDecorators": true,
|
||||
"emitDecoratorMetadata": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"target": "ES2020",
|
||||
"module": "ESNext",
|
||||
"moduleResolution": "bundler",
|
||||
"lib": ["ES2020", "DOM"],
|
||||
"strict": true,
|
||||
"esModuleInterop": true,
|
||||
"allowSyntheticDefaultImports": true,
|
||||
"skipLibCheck": true,
|
||||
"forceConsistentCasingInFileNames": true,
|
||||
"noEmit": true,
|
||||
"resolveJsonModule": true,
|
||||
"experimentalDecorators": true,
|
||||
"emitDecoratorMetadata": true
|
||||
},
|
||||
"include": ["src/**/*"],
|
||||
"exclude": ["node_modules", "dist"]
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
import { defineConfig } from 'tsup';
|
||||
import { runtimeOnlyPreset } from '@esengine/build-config/presets/tsup';
|
||||
|
||||
export default defineConfig({
|
||||
...runtimeOnlyPreset(),
|
||||
tsconfig: 'tsconfig.build.json'
|
||||
});
|
||||
Reference in New Issue
Block a user