@colyseus/schema 4.0.27 → 4.0.29

package/README.md

@@ -40,6 +40,26 @@ export class MyState extends Schema {
 }
 ```
 
+## TypeScript support
+
+Compatible with TypeScript **5.x**, **6.x** and **7.x**.
+
+The `@type()` decorator uses legacy decorators — enable them in your `tsconfig.json`:
+
+```json
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false
+  }
+}
+```
+
+> **Note:** `schema-codegen` requires TypeScript 5.x or 6.x installed in your
+> project — TypeScript 7's native compiler no longer ships the JS compiler API
+> that codegen uses to parse your schema files. The runtime and your build are
+> not affected by this.
+
 ## Supported types
 
 ### Primitive Types
@@ -276,6 +296,9 @@ up-to-date version of the schema definitions.
 
 You can generate the client-side schema files based on the TypeScript schema definitions automatically.
 
+> `schema-codegen` requires TypeScript 5.x or 6.x installed in your project
+> (TypeScript 7+ no longer ships the JS compiler API it uses for parsing).
+
 ```
 # C#/Unity
 schema-codegen ./schemas/State.ts --output ./unity-project/ --csharp

package/build/codegen/cli.cjs

@@ -472,6 +472,11 @@ function inspectNode(node, context, decoratorName) {
 }
 let parsedFiles;
 function parseFiles(fileNames, decoratorName = "type", context = new Context()) {
+    if (typeof ts__namespace.createSourceFile !== "function") {
+        // typescript@7+ (native) no longer ships the JS compiler API
+        throw new Error(`schema-codegen requires the TypeScript compiler API, which the installed "typescript@${ts__namespace.version}" package does not provide.\n` +
+            `TypeScript 7+ no longer ships the JS compiler API — install typescript 5.x or 6.x (e.g. \`npm install --save-dev typescript@6\`) to use schema-codegen.`);
+    }
     /**
      * Re-set globalContext for each test case
      */
@@ -508,7 +513,10 @@ function parseFiles(fileNames, decoratorName = "type", context = new Context())
                 break;
             }
             catch (e) {
-                // console.log(`${fileNameAlternatives[i]} => ${e.message}`);
+                // only swallow fs errors (ENOENT/EISDIR) while probing alternatives
+                if (!e?.code) {
+                    throw e;
+                }
             }
         }
         if (sourceFile) {
@@ -2286,7 +2294,7 @@ function recursiveFiles(dir) {
     return collect;
 }
 
-function displayHelp() {
+function displayHelp(exitCode = 0) {
     console.log(`\nschema-codegen [path/to/Schema.ts]
 
 Usage (C#/Unity)
@@ -2305,7 +2313,7 @@ ${Object.
 Optional:
     --namespace: generate namespace on output code
     --decorator: custom name for @type decorator to scan for`);
-    process.exit();
+    process.exit(exitCode);
 }
 const args = argv(process.argv.slice(2));
 if (args.help) {
@@ -2319,7 +2327,7 @@ for (let target in generators) {
 }
 if (!args.output) {
     console.error("You must provide a valid --output directory.");
-    displayHelp();
+    displayHelp(1);
 }
 try {
     args.files = args._;
@@ -2334,6 +2342,6 @@ try {
 catch (e) {
     console.error(e.message);
     console.error(e.stack);
-    displayHelp();
+    displayHelp(1);
 }
 //# sourceMappingURL=cli.cjs.map