PR feedback: remove more instanceof, rename splitStringIntoLines to s…

…plitIntoLines, remove TokenKind limitations for onReferences

scripts/compile-doc-examples.ts

@@ -24,7 +24,7 @@ class DocCompiler {
 
     public async processDoc(docPath: string) {
         let contents = fsExtra.readFileSync(docPath).toString();
-        this.lines = util.splitStringIntoLines(contents);
+        this.lines = util.splitIntoLines(contents);
         this.index = 0;
         while (this.index < this.lines.length) {
             let line = this.lines[this.index];
@@ -61,7 +61,7 @@ class DocCompiler {
 
         var transpiledStartIndex: number;
         var transpiledStopIndex: number;
-        //find the transpiled code block (there must be one after every 
+        //find the transpiled code block (there must be one after every
         //+2 to step past the last line of code, and the final ```
         outer: for (var i = sourceStopIndex + 2; i < this.lines.length; i++) {
             let line = this.lines[i];
@@ -122,4 +122,4 @@ new DocCompiler().run()
         console.log.bind(console)
     ).catch(
         console.error.bind(console)
-    );
+    );

src/LanguageServer.spec.ts

@@ -490,7 +490,7 @@ describe('LanguageServer', () => {
             }
         });
 
-        it('should return an empty response if we entered on anything other than an identifier token', async () => {
+        it('should return an empty response if we entered on a token that should not return any results', async () => {
             let references = await svr.onReferences({
                 textDocument: {
                     uri: functionDocument.uri

src/LanguageServer.ts

@@ -42,6 +42,7 @@ import { BrsFile } from './files/BrsFile';
 import type { Token } from './lexer';
 import { Lexer } from './lexer';
 import { DiagnosticCollection } from './DiagnosticCollection';
+import { isBrsFile } from './astUtils/reflection';
 
 export class LanguageServer {
     //cast undefined as any to get around strictNullChecks...it's ok in this case
@@ -962,7 +963,7 @@ export class LanguageServer {
         const pathAbsolute = util.uriToPath(params.textDocument.uri);
         for (const workspace of this.getWorkspaces()) {
             const file = workspace.builder.program.getFileByPathAbsolute(pathAbsolute);
-            if (file instanceof BrsFile) {
+            if (isBrsFile(file)) {
                 const symbols = await file.getDocumentSymbols();
                 return symbols;
             }

src/Program.ts

@@ -664,7 +664,7 @@ export class Program {
         const results = await Promise.all(
             Object.keys(this.files).map(async key => {
                 const file = this.files[key];
-                if (file instanceof BrsFile) {
+                if (isBrsFile(file)) {
                     return file.getWorkspaceSymbols();
                 }
                 return [];
@@ -683,7 +683,7 @@ export class Program {
             return [];
         }
 
-        if (file instanceof BrsFile) {
+        if (isBrsFile(file)) {
             return file.getDefinition(position);
         } else {
             let results = [] as Location[];
@@ -719,7 +719,7 @@ export class Program {
         const scopes = this.getScopesForFile(file);
         for (const scope of scopes) {
             for (const file of scope.getFiles()) {
-                if (file instanceof XmlFile) {
+                if (isXmlFile(file)) {
                     continue;
                 }
 

src/files/BrsFile.ts

@@ -22,7 +22,7 @@ import { TranspileState } from '../parser/TranspileState';
 import { Preprocessor } from '../preprocessor/Preprocessor';
 import { LogLevel } from '../Logger';
 import { serializeError } from 'serialize-error';
-import { isCallExpression, isClassMethodStatement, isClassStatement, isCommentStatement, isDottedGetExpression, isFunctionExpression, isFunctionStatement, isFunctionType, isImportStatement, isLibraryStatement, isLiteralExpression, isNamespaceStatement, isStringType, isVariableExpression } from '../astUtils/reflection';
+import { isCallExpression, isClassMethodStatement, isClassStatement, isCommentStatement, isDottedGetExpression, isFunctionExpression, isFunctionStatement, isFunctionType, isImportStatement, isLibraryStatement, isLiteralExpression, isNamespaceStatement, isStringType, isVariableExpression, isXmlFile } from '../astUtils/reflection';
 import { createVisitor, WalkMode } from '../astUtils/visitors';
 import { XmlFile } from './XmlFile';
 import type { DependencyGraph } from '../DependencyGraph';
@@ -1137,6 +1137,7 @@ export class BrsFile {
         //get the token at the position
         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 = [
             TokenKind.Identifier,
             TokenKind.StringLiteral
@@ -1177,7 +1178,7 @@ export class BrsFile {
         //look through all files in scope for matches
         for (const scope of this.program.getScopesForFile(this)) {
             for (const file of scope.getFiles()) {
-                if (file instanceof XmlFile || filesSearched[file.pathAbsolute]) {
+                if (isXmlFile(file) || filesSearched[file.pathAbsolute]) {
                     continue;
                 }
                 filesSearched[file.pathAbsolute] = true;
@@ -1298,7 +1299,7 @@ export class BrsFile {
         }
         const documentation = functionComments.join('').trim();
 
-        const lines = util.splitStringIntoLines(this.fileContents);
+        const lines = util.splitIntoLines(this.fileContents);
 
         const params = [] as ParameterInformation[];
         for (const param of func.parameters) {
@@ -1317,18 +1318,13 @@ export class BrsFile {
 
         let locations = [] as Location[];
 
-        // No need to actually look if they didn't select a token we can search against
-        if (callSiteToken?.kind !== TokenKind.Identifier) {
-            return locations;
-        }
-
         const searchFor = callSiteToken.text.toLowerCase();
 
         const scopes = this.program.getScopesForFile(this);
 
         for (const scope of scopes) {
             for (const file of scope.getFiles()) {
-                if (file instanceof XmlFile) {
+                if (isXmlFile(file)) {
                     continue;
                 }
 
@@ -1361,7 +1357,7 @@ export class BrsFile {
         } else {
             //create a source map from the original source code
             let chunks = [] as (SourceNode | string)[];
-            let lines = util.splitStringIntoLines(this.fileContents);
+            let lines = util.splitIntoLines(this.fileContents);
             for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
                 let line = lines[lineIndex];
                 chunks.push(

src/util.ts

@@ -919,7 +919,7 @@ export class Util {
         }
     }
 
-    public splitStringIntoLines(string: string) {
+    public splitIntoLines(string: string) {
         return string.split(/\r?\n/g);
     }
 
@@ -928,7 +928,7 @@ export class Util {
         if (Array.isArray(string)) {
             lines = string;
         } else {
-            lines = this.splitStringIntoLines(string);
+            lines = this.splitIntoLines(string);
         }
 
         const start = range.start;