Adds plugin hooks for file validation

src/Program.spec.ts

@@ -2335,4 +2335,34 @@ describe('Program', () => {
             }
         });
     });
+
+    describe('plugins', () => {
+        it('emits file validation events', () => {
+            const plugin = {
+                name: 'test',
+                beforeFileValidate: sinon.spy(),
+                onFileValidate: sinon.spy(),
+                afterFileValidate: sinon.spy()
+            };
+            program.plugins.add(plugin);
+            program.addOrReplaceFile('source/main.brs', '');
+            expect(plugin.beforeFileValidate.callCount).to.equal(1);
+            expect(plugin.onFileValidate.callCount).to.equal(1);
+            expect(plugin.afterFileValidate.callCount).to.equal(1);
+        });
+
+        it('emits file validation events', () => {
+            const plugin = {
+                name: 'test',
+                beforeFileValidate: sinon.spy(),
+                onFileValidate: sinon.spy(),
+                afterFileValidate: sinon.spy()
+            };
+            program.plugins.add(plugin);
+            program.addOrReplaceFile('components/main.xml', '');
+            expect(plugin.beforeFileValidate.callCount).to.equal(1);
+            expect(plugin.onFileValidate.callCount).to.equal(1);
+            expect(plugin.afterFileValidate.callCount).to.equal(1);
+        });
+    });
 });

src/files/BrsFile.ts

@@ -276,6 +276,18 @@ export class BrsFile {
             //find all places where a sub/function is being called
             this.findFunctionCalls();
 
+            //emit an event before starting to validate this file
+            this.program.plugins.emit('beforeFileValidate', {
+                file: this,
+                program: this.program
+            });
+
+            //emit an event to allow plugins to contribute to the file validation process
+            this.program.plugins.emit('onFileValidate', {
+                file: this,
+                program: this.program
+            });
+
             this.findAndValidateImportAndImportStatements();
 
             //attach this file to every diagnostic

src/files/XmlFile.ts

@@ -193,16 +193,28 @@ export class XmlFile {
 
         this.getCommentFlags(this.parser.tokens as any[]);
 
-        if (!this.parser.ast.root) {
-            //skip empty XML
-            return;
-        }
-
         //notify AST ready
         this.program.plugins.emit('afterFileParse', this);
 
-        //initial validation
-        this.validateComponent(this.parser.ast);
+        //emit an event before starting to validate this file
+        this.program.plugins.emit('beforeFileValidate', {
+            file: this,
+            program: this.program
+        });
+
+        //emit an event to allow plugins to contribute to the file validation process
+        this.program.plugins.emit('onFileValidate', {
+            file: this,
+            program: this.program
+        });
+
+        if (this.parser.ast.root) {
+
+            //initial validation
+            this.validateComponent(this.parser.ast);
+        } else {
+            //skip empty XML
+        }
     }
 
     /**

src/interfaces.ts

@@ -207,6 +207,17 @@ export interface CompilerPlugin {
     //file events
     beforeFileParse?: (source: SourceObj) => void;
     afterFileParse?: (file: BscFile) => void;
+    /**
+     * Called before each file is validated
+     */
+    beforeFileValidate?: PluginHandler<BeforeFileValidateEvent>;
+    /**
+     * Called during the file validation process. If your plugin contributes file validations, this is a good place to contribute them.
+     */
+    onFileValidate?: PluginHandler<OnFileValidateEvent>;
+    /**
+     * Called after each file is validated
+     */
     afterFileValidate?: (file: BscFile) => void;
     beforeFileTranspile?: PluginHandler<BeforeFileTranspileEvent>;
     afterFileTranspile?: PluginHandler<AfterFileTranspileEvent>;
@@ -231,6 +242,16 @@ export interface OnGetSemanticTokensEvent {
     semanticTokens: SemanticToken[];
 }
 
+export interface BeforeFileValidateEvent<T extends BscFile = BscFile> {
+    program: Program;
+    file: T;
+}
+
+export interface OnFileValidateEvent<T extends BscFile = BscFile> {
+    program: Program;
+    file: T;
+}
+
 export type Editor = Pick<AstEditor, 'addToArray' | 'hasChanges' | 'removeFromArray' | 'setArrayValue' | 'setProperty'>;
 
 export interface BeforeFileTranspileEvent {