Detecting types derived from array by TheLartians · Pull Request #289 · TypeScriptToLua/TypeScriptToLua

TheLartians · 2018-11-30T00:08:35Z

Allow the transpiler to detect types derived from array. This allows us to easily create interfaces for array-like types implemented in lua and get a coherent typescript-style interface while retaining the original functionality.

Oversimplified example

An array with a clear method:

function ClearableArray()
  local data = {}
  return setmetatable({ 
    clear = function() data = {} end
  },{
    __index = function(self,key) return data[key] end,
    __newindex = function(self,key,value) data[key] = value end,
    __len = function() return #data end
  })
end

Typescript interface:

declare interface ClearableArray extends Array<any>{
  clear():void
}
declare function ClearableArray():ClearableArray

Usage:

let a = ClearableArray()
a[0] = 1
a.push(2)
print(a.length) // 2
a.clear()
print(a.length) // 0

Perryvw

Would be nice if you could add one or two tests for this.

src/Transpiler.ts

src/TSHelper.ts

src/Transpiler.ts

TheLartians · 2018-11-30T12:32:31Z

I added a translation test to see if the array base detection is working. Doing so I noticed that it won't work if the derived array class is generic, e.g. declare interface CustomArray<T> extends Array<T>{ };. In this case type.getBaseTypes() will return undefined. Is there a way to find bases of generics?

Perryvw · 2018-11-30T12:49:24Z

I prefer functional unit tests over translation tests. You can find bases of generic types using type.typeName/type.typeArguments, try putting const abc : Array<string> = []; into https://ts-ast-viewer.com/

TheLartians · 2018-11-30T13:40:57Z

I prefer functional unit tests over translation tests.

I added a unit test for the derived array type.

You can find bases of generic types using type.typeName/type.typeArguments

Won't type.typeArguments just give me the generic's argument though?

Perryvw · 2018-12-01T18:58:40Z

src/TSHelper.ts

        return [false, null, null];
    }
+
+    public static isDefaultArrayCallExpression(node: ts.CallExpression,


I would just pass in a string and implement this as a Set.has(functionString), then do the transpilation before passing in the value. I don't think there is any real need for the actual node over the function name in this function?

Sure, that would work as well. In this case I replicated the implementation of transpiler.transpileArrayCallExpression to match the existing coding style.

The reason I don't like this is you are effectively moving part of the transpilation process into TSHelper, which is supposed to only contain helper methods for the transpiler.

Perryvw · 2018-12-02T13:36:00Z

Assignments.ts translation test was removed, please make sure your cases are covered by functional tests and remove the file from your branch too to solve the conflict.

TheLartians · 2018-12-02T14:07:21Z

I changed isDefaultArrayCall(node) to isDefaultArrayCallMethodName(string) to keep the transpilation process separated from the helper functions.
The Assignments.ts translation test is removed and this case is still covered by the unit test.

* converting 'else if' statements to lua 'elseif' instead of nested ifs (#254) * Const enum support (#253) * Const enum support * Changed string concatenation to interpolation * refactored try block to allow rethrow (#251) * refactored try block to allow rethrow * updated rethrow test with something less convoluted * Made LuaJIT use table.unpack for destructing assignments (#257) * Fixed JIT using table.unpack (#258) * Fixed JIT using table.unpack sry * Fixed test for JIT unpack * Moved transpileDestructingAssignmentValue from 5.1 to 5.0 * Moved transpile switch to Lua 5.2 (#259) * Moved transpile switch to Lua 5.2 Closes #194 * Fixed typo * Cleaned up ForOf code (#260) * Cleaned up forOf loop, made it use numeric loop instead of ipairs * Fixed bug in non-array loop header and fixed tests * Fixed up some PR comments * passing nil instead of _G as context for global functions when in ES strict mode * fixed logic for determining strict mode * replaced hack-around when passing nil as a function context with a null keyword * testing viability of wrapping context/no-context calls on assignment * working on more function assignment situations * Fix error in module namespace enum exporting (#272) * fixed getting constructor signature and refactored things a bit * checking resolved signature when comparing function types passed as arguments * 0.11.0 * Update CHANGELOG.md * Luajit unpack fix (#273) * LuaJIT uses LuaTranspiler's spread * Added some unit tests for spreading * Stopped using prototype * Removed Transpiler import * Fixed constructor overloads (#275) * Fixed constructor overloads Fixes #274 * Removed lambda body * Removed transpileFile (should be added to changelog since this was exposed in the API) * Lualib omit when unused (#280) * lualib inline omit header when no features are used * Tests to enforce no lualib text when unused, unless using always * Fixed bug with default values for constructor parameters * 0.11.1 * working on assignment checks for methods vs functions * handling context in calls and decls * refactoring and handling tuple destructuring * generalized tuple assignment checking * overloads with function and method signatures default to functions now * preventing non-methods from being passed to bind/call/apply * removed uneccessary helpers * using proper exceptions for function conversion errors * removed context arg from custom constructors and added check for assigning to untyped vars * updated tests * removing leftover NoContext decorators * Added discord badge and link to readme * Added support for JSDoc tags as decorators * Fixed invalid jsdoc failing a test * Added deprecation warning for ! decorators * Refactored decorator creation, made decorators case-insensitive * Fixed jsdoc tests * Fixed test runner not failing * recursing into interfaces during assignment validation * Update README.md * fixes for issues with overloads using different context types * Fixed casing and symbol of decorators to be consistent with the new convention * less-lazy variable naming and improved error message * removing assignments translation test (#296) * Create CONTRIBUTING.md * Update README.md * Detecting types derived from array (#289) * check the base types to determine if a type inherits from Array<T> * dont block exceptions * remove empty else clause * remove space * added tsHelper.isDefaultArrayCallExpression() * added derived array recognition test code * Added isExplicitArrayType() method * added unit test * rewrite isDefaultArrayCall() -> isDefaultArrayCallMethodName() * change switch statement to Set<string> lookup * 0.12.0 * stabilize package lock * Check inherited accessors (#297) * check for inherited accessor methods * diversify test * removed FocusTests and repositioned forAllTypes * rename forTypeOrAnySupertype * Fixed default constructor on subclass (#301) * Use declared types (#302) * update forTypeOrAnySupertype() to use declared type * added test case for accessor using this * enhance test to use generics * 0.12.1 * suite of tests for new functions and fixes for edge-cases found * validating return values and hanlding inference of contexts when passing functions as arguments or return values * renamed getFunctionReturnType to getContainingFunctionReturnType * handling more edge cases, adding more tests and a little bit of refactoring

check the base types to determine if a type inherits from Array<T>

0db2d73

TheLartians changed the title ~~Extending Array~~ Detecting types derived from array Nov 30, 2018

dont block exceptions

bd43ab0

Perryvw requested changes Nov 30, 2018

View reviewed changes

src/Transpiler.ts Outdated Show resolved Hide resolved

src/TSHelper.ts Outdated Show resolved Hide resolved

src/TSHelper.ts Outdated Show resolved Hide resolved

src/Transpiler.ts Outdated Show resolved Hide resolved

TheLartians added 5 commits November 30, 2018 11:11

remove empty else clause

f6e2112

remove space

258d4cf

added tsHelper.isDefaultArrayCallExpression()

0c497e1

added derived array recognition test code

4dd2169

Merge https://github.com/Perryvw/TypescriptToLua

dbe66fc

TheLartians added 2 commits November 30, 2018 13:57

Added isExplicitArrayType() method

2f4495b

added unit test

d21091d

Perryvw reviewed Dec 1, 2018

View reviewed changes

merge with https://github.com/Perryvw/TypescriptToLua.git

b7c31b5

TheLartians force-pushed the master branch from e74dd39 to b7c31b5 Compare December 2, 2018 13:42

rewrite isDefaultArrayCall() -> isDefaultArrayCallMethodName()

47c45e0

change switch statement to Set<string> lookup

e0f272b

Perryvw approved these changes Dec 2, 2018

View reviewed changes

Perryvw merged commit a4f1f56 into TypeScriptToLua:master Dec 2, 2018

TheLartians mentioned this pull request Dec 17, 2018

allow non-default properties with derived array types #308

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Detecting types derived from array#289

Detecting types derived from array#289
Perryvw merged 12 commits intoTypeScriptToLua:masterfrom
TheLartians:master

TheLartians commented Nov 30, 2018

Uh oh!

Perryvw left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheLartians commented Nov 30, 2018 •

edited

Loading

Uh oh!

Perryvw commented Nov 30, 2018

Uh oh!

TheLartians commented Nov 30, 2018

Uh oh!

Perryvw Dec 1, 2018

Uh oh!

TheLartians Dec 2, 2018

Uh oh!

Perryvw Dec 2, 2018

Uh oh!

Perryvw commented Dec 2, 2018

Uh oh!

TheLartians commented Dec 2, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

TheLartians commented Nov 30, 2018

Uh oh!

Perryvw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TheLartians commented Nov 30, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Perryvw commented Nov 30, 2018

Uh oh!

TheLartians commented Nov 30, 2018

Uh oh!

Perryvw Dec 1, 2018

Choose a reason for hiding this comment

Uh oh!

TheLartians Dec 2, 2018

Choose a reason for hiding this comment

Uh oh!

Perryvw Dec 2, 2018

Choose a reason for hiding this comment

Uh oh!

Perryvw commented Dec 2, 2018

Uh oh!

TheLartians commented Dec 2, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

TheLartians commented Nov 30, 2018 •

edited

Loading