Files
esengine/packages/editor/plugins/shader-editor/src/index.ts
YHH 155411e743 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
2025-12-26 14:50:35 +08:00

111 lines
3.2 KiB
TypeScript

/**
* @esengine/shader-editor
*
* Shader editor with code editing, analysis, and preview.
* 着色器编辑器,支持代码编辑、分析和预览。
*/
import type { ServiceContainer } from '@esengine/ecs-framework';
import type {
IEditorModuleLoader,
IEditorPlugin,
ModuleManifest,
IFileSystem
} from '@esengine/editor-core';
import {
InspectorRegistry,
IInspectorRegistry,
IFileSystemService
} from '@esengine/editor-core';
// Components
import { useShaderEditorStore } from './stores/ShaderEditorStore';
import { ShaderAssetInspectorProvider } from './providers/ShaderAssetInspectorProvider';
// Import styles
import './styles/ShaderInspector.css';
// Re-exports
export { useShaderEditorStore, createDefaultShaderData } from './stores/ShaderEditorStore';
export type { ShaderData, ShaderEditorState } from './stores/ShaderEditorStore';
export { ShaderAnalyzer, shaderAnalyzer } from './analysis/ShaderAnalyzer';
export type {
ShaderAnalysis,
ShaderComplexity,
UniformInfo,
AttributeInfo,
VaryingInfo
} from './analysis/ShaderAnalyzer';
export { ShaderAssetInspectorProvider } from './providers/ShaderAssetInspectorProvider';
/**
* Shader Editor Module.
* 着色器编辑器模块。
*/
export class ShaderEditorModule implements IEditorModuleLoader {
private unsubscribers: Array<() => void> = [];
private inspectorProvider?: ShaderAssetInspectorProvider;
async install(services: ServiceContainer): Promise<void> {
// Register Shader Asset Inspector Provider.
// 注册着色器资产检视器提供者。
const inspectorRegistry = services.resolve<InspectorRegistry>(IInspectorRegistry);
if (inspectorRegistry) {
this.inspectorProvider = new ShaderAssetInspectorProvider();
// Set up save handler.
// 设置保存处理器。
const fileSystem = services.tryResolve<IFileSystem>(IFileSystemService);
if (fileSystem) {
this.inspectorProvider.setSaveHandler(async (path, content) => {
await fileSystem.writeFile(path, content);
});
}
inspectorRegistry.register(this.inspectorProvider);
}
}
async uninstall(): Promise<void> {
// Clean up subscriptions.
this.unsubscribers.forEach(unsub => unsub());
this.unsubscribers = [];
// Reset store.
useShaderEditorStore.getState().reset();
}
}
export const shaderEditorModule = new ShaderEditorModule();
/**
* Shader Editor Plugin Manifest.
* 着色器编辑器插件清单。
*/
const manifest: ModuleManifest = {
id: '@esengine/shader-editor',
name: '@esengine/shader-editor',
displayName: 'Shader Editor',
version: '1.0.0',
description: 'Shader code editing with analysis and preview',
category: 'Rendering',
isCore: true,
defaultEnabled: true,
isEngineModule: true,
dependencies: ['material-system'],
exports: {
other: ['ShaderAnalyzer']
}
};
/**
* Shader Editor Plugin (editor only, no runtime).
* 着色器编辑器插件(仅编辑器,无运行时)。
*/
export const ShaderEditorPlugin: IEditorPlugin = {
manifest,
editorModule: shaderEditorModule
};
export default shaderEditorModule;