brighterscript 0.66.0-alpha.0 → 0.66.0-alpha.10

package/dist/files/BrsFile.Class.spec.js

@@ -64,6 +64,27 @@ describe('BrsFile BrighterScript classes', () => {
             DiagnosticMessages_1.DiagnosticMessages.classConstructorMissingSuperCall()
         ]);
     });
+    it('allows class named `optional`', () => {
+        program.setFile('source/main.bs', `
+            class optional
+                thing = 1
+            end class
+        `);
+        program.validate();
+        (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+    });
+    it('supports optional fields', () => {
+        program.setFile('source/main.bs', `
+            class Movie
+                name as string
+                optional subtitles as string
+                public optional isRepeatEnabled as boolean
+                private optional wasPlayed
+            end class
+        `);
+        program.validate();
+        (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
+    });
     it('access modifier is option for override', () => {
         let file = program.setFile({ src: `${testHelpers_spec_2.rootDir}/source/main.bs`, dest: 'source/main.bs' }, `
             class Animal
@@ -143,7 +164,7 @@ describe('BrsFile BrighterScript classes', () => {
                     end sub
                 end class
                 class Duck extends Bird
-                    sub new()
+                    sub new(name)
                         thing = { m: "m"}
                         print thing.m
                         name = "Donald" + "Duck"
@@ -157,18 +178,20 @@ describe('BrsFile BrighterScript classes', () => {
         it('allows non-`m` expressions and statements before the super call', () => {
             program.setFile('source/main.bs', `
                 class Bird
-                    sub new(name)
+                    name as string
+                    sub new(name as string)
+                        m.name = name
                     end sub
                 end class
                 class Duck extends Bird
                     sub new()
                         m.name = m.name + "Duck"
-                        super()
+                        super("Flappy")
                     end sub
                 end class
             `);
             program.validate();
-            (0, testHelpers_spec_1.expectDiagnostics)(program, [Object.assign(Object.assign({}, DiagnosticMessages_1.DiagnosticMessages.classConstructorIllegalUseOfMBeforeSuperCall()), { range: vscode_languageserver_1.Range.create(7, 24, 7, 25) }), Object.assign(Object.assign({}, DiagnosticMessages_1.DiagnosticMessages.classConstructorIllegalUseOfMBeforeSuperCall()), { range: vscode_languageserver_1.Range.create(7, 33, 7, 34) })]);
+            (0, testHelpers_spec_1.expectDiagnostics)(program, [Object.assign(Object.assign({}, DiagnosticMessages_1.DiagnosticMessages.classConstructorIllegalUseOfMBeforeSuperCall()), { range: vscode_languageserver_1.Range.create(9, 24, 9, 25) }), Object.assign(Object.assign({}, DiagnosticMessages_1.DiagnosticMessages.classConstructorIllegalUseOfMBeforeSuperCall()), { range: vscode_languageserver_1.Range.create(9, 33, 9, 34) })]);
         });
     });
     describe('transpile', () => {
@@ -184,22 +207,22 @@ describe('BrsFile BrighterScript classes', () => {
                 end class
             `);
             (0, chai_config_spec_1.expect)(file.ast.statements[1].body[0].func.body.statements[0].expression.callee.name.text).to.eql('super');
-            await program.transpile([], testHelpers_spec_2.stagingDir);
+            await program.getTranspiledFileContents(file.srcPath);
             (0, chai_config_spec_1.expect)(file.ast.statements[1].body[0].func.body.statements[0].expression.callee.name.text).to.eql('super');
         });
-        it('follows correct sequence for property initializers', () => {
-            testTranspile(`
+        it('follows correct sequence for property initializers', async () => {
+            await testTranspile(`
                 class Animal
                     species1 = "Animal"
                     sub new()
-                        print "From Animal: " + m.species
+                        print "From Animal: " + m.species1
                     end sub
                 end class
                 class Duck extends Animal
                     species2 = "Duck"
                     sub new()
                         super()
-                        print "From Duck: " + m.species
+                        print "From Duck: " + m.species2
                     end sub
                 end class
             `, `
@@ -207,7 +230,7 @@ describe('BrsFile BrighterScript classes', () => {
                     instance = {}
                     instance.new = sub()
                         m.species1 = "Animal"
-                        print "From Animal: " + m.species
+                        print "From Animal: " + m.species1
                     end sub
                     return instance
                 end function
@@ -222,7 +245,7 @@ describe('BrsFile BrighterScript classes', () => {
                     instance.new = sub()
                         m.super0_new()
                         m.species2 = "Duck"
-                        print "From Duck: " + m.species
+                        print "From Duck: " + m.species2
                     end sub
                     return instance
                 end function
@@ -233,8 +256,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, 'trim', 'source/main.bs');
         });
-        it('allows comments as first line of constructor', () => {
-            testTranspile(`
+        it('allows comments as first line of constructor', async () => {
+            await testTranspile(`
                 class Animal
                 end class
                 class Duck extends Animal
@@ -271,8 +294,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `);
         });
-        it('does not inject a call to super if one exists', () => {
-            testTranspile(`
+        it('does not inject a call to super if one exists', async () => {
+            await testTranspile(`
                 class Animal
                 end class
                 class Duck extends Animal
@@ -309,8 +332,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `);
         });
-        it('handles class inheritance inferred constructor calls', () => {
-            testTranspile(`
+        it('handles class inheritance inferred constructor calls', async () => {
+            await testTranspile(`
                 class Animal
                     className1 = "Animal"
                 end class
@@ -363,8 +386,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, undefined, 'source/main.bs');
         });
-        it('works with namespaces', () => {
-            testTranspile(`
+        it('works with namespaces', async () => {
+            await testTranspile(`
                 namespace Birds.WaterFowl
                     class Duck
                     end class
@@ -398,8 +421,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, undefined, 'source/main.bs');
         });
-        it('works for simple  class', () => {
-            testTranspile(`
+        it('works for simple  class', async () => {
+            await testTranspile(`
                 class Duck
                 end class
             `, `
@@ -416,8 +439,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, undefined, 'source/main.bs');
         });
-        it('registers the constructor and properly handles its parameters', () => {
-            testTranspile(`
+        it('registers the constructor and properly handles its parameters', async () => {
+            await testTranspile(`
                 class Duck
                     sub new(name as string, age as integer)
                     end sub
@@ -436,11 +459,14 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, undefined, 'source/main.bs');
         });
-        it('properly handles child class constructor override and super calls', () => {
-            testTranspile(`
+        it('properly handles child class constructor override and super calls', async () => {
+            await testTranspile(`
                 class Animal
                     sub new(name as string)
                     end sub
+
+                    sub DoSomething()
+                    end sub
                 end class
 
                 class Duck extends Animal
@@ -454,6 +480,8 @@ describe('BrsFile BrighterScript classes', () => {
                     instance = {}
                     instance.new = sub(name as string)
                     end sub
+                    instance.DoSomething = sub()
+                    end sub
                     return instance
                 end function
                 function Animal(name as string)
@@ -477,8 +505,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, undefined, 'source/main.bs');
         });
-        it('transpiles super in nested blocks', () => {
-            testTranspile(`
+        it('transpiles super in nested blocks', async () => {
+            await testTranspile(`
                 class Creature
                     sub new(name as string)
                     end sub
@@ -532,7 +560,7 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, 'trim', 'source/main.bs');
         });
-        it('properly transpiles classes from outside current namespace', () => {
+        it('properly transpiles classes from outside current namespace', async () => {
             addFile('source/Animals.bs', `
                 namespace Animals
                     class Duck
@@ -541,7 +569,7 @@ describe('BrsFile BrighterScript classes', () => {
                 class Bird
                 end class
             `);
-            testTranspile(`
+            await testTranspile(`
                 namespace Animals
                     sub init()
                         donaldDuck = new Duck()
@@ -557,8 +585,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end sub
             `, undefined, 'source/main.bs');
         });
-        it('properly transpiles new statement for missing class ', () => {
-            testTranspile(`
+        it('properly transpiles new statement for missing class ', async () => {
+            await testTranspile(`
                 sub main()
                     bob = new Human()
                 end sub
@@ -568,14 +596,14 @@ describe('BrsFile BrighterScript classes', () => {
                 end sub
             `, undefined, 'source/main.bs', false);
         });
-        it('new keyword transpiles correctly', () => {
+        it('new keyword transpiles correctly', async () => {
             addFile('source/Animal.bs', `
                 class Animal
                     sub new(name as string)
                     end sub
                 end class
             `);
-            testTranspile(`
+            await testTranspile(`
                 sub main()
                     a = new Animal("donald")
                 end sub
@@ -585,8 +613,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end sub
             `, undefined, 'source/main.bs');
         });
-        it('calls super ', () => {
-            const { file } = testTranspile(`
+        it('calls super ', async () => {
+            const { file } = await testTranspile(`
                 class Parent
                     sub new()
                     end sub
@@ -625,8 +653,8 @@ describe('BrsFile BrighterScript classes', () => {
             const constructor = file.ast.statements[0].body[0];
             (0, chai_config_spec_1.expect)(constructor.func.body.statements).to.be.lengthOf(0);
         });
-        it('adds field initializers', () => {
-            const { file } = testTranspile(`
+        it('adds field initializers', async () => {
+            const { file } = await testTranspile(`
                 class Person
                     sub new()
                     end sub
@@ -650,8 +678,8 @@ describe('BrsFile BrighterScript classes', () => {
             const constructor = file.ast.statements[0].body[0];
             (0, chai_config_spec_1.expect)(constructor.func.body.statements).to.be.lengthOf(0);
         });
-        it('does not screw up local variable references', () => {
-            testTranspile(`
+        it('does not screw up local variable references', async () => {
+            await testTranspile(`
                 class Animal
                     sub new(name as string)
                         m.name = name
@@ -758,8 +786,8 @@ describe('BrsFile BrighterScript classes', () => {
                 end sub
             `, 'trim', 'source/main.bs');
         });
-        it('calculates the proper super index', () => {
-            testTranspile(`
+        it('calculates the proper super index', async () => {
+            await testTranspile(`
                 class Duck
                     public sub walk(meters as integer)
                         print "Walked " + meters.ToStr() + " meters"
@@ -807,6 +835,305 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             `, 'trim', 'source/main.bs');
         });
+        it('adds namespacing to constructors on field definitions', async () => {
+            await testTranspile(`
+                namespace MyNS
+                    class KlassOne
+                        other = new KlassTwo()
+                    end class
+
+                    class KlassTwo
+                    end class
+                end namespace
+            `, `
+                function __MyNS_KlassOne_builder()
+                    instance = {}
+                    instance.new = sub()
+                        m.other = MyNS_KlassTwo()
+                    end sub
+                    return instance
+                end function
+                function MyNS_KlassOne()
+                    instance = __MyNS_KlassOne_builder()
+                    instance.new()
+                    return instance
+                end function
+                function __MyNS_KlassTwo_builder()
+                    instance = {}
+                    instance.new = sub()
+                    end sub
+                    return instance
+                end function
+                function MyNS_KlassTwo()
+                    instance = __MyNS_KlassTwo_builder()
+                    instance.new()
+                    return instance
+                end function
+            `, 'trim', 'source/main.bs');
+        });
+        it('works with enums as field initial values inside a namespace', async () => {
+            await testTranspile(`
+                namespace MyNS
+                    class HasEnumKlass
+                        enumValue = MyEnum.A
+                    end class
+                    enum MyEnum
+                        A = "A"
+                        B = "B"
+                    end enum
+                end namespace
+            `, `
+                function __MyNS_HasEnumKlass_builder()
+                    instance = {}
+                    instance.new = sub()
+                        m.enumValue = "A"
+                    end sub
+                    return instance
+                end function
+                function MyNS_HasEnumKlass()
+                    instance = __MyNS_HasEnumKlass_builder()
+                    instance.new()
+                    return instance
+                end function
+            `, 'trim', 'source/main.bs');
+        });
+        it('allows enums as super args inside a namespace', async () => {
+            await testTranspile(`
+                namespace MyNS
+                    class SubKlass extends SuperKlass
+                        sub new()
+                            super(MyEnum.B)
+                        end sub
+                    end class
+
+                    class SuperKlass
+                        sub new(enumVal as MyEnum)
+                            print enumVal
+                        end sub
+                    end class
+
+                    enum MyEnum
+                        A = "A"
+                        B = "B"
+                    end enum
+                end namespace
+            `, `
+                function __MyNS_SubKlass_builder()
+                    instance = __MyNS_SuperKlass_builder()
+                    instance.super0_new = instance.new
+                    instance.new = sub()
+                        m.super0_new("B")
+                    end sub
+                    return instance
+                end function
+                function MyNS_SubKlass()
+                    instance = __MyNS_SubKlass_builder()
+                    instance.new()
+                    return instance
+                end function
+                function __MyNS_SuperKlass_builder()
+                    instance = {}
+                    instance.new = sub(enumVal as dynamic)
+                        print enumVal
+                    end sub
+                    return instance
+                end function
+                function MyNS_SuperKlass(enumVal as dynamic)
+                    instance = __MyNS_SuperKlass_builder()
+                    instance.new(enumVal)
+                    return instance
+                end function
+            `, 'trim', 'source/main.bs');
+        });
+        it('works with enums as values referenced in a namespace directly', async () => {
+            await testTranspile(`
+                namespace MyNS
+                    class HasEnumKlass
+                        myArray = [true, true] as boolean[]
+                        sub new()
+                            m.myArray[MyEnum.A] = true
+                            m.myArray[MyEnum.B] = false
+                        end sub
+                    end class
+                    enum MyEnum
+                        A = 0
+                        B = 1
+                    end enum
+                end namespace
+            `, `
+                function __MyNS_HasEnumKlass_builder()
+                    instance = {}
+                    instance.new = sub()
+                        m.myArray = [
+                            true
+                            true
+                        ]
+                        m.myArray[0] = true
+                        m.myArray[1] = false
+                    end sub
+                    return instance
+                end function
+                function MyNS_HasEnumKlass()
+                    instance = __MyNS_HasEnumKlass_builder()
+                    instance.new()
+                    return instance
+                end function
+            `, 'trim', 'source/main.bs');
+        });
+        it('works with enums as values referenced in a namespace with namespace', async () => {
+            await testTranspile(`
+                namespace MyNS
+                    class HasEnumKlass
+                        myArray = [true, true] as boolean[]
+                        sub new()
+                            m.myArray[MyNS.MyEnum.A] = true
+                            m.myArray[MyNS.MyEnum.B] = false
+                        end sub
+                    end class
+                    enum MyEnum
+                        A = 0
+                        B = 1
+                    end enum
+                end namespace
+            `, `
+                function __MyNS_HasEnumKlass_builder()
+                    instance = {}
+                    instance.new = sub()
+                        m.myArray = [
+                            true
+                            true
+                        ]
+                        m.myArray[0] = true
+                        m.myArray[1] = false
+                    end sub
+                    return instance
+                end function
+                function MyNS_HasEnumKlass()
+                    instance = __MyNS_HasEnumKlass_builder()
+                    instance.new()
+                    return instance
+                end function
+            `, 'trim', 'source/main.bs');
+        });
+        it('allows namespaced class function as function parameters', async () => {
+            await testTranspile(`
+                namespace Alpha
+                    function foo()
+                        return 1
+                    end function
+
+                    function callSomeFunc(f as function)
+                        return f()
+                    end function
+
+                    sub callFoo()
+                        callSomeFunc(foo)
+                    end sub
+                end namespace
+            `, `
+                function Alpha_foo()
+                    return 1
+                end function
+
+                function Alpha_callSomeFunc(f as function)
+                    return f()
+                end function
+
+                sub Alpha_callFoo()
+                    Alpha_callSomeFunc(Alpha_foo)
+                end sub
+            `, 'trim', 'source/main.bs');
+        });
+        it('allows namespaced class constructors as function parameters', async () => {
+            await testTranspile(`
+                namespace Alpha
+                    class Button
+                    end class
+
+                    function callSomeFunc(f as function)
+                        return f()
+                    end function
+
+                    sub makeButton()
+                        callSomeFunc(Button)
+                    end sub
+                end namespace
+            `, `
+                function __Alpha_Button_builder()
+                    instance = {}
+                    instance.new = sub()
+                    end sub
+                    return instance
+                end function
+                function Alpha_Button()
+                    instance = __Alpha_Button_builder()
+                    instance.new()
+                    return instance
+                end function
+
+                function Alpha_callSomeFunc(f as function)
+                    return f()
+                end function
+
+                sub Alpha_makeButton()
+                    Alpha_callSomeFunc(Alpha_Button)
+                end sub
+            `, 'trim', 'source/main.bs');
+        });
+        it('allows class constructors as functions in array', async () => {
+            await testTranspile(`
+                namespace Alpha
+                    class Button
+                    end class
+
+                    class ButtonContainer
+                        private button = new Alpha.Button()
+
+                        sub new()
+                            m.init()
+                        end sub
+
+                        sub init()
+                            button = new Alpha.Button()
+                            items = [m.button, button, Alpha.Button]
+                        end sub
+                    end class
+                end namespace
+            `, `
+                function __Alpha_Button_builder()
+                    instance = {}
+                    instance.new = sub()
+                    end sub
+                    return instance
+                end function
+                function Alpha_Button()
+                    instance = __Alpha_Button_builder()
+                    instance.new()
+                    return instance
+                end function
+                function __Alpha_ButtonContainer_builder()
+                    instance = {}
+                    instance.new = sub()
+                        m.button = Alpha_Button()
+                        m.init()
+                    end sub
+                    instance.init = sub()
+                        button = Alpha_Button()
+                        items = [
+                            m.button
+                            Alpha_button
+                            Alpha_Button
+                        ]
+                    end sub
+                    return instance
+                end function
+                function Alpha_ButtonContainer()
+                    instance = __Alpha_ButtonContainer_builder()
+                    instance.new()
+                    return instance
+                end function
+            `, 'trim', 'source/main.bs');
+        });
     });
     it('detects using `new` keyword on non-classes', () => {
         program.setFile('source/main.bs', `
@@ -898,9 +1225,9 @@ describe('BrsFile BrighterScript classes', () => {
                 end function
             end class
         `);
-        await program.transpile([], testHelpers_spec_2.stagingDir);
+        await program.build({ stagingDir: testHelpers_spec_2.stagingDir });
         fsExtra.emptyDirSync(testHelpers_spec_2.stagingDir);
-        await program.transpile([], testHelpers_spec_2.stagingDir);
+        await program.build({ stagingDir: testHelpers_spec_2.stagingDir });
         (0, chai_config_spec_1.expect)(fsExtra.readFileSync((0, util_1.standardizePath) `${testHelpers_spec_2.stagingDir}/source/lib.brs`).toString().trimEnd()).to.eql((0, testHelpers_spec_1.trim) `
             function __Being_builder()
                 instance = {}
@@ -1137,7 +1464,7 @@ describe('BrsFile BrighterScript classes', () => {
             `);
             program.validate();
             (0, testHelpers_spec_1.expectDiagnostics)(program, [Object.assign(Object.assign({}, DiagnosticMessages_1.DiagnosticMessages.cannotFindName('GroundedBird', 'Vertibrates.GroundedBird')), { relatedInformation: [{
-                            message: `Not defined in scope 'source'`
+                            message: `In scope 'source'`
                         }] })]);
         });
         it('namespaced parent class from inside namespace', () => {
@@ -1224,8 +1551,8 @@ describe('BrsFile BrighterScript classes', () => {
             end class
         `);
         program.validate();
-        (0, testHelpers_spec_1.expectDiagnostics)(program, [
-            DiagnosticMessages_1.DiagnosticMessages.duplicateClassDeclaration('source', 'Animal')
+        (0, testHelpers_spec_1.expectDiagnosticsIncludes)(program, [
+            DiagnosticMessages_1.DiagnosticMessages.nameCollision('Class', 'Class', 'Animal')
         ]);
     });
     it('catches duplicate namespace-level class declarations', () => {
@@ -1238,8 +1565,8 @@ describe('BrsFile BrighterScript classes', () => {
             end namespace
         `);
         program.validate();
-        (0, testHelpers_spec_1.expectDiagnostics)(program, [
-            DiagnosticMessages_1.DiagnosticMessages.duplicateClassDeclaration('source', 'NameA.NameB.Animal')
+        (0, testHelpers_spec_1.expectDiagnosticsIncludes)(program, [
+            DiagnosticMessages_1.DiagnosticMessages.nameCollision('Class', 'Class', 'Animal').message
         ]);
     });
     it('catches namespaced class name which is the same as a global class', () => {
@@ -1253,7 +1580,7 @@ describe('BrsFile BrighterScript classes', () => {
         `);
         program.validate();
         (0, testHelpers_spec_1.expectDiagnostics)(program, [
-            DiagnosticMessages_1.DiagnosticMessages.namespacedClassCannotShareNamewithNonNamespacedClass('Animal').message
+            DiagnosticMessages_1.DiagnosticMessages.nameCollision('Class', 'Class', 'Animal').message
         ]);
     });
     it('catches class with same name as function', () => {
@@ -1264,7 +1591,7 @@ describe('BrsFile BrighterScript classes', () => {
             end sub
         `);
         program.validate();
-        (0, testHelpers_spec_1.expectDiagnostics)(program, [
+        (0, testHelpers_spec_1.expectDiagnosticsIncludes)(program, [
             DiagnosticMessages_1.DiagnosticMessages.functionCannotHaveSameNameAsClass('Animal').message
         ]);
     });
@@ -1276,7 +1603,7 @@ describe('BrsFile BrighterScript classes', () => {
             end sub
         `);
         program.validate();
-        (0, testHelpers_spec_1.expectDiagnostics)(program, [
+        (0, testHelpers_spec_1.expectDiagnosticsIncludes)(program, [
             DiagnosticMessages_1.DiagnosticMessages.functionCannotHaveSameNameAsClass('animal').message
         ]);
     });
@@ -1321,7 +1648,7 @@ describe('BrsFile BrighterScript classes', () => {
         program.validate();
         (0, testHelpers_spec_1.expectZeroDiagnostics)(program);
     });
-    it('computes correct super index for grandchild class', () => {
+    it('computes correct super index for grandchild class', async () => {
         program.setFile('source/main.bs', `
             sub Main()
                 c = new App.ClassC()
@@ -1335,7 +1662,7 @@ describe('BrsFile BrighterScript classes', () => {
                 end class
             end namespace
         `);
-        testTranspile(`
+        await testTranspile(`
             namespace App
                 class ClassC extends ClassB
                     sub new()
@@ -1359,12 +1686,12 @@ describe('BrsFile BrighterScript classes', () => {
             end function
         `, 'trim', 'source/App.ClassC.bs');
     });
-    it('computes correct super index for namespaced child class and global parent class', () => {
+    it('computes correct super index for namespaced child class and global parent class', async () => {
         program.setFile('source/ClassA.bs', `
             class ClassA
             end class
         `);
-        testTranspile(`
+        await testTranspile(`
             namespace App
                 class ClassB extends ClassA
                 end class
@@ -1418,7 +1745,7 @@ describe('BrsFile BrighterScript classes', () => {
         `);
         program.validate();
     });
-    it.skip('detects calling class constructors with too many parameters', () => {
+    it('detects calling class constructors with too many parameters', () => {
         program.setFile('source/main.bs', `
             class Parameterless
                 sub new()