brighterscript 0.43.1 → 0.44.0

package/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 
+## [0.44.0](https://github.com/rokucommunity/brighterscript/compare/v0.43.1...v0.44.0) - 2022-02-08
+### Added
+ - `onScopeValidate` plugin event useful when plugins want to contribute scope validations ([#505](https://github.com/rokucommunity/brighterscript/pull/505))
+### Changed
+ - show plugin transpile modifications in the `getTranspiledFile` callback (used for "show preview" functionality in vscode) ([#502](https://github.com/rokucommunity/brighterscript/pull/502))
+ - make `Program.getFile` more flexible, and deprecate `Program.getFileByPkgPath`, `Program.getFileByPathAbsolute` ([#506](https://github.com/rokucommunity/brighterscript/pull/506))
+ - add `Program.getFiles` and deprecate `Program.getFilesByPkgPath` ([#506](https://github.com/rokucommunity/brighterscript/pull/506))
+ - move file validation plugin event emitting into `Program.validate()` which means you can't trigger those events by calling `File.validate()` anymore.  ([#504](https://github.com/rokucommunity/brighterscript/pull/504))
+ - support generics for `Cache` class ([#503](https://github.com/rokucommunity/brighterscript/pull/503))
+### Fixed
+ - bug in hover showing required params as optional and optional params as required ([#501](https://github.com/rokucommunity/brighterscript/pull/501))
+
+
+
 ## [0.43.1](https://github.com/rokucommunity/brighterscript/compare/v0.43.0...v0.43.1) - 2022-01-28
 ### Fixed
  - crash when hovering over global functions ([#497](https://github.com/rokucommunity/brighterscript/pull/497))

package/dist/Cache.d.ts

@@ -1,13 +1,13 @@
 /**
- * Synchronous cache
+ * A cache that will call the factory to create the item if it doesn't exist
  */
-export declare class Cache {
+export declare class Cache<TKey = any, TValue = any> {
     private cache;
     /**
      * Get value from the cache if it exists,
      * otherwise call the factory function to create the value, add it to the cache, and return it.
      */
-    getOrAdd<T>(key: string, factory: (key: string) => T): T;
+    getOrAdd<K extends TKey, T extends TValue>(key: K, factory: (key: K) => T): T;
     /**
      * Clear the cache
      */

package/dist/Cache.js

@@ -2,27 +2,31 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cache = void 0;
 /**
- * Synchronous cache
+ * A cache that will call the factory to create the item if it doesn't exist
  */
 class Cache {
     constructor() {
-        this.cache = {};
+        this.cache = new Map();
     }
     /**
      * Get value from the cache if it exists,
      * otherwise call the factory function to create the value, add it to the cache, and return it.
      */
     getOrAdd(key, factory) {
-        if (this.cache[key] === undefined) {
-            this.cache[key] = factory(key);
+        if (!this.cache.has(key)) {
+            const value = factory(key);
+            this.cache.set(key, value);
+            return value;
+        }
+        else {
+            return this.cache.get(key);
         }
-        return this.cache[key];
     }
     /**
      * Clear the cache
      */
     clear() {
-        this.cache = {};
+        this.cache.clear();
     }
 }
 exports.Cache = Cache;

package/dist/Cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"Cache.js","sourceRoot":"","sources":["../src/Cache.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,KAAK;IAAlB;QACY,UAAK,GAAG,EAAyB,CAAC;IAkB9C,CAAC;IAhBG;;;OAGG;IACI,QAAQ,CAAI,GAAW,EAAE,OAA2B;QACvD,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YAC/B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;SAClC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAM,CAAC;IAChC,CAAC;IACD;;OAEG;IACI,KAAK;QACR,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IACpB,CAAC;CACJ;AAnBD,sBAmBC"}
+{"version":3,"file":"Cache.js","sourceRoot":"","sources":["../src/Cache.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,KAAK;IAAlB;QACY,UAAK,GAAG,IAAI,GAAG,EAAgB,CAAC;IAqB5C,CAAC;IAnBG;;;OAGG;IACI,QAAQ,CAAmC,GAAM,EAAE,OAAsB;QAC5E,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACtB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;YAC3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,KAAK,CAAC;SAChB;aAAM;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAM,CAAC;SACnC;IACL,CAAC;IACD;;OAEG;IACI,KAAK;QACR,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACvB,CAAC;CACJ;AAtBD,sBAsBC"}

package/dist/LanguageServer.d.ts

@@ -130,12 +130,7 @@ export declare class LanguageServer {
     private onFullSemanticTokens;
     private diagnosticCollection;
     private sendDiagnostics;
-    onExecuteCommand(params: ExecuteCommandParams): Promise<{
-        pathAbsolute: string;
-        pkgPath: string;
-        code: string;
-        map: import("source-map").SourceMapGenerator;
-    }>;
+    onExecuteCommand(params: ExecuteCommandParams): Promise<import("./Program").FileTranspileResult>;
     private transpileFile;
     dispose(): void;
 }

package/dist/PluginInterface.d.ts

@@ -12,11 +12,11 @@ export default class PluginInterface<T extends CompilerPlugin = CompilerPlugin>
     /**
      * Add a plugin to the beginning of the list of plugins
      */
-    addFirst(plugin: CompilerPlugin): void;
+    addFirst<T extends CompilerPlugin = CompilerPlugin>(plugin: T): T;
     /**
      * Add a plugin to the end of the list of plugins
      */
-    add(plugin: CompilerPlugin): void;
+    add<T extends CompilerPlugin = CompilerPlugin>(plugin: T): T;
     has(plugin: CompilerPlugin): boolean;
-    remove(plugin: CompilerPlugin): void;
+    remove<T extends CompilerPlugin = CompilerPlugin>(plugin: T): T;
 }

package/dist/PluginInterface.js

@@ -30,6 +30,7 @@ class PluginInterface {
         if (!this.has(plugin)) {
             this.plugins.unshift(plugin);
         }
+        return plugin;
     }
     /**
      * Add a plugin to the end of the list of plugins
@@ -38,6 +39,7 @@ class PluginInterface {
         if (!this.has(plugin)) {
             this.plugins.push(plugin);
         }
+        return plugin;
     }
     has(plugin) {
         return this.plugins.includes(plugin);
@@ -46,6 +48,7 @@ class PluginInterface {
         if (this.has(plugin)) {
             this.plugins.splice(this.plugins.indexOf(plugin));
         }
+        return plugin;
     }
 }
 exports.default = PluginInterface;

package/dist/PluginInterface.js.map

@@ -1 +1 @@
-{"version":3,"file":"PluginInterface.js","sourceRoot":"","sources":["../src/PluginInterface.ts"],"names":[],"mappings":";;AAEA,qCAAoC;AAOpC,MAAqB,eAAe;IAEhC,YACY,OAAyB,EACzB,MAAc;QADd,YAAO,GAAP,OAAO,CAAkB;QACzB,WAAM,GAAN,MAAM,CAAQ;IACtB,CAAC;IAEL;;OAEG;IACI,IAAI,CAA6B,KAAQ,EAAE,GAAG,IAAqB;QACtE,KAAK,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YAC7B,IAAK,MAAc,CAAC,KAAK,CAAC,EAAE;gBACxB,IAAI;oBACA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAQ,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE;wBACvD,MAAc,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;oBACpC,CAAC,CAAC,CAAC;iBACN;gBAAC,OAAO,GAAG,EAAE;oBACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,MAAM,CAAC,IAAI,IAAI,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC;iBAChF;aACJ;SACJ;IACL,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,MAAsB;QAClC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAChC;IACL,CAAC;IAED;;OAEG;IACI,GAAG,CAAC,MAAsB;QAC7B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC7B;IACL,CAAC;IAEM,GAAG,CAAC,MAAsB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAAC,MAAsB;QAChC,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;SACrD;IACL,CAAC;CACJ;AAnDD,kCAmDC"}
+{"version":3,"file":"PluginInterface.js","sourceRoot":"","sources":["../src/PluginInterface.ts"],"names":[],"mappings":";;AAEA,qCAAoC;AAOpC,MAAqB,eAAe;IAEhC,YACY,OAAyB,EACzB,MAAc;QADd,YAAO,GAAP,OAAO,CAAkB;QACzB,WAAM,GAAN,MAAM,CAAQ;IACtB,CAAC;IAEL;;OAEG;IACI,IAAI,CAA6B,KAAQ,EAAE,GAAG,IAAqB;QACtE,KAAK,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YAC7B,IAAK,MAAc,CAAC,KAAK,CAAC,EAAE;gBACxB,IAAI;oBACA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,iBAAQ,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,GAAG,EAAE;wBACvD,MAAc,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;oBACpC,CAAC,CAAC,CAAC;iBACN;gBAAC,OAAO,GAAG,EAAE;oBACV,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,6BAA6B,MAAM,CAAC,IAAI,IAAI,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC;iBAChF;aACJ;SACJ;IACL,CAAC;IAED;;OAEG;IACI,QAAQ,CAA4C,MAAS;QAChE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;SAChC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,GAAG,CAA4C,MAAS;QAC3D,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC7B;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,GAAG,CAAC,MAAsB;QAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAEM,MAAM,CAA4C,MAAS;QAC9D,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAClB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;SACrD;QACD,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAtDD,kCAsDC"}

package/dist/Program.d.ts

@@ -4,12 +4,13 @@ import type { BsConfig } from './BsConfig';
 import { Scope } from './Scope';
 import { BrsFile } from './files/BrsFile';
 import { XmlFile } from './files/XmlFile';
-import type { BsDiagnostic, File, FileReference, FileObj, BscFile, SemanticToken } from './interfaces';
+import type { BsDiagnostic, File, FileReference, FileObj, BscFile, SemanticToken, FileLink } from './interfaces';
 import { XmlScope } from './XmlScope';
 import { Logger } from './Logger';
 import type { ManifestValue } from './preprocessor/Manifest';
 import PluginInterface from './PluginInterface';
 import type { FunctionStatement, Statement } from './parser/Statement';
+import type { SourceMapGenerator } from 'source-map';
 export interface SourceObj {
     pathAbsolute: string;
     source: string;
@@ -24,10 +25,6 @@ export interface SignatureInfoObj {
     key: string;
     signature: SignatureInformation;
 }
-export interface FileLink<T> {
-    item: T;
-    file: BrsFile;
-}
 export declare class Program {
     /**
      * The root directory for this program
@@ -116,8 +113,9 @@ export declare class Program {
     /**
      * Determine if the specified file is loaded in this program right now.
      * @param filePath
+     * @param normalizePath should the provided path be normalized before use
      */
-    hasFile(filePath: string): boolean;
+    hasFile(filePath: string, normalizePath?: boolean): boolean;
     getPkgPath(...args: any[]): any;
     /**
      * roku filesystem is case INsensitive, so find the scope by key case insensitive
@@ -132,6 +130,14 @@ export declare class Program {
      * Find the scope for the specified component
      */
     getComponentScope(componentName: string): XmlScope;
+    /**
+     * Update internal maps with this file reference
+     */
+    private assignFile;
+    /**
+     * Remove this file from internal maps
+     */
+    private unassignFile;
     /**
      * Load a file into the program. If that file already exists, it is replaced.
      * If file contents are provided, those are used, Otherwise, the file is loaded from the file system
@@ -155,28 +161,33 @@ export declare class Program {
      * Roku is a case insensitive file system. It is an error to have multiple files
      * with the same path with only case being different.
      * @param pathAbsolute
+     * @deprecated use `getFile` instead, which auto-detects the path type
      */
     getFileByPathAbsolute<T extends BrsFile | XmlFile>(pathAbsolute: string): T;
     /**
      * Get a list of files for the given (platform-normalized) pkgPath array.
      * Missing files are just ignored.
+     * @deprecated use `getFiles` instead, which auto-detects the path types
      */
     getFilesByPkgPaths<T extends BscFile[]>(pkgPaths: string[]): T;
     /**
      * Get a file with the specified (platform-normalized) pkg path.
      * If not found, return undefined
+     * @deprecated use `getFile` instead, which auto-detects the path type
      */
     getFileByPkgPath<T extends BscFile>(pkgPath: string): T;
     /**
      * Remove a set of files from the program
-     * @param absolutePaths
+     * @param filePaths can be an array of srcPath or destPath strings
+     * @param normalizePath should this function repair and standardize the filePaths? Passing false should have a performance boost if you can guarantee your paths are already sanitized
      */
-    removeFiles(absolutePaths: string[]): void;
+    removeFiles(filePaths: string[], normalizePath?: boolean): void;
     /**
      * Remove a file from the program
-     * @param pathAbsolute
+     * @param filePath can be a srcPath, a pkgPath, or a destPath (same as pkgPath but without `pkg:/`)
+     * @param normalizePath should this function repair and standardize the path? Passing false should have a performance boost if you can guarantee your path is already sanitized
      */
-    removeFile(pathAbsolute: string): void;
+    removeFile(filePath: string, normalizePath?: boolean): void;
     /**
      * Traverse the entire project, and validate all scopes
      * @param force - if true, then all scopes are force to validate, even if they aren't marked as dirty
@@ -190,16 +201,27 @@ export declare class Program {
      * Determine if the given file is included in at least one scope in this program
      */
     private fileIsIncludedInAnyScope;
+    /**
+     * Get the files for a list of filePaths
+     * @param filePaths can be an array of srcPath or a destPath strings
+     * @param normalizePath should this function repair and standardize the paths? Passing false should have a performance boost if you can guarantee your paths are already sanitized
+     */
+    getFiles<T extends BscFile>(filePaths: string[], normalizePath?: boolean): T[];
     /**
      * Get the file at the given path
-     * @param pathAbsolute
+     * @param filePath can be a srcPath or a destPath
+     * @param normalizePath should this function repair and standardize the path? Passing false should have a performance boost if you can guarantee your path is already sanitized
      */
-    private getFile;
+    getFile<T extends BscFile>(filePath: string, normalizePath?: boolean): T;
     /**
      * Get a list of all scopes the file is loaded into
      * @param file
      */
     getScopesForFile(file: XmlFile | BrsFile): Scope[];
+    /**
+     * Get the first found scope for a file.
+     */
+    getFirstScopeForFile(file: XmlFile | BrsFile): Scope;
     getStatementsByName(name: string, originFile: BrsFile, namespaceName?: string): FileLink<Statement>[];
     getStatementsForXmlFile(scope: XmlScope, filterName?: string): FileLink<FunctionStatement>[];
     /**
@@ -240,12 +262,12 @@ export declare class Program {
      * Transpile a single file and get the result as a string.
      * This does not write anything to the file system.
      */
-    getTranspiledFileContents(pathAbsolute: string): {
-        pathAbsolute: string;
-        pkgPath: string;
-        code: string;
-        map: import("source-map").SourceMapGenerator;
-    };
+    getTranspiledFileContents(pathAbsolute: string): FileTranspileResult;
+    /**
+     * Internal function used to transpile files.
+     * This does not write anything to the file system
+     */
+    private _getTranspiledFileContents;
     transpile(fileEntries: FileObj[], stagingFolderPath: string): Promise<void>;
     /**
      * Find a list of files in the program that have a function with the given name (case INsensitive)
@@ -262,3 +284,10 @@ export declare class Program {
     private _manifest;
     dispose(): void;
 }
+export interface FileTranspileResult {
+    pathAbsolute: string;
+    pkgPath: string;
+    code: string;
+    map: SourceMapGenerator;
+    typedef: string;
+}