brighterscript 1.0.0-alpha.24 → 1.0.0-alpha.25

package/dist/files/LazyFileData.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LazyFileData = void 0;
+class LazyFileData {
+    constructor(initialData) {
+        this.initialData = initialData;
+        /**
+         * Has the data been loaded
+         */
+        this.isValueLoaded = false;
+    }
+    get value() {
+        if (!this.isValueLoaded) {
+            this.isValueLoaded = true;
+            this.resolve();
+        }
+        return this.resolvedData;
+    }
+    set value(value) {
+        this.isValueLoaded = true;
+        this.initialData = value;
+        this.resolve();
+    }
+    /**
+     * Resolve the initialData into the actual data
+     */
+    resolve() {
+        let result;
+        if (Buffer.isBuffer(this.initialData)) {
+            result = this.initialData;
+        }
+        else if (typeof this.initialData === 'string') {
+            result = Buffer.from(this.initialData);
+        }
+        else if (typeof this.initialData === 'function') {
+            result = this.initialData();
+            //convert result to buffer
+            if (!Buffer.isBuffer(result)) {
+                result = Buffer.from(result);
+            }
+        }
+        else if (isLazyFileData(this.initialData)) {
+            result = this.initialData.value;
+        }
+        this.resolvedData = result;
+        delete this.initialData;
+    }
+}
+exports.LazyFileData = LazyFileData;
+function isLazyFileData(item) {
+    var _a;
+    return ((_a = item === null || item === void 0 ? void 0 : item.constructor) === null || _a === void 0 ? void 0 : _a.name) === 'LazyFileData';
+}
+//# sourceMappingURL=LazyFileData.js.map

package/dist/files/LazyFileData.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LazyFileData.js","sourceRoot":"","sources":["../../src/files/LazyFileData.ts"],"names":[],"mappings":";;;AAAA,MAAa,YAAY;IACrB,YACY,WAAqB;QAArB,gBAAW,GAAX,WAAW,CAAU;QAGjC;;WAEG;QACI,kBAAa,GAAG,KAAK,CAAC;IALzB,CAAC;IAYL,IAAW,KAAK;QACZ,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE;YACrB,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,OAAO,EAAE,CAAC;SAClB;QACD,OAAO,IAAI,CAAC,YAAY,CAAC;IAC7B,CAAC;IAED,IAAW,KAAK,CAAC,KAAe;QAC5B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;IAED;;OAEG;IACK,OAAO;QACX,IAAI,MAAW,CAAC;QAChB,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YACnC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC;SAC7B;aAAM,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ,EAAE;YAC7C,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;SAC1C;aAAM,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,UAAU,EAAE;YAC/C,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;YAC5B,0BAA0B;YAC1B,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE;gBAC1B,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;aAChC;SACJ;aAAM,IAAI,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YACzC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC;SACnC;QACD,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC;IAC5B,CAAC;CACJ;AAlDD,oCAkDC;AAID,SAAS,cAAc,CAAC,IAAS;;IAC7B,OAAO,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,0CAAE,IAAI,MAAK,cAAc,CAAC;AACtD,CAAC"}

package/dist/files/LazyFileData.spec.d.ts

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

package/dist/files/LazyFileData.spec.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const chai_1 = require("chai");
+const LazyFileData_1 = require("./LazyFileData");
+describe('LazyFileData', () => {
+    it('lazy loads string data', () => {
+        var _a;
+        const data = new LazyFileData_1.LazyFileData('cat');
+        (0, chai_1.expect)(data['initialData']).to.eql('cat');
+        (0, chai_1.expect)(data['resolvedData']).to.be.undefined;
+        (0, chai_1.expect)(data.isValueLoaded).to.be.false;
+        //now lazy-load the data
+        (0, chai_1.expect)(Buffer.isBuffer(data.value)).to.be.true;
+        (0, chai_1.expect)(data['initialData']).to.be.undefined;
+        (0, chai_1.expect)((_a = data['resolvedData']) === null || _a === void 0 ? void 0 : _a.toString()).to.eql('cat');
+        (0, chai_1.expect)(data.isValueLoaded).to.be.true;
+    });
+    it('supports LazyFileData as initialData', () => {
+        var _a;
+        const data = new LazyFileData_1.LazyFileData(new LazyFileData_1.LazyFileData('cat'));
+        (0, chai_1.expect)((_a = data.value) === null || _a === void 0 ? void 0 : _a.toString()).to.eql('cat');
+    });
+    it('supports Buffer', () => {
+        (0, chai_1.expect)(new LazyFileData_1.LazyFileData(Buffer.from('cat')).value.toString()).to.eql('cat');
+    });
+});
+//# sourceMappingURL=LazyFileData.spec.js.map

package/dist/files/LazyFileData.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LazyFileData.spec.js","sourceRoot":"","sources":["../../src/files/LazyFileData.spec.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAC9B,iDAA8C;AAE9C,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;;QAC9B,MAAM,IAAI,GAAG,IAAI,2BAAY,CAAC,KAAK,CAAC,CAAC;QACrC,IAAA,aAAM,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAA,aAAM,EAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAC7C,IAAA,aAAM,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAEvC,wBAAwB;QACxB,IAAA,aAAM,EAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC/C,IAAA,aAAM,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAC5C,IAAA,aAAM,EAAC,MAAA,IAAI,CAAC,cAAc,CAAC,0CAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACvD,IAAA,aAAM,EAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;;QAC5C,MAAM,IAAI,GAAG,IAAI,2BAAY,CACzB,IAAI,2BAAY,CAAC,KAAK,CAAC,CAC1B,CAAC;QACF,IAAA,aAAM,EAAC,MAAA,IAAI,CAAC,KAAK,0CAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;QACvB,IAAA,aAAM,EACF,IAAI,2BAAY,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,EAAE,CACxD,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/files/XmlFile.d.ts

@@ -1,36 +1,62 @@
 import type { CodeWithSourceMap } from 'source-map';
-import type { CompletionItem, Location, Position, Range } from 'vscode-languageserver';
-import type { Callable, BsDiagnostic, FileReference, FunctionCall, CommentFlag, BscFile, Hover } from '../interfaces';
+import type { Location, Position, Range } from 'vscode-languageserver';
+import type { Callable, BsDiagnostic, FileReference, FunctionCall, CommentFlag, SerializedCodeFile } from '../interfaces';
 import type { Program } from '../Program';
 import SGParser from '../parser/SGParser';
 import type { DependencyGraph } from '../DependencyGraph';
-import type { SGAst, SGToken } from '../parser/SGTypes';
+import { type SGToken } from '../parser/SGTypes';
 import type { IToken, TokenType } from 'chevrotain';
-import type { FunctionExpression } from '../parser/Expression';
-export declare class XmlFile {
+import type { BscFile } from './BscFile';
+import type { Editor } from '../astUtils/Editor';
+import type { FunctionScope } from '../FunctionScope';
+export declare class XmlFile implements BscFile {
+    /**
+     * Create a new instance of BrsFile
+     */
+    constructor(options: {
+        /**
+         * The absolute path to the source file on disk (e.g. '/usr/you/projects/RokuApp/source/main.brs' or 'c:/projects/RokuApp/source/main.brs').
+         */
+        srcPath: string;
+        /**
+         * The absolute path to the file on-device (i.e. 'source/main.brs') without the leading `pkg:/`
+         */
+        destPath: string;
+        pkgPath?: string;
+        program: Program;
+    });
+    type: string;
     /**
      * The absolute path to the source file on disk (e.g. '/usr/you/projects/RokuApp/source/main.brs' or 'c:/projects/RokuApp/source/main.brs').
      */
     srcPath: string;
     /**
-     * The full pkg path (i.e. `pkg:/path/to/file.brs`)
+     * The absolute path to the file on-device (i.e. 'source/main.brs') without the leading `pkg:/`
      */
+    destPath: string;
     pkgPath: string;
     program: Program;
-    constructor(
     /**
-     * The absolute path to the source file on disk (e.g. '/usr/you/projects/RokuApp/source/main.brs' or 'c:/projects/RokuApp/source/main.brs').
+     * An editor assigned during the build flow that manages edits that will be undone once the build process is complete.
      */
-    srcPath: string, 
+    editor?: Editor;
     /**
-     * The full pkg path (i.e. `pkg:/path/to/file.brs`)
+     * The absolute path to the source location for this file
+     * @deprecated use `srcPath` instead
      */
-    pkgPath: string, program: Program);
+    get pathAbsolute(): string;
+    set pathAbsolute(value: string);
     private cache;
     /**
      * The list of possible autoImport codebehind pkg paths.
+     * @deprecated use `possibleCodebehindDestPaths` instead.
+     */
+    get possibleCodebehindPkgPaths(): string[];
+    set possibleCodebehindPkgPaths(value: string[]);
+    /**
+     * The list of possible autoImport codebehind destPath values
      */
-    private possibleCodebehindPkgPaths;
+    possibleCodebehindDestPaths: string[];
     /**
      * An unsubscribe function for the dependencyGraph subscription
      */
@@ -45,13 +71,17 @@ export declare class XmlFile {
      */
     extension: string;
     commentFlags: CommentFlag[];
+    /**
+     * Will this file result in only comment or whitespace output? If so, it can be excluded from the output if that bsconfig setting is enabled.
+     */
+    readonly canBePruned = false;
     /**
      * The list of script imports delcared in the XML of this file.
      * This excludes parent imports and auto codebehind imports
      */
     get scriptTagImports(): FileReference[];
     /**
-     * List of all pkgPaths to scripts that this XmlFile depends, regardless of whether they are loaded in the program or not.
+     * List of all `destPath` values pointing to scripts that this XmlFile depends on, regardless of whether they are loaded in the program or not.
      * This includes own dependencies and all parent compoent dependencies
      * coming from:
      *  - script tags
@@ -60,7 +90,7 @@ export declare class XmlFile {
      */
     getAllDependencies(): string[];
     /**
-     * List of all pkgPaths to scripts that this XmlFile depends on directly, regardless of whether they are loaded in the program or not.
+     * List of all destPaths to scripts that this XmlFile depends on directly, regardless of whether they are loaded in the program or not.
      * This does not account for parent component scripts
      * coming from:
      *  - script tags
@@ -69,7 +99,7 @@ export declare class XmlFile {
      */
     getOwnDependencies(): string[];
     /**
-     * List of all pkgPaths to scripts that this XmlFile depends on that are actually loaded into the program.
+     * List of all destPaths to scripts that this XmlFile depends on that are actually loaded into the program.
      * This does not account for parent component scripts.
      * coming from:
      *  - script tags
@@ -83,10 +113,14 @@ export declare class XmlFile {
      * The range of the entire file
      */
     fileRange: Range;
+    /**
+     * Diagnostics for this file
+     */
     diagnostics: BsDiagnostic[];
     parser: SGParser;
     callables: Callable[];
     functionCalls: FunctionCall[];
+    functionScopes: FunctionScope[];
     /**
      * The name of the component that this component extends.
      * Available after `parse()`
@@ -99,35 +133,46 @@ export declare class XmlFile {
     get componentName(): SGToken;
     /**
      * Does this file need to be transpiled?
+     * @deprecated use the `.editor` property to push changes to the file, which will force transpilation
      */
-    needsTranspiled: boolean;
+    get needsTranspiled(): boolean;
+    set needsTranspiled(value: boolean);
+    _needsTranspiled: boolean;
     /**
      * The AST for this file
      */
-    get ast(): SGAst;
+    get ast(): import("../parser/SGTypes").SGAst;
     /**
      * The full file contents
      */
     fileContents: string;
     /**
      * Calculate the AST for this file
-     * @param fileContents
+     * @param fileContents the xml source code to parse
      */
     parse(fileContents: string): void;
-    validate(): void;
+    /**
+     * Generate the code, map, and typedef for this file
+     */
+    serialize(): SerializedCodeFile;
     /**
      * Collect all bs: comment flags
      */
     getCommentFlags(tokens: Array<IToken & {
         tokenType: TokenType;
     }>): void;
-    private validateComponent;
     private dependencyGraph;
+    onDependenciesChanged(): void;
     /**
      * Attach the file to the dependency graph so it can monitor changes.
      * Also notify the dependency graph of our current dependencies so other dependents can be notified.
+     * @deprecated this does nothing. This functionality is now handled by the file api and will be deleted in v1
      */
     attachDependencyGraph(dependencyGraph: DependencyGraph): void;
+    /**
+     * The list of files that this file depends on
+     */
+    get dependencies(): string[];
     /**
      * A slight hack. Gives the Program a way to support multiple components with the same name
      * without causing major issues. A value of 0 will be ignored as part of the dependency graph key.
@@ -139,9 +184,10 @@ export declare class XmlFile {
     /**
      * The key used in the dependency graph for this file.
      * If we have a component name, we will use that so we can be discoverable by child components.
-     * If we don't have a component name, use the pkgPath so at least we can self-validate
+     * If we don't have a component name, use the destPath so at least we can self-validate
      */
     get dependencyGraphKey(): string;
+    set dependencyGraphKey(value: string);
     /**
      * The key used in the dependency graph for this component's parent.
      * If we have aparent, we will use that. If we don't, this will return undefined
@@ -149,26 +195,18 @@ export declare class XmlFile {
     get parentComponentDependencyGraphKey(): string;
     /**
      * Determines if this xml file has a reference to the specified file (or if it's itself)
-     * @param file
      */
     doesReferenceFile(file: BscFile): boolean;
-    /**
-     * Get all available completions for the specified position
-     * @param lineIndex
-     * @param columnIndex
-     */
-    getCompletions(position: Position): CompletionItem[];
     /**
      * Get the parent component (the component this component extends)
      */
     get parentComponent(): XmlFile;
-    getHover(position: Position): Hover;
     getReferences(position: Position): Promise<Location[]>;
-    getFunctionExpressionAtPosition(position: Position, functionExpressions?: FunctionExpression[]): FunctionExpression;
+    getFunctionScopeAtPosition(position: Position, functionScopes?: FunctionScope[]): FunctionScope;
     /**
      * Walk up the ancestor chain and aggregate all of the script tag imports
      */
-    getAncestorScriptTagImports(): any[];
+    getAncestorScriptTagImports(): FileReference[];
     /**
      * Remove this file from the dependency graph as a node
      */
@@ -179,7 +217,7 @@ export declare class XmlFile {
      * and only includes the ones that are not found on the parent.
      * If no parent is found, all imports are returned
      */
-    private getMissingImportsForTranspile;
+    getMissingImportsForTranspile(): string[];
     private logDebug;
     /**
      * Convert the brightscript/brighterscript source code into valid brightscript