gewuyou/GFramework
1
0
Fork 0
mirror of https://github.com/GeWuYou/GFramework.git synced 2026-05-08 01:24:31 +08:00
Code Issues Packages Projects Releases Wiki Activity
GFramework/tools/gframework-config-tool
History
GeWuYou c732285dfb docs(config): 添加游戏内容配置系统文档和验证工具 
- 新增游戏内容配置系统完整文档，涵盖 YAML 配置、JSON Schema 结构、目录组织
- 实现配置系统的运行时查询、类型生成、VS Code 插件集成等功能说明
- 添加 Schema 示例、YAML 示例和推荐接入模板
- 提供运行时读取、热重载、批处理编辑等功能的使用指南
- 实现配置校验行为、跨表引用、诊断对象等核心功能文档
- 集成开发期工具支持，包括表单编辑、批量更新、注释渲染等能力
- 添加架构接入模板和生产部署相关建议
2026-04-06 20:17:57 +08:00
..
src
docs(config): 添加游戏内容配置系统文档和验证工具
2026-04-06 20:17:57 +08:00
test
docs(config): 添加游戏内容配置系统文档和验证工具
2026-04-06 20:17:57 +08:00
.gitignore
feat(config-tool): 添加配置验证工具和相关功能
2026-04-01 23:06:44 +08:00
.vscodeignore
feat(config-tool): 添加配置验证工具和相关功能
2026-04-01 23:06:44 +08:00
bun.lock
feat(config-tool): 添加配置验证工具和相关功能
2026-04-01 23:06:44 +08:00
LICENSE
feat(config-tool): 添加配置验证工具和相关功能
2026-04-01 23:06:44 +08:00
package.json
feat(config): 添加游戏内容配置系统和VS Code工具
2026-04-02 21:29:07 +08:00
package.nls.json
feat(config-tool): 添加 VS Code 扩展实现配置文件管理功能
2026-04-02 20:45:02 +08:00
package.nls.zh-cn.json
feat(config-tool): 添加 VS Code 扩展实现配置文件管理功能
2026-04-02 20:45:02 +08:00
README.md
feat(config): 添加游戏内容配置系统和VS Code工具
2026-04-02 21:29:07 +08:00

README.md

GFramework Config Tool

VS Code extension 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/
  • Localize extension UI text in English and Simplified Chinese, including the form preview, prompts, and notifications
  • 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
  • Render existing YAML comments in the form preview and edit per-field YAML comments directly from the form
  • Jump from reference fields to the referenced schema, config domain, or direct config file when a reference value is present
  • Initialize empty config files from schema-derived example YAML
  • 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

cd tools/gframework-config-tool
bun install
bun run test

Packaging And Publishing

cd tools/gframework-config-tool
bun install
bun run package:vsix
VSCE_PAT=your_marketplace_pat bun run publish:marketplace

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