brighterscript 1.0.0-alpha.47 → 1.0.0-alpha.49

package/dist/util.js

@@ -8,7 +8,6 @@ const path = require("path");
 const roku_deploy_1 = require("roku-deploy");
 const vscode_languageserver_1 = require("vscode-languageserver");
 const vscode_uri_1 = require("vscode-uri");
-const xml2js = require("xml2js");
 const DiagnosticMessages_1 = require("./DiagnosticMessages");
 const interfaces_1 = require("./interfaces");
 const BooleanType_1 = require("./types/BooleanType");
@@ -125,29 +124,6 @@ class Util {
         //ensure every path has the leading pkg:/
         return 'pkg:/' + pkgPath.replace(/^pkg:\//i, '');
     }
-    /**
-     * Determine if the given path starts with a protocol
-     */
-    startsWithProtocol(path) {
-        return !!/^[-a-z]+:\//i.exec(path);
-    }
-    /**
-     * Given a pkg path of any kind, transform it to a roku-specific pkg path (i.e. "pkg:/some/path.brs")
-     * @deprecated use `sanitizePkgPath instead. Will be removed in v1
-     */
-    getRokuPkgPath(pkgPath) {
-        return this.sanitizePkgPath(pkgPath);
-    }
-    /**
-     * Given a path to a file/directory, replace all path separators with the current system's version.
-     */
-    pathSepNormalize(filePath, separator) {
-        if (!filePath) {
-            return filePath;
-        }
-        separator = separator ? separator : path.sep;
-        return filePath.replace(/[\\/]+/g, separator);
-    }
     /**
      * Find the path to the config file.
      * If the config file path doesn't exist
@@ -247,18 +223,15 @@ class Util {
                 result._ancestors = parentProjectPaths;
             }
             //make any paths in the config absolute (relative to the CURRENT config file)
-            if (result.outFile) {
-                result.outFile = path.resolve(projectFileCwd, result.outFile);
-            }
             if (result.rootDir) {
                 result.rootDir = path.resolve(projectFileCwd, result.rootDir);
             }
+            if (result.outDir) {
+                result.outDir = path.resolve(projectFileCwd, result.outDir);
+            }
             if (result.cwd) {
                 result.cwd = path.resolve(projectFileCwd, result.cwd);
             }
-            if (result.stagingDir) {
-                result.stagingDir = path.resolve(projectFileCwd, result.stagingDir);
-            }
             if (result.sourceRoot && result.resolveSourceRoot) {
                 result.sourceRoot = path.resolve(projectFileCwd, result.sourceRoot);
             }
@@ -284,35 +257,6 @@ class Util {
         }
         collection[key] = [...result];
     }
-    /**
-     * Do work within the scope of a changed current working directory
-     * @param targetCwd the cwd where the work should be performed
-     * @param callback a function to call when the cwd has been changed to `targetCwd`
-     */
-    cwdWork(targetCwd, callback) {
-        let originalCwd = process.cwd();
-        if (targetCwd) {
-            process.chdir(targetCwd);
-        }
-        let result;
-        let err;
-        try {
-            result = callback();
-        }
-        catch (e) {
-            err = e;
-        }
-        if (targetCwd) {
-            process.chdir(originalCwd);
-        }
-        if (err) {
-            throw err;
-        }
-        else {
-            //justification: `result` is set as long as `err` is not set and vice versa
-            return result;
-        }
-    }
     /**
      * Given a BsConfig object, start with defaults,
      * merge with bsconfig.json and the provided options.
@@ -344,38 +288,55 @@ class Util {
      * @param config a bsconfig object to use as the baseline for the resulting config
      */
     normalizeConfig(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         config = config !== null && config !== void 0 ? config : {};
         const cwd = (_a = config.cwd) !== null && _a !== void 0 ? _a : process.cwd();
-        const rootFolderName = path.basename(cwd);
-        const retainStagingDir = ((_b = config.retainStagingDir) !== null && _b !== void 0 ? _b : config.retainStagingDir) === true ? true : false;
         let logLevel = logging_1.LogLevel.log;
         if (typeof config.logLevel === 'string') {
-            logLevel = (_c = logging_1.LogLevel[config.logLevel.toLowerCase()]) !== null && _c !== void 0 ? _c : logging_1.LogLevel.log;
+            logLevel = (_b = logging_1.LogLevel[config.logLevel.toLowerCase()]) !== null && _b !== void 0 ? _b : logging_1.LogLevel.log;
         }
-        let bslibDestinationDir = (_d = config.bslibDestinationDir) !== null && _d !== void 0 ? _d : 'source';
+        let bslibDestinationDir = (_c = config.bslibDestinationDir) !== null && _c !== void 0 ? _c : 'source';
         if (bslibDestinationDir !== 'source') {
             // strip leading and trailing slashes
             bslibDestinationDir = bslibDestinationDir.replace(/^(\/*)(.*?)(\/*)$/, '$2');
         }
+        let noEmit;
+        if ('noEmit' in config) {
+            noEmit = config.noEmit;
+        }
+        else if ('copyToStaging' in config) {
+            noEmit = !config.copyToStaging; //invert the old value
+        }
+        else {
+            noEmit = false; //default case
+        }
+        let outDir;
+        if ('outDir' in config) {
+            outDir = (_d = config.outDir) !== null && _d !== void 0 ? _d : './out';
+        }
+        else if ('stagingFolderPath' in config) {
+            outDir = config.stagingFolderPath;
+        }
+        else if ('stagingDir' in config) {
+            outDir = config.stagingDir;
+        }
+        else {
+            outDir = './out'; //default case
+        }
         const configWithDefaults = {
             cwd: cwd,
-            deploy: config.deploy === true ? true : false,
             //use default files array from rokuDeploy
             files: (_e = config.files) !== null && _e !== void 0 ? _e : [...roku_deploy_1.DefaultFiles],
-            createPackage: config.createPackage === false ? false : true,
-            outFile: (_f = config.outFile) !== null && _f !== void 0 ? _f : `./out/${rootFolderName}.zip`,
+            outDir: outDir,
             sourceMap: config.sourceMap === true,
-            username: (_g = config.username) !== null && _g !== void 0 ? _g : 'rokudev',
             watch: config.watch === true ? true : false,
             emitFullPaths: config.emitFullPaths === true ? true : false,
-            retainStagingDir: retainStagingDir,
-            copyToStaging: config.copyToStaging === false ? false : true,
-            ignoreErrorCodes: (_h = config.ignoreErrorCodes) !== null && _h !== void 0 ? _h : [],
-            diagnosticSeverityOverrides: (_j = config.diagnosticSeverityOverrides) !== null && _j !== void 0 ? _j : {},
-            diagnosticFilters: (_k = config.diagnosticFilters) !== null && _k !== void 0 ? _k : [],
+            noEmit: noEmit,
+            ignoreErrorCodes: (_f = config.ignoreErrorCodes) !== null && _f !== void 0 ? _f : [],
+            diagnosticSeverityOverrides: (_g = config.diagnosticSeverityOverrides) !== null && _g !== void 0 ? _g : {},
+            diagnosticFilters: (_h = config.diagnosticFilters) !== null && _h !== void 0 ? _h : [],
             diagnosticFiltersV0Compatibility: config.diagnosticFiltersV0Compatibility === true ? true : false,
-            plugins: (_l = config.plugins) !== null && _l !== void 0 ? _l : [],
+            plugins: (_j = config.plugins) !== null && _j !== void 0 ? _j : [],
             pruneEmptyCodeFiles: config.pruneEmptyCodeFiles === true ? true : false,
             autoImportComponentScript: config.autoImportComponentScript === true ? true : false,
             showDiagnosticsInConsole: config.showDiagnosticsInConsole === false ? false : true,
@@ -427,12 +388,6 @@ class Util {
         }
         return result;
     }
-    /**
-     * Split a file by newline characters (LF or CRLF)
-     */
-    getLines(text) {
-        return text.split(/\r?\n/);
-    }
     /**
      * Given an absolute path to a source file, and a target path,
      * compute the pkg path for the target relative to the source file's location
@@ -713,37 +668,6 @@ class Util {
     getSgNodeTypeName(sgNodeName) {
         return 'roSGNode' + sgNodeName;
     }
-    /**
-     * Parse an xml file and get back a javascript object containing its results
-     */
-    parseXml(text) {
-        return new Promise((resolve, reject) => {
-            xml2js.parseString(text, (err, data) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    resolve(data);
-                }
-            });
-        });
-    }
-    propertyCount(object) {
-        let count = 0;
-        for (let key in object) {
-            if (object.hasOwnProperty(key)) {
-                count++;
-            }
-        }
-        return count;
-    }
-    padLeft(subject, totalLength, char) {
-        totalLength = totalLength > 1000 ? 1000 : totalLength;
-        while (subject.length < totalLength) {
-            subject = char + subject;
-        }
-        return subject;
-    }
     /**
      * Force the drive letter to lower case
      */
@@ -773,21 +697,6 @@ class Util {
             return subject;
         }
     }
-    /**
-     * Determine if two arrays containing primitive values are equal.
-     * This considers order and compares by equality.
-     */
-    areArraysEqual(arr1, arr2) {
-        if (arr1.length !== arr2.length) {
-            return false;
-        }
-        for (let i = 0; i < arr1.length; i++) {
-            if (arr1[i] !== arr2[i]) {
-                return false;
-            }
-        }
-        return true;
-    }
     /**
      * Does the string appear to be a uri (i.e. does it start with `file:`)
      */
@@ -826,19 +735,6 @@ class Util {
         const normalizedPath = path.normalize(parsedPath);
         return normalizedPath;
     }
-    /**
-     * Get the outDir from options, taking into account cwd and absolute outFile paths
-     */
-    getOutDir(options) {
-        options = this.normalizeConfig(options);
-        let cwd = path.normalize(options.cwd ? options.cwd : process.cwd());
-        if (path.isAbsolute(options.outFile)) {
-            return path.dirname(options.outFile);
-        }
-        else {
-            return path.normalize(path.join(cwd, path.dirname(options.outFile)));
-        }
-    }
     /**
      * Get paths to all files on disc that match this project's source list
      */
@@ -862,31 +758,6 @@ class Util {
             return undefined;
         }
     }
-    /**
-     * Walks up the chain to find the closest bsconfig.json file
-     */
-    async findClosestConfigFile(currentPath) {
-        //make the path absolute
-        currentPath = path.resolve(path.normalize(currentPath));
-        let previousPath;
-        //using ../ on the root of the drive results in the same file path, so that's how we know we reached the top
-        while (previousPath !== currentPath) {
-            previousPath = currentPath;
-            let bsPath = path.join(currentPath, 'bsconfig.json');
-            let brsPath = path.join(currentPath, 'brsconfig.json');
-            if (await this.pathExists(bsPath)) {
-                return bsPath;
-            }
-            else if (await this.pathExists(brsPath)) {
-                return brsPath;
-            }
-            else {
-                //walk upwards one directory
-                currentPath = path.resolve(path.join(currentPath, '../'));
-            }
-        }
-        //got to the root path, no config file exists
-    }
     /**
      * Set a timeout for the specified milliseconds, and resolve the promise once the timeout is finished.
      * @param milliseconds the minimum number of milliseconds to sleep for
@@ -902,14 +773,6 @@ class Util {
             }
         });
     }
-    /**
-     * Given an array, map and then flatten
-     * @param array the array to flatMap over
-     * @param callback a function that is called for every array item
-     */
-    flatMap(array, callback) {
-        return Array.prototype.concat.apply([], array.map(callback));
-    }
     /**
      * Determines if the position is greater than the range. This means
      * the position does not touch the range, and has a position greater than the end
@@ -954,27 +817,6 @@ class Util {
             return undefined;
         }
     }
-    /**
-     * Get a location object back by extracting location information from other objects that contain location
-     */
-    getRange(startObj, endObj) {
-        var _a, _b;
-        if (!(startObj === null || startObj === void 0 ? void 0 : startObj.range) || !(endObj === null || endObj === void 0 ? void 0 : endObj.range)) {
-            return undefined;
-        }
-        return exports.util.createRangeFromPositions((_a = startObj.range) === null || _a === void 0 ? void 0 : _a.start, (_b = endObj.range) === null || _b === void 0 ? void 0 : _b.end);
-    }
-    /**
-     * If the two items both start on the same line
-     */
-    sameStartLine(first, second) {
-        if (first && second && first.range.start.line === second.range.start.line) {
-            return true;
-        }
-        else {
-            return false;
-        }
-    }
     /**
      * If the two items have lines that touch
      */
@@ -991,18 +833,6 @@ class Util {
             return false;
         }
     }
-    /**
-     * Given text with (or without) dots separating text, get the rightmost word.
-     * (i.e. given "A.B.C", returns "C". or "B" returns "B because there's no dot)
-     */
-    getTextAfterFinalDot(name) {
-        if (name) {
-            let parts = name.split('.');
-            if (parts.length > 0) {
-                return parts[parts.length - 1];
-            }
-        }
-    }
     /**
      * Find a script import that the current position touches, or undefined if not found
      */
@@ -1275,17 +1105,6 @@ class Util {
             character: character
         };
     }
-    /**
-     * Convert a list of tokens into a string, including their leading whitespace
-     */
-    tokensToString(tokens) {
-        let result = '';
-        //skip iterating the final token
-        for (let token of tokens) {
-            result += token.leadingWhitespace + token.text;
-        }
-        return result;
-    }
     /**
      * Convert a token into a BscType
      */
@@ -1548,12 +1367,12 @@ class Util {
         let hasInvalid = (0, reflection_1.isInvalidTypeLike)(leftType) || (0, reflection_1.isInvalidTypeLike)(rightType);
         let hasDynamic = (0, reflection_1.isDynamicType)(leftType) || (0, reflection_1.isDynamicType)(rightType);
         let bothDynamic = (0, reflection_1.isDynamicType)(leftType) && (0, reflection_1.isDynamicType)(rightType);
-        let bothNumbers = (0, reflection_1.isNumberType)(leftType) && (0, reflection_1.isNumberType)(rightType);
-        let hasNumber = (0, reflection_1.isNumberType)(leftType) || (0, reflection_1.isNumberType)(rightType);
+        let bothNumbers = (0, reflection_1.isNumberTypeLike)(leftType) && (0, reflection_1.isNumberTypeLike)(rightType);
+        let hasNumber = (0, reflection_1.isNumberTypeLike)(leftType) || (0, reflection_1.isNumberTypeLike)(rightType);
         let bothStrings = (0, reflection_1.isStringTypeLike)(leftType) && (0, reflection_1.isStringTypeLike)(rightType);
         let hasString = (0, reflection_1.isStringTypeLike)(leftType) || (0, reflection_1.isStringTypeLike)(rightType);
         let hasBoolean = (0, reflection_1.isBooleanTypeLike)(leftType) || (0, reflection_1.isBooleanTypeLike)(rightType);
-        let eitherBooleanOrNum = ((0, reflection_1.isNumberType)(leftType) || (0, reflection_1.isBooleanTypeLike)(leftType)) && ((0, reflection_1.isNumberType)(rightType) || (0, reflection_1.isBooleanTypeLike)(rightType));
+        let eitherBooleanOrNum = ((0, reflection_1.isNumberTypeLike)(leftType) || (0, reflection_1.isBooleanTypeLike)(leftType)) && ((0, reflection_1.isNumberTypeLike)(rightType) || (0, reflection_1.isBooleanTypeLike)(rightType));
         let leftIsPrimitive = (0, reflection_1.isPrimitiveType)(leftType);
         let rightIsPrimitive = (0, reflection_1.isPrimitiveType)(rightType);
         let hasPrimitive = leftIsPrimitive || rightIsPrimitive;
@@ -1774,7 +1593,7 @@ class Util {
             // Math operators
             case TokenKind_1.TokenKind.Plus: // (`num = +num` is valid syntax)
             case TokenKind_1.TokenKind.Minus:
-                if ((0, reflection_1.isNumberType)(exprType)) {
+                if ((0, reflection_1.isNumberTypeLike)(exprType)) {
                     // a negative number will be the same type, eg, double->double, int->int, etc.
                     return this.getUnboxedType(exprType);
                 }
@@ -1783,7 +1602,7 @@ class Util {
                 if ((0, reflection_1.isBooleanTypeLike)(exprType)) {
                     return BooleanType_1.BooleanType.instance;
                 }
-                else if ((0, reflection_1.isNumberType)(exprType)) {
+                else if ((0, reflection_1.isNumberTypeLike)(exprType)) {
                     //numbers can be "notted"
                     // by default they go to ints, except longints, which stay that way
                     if ((0, reflection_1.isLongIntegerTypeLike)(exprType)) {
@@ -2010,19 +1829,6 @@ class Util {
         }
         return result;
     }
-    /**
-     * Get the first locatable item found at the specified position
-     * @param locatables an array of items that have a `range` property
-     * @param position the position that the locatable must contain
-     */
-    getFirstLocatableAt(locatables, position) {
-        var _a;
-        for (let token of locatables) {
-            if (exports.util.rangeContains((_a = token.location) === null || _a === void 0 ? void 0 : _a.range, position)) {
-                return token;
-            }
-        }
-    }
     /**
      * Sort an array of objects that have a Range
      */
@@ -2067,26 +1873,6 @@ class Util {
             return 0;
         });
     }
-    /**
-     * Split the given text and return ranges for each chunk.
-     * Only works for single-line strings
-     */
-    splitGetRange(separator, text, range) {
-        const chunks = text.split(separator);
-        const result = [];
-        let offset = 0;
-        for (let chunk of chunks) {
-            //only keep nonzero chunks
-            if (chunk.length > 0) {
-                result.push({
-                    text: chunk,
-                    range: this.createRange(range.start.line, range.start.character + offset, range.end.line, range.start.character + offset + chunk.length)
-                });
-            }
-            offset += chunk.length + separator.length;
-        }
-        return result;
-    }
     /**
      * Wrap the given code in a markdown code fence (with the language)
      */
@@ -2158,16 +1944,6 @@ class Util {
         return result;
         /* eslint-enable no-var */
     }
-    stringJoin(strings, separator) {
-        var _a;
-        // eslint-disable-next-line no-var
-        var result = (_a = strings[0]) !== null && _a !== void 0 ? _a : '';
-        // eslint-disable-next-line no-var
-        for (var i = 1; i < strings.length; i++) {
-            result += separator + strings[i];
-        }
-        return result;
-    }
     /**
      * Break an expression into each part.
      */
@@ -2191,44 +1967,6 @@ class Util {
         }
         return parts;
     }
-    /**
-     * Break an expression into each part, and return any VariableExpression or DottedGet expresisons from left-to-right.
-     */
-    getDottedGetPath(expression) {
-        let parts = [];
-        let nextPart = expression;
-        loop: while (nextPart) {
-            switch (nextPart === null || nextPart === void 0 ? void 0 : nextPart.kind) {
-                case AstNode_1.AstNodeKind.DottedGetExpression:
-                    parts.push(nextPart);
-                    nextPart = nextPart.obj;
-                    continue;
-                case AstNode_1.AstNodeKind.IndexedGetExpression:
-                case AstNode_1.AstNodeKind.XmlAttributeGetExpression:
-                    nextPart = nextPart.obj;
-                    parts = [];
-                    continue;
-                case AstNode_1.AstNodeKind.CallExpression:
-                case AstNode_1.AstNodeKind.CallfuncExpression:
-                    nextPart = nextPart.callee;
-                    parts = [];
-                    continue;
-                case AstNode_1.AstNodeKind.NewExpression:
-                    nextPart = nextPart.call.callee;
-                    parts = [];
-                    continue;
-                case AstNode_1.AstNodeKind.TypeExpression:
-                    nextPart = nextPart.expression;
-                    continue;
-                case AstNode_1.AstNodeKind.VariableExpression:
-                    parts.push(nextPart);
-                    break loop;
-                default:
-                    return [];
-            }
-        }
-        return parts.reverse();
-    }
     /**
      * Returns an integer if valid, or undefined. Eliminates checking for NaN
      */
@@ -2425,6 +2163,19 @@ class Util {
             crossedCallFunc: crossedCallFunc
         };
     }
+    getCircularReferenceDiagnosticDetail(circularReferenceInfo, defaultName = '') {
+        if (!circularReferenceInfo || !circularReferenceInfo.referenceChainNames) {
+            if (defaultName) {
+                return [defaultName];
+            }
+            return [];
+        }
+        if (circularReferenceInfo.referenceChainNames[0] === circularReferenceInfo.referenceChainNames[circularReferenceInfo.referenceChainNames.length - 1]) {
+            // last element is same as first it will read okay
+            return circularReferenceInfo.referenceChainNames;
+        }
+        return [...circularReferenceInfo.referenceChainNames, circularReferenceInfo.referenceChainNames[0]];
+    }
     isInTypeExpression(expression) {
         //TODO: this is much faster than node.findAncestor(), but may need to be updated for "complicated" type expressions
         if ((0, reflection_1.isTypeExpression)(expression) ||
@@ -2543,12 +2294,12 @@ class Util {
     hasLeadingComments(input) {
         var _a;
         const leadingTrivia = (0, Token_1.isToken)(input) ? input === null || input === void 0 ? void 0 : input.leadingTrivia : (_a = input === null || input === void 0 ? void 0 : input.leadingTrivia) !== null && _a !== void 0 ? _a : [];
-        return !!leadingTrivia.find(t => t.kind === TokenKind_1.TokenKind.Comment);
+        return !!leadingTrivia.find(t => (t === null || t === void 0 ? void 0 : t.kind) === TokenKind_1.TokenKind.Comment);
     }
     getLeadingComments(input) {
         var _a;
         const leadingTrivia = (0, Token_1.isToken)(input) ? input === null || input === void 0 ? void 0 : input.leadingTrivia : (_a = input === null || input === void 0 ? void 0 : input.leadingTrivia) !== null && _a !== void 0 ? _a : [];
-        return leadingTrivia.filter(t => t.kind === TokenKind_1.TokenKind.Comment);
+        return leadingTrivia.filter(t => (t === null || t === void 0 ? void 0 : t.kind) === TokenKind_1.TokenKind.Comment);
     }
     isLeadingCommentOnSameLine(line, input) {
         var _a;
@@ -2830,6 +2581,17 @@ class Util {
         }
         return resultType;
     }
+    /**
+     * Get a short name that can be used to reference the project in logs. (typically something like `prj1`, `prj8`, etc...)
+     */
+    getProjectLogName(config) {
+        //if we have a project number, use it
+        if ((config === null || config === void 0 ? void 0 : config.projectNumber) !== undefined) {
+            return `prj${config.projectNumber}`;
+        }
+        //just return empty string so log functions don't crash with undefined project numbers
+        return '';
+    }
 }
 exports.Util = Util;
 /**
@@ -2838,7 +2600,7 @@ exports.Util = Util;
  */
 function standardizePath(stringParts, ...expressions) {
     let result = [];
-    for (let i = 0; i < stringParts.length; i++) {
+    for (let i = 0; i < (stringParts === null || stringParts === void 0 ? void 0 : stringParts.length); i++) {
         result.push(stringParts[i], expressions[i]);
     }
     return exports.util.standardizePath(result.join(''));