Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the configuration documentation (JA/EN/CN) to clarify how stage.json/config.json behave (including warnings about unsupported keys) and bumps the framework package version and several devDependencies.
Changes:
- Expanded
stage.json/config.jsondocs with clearer semantics (startup load timing, env merge behavior, reserved vs user-defined properties) and added warning callouts. - Refined examples/wording for loading and gotoView callbacks, plus section separators.
- Bumped
package.jsonversion to4.0.3and updated multiple devDependencies.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| specs/ja/config.md | Adds detailed JP explanations + warnings for supported config keys and usage patterns. |
| specs/en/config.md | Adds detailed EN explanations + warnings for supported config keys and usage patterns. |
| specs/cn/config.md | Adds detailed CN explanations + warnings for supported config keys and usage patterns. |
| package.json | Version bump and devDependency updates. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | `width` | number | 240 | 表示領域の幅（ピクセル単位）。実際の描画キャンバスの基準幅として使用される | | ||
| | `height` | number | 240 | 表示領域の高さ（ピクセル単位）。実際の描画キャンバスの基準高さとして使用される | | ||
| | `fps` | number | 60 | 1秒間の描画回数。指定可能な範囲は 1〜60 | | ||
| | `options` | object | null | 追加オプション設定。省略可能 | |
There was a problem hiding this comment.
stage.json の options は説明上「省略可能」ですが、型/デフォルトが object / null になっています。フレームワーク側の型定義では stage.options?: IOptions（src/interface/IStage.ts）なので、ドキュメントも object (optional) もしくは object | undefined（デフォルトは省略/—）に合わせた方が矛盾がありません。
| | `options` | object | null | 追加オプション設定。省略可能 | | |
| | `options` | object (optional) | — | 追加オプション設定。省略可能 | |
| | `fullScreen` | boolean | false | `true` にするとウィンドウ全体にStageを拡張して描画する。`false` の場合は `width`・`height` で指定したサイズで固定描画 | | ||
| | `tagId` | string \| null | null | 描画先とするHTML要素のID。指定したIDのエレメント内部にキャンバスが生成される。`null` の場合は `<body>` 直下に生成される | | ||
| | `bgColor` | string | "transparent" | 背景色を16進数カラーコードで指定（例: `"#1461A0"`）。`"transparent"` を指定すると透明になる | |
There was a problem hiding this comment.
options.tagId の型が string | null、デフォルトが null になっていますが、フレームワークの型定義 IOptions は tagId?: string（src/interface/IOptions.ts）です。null を許容する設計なら型定義側も含めて揃えるか、ドキュメント側を「省略可（未指定の場合は <body> 直下）」に寄せてください。
| | `width` | number | 240 | Display area width in pixels. Used as the base width of the rendering canvas | | ||
| | `height` | number | 240 | Display area height in pixels. Used as the base height of the rendering canvas | | ||
| | `fps` | number | 60 | Number of renders per second. Valid range is 1–60 | | ||
| | `options` | object | null | Additional option settings. Can be omitted | |
There was a problem hiding this comment.
For stage.json, options is described as “can be omitted” but the table shows type/default as object / null. In the framework typings it is stage.options?: IOptions (src/interface/IStage.ts), so documenting it as optional (or object | undefined with default “—”) would avoid a mismatch.
| | `options` | object | null | Additional option settings. Can be omitted | | |
| | `options` | object \| undefined | — | Additional option settings. Can be omitted | |
| | `fullScreen` | boolean | false | When `true`, the Stage expands to fill the entire window. When `false`, rendering is fixed to the size specified by `width` and `height` | | ||
| | `tagId` | string \| null | null | ID of the HTML element to use as the rendering target. The canvas is created inside the element with the specified ID. When `null`, the canvas is created directly under `<body>` | | ||
| | `bgColor` | string | "transparent" | Background color as a hexadecimal color code (e.g. `"#1461A0"`). Use `"transparent"` for a transparent background | |
There was a problem hiding this comment.
options.tagId is documented as string | null with default null, but the framework’s IOptions type is tagId?: string (src/interface/IOptions.ts). Either update the docs to describe it as optional (not null), or update the type definitions if null is truly supported/expected.
| | `width` | number | 240 | 显示区域宽度（像素）。作为渲染画布的基准宽度使用 | | ||
| | `height` | number | 240 | 显示区域高度（像素）。作为渲染画布的基准高度使用 | | ||
| | `fps` | number | 60 | 每秒渲染次数。有效范围为 1〜60 | | ||
| | `options` | object | null | 附加选项设置。可省略 | |
There was a problem hiding this comment.
stage.json 的 options 被描述为“可省略”，但表格里类型/默认值写成了 object / null。框架的类型定义是 stage.options?: IOptions（src/interface/IStage.ts），建议文档改为可选（或 object | undefined，默认值用 “—/省略”），避免与实际类型不一致。
| | `options` | object | null | 附加选项设置。可省略 | | |
| | `options` | object（可选） | — | 附加选项设置。可省略 | |
| | `fullScreen` | boolean | false | 设为 `true` 时，Stage 扩展为填充整个窗口。设为 `false` 时，以 `width`・`height` 指定的尺寸固定渲染 | | ||
| | `tagId` | string \| null | null | 用作渲染目标的 HTML 元素 ID。画布在指定 ID 的元素内部创建。为 `null` 时直接在 `<body>` 下创建 | | ||
| | `bgColor` | string | "transparent" | 以十六进制颜色代码指定背景色（例：`"#1461A0"`）。指定 `"transparent"` 则为透明 | |
There was a problem hiding this comment.
options.tagId 文档写为 string | null 且默认 null，但框架类型 IOptions 中是 tagId?: string（src/interface/IOptions.ts）。如果确实允许 null，建议同步更新类型定义；否则文档应改为“可省略/未指定时…”以与类型一致。
No description provided.