xray16 1.3.4 → 1.4.0

package/plugins/transform_luabind_class/transformation/setup.js

@@ -9,11 +9,17 @@ const lua_ast_1 = require("typescript-to-lua/dist/transformation/utils/lua-ast")
 const constants_1 = require("./constants");
 const utils_1 = require("./utils");
 /**
- * Create full class setup statement with name/super calls/methods/declaration/fields etc.
+ * Build the full set of statements that define a luabind class.
+ *
+ * @param context - Active transformation context.
+ * @param statement - Class declaration being transformed.
+ * @param className - Exported class identifier.
+ * @param localClassName - Local class identifier.
+ * @returns Lua statements that set up the class.
  */
 function createClassSetup(context, statement, className, localClassName) {
     const result = [];
-    // class("name")(base)
+    // Class("name")(base)
     const classInitializer = createLuabindClassStatement(statement, context, localClassName);
     result.push(tstl.createExpressionStatement(classInitializer));
     const classReference = createLuabindClassGlobalClassRef(statement, context, localClassName);
@@ -28,17 +34,17 @@ function createClassSetup(context, statement, className, localClassName) {
         result.push(...(0, lua_ast_1.createLocalOrExportedOrGlobalDeclaration)(context, className, classReference, statement));
     }
     if (defaultExportLeftHandSide) {
-        // local localClassName = ____exports.default
+        // Local localClassName = ____exports.default
         result.push(tstl.createVariableDeclarationStatement(localClassName, defaultExportLeftHandSide));
     }
     else {
         const exportScope = (0, export_1.getIdentifierExportScope)(context, className);
         if (exportScope) {
-            // local localClassName = ____exports.className
+            // Local localClassName = ____exports.className
             result.push(tstl.createVariableDeclarationStatement(localClassName, (0, export_1.createExportedIdentifier)(context, tstl.cloneIdentifier(className), exportScope)));
         }
     }
-    // localClassName.__name = className
+    // LocalClassName.__name = className
     result.push(tstl.createAssignmentStatement(tstl.createTableIndexExpression(tstl.cloneIdentifier(localClassName), tstl.createStringLiteral(constants_1.LUABIND_NAME_FIELD)), getReflectionClassName(statement, className), statement));
     return result;
 }
@@ -59,6 +65,11 @@ function getReflectionClassName(declaration, className) {
 }
 /**
  * Creates class("Name")(base) expression for luabind classes.
+ *
+ * @param declaration - Class declaration being transformed.
+ * @param context - Active transformation context.
+ * @param className - Exported class identifier.
+ * @returns Lua expression that creates the class.
  */
 function createLuabindClassStatement(declaration, context, className) {
     const extendedNode = (0, utils_1.getExtendedNode)(declaration);
@@ -73,7 +84,12 @@ function createLuabindClassStatement(declaration, context, className) {
     return classDeclaration;
 }
 /**
- * Creates name expression for luabind classes.
+ * Create the global reference expression for a luabind class.
+ *
+ * @param declaration - Class declaration being transformed.
+ * @param context - Active transformation context.
+ * @param className - Exported class identifier.
+ * @returns Identifier used to reference the class.
  */
 function createLuabindClassGlobalClassRef(declaration, context, className) {
     return className;

package/plugins/transform_luabind_class/transformation/super.d.ts

@@ -1,20 +1,36 @@
-import { CallExpression, Expression, SuperExpression } from "typescript";
+import { type CallExpression, type Expression, type SuperExpression } from "typescript";
 import * as tstl from "typescript-to-lua";
-import { ITransformationContext } from "./class_declaration";
+import { type ITransformationContext } from "./class_declaration";
 /**
  * Transform generic methods super calls.
  * Example: super.parentMethod(first, second).
+ *
+ * @param expression - Super expression to transform.
+ * @param context - Active transformation context.
+ * @returns Lua expression referencing the base class.
  */
 export declare function transformClassSuperMethodExpression(expression: Expression, context: ITransformationContext): tstl.Expression;
 /**
  * Check if super() call is in luabind class target.
+ *
+ * @param expression - Call or super expression to check.
+ * @param context - Active transformation context.
+ * @returns True when the call targets a luabind class.
  */
 export declare function isLuabindClassSuperCall(expression: CallExpression | SuperExpression, context: ITransformationContext): boolean;
 /**
  * Check if super.method() call is in luabind class target.
+ *
+ * @param expression - Call or super expression to check.
+ * @param context - Active transformation context.
+ * @returns True when the call targets a luabind class.
  */
 export declare function isLuabindClassSuperMethodCall(expression: CallExpression | SuperExpression, context: ITransformationContext): boolean;
 /**
- * Transform super() call in luabind classes to base_class.__init(self, param).
+ * Transform a super() call into luabind classes to base_class.__init(self, param).
+ *
+ * @param expression - Super constructor call to transform.
+ * @param context - Active transformation context.
+ * @returns Lua call to the base class constructor.
  */
 export declare function transformLuabindConstructorSuperCall(expression: CallExpression, context: ITransformationContext): tstl.CallExpression;

package/plugins/transform_luabind_class/transformation/super.js

@@ -14,6 +14,10 @@ const utils_1 = require("./utils");
 /**
  * Transform generic methods super calls.
  * Example: super.parentMethod(first, second).
+ *
+ * @param expression - Super expression to transform.
+ * @param context - Active transformation context.
+ * @returns Lua expression referencing the base class.
  */
 function transformClassSuperMethodExpression(expression, context) {
     const superInfos = context.classSuperInfos;
@@ -39,6 +43,10 @@ function transformClassSuperMethodExpression(expression, context) {
 }
 /**
  * Check if super() call is in luabind class target.
+ *
+ * @param expression - Call or super expression to check.
+ * @param context - Active transformation context.
+ * @returns True when the call targets a luabind class.
  */
 function isLuabindClassSuperCall(expression, context) {
     const calledExpression = (0, call_1.getCalledExpression)(expression);
@@ -54,6 +62,10 @@ function isLuabindClassSuperCall(expression, context) {
 }
 /**
  * Check if super.method() call is in luabind class target.
+ *
+ * @param expression - Call or super expression to check.
+ * @param context - Active transformation context.
+ * @returns True when the call targets a luabind class.
  */
 function isLuabindClassSuperMethodCall(expression, context) {
     const superInfos = context.classSuperInfos;
@@ -62,7 +74,11 @@ function isLuabindClassSuperMethodCall(expression, context) {
     return superInfo?.classDeclaration ? (0, utils_1.isLuabindClassType)(superInfo.classDeclaration, context) : false;
 }
 /**
- * Transform super() call in luabind classes to base_class.__init(self, param).
+ * Transform a super() call into luabind classes to base_class.__init(self, param).
+ *
+ * @param expression - Super constructor call to transform.
+ * @param context - Active transformation context.
+ * @returns Lua call to the base class constructor.
  */
 function transformLuabindConstructorSuperCall(expression, context) {
     const signature = context.checker.getResolvedSignature(expression);

package/plugins/transform_luabind_class/transformation/utils.d.ts

@@ -1,30 +1,53 @@
-import { ClassLikeDeclaration, ClassLikeDeclarationBase, Expression, ExpressionWithTypeArguments, HasModifiers, HeritageClause, Type } from "typescript";
-import { TransformationContext } from "typescript-to-lua";
+import { type ClassLikeDeclaration, type ClassLikeDeclarationBase, type Expression, type ExpressionWithTypeArguments, type HasModifiers, type HeritageClause, type Type } from "typescript";
+import { type TransformationContext } from "typescript-to-lua";
 /**
- * Whether method / field is static.
+ * Whether a method or field is static.
+ *
+ * @param node - Node with modifiers to check.
+ * @returns True when the node is marked static.
  */
 export declare function isStaticNode(node: HasModifiers): boolean;
 /**
  * Get class extends node.
+ *
+ * @param node - Class declaration to read.
+ * @returns Extends clause of the class, if any.
  */
 export declare function getExtendsClause(node: ClassLikeDeclarationBase): HeritageClause | undefined;
 /**
  * Get class extended node.
+ *
+ * @param node - Class declaration to read.
+ * @returns First extended type node, if any.
  */
 export declare function getExtendedNode(node: ClassLikeDeclarationBase): ExpressionWithTypeArguments | undefined;
 /**
- * Get class extended node.
+ * Get the resolved type of the extended class.
+ *
+ * @param context - Active transformation context.
+ * @param node - Class declaration to read.
+ * @returns Resolved type of the extended class, if any.
  */
 export declare function getExtendedType(context: TransformationContext, node: ClassLikeDeclarationBase): Type | undefined;
 /**
  * Check if class is decorated with provided decorator name.
+ *
+ * @param declaration - Class declaration to inspect.
+ * @returns True when the class carries the luabind decorator.
  */
 export declare function isLuabindDecoratedClass(declaration: ClassLikeDeclaration): boolean;
 /**
  * Mark provided class as Luabind target.
+ *
+ * @param declaration - Class declaration to mark.
+ * @param context Active transformation context.
  */
 export declare function markTypeAsLuabind(declaration: ClassLikeDeclaration, context: TransformationContext): void;
 /**
  * Check if provided class is specified as LuaBind.
+ *
+ * @param declaration - Class declaration or expression to inspect.
+ * @param context - Active transformation context.
+ * @returns True when the class is a luabind target.
  */
 export declare function isLuabindClassType(declaration: Expression | ClassLikeDeclaration, context: TransformationContext): boolean;

package/plugins/transform_luabind_class/transformation/utils.js

@@ -10,19 +10,28 @@ exports.isLuabindClassType = isLuabindClassType;
 const typescript_1 = require("typescript");
 const constants_1 = require("./constants");
 /**
- * Whether method / field is static.
+ * Whether a method or field is static.
+ *
+ * @param node - Node with modifiers to check.
+ * @returns True when the node is marked static.
  */
 function isStaticNode(node) {
     return node.modifiers?.some((m) => m.kind === typescript_1.SyntaxKind.StaticKeyword) === true;
 }
 /**
  * Get class extends node.
+ *
+ * @param node - Class declaration to read.
+ * @returns Extends clause of the class, if any.
  */
 function getExtendsClause(node) {
     return node.heritageClauses?.find((clause) => clause.token === typescript_1.SyntaxKind.ExtendsKeyword);
 }
 /**
  * Get class extended node.
+ *
+ * @param node - Class declaration to read.
+ * @returns First extended type node, if any.
  */
 function getExtendedNode(node) {
     const extendsClause = getExtendsClause(node);
@@ -31,7 +40,11 @@ function getExtendedNode(node) {
     return extendsClause.types[0];
 }
 /**
- * Get class extended node.
+ * Get the resolved type of the extended class.
+ *
+ * @param context - Active transformation context.
+ * @param node - Class declaration to read.
+ * @returns Resolved type of the extended class, if any.
  */
 function getExtendedType(context, node) {
     const extendedNode = getExtendedNode(node);
@@ -39,6 +52,9 @@ function getExtendedType(context, node) {
 }
 /**
  * Check if class is decorated with provided decorator name.
+ *
+ * @param declaration - Class declaration to inspect.
+ * @returns True when the class carries the luabind decorator.
  */
 function isLuabindDecoratedClass(declaration) {
     const decorators = (0, typescript_1.getDecorators)(declaration);
@@ -49,6 +65,9 @@ function isLuabindDecoratedClass(declaration) {
 }
 /**
  * Mark provided class as Luabind target.
+ *
+ * @param declaration - Class declaration to mark.
+ * @param context Active transformation context.
  */
 function markTypeAsLuabind(declaration, context) {
     const typeAtLocation = context.checker.getTypeAtLocation(declaration);
@@ -57,6 +76,10 @@ function markTypeAsLuabind(declaration, context) {
 }
 /**
  * Check if provided class is specified as LuaBind.
+ *
+ * @param declaration - Class declaration or expression to inspect.
+ * @param context - Active transformation context.
+ * @returns True when the class is a luabind target.
  */
 function isLuabindClassType(declaration, context) {
     const typeAtLocation = context.checker.getTypeAtLocation(declaration);

package/plugins/utils/ast.d.ts

@@ -1,2 +1,2 @@
-import { Identifier, StringLiteral } from "typescript";
+import { type Identifier, type StringLiteral } from "typescript";
 export declare function getIdentifierText(node: Identifier | StringLiteral): string;

package/plugins/utils/diagnostics.d.ts

@@ -1,12 +1,16 @@
-import { DiagnosticCategory, Node } from "typescript";
-type MessageProvider<TArgs extends any[]> = string | ((...args: TArgs) => string);
+import { DiagnosticCategory, type Node } from "typescript";
+type MessageProvider<TArgs extends Array<any>> = string | ((...args: TArgs) => string);
 /**
- * Create diagnostics factory to push errors when transpile lua to typescript.
+ * Create a factory that builds diagnostics for transformation errors.
+ *
+ * @param category - Severity assigned to produced diagnostics.
+ * @param message - Static message or a function that builds it.
+ * @returns Factory that creates a diagnostic for a given node.
  */
-export declare function createDiagnosticFactory<TArgs extends any[]>(category: DiagnosticCategory, message: MessageProvider<TArgs>): ((node: Node, ...args: TArgs) => import("typescript").Diagnostic) & {
+export declare function createDiagnosticFactory<TArgs extends Array<any>>(category: DiagnosticCategory, message: MessageProvider<TArgs>): ((node: Node, ...args: TArgs) => import("typescript").Diagnostic) & {
     code: number;
 };
-export declare function createErrorDiagnosticFactory<TArgs extends any[]>(message: MessageProvider<TArgs>): ((node: Node, ...args: TArgs) => import("typescript").Diagnostic) & {
+export declare function createErrorDiagnosticFactory<TArgs extends Array<any>>(message: MessageProvider<TArgs>): ((node: Node, ...args: TArgs) => import("typescript").Diagnostic) & {
     code: number;
 };
 export {};

package/plugins/utils/diagnostics.js

@@ -5,7 +5,11 @@ exports.createErrorDiagnosticFactory = createErrorDiagnosticFactory;
 const typescript_1 = require("typescript");
 const utils_1 = require("typescript-to-lua/dist/utils");
 /**
- * Create diagnostics factory to push errors when transpile lua to typescript.
+ * Create a factory that builds diagnostics for transformation errors.
+ *
+ * @param category - Severity assigned to produced diagnostics.
+ * @param message - Static message or a function that builds it.
+ * @returns Factory that creates a diagnostic for a given node.
  */
 function createDiagnosticFactory(category, message) {
     return (0, utils_1.createSerialDiagnosticFactory)((node, ...args) => ({

package/plugins/utils/tracy.d.ts

@@ -1,4 +1,4 @@
-import { ArrowFunction, ExpressionStatement, FunctionDeclaration, MethodDeclaration, Node, NodeArray, Statement } from "typescript";
+import { type ArrowFunction, type ExpressionStatement, type FunctionDeclaration, type MethodDeclaration, type Node, type NodeArray, type Statement } from "typescript";
 export declare function isTraceBeginExpression(node: Node): boolean;
 export declare function isTraceEndExpression(node: Node): boolean;
 export declare function createTraceZoneBeginExpression(): ExpressionStatement;

package/types/index.d.ts

@@ -1,55 +1,55 @@
-import "./xr_ai/xr_action";
-import "./xr_ai/xr_alife";
-import "./xr_ai/xr_enemy_evaluation";
-import "./xr_ai/xr_goap";
-import "./xr_ai/xr_graph";
-import "./xr_ai/xr_memory";
-
-import "./xr_lib/xr_animation";
-import "./xr_lib/xr_bitwise";
-import "./xr_lib/xr_color";
-import "./xr_lib/xr_debug";
-import "./xr_lib/xr_dialog";
-import "./xr_lib/xr_flags";
-import "./xr_lib/xr_fs";
-import "./xr_lib/xr_game";
-import "./xr_lib/xr_hit";
-import "./xr_lib/xr_ini";
-import "./xr_lib/xr_level";
-import "./xr_lib/xr_luabind";
-import "./xr_lib/xr_map";
-import "./xr_lib/xr_math";
-import "./xr_lib/xr_multiplayer";
-import "./xr_lib/xr_profile";
-import "./xr_lib/xr_properties";
-import "./xr_lib/xr_relation";
-import "./xr_lib/xr_render";
-import "./xr_lib/xr_save";
-import "./xr_lib/xr_sound";
-import "./xr_lib/xr_stats";
-import "./xr_lib/xr_task";
-import "./xr_lib/xr_time";
-import "./xr_lib/xr_type";
-
-import "./xr_object/client/xr_anomaly";
-import "./xr_object/client/xr_artefact";
-import "./xr_object/client/xr_client_object";
-import "./xr_object/client/xr_creature";
-import "./xr_object/client/xr_item";
-import "./xr_object/client/xr_level";
-import "./xr_object/client/xr_physic";
-import "./xr_object/client/xr_zone";
-import "./xr_object/script/xr_script_interface";
-import "./xr_object/script/xr_script_object";
-import "./xr_object/script/xr_script_trade";
-import "./xr_object/server/xr_server_object";
-
-import "./xr_ui/xr_ui_asset";
-import "./xr_ui/xr_ui_core";
-import "./xr_ui/xr_ui_event";
-import "./xr_ui/xr_ui_interface";
-import "./xr_ui/xr_ui_menu";
-
-import "./xrf_plugin";
-
-declare module "xray16" {}
+import "./xr_ai/xr_action";
+import "./xr_ai/xr_alife";
+import "./xr_ai/xr_enemy_evaluation";
+import "./xr_ai/xr_goap";
+import "./xr_ai/xr_graph";
+import "./xr_ai/xr_memory";
+
+import "./xr_lib/xr_animation";
+import "./xr_lib/xr_bitwise";
+import "./xr_lib/xr_color";
+import "./xr_lib/xr_debug";
+import "./xr_lib/xr_dialog";
+import "./xr_lib/xr_flags";
+import "./xr_lib/xr_fs";
+import "./xr_lib/xr_game";
+import "./xr_lib/xr_hit";
+import "./xr_lib/xr_ini";
+import "./xr_lib/xr_level";
+import "./xr_lib/xr_luabind";
+import "./xr_lib/xr_map";
+import "./xr_lib/xr_math";
+import "./xr_lib/xr_multiplayer";
+import "./xr_lib/xr_profile";
+import "./xr_lib/xr_properties";
+import "./xr_lib/xr_relation";
+import "./xr_lib/xr_render";
+import "./xr_lib/xr_save";
+import "./xr_lib/xr_sound";
+import "./xr_lib/xr_stats";
+import "./xr_lib/xr_task";
+import "./xr_lib/xr_time";
+import "./xr_lib/xr_type";
+
+import "./xr_object/client/xr_anomaly";
+import "./xr_object/client/xr_artefact";
+import "./xr_object/client/xr_client_object";
+import "./xr_object/client/xr_creature";
+import "./xr_object/client/xr_item";
+import "./xr_object/client/xr_level";
+import "./xr_object/client/xr_physic";
+import "./xr_object/client/xr_zone";
+import "./xr_object/script/xr_script_interface";
+import "./xr_object/script/xr_script_object";
+import "./xr_object/script/xr_script_trade";
+import "./xr_object/server/xr_server_object";
+
+import "./xr_ui/xr_ui_asset";
+import "./xr_ui/xr_ui_core";
+import "./xr_ui/xr_ui_event";
+import "./xr_ui/xr_ui_interface";
+import "./xr_ui/xr_ui_menu";
+
+import "./xrf_plugin";
+
+declare module "xray16" {}