Add generic type param for addReplaceFile.

Export `BscType` type for `BrsFile | XmlFile`

docs/plugins.md

@@ -129,12 +129,12 @@ export interface CompilerPlugin {
     beforeScopeValidate?: ValidateHandler;
     afterScopeValidate?: ValidateHandler;
     beforeFileParse?: (source: SourceObj) => void;
-    afterFileParse?: (file: (BrsFile | XmlFile)) => void;
-    afterFileValidate?: (file: (BrsFile | XmlFile)) => void;
+    afterFileParse?: (file: BscFile) => void;
+    afterFileValidate?: (file: BscFile) => void;
     beforeFileTranspile?: (entry: TranspileObj) => void;
     afterFileTranspile?: (entry: TranspileObj) => void;
-    beforeFileDispose?: (file: (BrsFile | XmlFile)) => void;
-    afterFileDispose?: (file: (BrsFile | XmlFile)) => void;
+    beforeFileDispose?: (file: BscFile) => void;
+    afterFileDispose?: (file: BscFile) => void;
 }
 
 // related types:
@@ -149,11 +149,11 @@ interface SourceObj {
 }
 
 interface TranspileObj {
-    file: (BrsFile | XmlFile);
+    file: (BscFile);
     outputPath: string;
 }
 
-type ValidateHandler = (scope: Scope, files: (BrsFile | XmlFile)[], callables: CallableContainerMap) => void;
+type ValidateHandler = (scope: Scope, files: BscFile[], callables: CallableContainerMap) => void;
 interface CallableContainerMap {
     [name: string]: CallableContainer[];
 }
@@ -206,7 +206,7 @@ const pluginInterface: CompilerPlugin = {
 export default pluginInterface;
 
 // post-parsing validation
-function afterFileValidate(file: BrsFile | XmlFile) {
+function afterFileValidate(file: BscFile) {
     if (!isBrsFile(file)) {
         return;
     }

src/Program.ts

@@ -7,7 +7,7 @@ import { Scope } from './Scope';
 import { DiagnosticMessages } from './DiagnosticMessages';
 import { BrsFile } from './files/BrsFile';
 import { XmlFile } from './files/XmlFile';
-import { BsDiagnostic, File, FileReference, FileObj } from './interfaces';
+import { BsDiagnostic, File, FileReference, FileObj, BscFile } from './interfaces';
 import { standardizePath as s, util } from './util';
 import { XmlScope } from './XmlScope';
 import { DiagnosticFilterer } from './DiagnosticFilterer';
@@ -27,7 +27,7 @@ export interface SourceObj {
 }
 
 export interface TranspileObj {
-    file: (BrsFile | XmlFile);
+    file: BscFile;
     outputPath: string;
 }
 
@@ -111,7 +111,7 @@ export class Program {
     /**
      * A map of every file loaded into this program
      */
-    public files = {} as { [pathAbsolute: string]: BrsFile | XmlFile };
+    public files = {} as { [pathAbsolute: string]: BscFile };
 
     private scopes = {} as { [name: string]: Scope };
 
@@ -235,14 +235,14 @@ export class Program {
      * contents from the file system.
      * @param filePaths
      */
-    public async addOrReplaceFiles(fileObjects: Array<FileObj>) {
+    public async addOrReplaceFiles<T extends BscFile[]>(fileObjects: Array<FileObj>) {
         let promises = [];
         for (let fileObject of fileObjects) {
             promises.push(
                 this.addOrReplaceFile(fileObject)
             );
         }
-        return Promise.all(promises);
+        return Promise.all(promises) as Promise<T>;
     }
 
     public getPkgPath(...args: any[]): any { //eslint-disable-line
@@ -284,15 +284,15 @@ export class Program {
      * @param relativePath the file path relative to the root dir
      * @param fileContents the file contents. If not provided, the file will be loaded from disk
      */
-    public async addOrReplaceFile(relativePath: string, fileContents?: string): Promise<XmlFile | BrsFile>;
+    public async addOrReplaceFile<T extends BscFile>(relativePath: string, fileContents?: string): Promise<T>;
     /**
      * 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 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
      */
-    public async addOrReplaceFile(fileEntry: FileObj, fileContents?: string): Promise<XmlFile | BrsFile>;
-    public async addOrReplaceFile(fileParam: FileObj | string, fileContents?: string): Promise<XmlFile | BrsFile> {
+    public async addOrReplaceFile<T extends BscFile>(fileEntry: FileObj, fileContents?: string): Promise<T>;
+    public async addOrReplaceFile<T extends BscFile>(fileParam: FileObj | string, fileContents?: string): Promise<T> {
         assert.ok(fileParam, 'fileEntry is required');
         let pathAbsolute: string;
         let pkgPath: string;
@@ -313,7 +313,7 @@ export class Program {
                 this.removeFile(pathAbsolute);
             }
             let fileExtension = path.extname(pathAbsolute).toLowerCase();
-            let file: BrsFile | XmlFile | undefined;
+            let file: BscFile | undefined;
 
             //load the file contents by file path if not provided
             let getFileContents = async () => {
@@ -391,7 +391,7 @@ export class Program {
             }
             return file;
         });
-        return file;
+        return file as T;
     }
 
     /**
@@ -424,7 +424,7 @@ export class Program {
      * Get a list of files for the given pkgPath array.
      * Missing files are just ignored.
      */
-    public getFilesByPkgPaths(pkgPaths: string[]) {
+    public getFilesByPkgPaths<T extends BscFile[]>(pkgPaths: string[]) {
         pkgPaths = pkgPaths.map(x => s`${x}`.toLowerCase());
 
         let result = [] as Array<XmlFile | BrsFile>;
@@ -434,15 +434,15 @@ export class Program {
                 result.push(file);
             }
         }
-        return result;
+        return result as T;
     }
 
     /**
      * Get a file with the specified pkg path.
      * If not found, return undefined
      */
-    public getFileByPkgPath(pkgPath: string) {
-        return this.getFilesByPkgPaths([pkgPath])[0];
+    public getFileByPkgPath<T extends BscFile>(pkgPath: string) {
+        return this.getFilesByPkgPaths([pkgPath])[0] as T;
     }
 
     /**
@@ -573,7 +573,7 @@ export class Program {
     /**
      * Determine if the given file is included in at least one scope in this program
      */
-    private fileIsIncludedInAnyScope(file: BrsFile | XmlFile) {
+    private fileIsIncludedInAnyScope(file: BscFile) {
         for (let scopeName in this.scopes) {
             if (this.scopes[scopeName].hasFile(file)) {
                 return true;
@@ -586,9 +586,9 @@ export class Program {
      * Get the file at the given path
      * @param pathAbsolute
      */
-    private getFile(pathAbsolute: string) {
+    private getFile<T extends BscFile>(pathAbsolute: string) {
         pathAbsolute = s`${pathAbsolute}`;
-        return this.files[pathAbsolute];
+        return this.files[pathAbsolute] as T;
     }
 
     /**

src/Scope.ts

@@ -1,9 +1,7 @@
 import { CompletionItem, CompletionItemKind, Location, Position, Range } from 'vscode-languageserver';
 import chalk from 'chalk';
 import { DiagnosticMessages, DiagnosticInfo } from './DiagnosticMessages';
-import { BrsFile } from './files/BrsFile';
-import { XmlFile } from './files/XmlFile';
-import { CallableContainer, BsDiagnostic, FileReference } from './interfaces';
+import { CallableContainer, BsDiagnostic, FileReference, BscFile } from './interfaces';
 import { Program } from './Program';
 import { BsClassValidator } from './validators/ClassValidator';
 import { NamespaceStatement, ParseMode, Statement, NewExpression, FunctionStatement, ClassStatement } from './parser';
@@ -131,7 +129,7 @@ export class Scope {
 
     public getFiles() {
         return this.cache.getOrAdd('files', () => {
-            let result = [] as Array<BrsFile | XmlFile>;
+            let result = [] as BscFile[];
             let dependencies = this.program.dependencyGraph.getAllDependencies(this.dependencyGraphKey);
             for (let dependency of dependencies) {
                 //skip scopes and components
@@ -380,7 +378,7 @@ export class Scope {
         this.cache.clear();
     }
 
-    private detectVariableNamespaceCollisions(file: BrsFile | XmlFile) {
+    private detectVariableNamespaceCollisions(file: BscFile) {
         //find all function parameters
         for (let func of file.parser.references.functionExpressions) {
             for (let param of func.parameters) {
@@ -428,7 +426,7 @@ export class Scope {
     /**
      * Find function declarations with the same name as a stdlib function
      */
-    private diagnosticDetectFunctionCollisions(file: BrsFile | XmlFile) {
+    private diagnosticDetectFunctionCollisions(file: BscFile) {
         for (let func of file.callables) {
             if (globalCallableMap[func.getName(ParseMode.BrighterScript).toLowerCase()]) {
                 this.diagnostics.push({
@@ -464,7 +462,7 @@ export class Scope {
      * @param file
      * @param callableContainersByLowerName
      */
-    private diagnosticDetectFunctionCallsWithWrongParamCount(file: BrsFile | XmlFile, callableContainersByLowerName: { [lowerName: string]: CallableContainer[] }) {
+    private diagnosticDetectFunctionCallsWithWrongParamCount(file: BscFile, callableContainersByLowerName: { [lowerName: string]: CallableContainer[] }) {
         //validate all function calls
         for (let expCall of file.functionCalls) {
             let callableContainersWithThisName = callableContainersByLowerName[expCall.name.toLowerCase()];
@@ -503,7 +501,7 @@ export class Scope {
      * @param file
      * @param callableContainerMap
      */
-    private diagnosticDetectShadowedLocalVars(file: BrsFile | XmlFile, callableContainerMap: { [lowerName: string]: CallableContainer[] }) {
+    private diagnosticDetectShadowedLocalVars(file: BscFile, callableContainerMap: { [lowerName: string]: CallableContainer[] }) {
         //loop through every function scope
         for (let scope of file.functionScopes) {
             //every var declaration in this scope
@@ -558,7 +556,7 @@ export class Scope {
      * @param file
      * @param callablesByLowerName
      */
-    private diagnosticDetectCallsToUnknownFunctions(file: BrsFile | XmlFile, callablesByLowerName: { [lowerName: string]: CallableContainer[] }) {
+    private diagnosticDetectCallsToUnknownFunctions(file: BscFile, callablesByLowerName: { [lowerName: string]: CallableContainer[] }) {
         //validate all expression calls
         for (let expCall of file.functionCalls) {
             let lowerName = expCall.name.toLowerCase();
@@ -727,7 +725,7 @@ export class Scope {
      * Determine if this scope is referenced and known by the file.
      * @param file
      */
-    public hasFile(file: BrsFile | XmlFile) {
+    public hasFile(file: BscFile) {
         let files = this.getFiles();
         let hasFile = files.includes(file);
         return hasFile;
@@ -759,7 +757,7 @@ export class Scope {
     /**
      * Get the definition (where was this thing first defined) of the symbol under the position
      */
-    public getDefinition(file: BrsFile | XmlFile, position: Position): Location[] { //eslint-disable-line
+    public getDefinition(file: BscFile, position: Position): Location[] { //eslint-disable-line
         //TODO implement for brs files
         return [];
     }
@@ -778,7 +776,7 @@ export class Scope {
 }
 
 interface NamespaceContainer {
-    file: BrsFile | XmlFile;
+    file: BscFile;
     fullName: string;
     nameRange: Range;
     lastPartName: string;
@@ -789,5 +787,5 @@ interface NamespaceContainer {
 }
 
 interface AugmentedNewExpression extends NewExpression {
-    file: BrsFile | XmlFile;
+    file: BscFile;
 }

src/XmlScope.spec.ts

@@ -19,21 +19,21 @@ describe('XmlScope', () => {
 
     describe('constructor', () => {
         it('listens for attach/detach parent events', async () => {
-            let parentXmlFile = await program.addOrReplaceFile('components/parent.xml', `
+            let parentXmlFile = await program.addOrReplaceFile<XmlFile>('components/parent.xml', `
                 <?xml version="1.0" encoding="utf-8" ?>
                 <component name="Parent" extends="Scene">
                 </component>
-            `) as XmlFile;
+            `);
             let scope = program.getScopeByName(parentXmlFile.pkgPath);
 
             //should default to global scope
             expect(scope.getParentScope()).to.equal(program.globalScope);
 
-            let childXmlFile = await program.addOrReplaceFile('components/child.xml', `
+            let childXmlFile = await program.addOrReplaceFile<XmlFile>('components/child.xml', `
                 <?xml version="1.0" encoding="utf-8" ?>
                 <component name="Child" extends="Parent">
                 </component>
-            `) as XmlFile;
+            `);
             let childScope = program.getComponentScope('Child');
 
             await program.validate();

src/XmlScope.ts

@@ -1,9 +1,8 @@
 import { Location, Position } from 'vscode-languageserver';
 import { Scope } from './Scope';
 import { DiagnosticMessages } from './DiagnosticMessages';
-import { BrsFile } from './files/BrsFile';
 import { XmlFile } from './files/XmlFile';
-import { FileReference } from './interfaces';
+import { BscFile, FileReference } from './interfaces';
 import { Program } from './Program';
 import util from './util';
 import { isXmlFile } from './astUtils/reflection';
@@ -85,7 +84,7 @@ export class XmlScope extends Scope {
         return this.cache.getOrAdd('files', () => {
             let result = [
                 this.xmlFile
-            ] as Array<BrsFile | XmlFile>;
+            ] as BscFile[];
             let scriptPkgPaths = this.xmlFile.getAllScriptImports();
             for (let scriptPkgPath of scriptPkgPaths) {
                 let file = this.program.getFileByPkgPath(scriptPkgPath);
@@ -100,7 +99,7 @@ export class XmlScope extends Scope {
     /**
      * Get the definition (where was this thing first defined) of the symbol under the position
      */
-    public getDefinition(file: BrsFile | XmlFile, position: Position): Location[] {
+    public getDefinition(file: BscFile, position: Position): Location[] {
         let results = [] as Location[];
         //if the position is within the file's parent component name
         if (

src/astUtils/reflection.ts

@@ -6,16 +6,16 @@ import { BrsFile } from '../files/BrsFile';
 import { XmlFile } from '../files/XmlFile';
 import { InternalWalkMode } from './visitors';
 import { FunctionType } from '../types/FunctionType';
-import { File } from '../interfaces';
+import { BscFile, File } from '../interfaces';
 import { StringType } from '../types/StringType';
 
 // File reflection
 
-export function isBrsFile(file: (BrsFile | XmlFile | File)): file is BrsFile {
+export function isBrsFile(file: (BscFile | File)): file is BrsFile {
     return file?.constructor.name === 'BrsFile';
 }
 
-export function isXmlFile(file: (BrsFile | XmlFile)): file is XmlFile {
+export function isXmlFile(file: (BscFile)): file is XmlFile {
     return file?.constructor.name === 'XmlFile';
 }
 

src/astUtils/visitors.spec.ts

@@ -311,7 +311,7 @@ describe('astUtils visitors', () => {
 
     describe('walk', () => {
         async function testWalk(text: string, expectedConstructors: string[], walkMode = WalkMode.visitAllRecursive) {
-            const file = await program.addOrReplaceFile('source/main.bs', text) as BrsFile;
+            const file = await program.addOrReplaceFile<BrsFile>('source/main.bs', text);
             const items = [];
             let index = 1;
             file.ast.walk((element: any) => {
@@ -325,14 +325,14 @@ describe('astUtils visitors', () => {
         }
 
         it('Walks through all expressions until cancelled', async () => {
-            const file = await program.addOrReplaceFile('source/main.bs', `
+            const file = await program.addOrReplaceFile<BrsFile>('source/main.bs', `
                 sub logger(message = "nil" as string)
                     innerLog = sub(message = "nil" as string)
                         print message
                     end sub
                     innerLog(message)
                 end sub
-            `) as BrsFile;
+            `);
 
             const cancel = new CancellationTokenSource();
             let count = 0;

src/examples/plugins/removePrint.ts

@@ -1,8 +1,6 @@
 import { isBrsFile } from '../../astUtils/reflection';
 import { createVisitor, WalkMode } from '../../astUtils/visitors';
-import { BrsFile } from '../../files/BrsFile';
-import { XmlFile } from '../../files/XmlFile';
-import { CompilerPlugin } from '../../interfaces';
+import { BscFile, CompilerPlugin } from '../../interfaces';
 import { EmptyStatement } from '../../parser/Statement';
 
 // entry point
@@ -14,7 +12,7 @@ export default pluginInterface;
 
 // note: it is normally not recommended to modify the AST too much at this stage,
 // because if the plugin runs in a language-server context it could break intellisense
-function afterFileParse(file: (BrsFile | XmlFile)) {
+function afterFileParse(file: BscFile) {
     if (!isBrsFile(file)) {
         return;
     }