Fixed language extensions LuaTable keys required to be tables (#1034)

Perryvw · web-flow · commit 5b673302e661 · 2021-06-13T22:48:48.000+02:00
* Fixed another mistake in language extensions where luatable keys were accidentally required to be tables

* update snapshot names
diff --git a/language-extensions/index.d.ts b/language-extensions/index.d.ts
@@ -535,7 +535,7 @@ declare type LuaTableDeleteMethod<TKey extends AnyNotNil> = ((key: TKey) => bool
  * @param TKey The type of the keys used to access the table.
  * @param TValue The type of the values stored in the table.
  */
-declare interface LuaTable<TKey extends AnyTable = AnyNotNil, TValue = any> {
+declare interface LuaTable<TKey extends AnyNotNil = AnyNotNil, TValue = any> {
     length: LuaLengthMethod<number>;
     get: LuaTableGetMethod<TKey, TValue>;
     set: LuaTableSetMethod<TKey, TValue>;
diff --git a/test/unit/language-extensions/__snapshots__/table.spec.ts.snap b/test/unit/language-extensions/__snapshots__/table.spec.ts.snap
@@ -1,5 +1,51 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("null"): code 1`] = `
+"local ____exports = {}
+____exports.__result = {}
+return ____exports"
+`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("null"): diagnostics 1`] = `"main.ts(1,38): error TS2344: Type 'null' does not satisfy the constraint 'AnyNotNil'."`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("number | undefined"): code 1`] = `
+"local ____exports = {}
+____exports.__result = {}
+return ____exports"
+`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("number | undefined"): diagnostics 1`] = `
+"main.ts(1,38): error TS2344: Type 'number | undefined' does not satisfy the constraint 'AnyNotNil'.
+  Type 'undefined' is not assignable to type 'AnyNotNil'."
+`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("string | null"): code 1`] = `
+"local ____exports = {}
+____exports.__result = {}
+return ____exports"
+`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("string | null"): diagnostics 1`] = `
+"main.ts(1,38): error TS2344: Type 'string | null' does not satisfy the constraint 'AnyNotNil'.
+  Type 'null' is not assignable to type 'AnyNotNil'."
+`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("undefined"): code 1`] = `
+"local ____exports = {}
+____exports.__result = {}
+return ____exports"
+`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("undefined"): diagnostics 1`] = `"main.ts(1,38): error TS2344: Type 'undefined' does not satisfy the constraint 'AnyNotNil'."`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("unknown"): code 1`] = `
+"local ____exports = {}
+____exports.__result = {}
+return ____exports"
+`;
+
+exports[`LuaTable extension interface LuaTable in strict mode does not accept key type that could be nil ("unknown"): diagnostics 1`] = `"main.ts(1,38): error TS2344: Type 'unknown' does not satisfy the constraint 'AnyNotNil'."`;
+
 exports[`LuaTableDelete extension LuaTableDelete invalid use as expression ("const foo = [tableDelete({}, \\"foo\\")];"): code 1`] = `
 "foo = {
     (function()
diff --git a/test/unit/language-extensions/table.spec.ts b/test/unit/language-extensions/table.spec.ts
@@ -254,6 +254,29 @@ describe("LuaTable extension interface", () => {
             .expectToEqual(3);
     });
 
+    // Test to catch issue from https://github.com/TypeScriptToLua/TypeScriptToLua/issues/1033
+    test("typed table in type declaration", () => {
+        util.testFunction`
+            function fill(tbl: LuaTable<string, number>) {
+                tbl.set("foo", 3);
+                return tbl;
+            }
+            return fill(new LuaTable()).get("foo");
+        `
+            .setOptions(tableProjectOptions)
+            .expectToEqual(3);
+    });
+
+    test.each([["null"], ["undefined"], ["number | undefined"], ["string | null"], ["unknown"]])(
+        "LuaTable in strict mode does not accept key type that could be nil (%p)",
+        keyType => {
+            util.testExpression`new LuaTable<${keyType}, unknown>()`
+                .setOptions({ ...tableProjectOptions, strict: true })
+                .expectToHaveDiagnostics()
+                .expectDiagnosticsToMatchSnapshot();
+        }
+    );
+
     test("object keyed table", () => {
         util.testFunction`
             interface Key { keyStr: string }
