brighterscript 0.41.6 → 0.44.0

package/dist/files/BrsFile.d.ts

@@ -3,13 +3,13 @@ import type { CompletionItem, Hover, Position } from 'vscode-languageserver';
 import { Location, SignatureInformation, DocumentSymbol, SymbolInformation } from 'vscode-languageserver';
 import type { Scope } from '../Scope';
 import { FunctionScope } from '../FunctionScope';
-import type { Callable, CommentFlag, FunctionCall, BsDiagnostic, FileReference } from '../interfaces';
-import type { Token } from '../lexer';
-import { TokenKind } from '../lexer';
-import { Parser, ParseMode } from '../parser';
+import type { Callable, CommentFlag, FunctionCall, BsDiagnostic, FileReference, FileLink } from '../interfaces';
+import type { Token } from '../lexer/Token';
+import { TokenKind } from '../lexer/TokenKind';
+import { Parser, ParseMode } from '../parser/Parser';
 import type { FunctionExpression, Expression } from '../parser/Expression';
 import type { ClassStatement, Statement } from '../parser/Statement';
-import type { FileLink, Program, SignatureInfoObj } from '../Program';
+import type { Program, SignatureInfoObj } from '../Program';
 import type { DependencyGraph } from '../DependencyGraph';
 /**
  * Holds all details about this file within the scope of the whole program
@@ -34,6 +34,11 @@ export declare class BrsFile {
      * The key used to identify this file in the dependency graph
      */
     dependencyGraphKey: string;
+    /**
+     * Indicates whether this file needs to be validated.
+     * Files are only ever validated a single time
+     */
+    isValidated: boolean;
     /**
      * The all-lowercase extension for this file (including the leading dot)
      */
@@ -57,7 +62,7 @@ export declare class BrsFile {
     /**
      * The AST for this file
      */
-    get ast(): import("../parser").Body;
+    get ast(): import("../parser/Statement").Body;
     private documentSymbols;
     private workspaceSymbols;
     /**
@@ -103,7 +108,9 @@ export declare class BrsFile {
      * @param fileContents
      */
     parse(fileContents: string): void;
-    findAndValidateImportAndImportStatements(): void;
+    private registerImports;
+    validate(): void;
+    private validateImportStatements;
     /**
      * Find a class. This scans all scopes for this file, and returns the first matching class that is found.
      * Returns undefined if not found.
@@ -192,6 +199,10 @@ export declare class BrsFile {
     getDefinition(position: Position): Location[];
     getClassMemberDefinitions(textToSearchFor: string, file: BrsFile): Location[];
     getHover(position: Position): Hover;
+    /**
+     * Build a hover documentation for a callable.
+     */
+    private getCallableDocumentation;
     getSignatureHelpForNamespaceMethods(callableName: string, dottedGetText: string, scope: Scope): {
         key: string;
         signature: SignatureInformation;

package/dist/files/BrsFile.js

@@ -7,8 +7,9 @@ const chalk_1 = require("chalk");
 const path = require("path");
 const DiagnosticMessages_1 = require("../DiagnosticMessages");
 const FunctionScope_1 = require("../FunctionScope");
-const lexer_1 = require("../lexer");
-const parser_1 = require("../parser");
+const Lexer_1 = require("../lexer/Lexer");
+const TokenKind_1 = require("../lexer/TokenKind");
+const Parser_1 = require("../parser/Parser");
 const DynamicType_1 = require("../types/DynamicType");
 const FunctionType_1 = require("../types/FunctionType");
 const VoidType_1 = require("../types/VoidType");
@@ -36,7 +37,12 @@ class BrsFile {
         /**
          * The parseMode used for the parser for this file
          */
-        this.parseMode = parser_1.ParseMode.BrightScript;
+        this.parseMode = Parser_1.ParseMode.BrightScript;
+        /**
+         * Indicates whether this file needs to be validated.
+         * Files are only ever validated a single time
+         */
+        this.isValidated = false;
         this.diagnostics = [];
         this.commentFlags = [];
         this.callables = [];
@@ -57,7 +63,7 @@ class BrsFile {
         //all BrighterScript files need to be transpiled
         if ((_a = this.extension) === null || _a === void 0 ? void 0 : _a.endsWith('.bs')) {
             this.needsTranspiled = true;
-            this.parseMode = parser_1.ParseMode.BrighterScript;
+            this.parseMode = Parser_1.ParseMode.BrighterScript;
         }
         this.isTypedef = this.extension === '.d.bs';
         if (!this.isTypedef) {
@@ -145,11 +151,13 @@ class BrsFile {
             this.diagnostics = [];
             //if we have a typedef file, skip parsing this file
             if (this.hasTypedef) {
+                //skip validation since the typedef is shadowing this file
+                this.isValidated = true;
                 return;
             }
             //tokenize the input file
             let lexer = this.program.logger.time(Logger_1.LogLevel.debug, ['lexer.lex', chalk_1.default.green(this.pathAbsolute)], () => {
-                return lexer_1.Lexer.scan(fileContents, {
+                return Lexer_1.Lexer.scan(fileContents, {
                     includeWhitespace: false
                 });
             });
@@ -172,32 +180,50 @@ class BrsFile {
             //if the preprocessor generated tokens, use them.
             let tokens = preprocessor.processedTokens.length > 0 ? preprocessor.processedTokens : lexer.tokens;
             this.program.logger.time(Logger_1.LogLevel.debug, ['parser.parse', chalk_1.default.green(this.pathAbsolute)], () => {
-                this._parser = parser_1.Parser.parse(tokens, {
+                this._parser = Parser_1.Parser.parse(tokens, {
                     mode: this.parseMode,
                     logger: this.program.logger
                 });
             });
             //absorb all lexing/preprocessing/parsing diagnostics
             this.diagnostics.push(...lexer.diagnostics, ...preprocessor.diagnostics, ...this._parser.diagnostics);
-            //notify AST ready
-            this.program.plugins.emit('afterFileParse', this);
             //extract all callables from this file
             this.findCallables();
             //find all places where a sub/function is being called
             this.findFunctionCalls();
-            this.findAndValidateImportAndImportStatements();
+            //register all import statements for use in the rest of the program
+            this.registerImports();
             //attach this file to every diagnostic
             for (let diagnostic of this.diagnostics) {
                 diagnostic.file = this;
             }
         }
         catch (e) {
-            this._parser = new parser_1.Parser();
+            this._parser = new Parser_1.Parser();
             this.diagnostics.push(Object.assign({ file: this, range: util_1.util.createRange(0, 0, 0, Number.MAX_VALUE) }, DiagnosticMessages_1.DiagnosticMessages.genericParserMessage('Critical error parsing file: ' + JSON.stringify((0, serialize_error_1.serializeError)(e)))));
         }
     }
-    findAndValidateImportAndImportStatements() {
-        var _a;
+    registerImports() {
+        var _a, _b, _c, _d;
+        for (const statement of (_c = (_b = (_a = this.parser) === null || _a === void 0 ? void 0 : _a.references) === null || _b === void 0 ? void 0 : _b.importStatements) !== null && _c !== void 0 ? _c : []) {
+            //register import statements
+            if ((0, reflection_1.isImportStatement)(statement) && statement.filePathToken) {
+                this.ownScriptImports.push({
+                    filePathRange: statement.filePathToken.range,
+                    pkgPath: util_1.util.getPkgPathFromTarget(this.pkgPath, statement.filePath),
+                    sourceFile: this,
+                    text: (_d = statement.filePathToken) === null || _d === void 0 ? void 0 : _d.text
+                });
+            }
+        }
+    }
+    validate() {
+        //only validate the file if it was actually parsed (skip files containing typedefs)
+        if (!this.hasTypedef) {
+            this.validateImportStatements();
+        }
+    }
+    validateImportStatements() {
         let topOfFileIncludeStatements = [];
         for (let stmt of this.ast.statements) {
             //skip comments
@@ -218,15 +244,6 @@ class BrsFile {
             ...this._parser.references.importStatements
         ];
         for (let result of statements) {
-            //register import statements
-            if ((0, reflection_1.isImportStatement)(result) && result.filePathToken) {
-                this.ownScriptImports.push({
-                    filePathRange: result.filePathToken.range,
-                    pkgPath: util_1.util.getPkgPathFromTarget(this.pkgPath, result.filePath),
-                    sourceFile: this,
-                    text: (_a = result.filePathToken) === null || _a === void 0 ? void 0 : _a.text
-                });
-            }
             //if this statement is not one of the top-of-file statements,
             //then add a diagnostic explaining that it is invalid
             if (!topOfFileIncludeStatements.includes(result)) {
@@ -284,7 +301,7 @@ class BrsFile {
         const processor = new CommentFlagProcessor_1.CommentFlagProcessor(this, ['rem', `'`], DiagnosticMessages_1.diagnosticCodes, [DiagnosticMessages_1.DiagnosticCodeMap.unknownDiagnosticCode]);
         this.commentFlags = [];
         for (let token of tokens) {
-            if (token.kind === lexer_1.TokenKind.Comment) {
+            if (token.kind === TokenKind_1.TokenKind.Comment) {
                 processor.tryAdd(token.text, token.range);
             }
         }
@@ -374,9 +391,9 @@ class BrsFile {
                 }
                 functionType.setName(assignment.name.text);
                 for (let param of assignment.value.parameters) {
-                    let isRequired = !param.defaultValue;
+                    let isOptional = !!param.defaultValue;
                     //TODO compute optional parameters
-                    functionType.addParameter(param.name.text, param.type, isRequired);
+                    functionType.addParameter(param.name.text, param.type, isOptional);
                 }
                 return functionType;
                 //literal
@@ -436,8 +453,8 @@ class BrsFile {
                     isRestArgument: false
                 };
                 params.push(callableParam);
-                let isRequired = !param.defaultValue;
-                functionType.addParameter(callableParam.name, callableParam.type, isRequired);
+                let isOptional = !!param.defaultValue;
+                functionType.addParameter(callableParam.name, callableParam.type, isOptional);
             }
             this.callables.push({
                 isSub: statement.func.functionType.text.toLowerCase() === 'sub',
@@ -570,10 +587,10 @@ class BrsFile {
         //if cursor is within a comment, disable completions
         let currentToken = this.getTokenAt(position);
         const tokenKind = currentToken === null || currentToken === void 0 ? void 0 : currentToken.kind;
-        if (tokenKind === lexer_1.TokenKind.Comment) {
+        if (tokenKind === TokenKind_1.TokenKind.Comment) {
             return [];
         }
-        else if (tokenKind === lexer_1.TokenKind.StringLiteral || tokenKind === lexer_1.TokenKind.TemplateStringQuasi) {
+        else if (tokenKind === TokenKind_1.TokenKind.StringLiteral || tokenKind === TokenKind_1.TokenKind.TemplateStringQuasi) {
             const match = /^("?)(pkg|libpkg):/.exec(currentToken.text);
             if (match) {
                 const [, openingQuote, fileProtocol] = match;
@@ -605,7 +622,7 @@ class BrsFile {
         let functionScope = this.getFunctionScopeAtPosition(position);
         if (!functionScope) {
             //we aren't in any function scope, so return the keyword completions and namespaces
-            if (this.getTokenBefore(currentToken, lexer_1.TokenKind.New)) {
+            if (this.getTokenBefore(currentToken, TokenKind_1.TokenKind.New)) {
                 // there's a new keyword, so only class types are viable here
                 return [...this.getGlobalClassStatementCompletions(currentToken, this.parseMode)];
             }
@@ -614,17 +631,17 @@ class BrsFile {
             }
         }
         const classNameCompletions = this.getGlobalClassStatementCompletions(currentToken, this.parseMode);
-        const newToken = this.getTokenBefore(currentToken, lexer_1.TokenKind.New);
+        const newToken = this.getTokenBefore(currentToken, TokenKind_1.TokenKind.New);
         if (newToken) {
             //we are after a new keyword; so we can only be namespaces or classes at this point
             result.push(...classNameCompletions);
             result.push(...namespaceCompletions);
             return result;
         }
-        if (this.tokenFollows(currentToken, lexer_1.TokenKind.Goto)) {
+        if (this.tokenFollows(currentToken, TokenKind_1.TokenKind.Goto)) {
             return this.getLabelCompletion(functionScope);
         }
-        if (this.isPositionNextToTokenKind(position, lexer_1.TokenKind.Dot)) {
+        if (this.isPositionNextToTokenKind(position, TokenKind_1.TokenKind.Dot)) {
             if (namespaceCompletions.length > 0) {
                 //if we matched a namespace, after a dot, it can't be anything else but something from our namespace completions
                 return namespaceCompletions;
@@ -670,7 +687,7 @@ class BrsFile {
                     kind: (0, reflection_1.isFunctionType)(variable.type) ? vscode_languageserver_1.CompletionItemKind.Function : vscode_languageserver_1.CompletionItemKind.Variable
                 });
             }
-            if (this.parseMode === parser_1.ParseMode.BrighterScript) {
+            if (this.parseMode === Parser_1.ParseMode.BrighterScript) {
                 //include the first part of namespaces
                 let namespaces = scope.getAllNamespaceStatements();
                 for (let stmt of namespaces) {
@@ -700,7 +717,7 @@ class BrsFile {
         let classStatement = this.getClassFromMReference(position, currentToken, functionScope);
         let results = new Map();
         if (classStatement) {
-            let classes = scope.getClassHierarchy(classStatement.item.getName(parser_1.ParseMode.BrighterScript).toLowerCase());
+            let classes = scope.getClassHierarchy(classStatement.item.getName(Parser_1.ParseMode.BrighterScript).toLowerCase());
             for (let cs of classes) {
                 for (let member of [...(_b = (_a = cs === null || cs === void 0 ? void 0 : cs.item) === null || _a === void 0 ? void 0 : _a.fields) !== null && _b !== void 0 ? _b : [], ...(_d = (_c = cs === null || cs === void 0 ? void 0 : cs.item) === null || _c === void 0 ? void 0 : _c.methods) !== null && _d !== void 0 ? _d : []]) {
                     if (!results.has(member.name.text.toLowerCase())) {
@@ -716,21 +733,21 @@ class BrsFile {
     }
     getClassFromMReference(position, currentToken, functionScope) {
         let previousToken = this.getPreviousToken(currentToken);
-        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === lexer_1.TokenKind.Dot) {
+        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === TokenKind_1.TokenKind.Dot) {
             previousToken = this.getPreviousToken(previousToken);
         }
-        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === lexer_1.TokenKind.Identifier && (previousToken === null || previousToken === void 0 ? void 0 : previousToken.text.toLowerCase()) === 'm' && (0, reflection_1.isClassMethodStatement)(functionScope.func.functionStatement)) {
+        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === TokenKind_1.TokenKind.Identifier && (previousToken === null || previousToken === void 0 ? void 0 : previousToken.text.toLowerCase()) === 'm' && (0, reflection_1.isClassMethodStatement)(functionScope.func.functionStatement)) {
             return { item: this.parser.references.classStatements.find((cs) => util_1.util.rangeContains(cs.range, position)), file: this };
         }
         return undefined;
     }
     getGlobalClassStatementCompletions(currentToken, parseMode) {
         var _a;
-        if (parseMode === parser_1.ParseMode.BrightScript) {
+        if (parseMode === Parser_1.ParseMode.BrightScript) {
             return [];
         }
         let results = new Map();
-        let completionName = (_a = this.getPartialVariableName(currentToken, [lexer_1.TokenKind.New])) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+        let completionName = (_a = this.getPartialVariableName(currentToken, [TokenKind_1.TokenKind.New])) === null || _a === void 0 ? void 0 : _a.toLowerCase();
         if (completionName === null || completionName === void 0 ? void 0 : completionName.includes('.')) {
             return [];
         }
@@ -752,17 +769,17 @@ class BrsFile {
     }
     getNamespaceCompletions(currentToken, parseMode, scope) {
         //BrightScript does not support namespaces, so return an empty list in that case
-        if (parseMode === parser_1.ParseMode.BrightScript) {
+        if (parseMode === Parser_1.ParseMode.BrightScript) {
             return [];
         }
-        let completionName = this.getPartialVariableName(currentToken, [lexer_1.TokenKind.New]);
+        let completionName = this.getPartialVariableName(currentToken, [TokenKind_1.TokenKind.New]);
         if (!completionName) {
             return [];
         }
         //remove any trailing identifer and then any trailing dot, to give us the
         //name of its immediate parent namespace
         let closestParentNamespaceName = completionName.replace(/\.([a-z0-9_]*)?$/gi, '');
-        let newToken = this.getTokenBefore(currentToken, lexer_1.TokenKind.New);
+        let newToken = this.getTokenBefore(currentToken, TokenKind_1.TokenKind.New);
         let result = new Map();
         for (let [, namespace] of scope.namespaceLookup) {
             //completionName = "NameA."
@@ -811,11 +828,11 @@ class BrsFile {
             return undefined;
         }
         let location;
-        const nameParts = this.getPartialVariableName(token, [lexer_1.TokenKind.New]).split('.');
+        const nameParts = this.getPartialVariableName(token, [TokenKind_1.TokenKind.New]).split('.');
         const endName = nameParts[nameParts.length - 1].toLowerCase();
         const namespaceName = nameParts.slice(0, -1).join('.').toLowerCase();
         const statementHandler = (statement) => {
-            if (!location && statement.getName(parser_1.ParseMode.BrighterScript).toLowerCase() === namespaceName) {
+            if (!location && statement.getName(Parser_1.ParseMode.BrighterScript).toLowerCase() === namespaceName) {
                 const namespaceItemStatementHandler = (statement) => {
                     if (!location && statement.name.text.toLowerCase() === endName) {
                         const uri = util_1.util.pathToUri(file.pathAbsolute);
@@ -841,7 +858,7 @@ class BrsFile {
      * Given a current token, walk
      */
     getPartialVariableName(currentToken, excludeTokens = null) {
-        let identifierAndDotKinds = [lexer_1.TokenKind.Identifier, ...lexer_1.AllowedLocalIdentifiers, lexer_1.TokenKind.Dot];
+        let identifierAndDotKinds = [TokenKind_1.TokenKind.Identifier, ...TokenKind_1.AllowedLocalIdentifiers, TokenKind_1.TokenKind.Dot];
         //consume tokens backwards until we find something other than a dot or an identifier
         let tokens = [];
         const parser = this.parser;
@@ -867,17 +884,17 @@ class BrsFile {
         const previousToken = this.getPreviousToken(closestToken);
         const previousTokenKind = previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind;
         //next to matched token
-        if (!closestToken || closestToken.kind === lexer_1.TokenKind.Eof) {
+        if (!closestToken || closestToken.kind === TokenKind_1.TokenKind.Eof) {
             return false;
         }
         else if (closestToken.kind === tokenKind) {
             return true;
         }
-        else if (closestToken.kind === lexer_1.TokenKind.Newline || previousTokenKind === lexer_1.TokenKind.Newline) {
+        else if (closestToken.kind === TokenKind_1.TokenKind.Newline || previousTokenKind === TokenKind_1.TokenKind.Newline) {
             return false;
             //next to an identifier, which is next to token kind
         }
-        else if (closestToken.kind === lexer_1.TokenKind.Identifier && previousTokenKind === tokenKind) {
+        else if (closestToken.kind === TokenKind_1.TokenKind.Identifier && previousTokenKind === tokenKind) {
             return true;
         }
         else {
@@ -888,7 +905,7 @@ class BrsFile {
         const index = this.parser.tokens.indexOf(currentToken);
         for (let i = index - 1; i >= 0; i--) {
             currentToken = this.parser.tokens[i];
-            if (currentToken.kind === lexer_1.TokenKind.Newline) {
+            if (currentToken.kind === TokenKind_1.TokenKind.Newline) {
                 break;
             }
             else if (currentToken.kind === tokenKind) {
@@ -908,7 +925,7 @@ class BrsFile {
         let tokens = [];
         for (let i = this.parser.tokens.indexOf(currentToken); direction === -1 ? i >= 0 : i === this.parser.tokens.length; i += direction) {
             currentToken = this.parser.tokens[i];
-            if (currentToken.kind === lexer_1.TokenKind.Newline || currentToken.kind === tokenKind) {
+            if (currentToken.kind === TokenKind_1.TokenKind.Newline || currentToken.kind === tokenKind) {
                 break;
             }
             tokens.push(currentToken);
@@ -1052,7 +1069,7 @@ class BrsFile {
         else {
             return;
         }
-        const name = (0, reflection_1.isClassFieldStatement)(statement) ? statement.name.text : statement.getName(parser_1.ParseMode.BrighterScript);
+        const name = (0, reflection_1.isClassFieldStatement)(statement) ? statement.name.text : statement.getName(Parser_1.ParseMode.BrighterScript);
         return vscode_languageserver_1.DocumentSymbol.create(name, '', symbolKind, statement.range, statement.range, children);
     }
     /**
@@ -1086,9 +1103,9 @@ class BrsFile {
         else {
             return symbols;
         }
-        const name = statement.getName(parser_1.ParseMode.BrighterScript);
+        const name = statement.getName(Parser_1.ParseMode.BrighterScript);
         const uri = util_1.util.pathToUri(this.pathAbsolute);
-        const symbol = vscode_languageserver_1.SymbolInformation.create(name, symbolKind, statement.range, uri, containerStatement === null || containerStatement === void 0 ? void 0 : containerStatement.getName(parser_1.ParseMode.BrighterScript));
+        const symbol = vscode_languageserver_1.SymbolInformation.create(name, symbolKind, statement.range, uri, containerStatement === null || containerStatement === void 0 ? void 0 : containerStatement.getName(Parser_1.ParseMode.BrighterScript));
         symbols.push(symbol);
         return symbols;
     }
@@ -1102,8 +1119,8 @@ class BrsFile {
         const token = this.getTokenAt(position);
         // While certain other tokens are allowed as local variables (AllowedLocalIdentifiers: https://github.com/rokucommunity/brighterscript/blob/master/src/lexer/TokenKind.ts#L418), these are converted by the parser to TokenKind.Identifier by the time we retrieve the token using getTokenAt
         let definitionTokenTypes = [
-            lexer_1.TokenKind.Identifier,
-            lexer_1.TokenKind.StringLiteral
+            TokenKind_1.TokenKind.Identifier,
+            TokenKind_1.TokenKind.StringLiteral
         ];
         //throw out invalid tokens and the wrong kind of tokens
         if (!token || !definitionTokenTypes.includes(token.kind)) {
@@ -1111,7 +1128,7 @@ class BrsFile {
         }
         let textToSearchFor = token.text.toLowerCase();
         const previousToken = this.getTokenAt({ line: token.range.start.line, character: token.range.start.character });
-        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === lexer_1.TokenKind.Callfunc) {
+        if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === TokenKind_1.TokenKind.Callfunc) {
             for (const scope of this.program.getScopes()) {
                 //to only get functions defined in interface methods
                 const callable = scope.getAllCallables().find((c) => c.callable.name.toLowerCase() === textToSearchFor); // eslint-disable-line @typescript-eslint/no-loop-func
@@ -1121,7 +1138,7 @@ class BrsFile {
             }
             return results;
         }
-        let classToken = this.getTokenBefore(token, lexer_1.TokenKind.Class);
+        let classToken = this.getTokenBefore(token, TokenKind_1.TokenKind.Class);
         if (classToken) {
             let cs = this.parser.references.classStatements.find((cs) => cs.classKeyword.range === classToken.range);
             if (cs === null || cs === void 0 ? void 0 : cs.parentClassName) {
@@ -1133,7 +1150,7 @@ class BrsFile {
             }
             return results;
         }
-        if (token.kind === lexer_1.TokenKind.StringLiteral) {
+        if (token.kind === TokenKind_1.TokenKind.StringLiteral) {
             // We need to strip off the quotes but only if present
             const startIndex = textToSearchFor.startsWith('"') ? 1 : 0;
             let endIndex = textToSearchFor.length;
@@ -1153,7 +1170,7 @@ class BrsFile {
                     results.push(vscode_languageserver_1.Location.create(uri, varDeclaration.nameRange));
                 }
             }
-            if (this.tokenFollows(token, lexer_1.TokenKind.Goto)) {
+            if (this.tokenFollows(token, TokenKind_1.TokenKind.Goto)) {
                 for (const label of functionScope.labelStatements) {
                     if (label.name.toLocaleLowerCase() === textToSearchFor) {
                         const uri = util_1.util.pathToUri(this.pathAbsolute);
@@ -1170,7 +1187,7 @@ class BrsFile {
                     continue;
                 }
                 filesSearched.add(file);
-                if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === lexer_1.TokenKind.Dot && file.parseMode === parser_1.ParseMode.BrighterScript) {
+                if ((previousToken === null || previousToken === void 0 ? void 0 : previousToken.kind) === TokenKind_1.TokenKind.Dot && file.parseMode === Parser_1.ParseMode.BrighterScript) {
                     results.push(...this.getClassMemberDefinitions(textToSearchFor, file));
                     const namespaceDefinition = this.getNamespaceDefinitions(token, file);
                     if (namespaceDefinition) {
@@ -1214,14 +1231,15 @@ class BrsFile {
         return results;
     }
     getHover(position) {
+        const fence = (code) => util_1.util.mdFence(code, 'brightscript');
         //get the token at the position
         let token = this.getTokenAt(position);
         let hoverTokenTypes = [
-            lexer_1.TokenKind.Identifier,
-            lexer_1.TokenKind.Function,
-            lexer_1.TokenKind.EndFunction,
-            lexer_1.TokenKind.Sub,
-            lexer_1.TokenKind.EndSub
+            TokenKind_1.TokenKind.Identifier,
+            TokenKind_1.TokenKind.Function,
+            TokenKind_1.TokenKind.EndFunction,
+            TokenKind_1.TokenKind.Sub,
+            TokenKind_1.TokenKind.EndSub
         ];
         //throw out invalid tokens and the wrong kind of tokens
         if (!token || !hoverTokenTypes.includes(token.kind)) {
@@ -1247,7 +1265,7 @@ class BrsFile {
                         return {
                             range: token.range,
                             //append the variable name to the front for scope
-                            contents: typeText
+                            contents: fence(typeText)
                         };
                     }
                 }
@@ -1255,7 +1273,7 @@ class BrsFile {
                     if (labelStatement.name.toLocaleLowerCase() === lowerTokenText) {
                         return {
                             range: token.range,
-                            contents: `${labelStatement.name}: label`
+                            contents: fence(`${labelStatement.name}: label`)
                         };
                     }
                 }
@@ -1269,12 +1287,41 @@ class BrsFile {
                 if (callable) {
                     return {
                         range: token.range,
-                        contents: callable.type.toString()
+                        contents: this.getCallableDocumentation(callable)
                     };
                 }
             }
         }
     }
+    /**
+     * Build a hover documentation for a callable.
+     */
+    getCallableDocumentation(callable) {
+        var _a;
+        const comments = [];
+        const tokens = callable.file.parser.tokens;
+        const idx = tokens.indexOf((_a = callable.functionStatement) === null || _a === void 0 ? void 0 : _a.func.functionType);
+        for (let i = idx - 1; i >= 0; i--) {
+            const token = tokens[i];
+            //skip whitespace and newline chars
+            if (token.kind === TokenKind_1.TokenKind.Comment) {
+                comments.push(token);
+            }
+            else if (token.kind === TokenKind_1.TokenKind.Newline || token.kind === TokenKind_1.TokenKind.Whitespace) {
+                //skip these tokens
+                continue;
+                //any other token means there are no more comments
+            }
+            else {
+                break;
+            }
+        }
+        let result = util_1.util.mdFence(callable.type.toString(), 'brightscript');
+        if (comments.length > 0) {
+            result += '\n***\n' + comments.reverse().map(x => x.text.replace(/^('|rem)/i, '')).join('\n');
+        }
+        return result;
+    }
     getSignatureHelpForNamespaceMethods(callableName, dottedGetText, scope) {
         var _a;
         if (!dottedGetText) {
@@ -1321,12 +1368,12 @@ class BrsFile {
                 }
             }
             const kind = currentToken.kind;
-            if (kind === lexer_1.TokenKind.Comment) {
+            if (kind === TokenKind_1.TokenKind.Comment) {
                 // Strip off common leading characters to make it easier to read
                 const commentText = currentToken.text.replace(/^[' *\/]+/, '');
                 functionComments.unshift(commentText);
             }
-            else if (kind === lexer_1.TokenKind.Newline) {
+            else if (kind === TokenKind_1.TokenKind.Newline) {
                 if (functionComments.length === 0) {
                     continue;
                 }
@@ -1385,7 +1432,7 @@ class BrsFile {
         const classConstructor = this.getClassMethod(classStatement, 'new');
         let sigHelp = classConstructor ? this.getSignatureHelpForStatement(classConstructor) : undefined;
         if (sigHelp) {
-            sigHelp.key = classStatement.getName(parser_1.ParseMode.BrighterScript);
+            sigHelp.key = classStatement.getName(Parser_1.ParseMode.BrighterScript);
             sigHelp.signature.label = sigHelp.signature.label.replace(/(function|sub) new/, sigHelp.key);
         }
         return sigHelp;
@@ -1462,7 +1509,7 @@ exports.BrsFile = BrsFile;
  * List of completions for all valid keywords/reserved words.
  * Build this list once because it won't change for the lifetime of this process
  */
-exports.KeywordCompletions = Object.keys(lexer_1.Keywords)
+exports.KeywordCompletions = Object.keys(TokenKind_1.Keywords)
     //remove any keywords with whitespace
     .filter(x => !x.includes(' '))
     //create completions