brighterscript 1.0.0-alpha.3 → 1.0.0-alpha.31

package/dist/Program.d.ts

@@ -1,44 +1,47 @@
-import type { CodeAction, CompletionItem, Position, Range, SignatureInformation, SymbolInformation } from 'vscode-languageserver';
-import { Location } from 'vscode-languageserver';
-import type { BsConfig } from './BsConfig';
+import type { CodeAction, Position, Range, SignatureInformation, Location, DocumentSymbol } from 'vscode-languageserver';
+import type { BsConfig, FinalizedBsConfig } from './BsConfig';
 import { Scope } from './Scope';
-import { BrsFile } from './files/BrsFile';
-import { XmlFile } from './files/XmlFile';
-import type { BsDiagnostic, FileReference, FileObj, BscFile } from './interfaces';
+import type { FileObj, SemanticToken, FileLink, Hover } from './interfaces';
 import { XmlScope } from './XmlScope';
-import { Logger } from './Logger';
+import type { Logger } from './logging';
 import PluginInterface from './PluginInterface';
-import type { FunctionStatement, Statement } from './parser/Statement';
-export interface SourceObj {
-    srcPath: string;
-    source: string;
-    definitions?: string;
-}
-export interface TranspileObj {
-    file: BscFile;
-    outputPath: string;
-}
+import type { FunctionStatement } from './parser/Statement';
+import { Editor } from './astUtils/Editor';
+import type { Statement } from './parser/AstNode';
+import type { FileData } from './files/LazyFileData';
+import type { UnresolvedSymbol } from './AstValidationSegmenter';
+import type { BscFile } from './files/BscFile';
+import { CrossScopeValidator } from './CrossScopeValidator';
+import { DiagnosticManager } from './DiagnosticManager';
+import type { ProvidedSymbolInfo, BrsFile } from './files/BrsFile';
+import type { XmlFile } from './files/XmlFile';
 export interface SignatureInfoObj {
     index: number;
     key: string;
     signature: SignatureInformation;
 }
-export interface FileLink<T> {
-    item: T;
-    file: BrsFile;
-}
 export declare class Program {
-    /**
-     * The root directory for this program
-     */
-    options: BsConfig;
     constructor(
     /**
      * The root directory for this program
      */
-    options: BsConfig, logger?: Logger, plugins?: PluginInterface);
+    options: BsConfig, logger?: Logger, plugins?: PluginInterface, diagnosticsManager?: DiagnosticManager);
+    options: FinalizedBsConfig;
     logger: Logger;
+    /**
+     * An editor that plugins can use to modify program-level things during the build flow. Don't use this to edit files (they have their own `.editor`)
+     */
+    editor: Editor;
+    /**
+     * A factory that creates `File` instances
+     */
+    private fileFactory;
     private createGlobalScope;
+    private recursivelyAddNodeToSymbolTable;
+    /**
+     * Do all setup required for the global symbol table.
+     */
+    private populateGlobalSymbolTable;
     /**
      * A graph of all files and their dependencies.
      * For example:
@@ -46,7 +49,7 @@ export declare class Program {
      *      lib2.brs -> [lib3.brs] //via an import statement
      */
     private dependencyGraph;
-    private diagnosticFilterer;
+    diagnostics: DiagnosticManager;
     /**
      * A scope that contains all built-in global functions.
      * All scopes should directly or indirectly inherit from this scope
@@ -56,28 +59,31 @@ export declare class Program {
      * Plugins which can provide extra diagnostics or transform AST
      */
     plugins: PluginInterface;
-    /**
-     * A set of diagnostics. This does not include any of the scope diagnostics.
-     * Should only be set from `this.validate()`
-     */
-    private diagnostics;
+    private fileSymbolInformation;
+    addFileSymbolInfo(file: BrsFile): void;
+    getFileSymbolInfo(file: BrsFile): {
+        provides: ProvidedSymbolInfo;
+        requires: UnresolvedSymbol[];
+    };
     /**
      * The path to bslib.brs (the BrightScript runtime for certain BrighterScript features)
      */
-    get bslibPkgPath(): "pkg:/source/roku_modules/bslib/bslib.brs" | "pkg:/source/roku_modules/rokucommunity_bslib/bslib.brs" | "pkg:/source/bslib.brs";
+    get bslibPkgPath(): string;
     get bslibPrefix(): "rokucommunity_bslib" | "bslib";
     /**
-     * A map of every file loaded ino this program, indexed by its lower-case pkgPath
+     * A map of every file loaded into this program, indexed by its original file location
      */
-    private pkgMap;
+    files: Record<string, BscFile>;
     /**
-     * A map of every file loaded into this program, indexed by its lower-case srcPath
+     * A map of every file loaded into this program, indexed by its destPath
      */
-    private files;
+    private destMap;
     /**
-     * Get a copy of the list of files currently loaded in the program
+     * Plugins can contribute multiple virtual files for a single physical file.
+     * This collection links the virtual files back to the physical file that produced them.
+     * The key is the standardized and lower-cased srcPath
      */
-    getFiles(): (BrsFile | XmlFile)[];
+    private fileClusters;
     private scopes;
     protected addScope(scope: Scope): void;
     /**
@@ -94,6 +100,14 @@ export declare class Program {
         file: XmlFile;
         scope: XmlScope;
     };
+    /**
+     * Get the sorted names of custom components
+     */
+    getSortedComponentNames(): string[];
+    /**
+     * Keeps a set of all the components that need to have their types updated during the current validation cycle
+     */
+    private componentSymbolsToUpdate;
     /**
      * Register (or replace) the reference to a component in the component map
      */
@@ -102,6 +116,18 @@ export declare class Program {
      * Remove the specified component from the components map
      */
     private unregisterComponent;
+    /**
+     * Adds a component described in an XML to the set of components that needs to be updated this validation cycle.
+     * @param xmlFile XML file with <component> tag
+     */
+    private addDeferredComponentTypeSymbolCreation;
+    private getComponentKey;
+    /**
+     * Updates the global symbol table with the first component in this.components to have the same name as the component in the file
+     * @param componentKey key getting a component from `this.components`
+     * @param componentName the unprefixed name of the component that will be added (e.g. 'MyLabel' NOT 'roSgNodeMyLabel')
+     */
+    private updateComponentSymbolInGlobalScope;
     /**
      * re-attach the dependency graph with a new key for any component who changed
      * their position in their own named array (only matters when there are multiple
@@ -112,24 +138,22 @@ export declare class Program {
      * Get a list of all files that are included in the project but are not referenced
      * by any scope in the program.
      */
-    getUnreferencedFiles(): (BrsFile | XmlFile)[];
+    getUnreferencedFiles(): BscFile[];
     /**
-     * Get the list of errors for the entire program. It's calculated on the fly
-     * by walking through every file, so call this sparingly.
+     * Get the list of errors for the entire program.
      */
-    getDiagnostics(): BsDiagnostic[];
-    addDiagnostics(diagnostics: BsDiagnostic[]): void;
+    getDiagnostics(): import("./interfaces").BsDiagnostic[];
     /**
      * Determine if the specified file is loaded in this program right now.
-     * @param filePath
+     * @param filePath the absolute or relative path to the file
      * @param normalizePath should the provided path be normalized before use
      */
     hasFile(filePath: string, normalizePath?: boolean): boolean;
     /**
      * roku filesystem is case INsensitive, so find the scope by key case insensitive
-     * @param scopeName
+     * @param scopeName xml scope names are their `destPath`. Source scope is stored with the key `"source"`
      */
-    getScopeByName(scopeName: string): Scope;
+    getScopeByName(scopeName: string): Scope | undefined;
     /**
      * Return all scopes
      */
@@ -149,16 +173,34 @@ export declare class Program {
     /**
      * 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
-     * @param srcDestOrPkgPath the absolute path, or the pkg path (i.e. `pkg:/path/to/file.brs`) or the destPath (i.e. `path/to/file.brs` relative to `pkg:/`)
-     * @param fileContents the file contents
+     * @param srcDestOrPkgPath the absolute path, the pkg path (i.e. `pkg:/path/to/file.brs`), or the destPath (i.e. `path/to/file.brs` relative to `pkg:/`)
+     * @param fileData the file contents. omit or pass `undefined` to prevent loading the data at this time
      */
-    setFile<T extends BscFile>(srcDestOrPkgPath: string, fileContents: string): T;
+    setFile<T extends BscFile>(srcDestOrPkgPath: string, fileData?: FileData): T;
     /**
      * Load a file into the program. If that file already exists, it is replaced.
      * @param fileEntry an object that specifies src and dest for the file.
-     * @param fileContents the file contents. If not provided, the file will be loaded from disk
+     * @param fileData the file contents. omit or pass `undefined` to prevent loading the data at this time
+     */
+    setFile<T extends BscFile>(fileEntry: FileObj, fileData: FileData): T;
+    /**
+     * Given a srcPath, a destPath, or both, resolve whichever is missing, relative to rootDir.
+     * @param fileParam an object representing file paths
+     * @param rootDir must be a pre-normalized path
      */
-    setFile<T extends BscFile>(fileEntry: FileObj, fileContents: string): T;
+    private getPaths;
+    /**
+     * Remove any leading `pkg:/` found in the path
+     */
+    private removePkgPrefix;
+    /**
+     * Is this file a .brs file found somewhere within the `pkg:/source/` folder?
+     */
+    private isSourceBrsFile;
+    /**
+     * Is this file a .brs file found somewhere within the `pkg:/source/` folder?
+     */
+    private isComponentsXmlFile;
     /**
      * Ensure source scope is created.
      * Note: automatically called internally, and no-op if it exists already.
@@ -166,110 +208,167 @@ export declare class Program {
     createSourceScope(): void;
     /**
      * Remove a set of files from the program
-     * @param srcPaths
+     * @param srcPaths 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(srcPaths: string[]): void;
+    removeFiles(srcPaths: string[], normalizePath?: boolean): void;
     /**
      * Remove a file from the program
-     * @param filePath can be a srcPath, a pkgPath, or a destPath (same as pkgPath but without `pkg:/`)
+     * @param filePath can be a srcPath, a destPath, or a destPath with leading `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(filePath: string, normalizePath?: boolean): void;
-    /**
-     * Remove all files from the program that are in the specified folder path (recursive)
-     * @param folderSrcPath The absolute path to the folder on disk
-     * @param normalizePath should the provided path be normalized before use?
      */
-    removeFilesInFolder(folderSrcPath: string, normalizePath?: boolean): void;
+    removeFile(filePath: string, normalizePath?: boolean, keepSymbolInformation?: boolean): void;
+    crossScopeValidation: CrossScopeValidator;
+    private isFirstValidation;
     /**
      * 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
      */
     validate(): void;
+    private logValidationMetrics;
+    private getScopesForCrossScopeValidation;
     /**
      * Flag all duplicate component names
      */
     private detectDuplicateComponentNames;
     /**
-     * Determine at least one scope has the file
+     * 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
      */
-    private fileIsIncludedInAnyScope;
+    getFiles<T extends BscFile>(filePaths: string[], normalizePath?: boolean): T[];
     /**
      * Get the file at the given path
-     * @param filePath can be a srcPath, a pkgPath, or a destPath (same as pkgPath but without `pkg:/`)
+     * @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
      */
     getFile<T extends BscFile>(filePath: string, normalizePath?: boolean): T;
+    /**
+     * Gets a sorted list of all scopeNames, always beginning with "global", "source", then any others in alphabetical order
+     */
+    private getSortedScopeNames;
     /**
      * Get a list of all scopes the file is loaded into
-     * @param file
+     * @param file the file
      */
-    getScopesForFile(file: XmlFile | BrsFile): Scope[];
+    getScopesForFile(file: BscFile | string): Scope[];
+    /**
+     * Get the first found scope for a file.
+     */
+    getFirstScopeForFile(file: BscFile): Scope | undefined;
     getStatementsByName(name: string, originFile: BrsFile, namespaceName?: string): FileLink<Statement>[];
     getStatementsForXmlFile(scope: XmlScope, filterName?: string): FileLink<FunctionStatement>[];
     /**
      * Find all available completion items at the given position
-     * @param srcPath The absolute path to the source file on disk
-     * @param lineIndex
-     * @param columnIndex
+     * @param filePath can be a srcPath or a destPath
+     * @param position the position (line & column) where completions should be found
      */
-    getCompletions(srcPath: string, position: Position): CompletionItem[];
+    getCompletions(filePath: string, position: Position): import("vscode-languageserver-types").CompletionItem[];
     /**
      * Goes through each file and builds a list of workspace symbols for the program. Used by LanguageServer's onWorkspaceSymbol functionality
      */
-    getWorkspaceSymbols(): SymbolInformation[];
+    getWorkspaceSymbols(): import("vscode-languageserver-types").WorkspaceSymbol[];
     /**
      * Given a position in a file, if the position is sitting on some type of identifier,
      * go to the definition of that identifier (where this thing was first defined)
-     * @param srcPath The absolute path to the source file on disk
      */
     getDefinition(srcPath: string, position: Position): Location[];
     /**
-     * @param srcPath The absolute path to the source file on disk
+     * Get hover information for a file and position
      */
-    getHover(srcPath: string, position: Position): Promise<import("vscode-languageserver-types").Hover>;
+    getHover(srcPath: string, position: Position): Hover[];
+    /**
+     * Get full list of document symbols for a file
+     * @param srcPath path to the file
+     */
+    getDocumentSymbols(srcPath: string): DocumentSymbol[] | undefined;
     /**
      * Compute code actions for the given file and range
-     * @param srcPath The absolute path to the source file on disk
      */
     getCodeActions(srcPath: string, range: Range): CodeAction[];
+    /**
+     * Get semantic tokens for the specified file
+     */
+    getSemanticTokens(srcPath: string): SemanticToken[] | undefined;
     getSignatureHelp(filepath: string, position: Position): SignatureInfoObj[];
-    private getPartialStatementInfo;
-    private getPartialItemCounts;
+    getReferences(srcPath: string, position: Position): Location[];
     /**
-     * @param srcPath The absolute path to the source file on disk
+     * Transpile a single file and get the result as a string.
+     * This does not write anything to the file system.
+     *
+     * This should only be called by `LanguageServer`.
+     * Internal usage should call `_getTranspiledFileContents` instead.
+     * @param filePath can be a srcPath or a destPath
      */
-    getReferences(srcPath: string, position: Position): Location[] | Promise<Location[]>;
+    getTranspiledFileContents(filePath: string): Promise<FileTranspileResult>;
+    private getTranspiledFileContentsPipeline;
     /**
-     * Get a list of all script imports, relative to the specified pkgPath
-     * @param sourcePkgPath - the pkgPath of the source that wants to resolve script imports.
+     * Get the absolute output path for a file
      */
-    getScriptImportCompletions(sourcePkgPath: string, scriptImport: FileReference): CompletionItem[];
+    private getOutputPath;
+    private getStagingDir;
     /**
-     * Transpile a single file and get the result as a string.
-     * This does not write anything to the file system.
-     * @param srcPath The absolute path to the source file on disk
+     * Prepare the program for building
+     * @param files the list of files that should be prepared
      */
-    getTranspiledFileContents(srcPath: string): {
-        srcPath: string;
-        pkgPath: string;
-        code: string;
-        map: import("source-map").SourceMapGenerator;
-    };
-    transpile(fileEntries: FileObj[], stagingFolderPath: string): Promise<void>;
+    private prepare;
     /**
-     * Find a list of files in the program that have a function with the given name (case INsensitive)
+     * Generate the contents of every file
+     */
+    private serialize;
+    /**
+     * Write the entire project to disk
      */
-    findFilesForFunction(functionName: string): (BrsFile | XmlFile)[];
+    private write;
+    private buildPipeline;
+    /**
+     * Build the project. This transpiles/transforms/copies all files and moves them to the staging directory
+     * @param options the list of options used to build the program
+     */
+    build(options?: ProgramBuildOptions): Promise<void>;
     /**
      * Find a list of files in the program that have a function with the given name (case INsensitive)
      */
-    findFilesForClass(className: string): (BrsFile | XmlFile)[];
+    findFilesForFunction(functionName: string): BscFile[];
     /**
-     * Get a map of the manifest information
+     * Find a list of files in the program that have a class with the given name (case INsensitive)
      */
-    getManifest(): Map<string, string | number | boolean>;
+    findFilesForClass(className: string): BscFile[];
+    findFilesForNamespace(name: string): BscFile[];
+    findFilesForEnum(name: string): BscFile[];
     private _manifest;
+    /**
+     * Modify a parsed manifest map by reading `bs_const` and injecting values from `options.manifest.bs_const`
+     * @param parsedManifest The manifest map to read from and modify
+     */
+    private buildBsConstsIntoParsedManifest;
+    /**
+     * Try to find and load the manifest into memory
+     * @param manifestFileObj A pointer to a potential manifest file object found during loading
+     * @param replaceIfAlreadyLoaded should we overwrite the internal `_manifest` if it already exists
+     */
+    loadManifest(manifestFileObj?: FileObj, replaceIfAlreadyLoaded?: boolean): void;
+    /**
+     * Get a map of the manifest information
+     */
+    getManifest(): Map<string, string>;
     dispose(): void;
 }
+export interface FileTranspileResult {
+    srcPath: string;
+    destPath: string;
+    pkgPath: string;
+    code: string;
+    map: string;
+    typedef: string;
+}
+export interface ProgramBuildOptions {
+    /**
+     * The directory where the final built files should be placed. This directory will be cleared before running
+     */
+    stagingDir?: string;
+    /**
+     * An array of files to build. If omitted, the entire list of files from the program will be used instead.
+     * Typically you will want to leave this blank
+     */
+    files?: BscFile[];
+}