create-genshin-ts 0.1.5 → 0.1.7

package/README.md

@@ -7,3 +7,6 @@ Scaffold a Genshin-TS project.
 ```bash
 npm create genshin-ts@latest
 ```
+
+genshin-ts includes a TypeScript plugin for more advanced TypeScript support enhancements; even if it is not enabled, it does not affect functionality or development workflow, but enabling it is recommended. See:
+[https://gsts.moe/doc/quick-start/install.html#typescript-plugin](https://gsts.moe/doc/quick-start/install.html#typescript-plugin)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-genshin-ts",
-  "version": "0.1.5",
+  "version": "0.1.7",
   "description": "Create a Genshin-TS project",
   "type": "module",
   "author": "josStorer <josstorer@outlook.com> (https://github.com/josStorer)",

package/templates/start/.vscode/settings.json

@@ -15,6 +15,11 @@
   "[javascriptreact]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "always"
+  },
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "typescript.enablePromptUseWorkspaceTsdk": true,
   "search.exclude": {
     "package-lock.json": true
   },

package/templates/start/README.md

@@ -123,6 +123,9 @@ Disable an option temporarily if you need to debug or compare graphs.
 
 - `number` is **float**; `bigint` is **int**.
 - Use `bigint` for modulo/bitwise operations.
+- When list indexing uses `bigint` / `IntValue`, wrap with `idx(...)`, e.g. `arr[idx(i)]` (you can apply this via ESLint auto-fix).
+- If this is shown as a warning (not an error), the TypeScript plugin is usually active and already treats `bigint` as a valid index value; you may disable `gsts/bigint-index-in-server`.
+- If `TS2538` still appears as an error in VSCode/Cursor, configure `"typescript.tsdk": "node_modules/typescript/lib"` and `"typescript.enablePromptUseWorkspaceTsdk": true` (the genshin-ts project template already includes these settings), then switch to the workspace TypeScript version.
 - Lists/dicts must be homogeneous; mixed types will fail.
 - Empty arrays may not infer a type; add a typed placeholder or use `list(...)`.
 - Prefer explicit helpers: `int`, `float`, `vec3`, `configId`, `prefabId`, `entity`, etc.
@@ -138,6 +141,7 @@ Logging and debug:
 
 Type helpers:
 - `bool(...)` / `int(...)` / `float(...)` / `str(...)`
+- `idx(...)`: helps `bigint` / `IntValue` index expressions pass TypeScript type-checking (type-check only; node-graph int semantics stay unchanged).
 - `vec3(...)` / `guid(...)` / `prefabId(...)` / `configId(...)` / `faction(...)` / `entity(...)`
 - `list('int', items)`: explicit list typing (critical for empty arrays).
 - `dict(...)`: read-only dict.

package/templates/start/README_ZH.md

@@ -128,6 +128,9 @@ g.server({
 
 - `number` 会视为 **float**，`bigint` 会视为 **int**。
 - 取余、位运算等整数运算请使用 `bigint`。
+- 列表下标若使用 `bigint` / `IntValue`，请用 `idx(...)` 包裹，例如 `arr[idx(i)]`（可直接应用 ESLint 自动修复）。
+- 若此处显示为“警告”而非“错误”，通常表示项目 TypeScript 插件已生效（已将 `bigint` 视作可索引），可按需禁用 `gsts/bigint-index-in-server`。
+- 若 VSCode/Cursor 里仍看到 `TS2538` 错误，请配置 `"typescript.tsdk": "node_modules/typescript/lib"` 与 `"typescript.enablePromptUseWorkspaceTsdk": true`（genshin-ts 的项目模板已经自带这些设置），并设置“使用工作区 TypeScript 版本”。
 - 列表/字典元素类型必须一致，混合类型会报错。
 - 空数组可能无法推断类型，建议先放一个同类型占位值。
 - 建议使用辅助函数明确类型：`int`、`float`、`vec3`、`configId`、`prefabId`、`entity` 等。
@@ -145,6 +148,7 @@ g.server({
 类型与构造：
 
 - `bool(...)` / `int(...)` / `float(...)` / `str(...)`：显式类型转换。
+- `idx(...)`：用于让 `bigint` / `IntValue` 索引通过 TypeScript 类型检查（仅用于通过类型检查，不改变节点图整数语义）。
 - `vec3(...)` / `guid(...)` / `prefabId(...)` / `configId(...)` / `faction(...)` / `entity(...)`：常用类型构造。
 - `list('int', items)`：显式声明列表类型（空数组时尤为重要）。
 - `dict(...)`：声明只读字典（节点图变量字典需用 `f.get` / `f.set`）。