brighterscript 0.45.5 → 0.45.6

package/CHANGELOG.md

@@ -6,6 +6,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+## [0.45.6](https://github.com/rokucommunity/brighterscript/compare/v0.45.5...v0.45.6) - 2022-03-17
+### Changed
+ - upgrade to  [roku-deploy@3.5.4](https://github.com/rokucommunity/roku-deploy/blob/master/CHANGELOG.md#354---2022-03-17) which fixed significant performance issues during globbing. ([roku-deploy#86](https://github.com/rokucommunity/roku-deploy/pull/86))
+### Fixed
+ - crash when checking for enums to transpile [#539](https://github.com/rokucommunity/brighterscript/pull/539)
+ - Transpile if statements as written [#537](https://github.com/rokucommunity/brighterscript/pull/537)
+ - Keep the original type case when transpiling. [#536](https://github.com/rokucommunity/brighterscript/pull/536)
+ - Show cli usage in plugins documentation
+
+
+
 ## [0.45.5](https://github.com/rokucommunity/brighterscript/compare/v0.45.4...v0.45.5) - 2022-03-10
 ### Fixed
  - bug with typedefs and auto-generated class constructor functions [#535](https://github.com/rokucommunity/brighterscript/pull/535)

package/README.md

@@ -61,12 +61,27 @@ BrighterScript adds several new features to the BrightScript language such as Na
   - And if it's not enough, the [plugin API](https://github.com/rokucommunity/brighterscript/blob/master/docs/plugins.md) allows extending the compiler to provide extra diagnostics or transformations.
 
 ## Who uses Brighterscript?
-
-Brighterscript is used by [applicaster](https://www.applicaster.com/), [The miracle channel](https://miraclechannel.ca/corco/), and in open source projects such as [rooibos](https://github.com/georgejecook/rooibos/blob/master/docs/index.md), the [maestro framework](https://github.com/georgejecook/maestro/blob/master/docs/index.md), and more.
-
-The BrighterScript project is used to power the popular [Brightscript Language](https://marketplace.visualstudio.com/items?itemName=rokucommunity.brightscript) VSCode extension, and other tools.
-
-More projects are adopting BrighterScript all the time, from using the new BrighterScript language features to simply using the compiler as part of their build pipeline. Be sure to watch this space!
+<br/>
+<p align="center">
+    <a href="https://www.applicaster.com/">
+        <img src="https://user-images.githubusercontent.com/2544493/96571912-377af280-129a-11eb-8295-49eb12e54aeb.png">
+    </a>&nbsp;&nbsp;&nbsp;
+    <a href="https://www.miraclechannel.ca/corcoplus">
+        <img src="https://user-images.githubusercontent.com/2544493/157429644-ba0d574a-d3c3-425f-8e68-98103fb8f707.png">
+    </a>&nbsp;&nbsp;&nbsp;
+    <a href="https://www.nba.com/">
+        <img src="https://user-images.githubusercontent.com/2544493/157430017-a27b62d0-63de-4e87-a6df-8448007bd24d.png">
+    </a>&nbsp;&nbsp;&nbsp;
+    <a href="https://github.com/georgejecook/rooibos/blob/master/docs/index.md">
+        <img src="https://user-images.githubusercontent.com/2544493/157430331-20913e84-f3f4-447a-b093-8780cd1241e6.png">
+    </a>
+</p>
+<br/>
+
+
+The BrighterScript project is used to power the popular [Brightscript Language](https://marketplace.visualstudio.com/items?itemName=rokucommunity.brightscript) VSCode extension, the [maestro framework](https://github.com/georgejecook/maestro/blob/master/docs/index.md), and more.
+
+[Contact us](https://github.com/rokucommunity/brighterscript/issues/new) if you use BrighterScript on your project and would like your logo listed above. More projects are adopting BrighterScript all the time, from using the new BrighterScript language features to simply using the compiler in their build pipeline.
 
 ## What's with the name?
 The name BrighterScript is a compliment to everything that is great about Roku's awesome BrightScript language. Naming things is hard, and discoverability and recognizability are both very important. Here are the reasons we chose this name:

package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.js

@@ -11,18 +11,22 @@ class BrsFilePreTranspileProcessor {
         this.replaceEnumValues();
     }
     replaceEnumValues() {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const membersByEnum = new Cache_1.Cache();
         const enumLookup = (_a = this.event.file.program.getFirstScopeForFile(this.event.file)) === null || _a === void 0 ? void 0 : _a.getEnumMap();
+        //skip this logic if current scope has no enums
+        if (((_b = enumLookup === null || enumLookup === void 0 ? void 0 : enumLookup.size) !== null && _b !== void 0 ? _b : 0) === 0) {
+            return;
+        }
         for (const expression of this.event.file.parser.references.expressions) {
-            const parts = (_b = util_1.default.getAllDottedGetParts(expression)) === null || _b === void 0 ? void 0 : _b.map(x => x.toLowerCase());
+            const parts = (_c = util_1.default.getAllDottedGetParts(expression)) === null || _c === void 0 ? void 0 : _c.map(x => x.toLowerCase());
             if (parts) {
                 //get the name of the enum member
                 const memberName = parts.pop();
                 //get the name of the enum (including leading namespace if applicable)
                 const enumName = parts.join('.');
                 const lowerEnumName = enumName.toLowerCase();
-                const theEnum = (_c = enumLookup.get(lowerEnumName)) === null || _c === void 0 ? void 0 : _c.item;
+                const theEnum = (_d = enumLookup.get(lowerEnumName)) === null || _d === void 0 ? void 0 : _d.item;
                 if (theEnum) {
                     const members = membersByEnum.getOrAdd(lowerEnumName, () => theEnum.getMemberValueMap());
                     const value = members === null || members === void 0 ? void 0 : members.get(memberName);

package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"BrsFilePreTranspileProcessor.js","sourceRoot":"","sources":["../../../src/bscPlugin/transpile/BrsFilePreTranspileProcessor.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AAGpC,qCAA8B;AAE9B,MAAa,4BAA4B;IACrC,YACY,KAAwC;QAAxC,UAAK,GAAL,KAAK,CAAmC;IAEpD,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAEO,iBAAiB;;QACrB,MAAM,aAAa,GAAG,IAAI,aAAK,EAA+B,CAAC;QAE/D,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,0CAAE,UAAU,EAAE,CAAC;QAC/F,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE;YACpE,MAAM,KAAK,GAAG,MAAA,cAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,0CAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAC/E,IAAI,KAAK,EAAE;gBACP,iCAAiC;gBACjC,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;gBAC/B,sEAAsE;gBACtE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACjC,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;gBAC7C,MAAM,OAAO,GAAG,MAAA,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,0CAAE,IAAI,CAAC;gBACpD,IAAI,OAAO,EAAE;oBACT,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;oBACzF,MAAM,KAAK,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC,UAAU,CAAC,CAAC;oBACvC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;iBAChE;aACJ;SACJ;IACL,CAAC;CACJ;AA/BD,oEA+BC"}
+{"version":3,"file":"BrsFilePreTranspileProcessor.js","sourceRoot":"","sources":["../../../src/bscPlugin/transpile/BrsFilePreTranspileProcessor.ts"],"names":[],"mappings":";;;AAAA,uCAAoC;AAGpC,qCAA8B;AAE9B,MAAa,4BAA4B;IACrC,YACY,KAAwC;QAAxC,UAAK,GAAL,KAAK,CAAmC;IAEpD,CAAC;IAEM,OAAO;QACV,IAAI,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAEO,iBAAiB;;QACrB,MAAM,aAAa,GAAG,IAAI,aAAK,EAA+B,CAAC;QAE/D,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,0CAAE,UAAU,EAAE,CAAC;QAC/F,+CAA+C;QAC/C,IAAI,CAAC,MAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,mCAAI,CAAC,CAAC,KAAK,CAAC,EAAE;YAC/B,OAAO;SACV;QACD,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,EAAE;YACpE,MAAM,KAAK,GAAG,MAAA,cAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,0CAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAC/E,IAAI,KAAK,EAAE;gBACP,iCAAiC;gBACjC,MAAM,UAAU,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC;gBAC/B,sEAAsE;gBACtE,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACjC,MAAM,aAAa,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC;gBAC7C,MAAM,OAAO,GAAG,MAAA,UAAU,CAAC,GAAG,CAAC,aAAa,CAAC,0CAAE,IAAI,CAAC;gBACpD,IAAI,OAAO,EAAE;oBACT,MAAM,OAAO,GAAG,aAAa,CAAC,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC;oBACzF,MAAM,KAAK,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC,UAAU,CAAC,CAAC;oBACvC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,uBAAuB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;iBAChE;aACJ;SACJ;IACL,CAAC;CACJ;AAnCD,oEAmCC"}

package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.spec.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const sinon_1 = require("sinon");
+const fsExtra = require("fs-extra");
+const Program_1 = require("../../Program");
+const util_1 = require("../../util");
+const sinon = (0, sinon_1.createSandbox)();
+describe('BrsFile', () => {
+    const tempDir = (0, util_1.standardizePath) `${process.cwd()}/.tmp`;
+    const rootDir = (0, util_1.standardizePath) `${tempDir}/rootDir`;
+    let program;
+    beforeEach(() => {
+        fsExtra.emptyDirSync(tempDir);
+        program = new Program_1.Program({ rootDir: rootDir, sourceMap: true });
+    });
+    afterEach(() => {
+        sinon.restore();
+        program.dispose();
+    });
+    describe('BrsFilePreTranspileProcessor', () => {
+        it('does not crash when operating on a file not included by any scope', async () => {
+            program.setFile('components/lib.brs', `
+                sub doSomething()
+                    a = { b: "c"}
+                    print a.b
+                end sub
+            `);
+            await program.transpile([], (0, util_1.standardizePath) `${tempDir}/out`);
+        });
+    });
+});
+//# sourceMappingURL=BrsFilePreTranspileProcessor.spec.js.map

package/dist/bscPlugin/transpile/BrsFilePreTranspileProcessor.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BrsFilePreTranspileProcessor.spec.js","sourceRoot":"","sources":["../../../src/bscPlugin/transpile/BrsFilePreTranspileProcessor.spec.ts"],"names":[],"mappings":";;AAAA,iCAAsC;AACtC,oCAAoC;AACpC,2CAAwC;AACxC,qCAAkD;AAClD,MAAM,KAAK,GAAG,IAAA,qBAAa,GAAE,CAAC;AAE9B,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACrB,MAAM,OAAO,GAAG,IAAA,sBAAC,EAAA,GAAG,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC;IACzC,MAAM,OAAO,GAAG,IAAA,sBAAC,EAAA,GAAG,OAAO,UAAU,CAAC;IACtC,IAAI,OAAgB,CAAC;IAErB,UAAU,CAAC,GAAG,EAAE;QACZ,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,GAAG,IAAI,iBAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,GAAG,EAAE;QACX,KAAK,CAAC,OAAO,EAAE,CAAC;QAChB,OAAO,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;QAC1C,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YAC/E,OAAO,CAAC,OAAO,CAAC,oBAAoB,EAAE;;;;;aAKrC,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,IAAA,sBAAC,EAAA,GAAG,OAAO,MAAM,CAAC,CAAC;QACnD,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

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

@@ -429,7 +429,7 @@ describe('BrsFile BrighterScript classes', () => {
                     instance.super0_sayHello = instance.sayHello
                     instance.sayHello = function(text)
                         text = "The duck says " + text
-                        if text <> invalid then
+                        if text <> invalid
                             m.super0_sayHello(text)
                         end if
                     end function

package/dist/files/BrsFile.spec.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const chai_1 = require("chai");
 const sinonImport = require("sinon");
-const path = require("path");
 const vscode_languageserver_1 = require("vscode-languageserver");
 const Program_1 = require("../Program");
 const BooleanType_1 = require("../types/BooleanType");
@@ -22,15 +21,18 @@ const Parser_1 = require("../parser/Parser");
 const Logger_1 = require("../Logger");
 const Statement_1 = require("../parser/Statement");
 const creators_1 = require("../astUtils/creators");
+const fsExtra = require("fs-extra");
 let sinon = sinonImport.createSandbox();
 describe('BrsFile', () => {
-    let rootDir = (0, util_1.standardizePath) `${process.cwd()}/.tmp/rootDir`;
+    let tempDir = (0, util_1.standardizePath) `${process.cwd()}/.tmp`;
+    let rootDir = (0, util_1.standardizePath) `${tempDir}/rootDir`;
     let program;
     let srcPath = (0, util_1.standardizePath) `${rootDir}/source/main.brs`;
     let destPath = 'source/main.brs';
     let file;
     let testTranspile = (0, testHelpers_spec_1.getTestTranspile)(() => [program, rootDir]);
     beforeEach(() => {
+        fsExtra.emptyDirSync(tempDir);
         program = new Program_1.Program({ rootDir: rootDir, sourceMap: true });
         file = new BrsFile_1.BrsFile(srcPath, destPath, program);
     });
@@ -1652,6 +1654,106 @@ describe('BrsFile', () => {
         //this test will throw an exception if something went wrong
     });
     describe('transpile', () => {
+        it('transpiles if statement keywords as provided', () => {
+            const code = `
+                If True Then
+                    Print True
+                Else If True Then
+                    print True
+                Else If False Then
+                    Print False
+                Else
+                    Print False
+                End If
+            `;
+            testTranspile(code);
+            testTranspile(code.toLowerCase());
+            testTranspile(code.toUpperCase());
+        });
+        it('does not transpile `then` tokens', () => {
+            const code = `
+                if true
+                    print true
+                else if true
+                    print false
+                end if
+            `;
+            testTranspile(code);
+        });
+        it('honors spacing between multi-word tokens', () => {
+            testTranspile(`
+                if true
+                    print true
+                elseif true
+                    print false
+                endif
+            `);
+        });
+        it('handles when only some of the statements have `then`', () => {
+            testTranspile(`
+                if true
+                else if true then
+                else if true
+                else if true then
+                    if true then
+                        return true
+                    end if
+                end if
+            `);
+        });
+        it('retains casing of parameter types', () => {
+            function test(type) {
+                testTranspile(`
+                    sub one(a as ${type}, b as ${type.toUpperCase()}, c as ${type.toLowerCase()})
+                    end sub
+                `);
+            }
+            test('Boolean');
+            test('Double');
+            test('Dynamic');
+            test('Float');
+            test('Integer');
+            test('LongInteger');
+            test('Object');
+            test('String');
+        });
+        it('retains casing of return types', () => {
+            function test(type) {
+                testTranspile(`
+                    sub one() as ${type}
+                    end sub
+
+                    sub two() as ${type.toLowerCase()}
+                    end sub
+
+                    sub three() as ${type.toUpperCase()}
+                    end sub
+                `);
+            }
+            test('Boolean');
+            test('Double');
+            test('Dynamic');
+            test('Float');
+            test('Integer');
+            test('LongInteger');
+            test('Object');
+            test('String');
+            test('Void');
+        });
+        it('retains casing of literal types', () => {
+            function test(type) {
+                testTranspile(`
+                    sub main()
+                        thing = ${type}
+                        thing = ${type.toLowerCase()}
+                        thing = ${type.toUpperCase()}
+                    end sub
+                `);
+            }
+            test('Invalid');
+            test('True');
+            test('False');
+        });
         describe('throwStatement', () => {
             it('transpiles properly', () => {
                 testTranspile(`
@@ -1900,29 +2002,6 @@ describe('BrsFile', () => {
                 end sub
         `, null, 'trim');
         });
-        it('adds `then` when missing', () => {
-            testTranspile(`
-                sub a()
-                    if true
-                        print "true"
-                    else if true
-                        print "true"
-                    else
-                        print "true"
-                    end if
-                end sub
-            `, `
-                sub a()
-                    if true then
-                        print "true"
-                    else if true then
-                        print "true"
-                    else
-                        print "true"
-                    end if
-                end sub
-            `, 'trim');
-        });
         it('does not add leading or trailing newlines', () => {
             testTranspile(`function abc()\nend function`, undefined, 'none');
         });
@@ -2675,38 +2754,35 @@ describe('BrsFile', () => {
         });
     });
     describe('Plugins', () => {
-        function testPluginTranspile() {
-            testTranspile(`
-                sub main()
-                    sayHello(sub()
-                        print "sub hello"
-                    end sub)
-                    print "something"
-                end sub
-
-                sub sayHello(fn)
-                    fn()
-                    print "hello"
-                end sub
-            `, 'sub main()\n    sayHello(sub()\n        \n    end sub)\n    \nend sub\n\nsub sayHello(fn)\n    fn()\n    \nend sub', 'none');
-        }
-        it('can use a plugin object which transforms the AST', () => {
-            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins('', [
-                require.resolve('../examples/plugins/removePrint')
-            ]), new Logger_1.Logger());
-            testPluginTranspile();
+        let pluginFileName;
+        let idx = 1;
+        beforeEach(() => {
+            pluginFileName = `plugin-${idx++}.js`;
+            fsExtra.outputFileSync((0, util_1.standardizePath) `${tempDir}/plugins/${pluginFileName}`, `
+                function plugin() {
+                    return {
+                        name: 'lower-file-name',
+                        afterFileParse: (evt) => {
+                            evt._customProp = true;
+                        }
+                    };
+                }
+                exports.default = plugin;
+            `);
         });
-        it('can load an absolute plugin which transforms the AST', () => {
-            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins('', [
-                path.resolve(process.cwd(), './dist/examples/plugins/removePrint.js')
+        it('can load an absolute plugin which receives callbacks', () => {
+            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins(tempDir, [
+                (0, util_1.standardizePath) `${tempDir}/plugins/${pluginFileName}`
             ]), new Logger_1.Logger());
-            testPluginTranspile();
+            const file = program.setFile('source/MAIN.brs', '');
+            (0, chai_1.expect)(file._customProp).to.exist;
         });
-        it('can load a relative plugin which transforms the AST', () => {
-            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins(process.cwd(), [
-                './dist/examples/plugins/removePrint.js'
+        it('can load a relative plugin which receives callbacks', () => {
+            program.plugins = new PluginInterface_1.default(util_1.default.loadPlugins(tempDir, [
+                `./plugins/${pluginFileName}`
             ]), new Logger_1.Logger());
-            testPluginTranspile();
+            const file = program.setFile('source/MAIN.brs', '');
+            (0, chai_1.expect)(file._customProp).to.exist;
         });
     });
 });