Added string.includes (#971)

Author: lolleko

src/LuaLib.ts

@@ -69,6 +69,7 @@ export enum LuaLibFeature {
     StringCharCodeAt = "StringCharCodeAt",
     StringConcat = "StringConcat",
     StringEndsWith = "StringEndsWith",
+    StringIncludes = "StringIncludes",
     StringPadEnd = "StringPadEnd",
     StringPadStart = "StringPadStart",
     StringReplace = "StringReplace",

src/lualib/StringIncludes.ts

@@ -0,0 +1,9 @@
+function __TS__StringIncludes(this: string, searchString: string, position?: number): boolean {
+    // http://lua-users.org/wiki/StringLibraryTutorial
+    if (!position) {
+        position = 1;
+    } else {
+        position += 1;
+    }
+    return string.find(this, searchString, position, true) !== undefined;
+}

src/lualib/declarations/string.d.ts

@@ -14,4 +14,10 @@ declare namespace string {
     function sub(s: string, i: number, j?: number): string;
     function format(formatstring: string, ...args: any[]): string;
     function match(string: string, pattern: string): string;
+    function find(
+        string: string,
+        pattern: string,
+        start?: number,
+        plainflag?: boolean
+    ): MultiReturn<[number, number]> | undefined;
 }

src/transformation/builtins/string.ts

@@ -129,6 +129,8 @@ export function transformStringPrototypeCall(
             return transformLuaLibFunction(context, LuaLibFeature.StringStartsWith, node, caller, ...params);
         case "endsWith":
             return transformLuaLibFunction(context, LuaLibFeature.StringEndsWith, node, caller, ...params);
+        case "includes":
+            return transformLuaLibFunction(context, LuaLibFeature.StringIncludes, node, caller, ...params);
         case "repeat":
             const math = lua.createIdentifier("math");
             const floor = lua.createStringLiteral("floor");

test/unit/builtins/string.spec.ts

@@ -240,6 +240,7 @@ test.each([
 test.each<{ inp: string; args: Parameters<string["startsWith"]> }>([
     { inp: "hello test", args: [""] },
     { inp: "hello test", args: ["hello"] },
+    { inp: "HELLO test", args: ["hello"] },
     { inp: "hello test", args: ["test"] },
     { inp: "hello test", args: ["test", 6] },
 ])("string.startsWith (%p)", ({ inp, args }) => {
@@ -249,12 +250,25 @@ test.each<{ inp: string; args: Parameters<string["startsWith"]> }>([
 test.each<{ inp: string; args: Parameters<string["endsWith"]> }>([
     { inp: "hello test", args: [""] },
     { inp: "hello test", args: ["test"] },
+    { inp: "hello TEST", args: ["test"] },
     { inp: "hello test", args: ["hello"] },
     { inp: "hello test", args: ["hello", 5] },
 ])("string.endsWith (%p)", ({ inp, args }) => {
     util.testExpression`"${inp}".endsWith(${util.formatCode(...args)})`.expectToMatchJsResult();
 });
 
+test.each<{ inp: string; args: Parameters<string["includes"]> }>([
+    { inp: "hello test", args: [""] },
+    { inp: "hello test", args: ["test"] },
+    { inp: "HELLO TEST", args: ["test"] },
+    { inp: "hello test", args: ["hello"] },
+    { inp: "HELLO TEST", args: ["hello"] },
+    { inp: "hello test", args: ["hello", 5] },
+    { inp: "hello test", args: ["test", 6] },
+])("string.includes (%p)", ({ inp, args }) => {
+    util.testExpression`"${inp}".includes(${util.formatCode(...args)})`.expectToMatchJsResult();
+});
+
 test.each([
     { inp: "hello test", count: 0 },
     { inp: "hello test", count: 1 },