mirror of
https://github.com/GeWuYou/GFramework.git
synced 2026-04-08 16:34:30 +08:00
38bd934779
- 新增游戏内容配置系统完整文档，介绍AI-First配表方案 - 实现YAML配置源文件和JSON Schema结构描述功能 - 添加运行时只读查询和Source Generator类型生成能力 - 集成VSCode插件提供配置浏览、校验和表单编辑功能 - 支持开发期热重载和跨表引用校验机制 - 提供批量编辑和嵌套对象安全表单入口
46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# GFramework Config Tools
|
|
|
|
Minimal VS Code extension scaffold for the GFramework AI-First config workflow.
|
|
|
|
## Current MVP
|
|
|
|
- Browse config files from the workspace `config/` directory
|
|
- Open raw YAML files
|
|
- Open matching schema files from `schemas/`
|
|
- Run lightweight schema validation for nested required fields, unknown nested fields, scalar types, scalar arrays, and
|
|
arrays of objects
|
|
- Open a lightweight form preview for nested object fields, object arrays, top-level scalar fields, and scalar arrays
|
|
- Batch edit one config domain across multiple files for top-level scalar and scalar-array fields
|
|
- Surface schema metadata such as `title`, `description`, `default`, `enum`, and `x-gframework-ref-table` in the
|
|
lightweight editors
|
|
|
|
## Validation Coverage
|
|
|
|
The extension currently validates the repository's minimal config-schema subset:
|
|
|
|
- required properties in nested objects
|
|
- unknown properties in nested objects
|
|
- scalar compatibility for `integer`, `number`, `boolean`, and `string`
|
|
- scalar arrays with scalar item type checks
|
|
- arrays of objects whose items use the same supported subset recursively
|
|
- scalar `enum` constraints and scalar-array item `enum` constraints
|
|
|
|
## Local Testing
|
|
|
|
```bash
|
|
cd tools/vscode-config-extension
|
|
node --test ./test/*.test.js
|
|
```
|
|
|
|
## Current Constraints
|
|
|
|
- Multi-root workspaces use the first workspace folder
|
|
- Validation only covers a minimal subset of JSON Schema
|
|
- Form preview supports object-array editing, but nested object arrays inside array items still fall back to raw YAML
|
|
- Batch editing remains limited to top-level scalar fields and top-level scalar arrays
|
|
|
|
## Workspace Settings
|
|
|
|
- `gframeworkConfig.configPath`
|
|
- `gframeworkConfig.schemasPath`
|