xray16 1.5.4 → 1.6.1

package/README.md

@@ -61,6 +61,7 @@ Plugins can be included in [tstl tsconfig](https://typescripttolua.github.io/doc
       { "name": "xray16/plugins/strip_lua_logger" },
       { "name": "xray16/plugins/inject_filename" },
       { "name": "xray16/plugins/from_cast_utils" },
+      { "name": "xray16/plugins/optimize_return_ternary" },
       { "name": "xray16/plugins/inject_tracy_zones" }
     ]
   }
@@ -106,6 +107,11 @@ Lua does not provide convenient API do get filename in runtime and static step i
 Plugin to simplify casting from `LuaTable` to typescript array/map objects.\
 All the calls are completely gets stripped and removed from runtime.
 
+### optimize_return_ternary
+
+Plugin rewrites returned ternary expressions into direct `if` / `else` branch returns when it is safe.\
+This avoids temporary result locals for patterns like `return condition ? first : second` while preserving general ternary semantics.
+
 ### inject_tracy_zones
 
 Plugin designed to work specifically with [tracy profiler](https://github.com/wolfpld/tracy).\

package/package.json

@@ -1,15 +1,19 @@
 {
   "name": "xray16",
-  "version": "1.5.4",
+  "version": "1.6.1",
   "author": "Neloreck",
   "repository": "https://github.com/xray-forge/xray-16-types",
+  "homepage": "https://xray-forge.github.io/xray-16-types/index.html",
   "private": false,
-  "main": "types/index.d.ts",
-  "types": "types/index.d.ts",
+  "main": "xray16.d.ts",
+  "types": "xray16.d.ts",
   "scripts": {
-    "prepublish": "npm run build:plugins",
+    "prepublish": "npm run build",
+    "prepack": "npm run build",
+    "build": "npm run build:plugins && npm run build:types",
     "build:plugins": "tsc -p ./src/tsconfig.json",
-    "build:types": "typedoc",
+    "build:types": "rollup -c rollup.dts.config.mjs",
+    "build:docs": "typedoc",
     "typecheck": "tsc --noEmit",
     "typedoc": "typedoc",
     "format": "prettier --write \"**/*.(js|ts|tsx|md)\" && eslint . --fix",
@@ -31,6 +35,8 @@
     "eslint-plugin-jsdoc": "^63.0.7",
     "globals": "^17.7.0",
     "prettier": "^3.4.2",
+    "rollup": "^4.62.2",
+    "rollup-plugin-dts": "^6.4.1",
     "typedoc": "^0.27.5",
     "typescript": "5.7.2",
     "typescript-eslint": "^8.62.0",
@@ -38,7 +44,7 @@
   },
   "files": [
     "plugins/**/*",
-    "types/**/*",
+    "xray16.d.ts",
     "README.md",
     "LICENSE"
   ]

package/plugins/optimize_return_ternary.d.ts

@@ -0,0 +1,6 @@
+import { type Plugin } from "typescript-to-lua";
+/**
+ * Plugin that rewrites returned ternary expressions as direct branch returns.
+ */
+declare const plugin: Plugin;
+export default plugin;

package/plugins/optimize_return_ternary.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ts = require("typescript");
+const lua = require("typescript-to-lua");
+const assignment_validation_1 = require("typescript-to-lua/dist/transformation/utils/assignment-validation");
+const preceding_statements_1 = require("typescript-to-lua/dist/transformation/utils/preceding-statements");
+const conditional_1 = require("typescript-to-lua/dist/transformation/visitors/conditional");
+const multi_1 = require("typescript-to-lua/dist/transformation/visitors/language-extensions/multi");
+const return_1 = require("typescript-to-lua/dist/transformation/visitors/return");
+function getConditionalExpression(expression) {
+    let current = expression;
+    while (ts.isParenthesizedExpression(current) ||
+        ts.isAsExpression(current) ||
+        ts.isTypeAssertionExpression(current) ||
+        ts.isNonNullExpression(current) ||
+        ts.isSatisfiesExpression(current)) {
+        current = current.expression;
+    }
+    return ts.isConditionalExpression(current) ? current : null;
+}
+function hasMultiReturnBranch(context, expression) {
+    return ((0, multi_1.isMultiReturnType)(context.checker.getTypeAtLocation(expression.whenTrue)) ||
+        (0, multi_1.isMultiReturnType)(context.checker.getTypeAtLocation(expression.whenFalse)));
+}
+function transformExpressionToReturnStatements(context, statement, expression) {
+    const conditionalExpression = getConditionalExpression(expression);
+    if (conditionalExpression !== null && !hasMultiReturnBranch(context, conditionalExpression)) {
+        return transformConditionalReturnStatement(context, statement, conditionalExpression);
+    }
+    const value = (0, preceding_statements_1.transformInPrecedingStatementScope)(context, () => context.transformExpression(expression));
+    return [...value.precedingStatements, (0, return_1.createReturnStatement)(context, [value.result], statement)];
+}
+function transformConditionalReturnStatement(context, statement, expression) {
+    (0, conditional_1.checkOnlyTruthyCondition)(expression.condition, context);
+    const condition = (0, preceding_statements_1.transformInPrecedingStatementScope)(context, () => context.transformExpression(expression.condition));
+    const whenTrue = transformExpressionToReturnStatements(context, statement, expression.whenTrue);
+    const whenFalse = transformExpressionToReturnStatements(context, statement, expression.whenFalse);
+    return [
+        ...condition.precedingStatements,
+        lua.createIfStatement(condition.result, lua.createBlock(whenTrue), lua.createBlock(whenFalse), expression),
+    ];
+}
+/**
+ * Plugin that rewrites returned ternary expressions as direct branch returns.
+ */
+const plugin = {
+    visitors: {
+        [ts.SyntaxKind.ReturnStatement]: (statement, context) => {
+            if (statement.expression === undefined) {
+                return context.superTransformStatements(statement);
+            }
+            const expression = getConditionalExpression(statement.expression);
+            if (expression === null || hasMultiReturnBranch(context, expression)) {
+                return context.superTransformStatements(statement);
+            }
+            const expressionType = context.checker.getTypeAtLocation(statement.expression);
+            const returnType = context.checker.getContextualType(statement.expression);
+            if (returnType !== undefined) {
+                (0, assignment_validation_1.validateAssignment)(context, statement, expressionType, returnType);
+            }
+            return transformConditionalReturnStatement(context, statement, expression);
+        },
+    },
+};
+exports.default = plugin;