DocSymbol Work: range and selectionRange tweaks (#88)

* fix: docSymbol range and selectionRange accuracy increased

* fix: lint

* fix: moving kindmap out of the function

* fix: better ranges

* fix: rename prop method and fix some logger issues

* fix: moving typecheck into the symbol definition

* fix: range calcs and test

* fix: remove textdoc

* fix: more cleanup

* fix: logger fix for improved performance

* chore: review suggestions in pr form (#93)

chore: review sugestions in pr form

@W-18895479@

* fix: updating name

* fix: partial syms when we run into lexer or parser errors (#91)

* fix: partial syms when we run into lexer or parser errors

* fix: logger fix for improved performance

* fix: remove unused getCompilationUnit method

* fix: using the qualifiedName id for selectionRange on constructor methods

* feat: tests for the new id location detector in constructor

* fix: end ranges are exclusive so this needed to be increased by one

* feat: license text and fixed error log

* fix: workaround for constructor

---------

Co-authored-by: peternhale <[email protected]>

Author: kylewalke

LICENSE.txt

@@ -1,5 +1,3 @@
-BSD 3-Clause License
-
 Copyright (c) 2025, Salesforce, Inc.
 All rights reserved.
 
@@ -21,9 +19,10 @@ THIS SOFTWARE IS PROVIDED BY SALESFORCE AND CONTRIBUTORS "AS IS"
 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL SALESFORCE OR CONTRIBUTORS BE LIABLE
+
 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

packages/apex-parser-ast/src/index.ts

@@ -44,6 +44,7 @@ export * from './utils/PlatformUtils';
 
 // Export utils
 export * from './utils/AnnotationUtils';
+export * from './utils/symbolNarrowing';
 
 // Export semantic validators
 export * from './semantics/modifiers/index';

packages/apex-parser-ast/src/parser/compilerService.ts

@@ -6,7 +6,7 @@
  * repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { CharStreams, CommonTokenStream } from 'antlr4ts';
+import { CharStreams, CommonTokenStream, DefaultErrorStrategy } from 'antlr4ts';
 import {
   ApexLexer,
   ApexParser,
@@ -56,6 +56,18 @@ export interface CompilationResultWithAssociations<T>
   commentAssociations: CommentAssociation[];
 }
 
+/**
+ * Result of creating a parse tree.
+ */
+export interface ParseTreeResult {
+  fileName: string;
+  parseTree: CompilationUnitContext | TriggerUnitContext;
+  errorListener: ApexErrorListener;
+  lexer: ApexLexer;
+  tokenStream: CommonTokenStream;
+  parser: ApexParser;
+}
+
 /**
  * Options for compilation behavior
  */
@@ -89,6 +101,52 @@ export class CompilerService {
     );
   }
 
+  /**
+   * Creates a parse tree from the given file content.
+   * This method handles the setup of the lexer, parser, and error listeners.
+   * @param fileContent The content of the Apex file.
+   * @param fileName The name of the file, used for error reporting and trigger detection.
+   * @returns A ParseTreeResult containing the parse tree and related objects.
+   */
+  private createParseTree(
+    fileContent: string,
+    fileName: string = 'unknown.cls',
+  ): ParseTreeResult {
+    this.logger.debug(() => `Creating parse tree for ${fileName}`);
+
+    // Create error listener
+    const errorListener = new ApexErrorListener(fileName);
+
+    // Set up parsing infrastructure
+    const inputStream = CharStreams.fromString(fileContent);
+    const lexer = new ApexLexer(new CaseInsensitiveInputStream(inputStream));
+    const tokenStream = new CommonTokenStream(lexer);
+    const parser = new ApexParser(tokenStream);
+    parser.errorHandler = new DefaultErrorStrategy();
+
+    // Set up error listeners
+    parser.removeErrorListeners();
+    lexer.removeErrorListeners();
+    parser.addErrorListener(errorListener);
+    const lexerErrorListener = new ApexLexerErrorListener(errorListener);
+    lexer.addErrorListener(lexerErrorListener);
+
+    // Parse the compilation unit
+    const isTrigger = fileName.endsWith('.trigger');
+    const parseTree = isTrigger
+      ? parser.triggerUnit()
+      : parser.compilationUnit();
+
+    return {
+      fileName,
+      parseTree,
+      errorListener,
+      lexer,
+      tokenStream,
+      parser,
+    };
+  }
+
   /**
    * Parse and compile a single Apex file.
    * @param fileContent The content of the Apex file to parse
@@ -109,8 +167,11 @@ export class CompilerService {
     this.logger.debug(() => `Starting compilation of ${fileName}`);
 
     try {
-      // Create error listener
-      const errorListener = new ApexErrorListener(fileName);
+      // Create parse tree and get associated components
+      const { parseTree, errorListener, tokenStream } = this.createParseTree(
+        fileContent,
+        fileName,
+      );
 
       // Create comment collector by default (opt-out behavior)
       let commentCollector: ApexCommentCollectorListener | null = null;
@@ -120,19 +181,6 @@ export class CompilerService {
         );
       }
 
-      // Set up parsing infrastructure
-      const inputStream = CharStreams.fromString(fileContent);
-      const lexer = new ApexLexer(new CaseInsensitiveInputStream(inputStream));
-      const tokenStream = new CommonTokenStream(lexer);
-      const parser = new ApexParser(tokenStream);
-
-      // Set up error listeners
-      parser.removeErrorListeners();
-      lexer.removeErrorListeners();
-      parser.addErrorListener(errorListener);
-      const lexerErrorListener = new ApexLexerErrorListener(errorListener);
-      lexer.addErrorListener(lexerErrorListener);
-
       // Set up the main listener
       listener.setErrorListener(errorListener);
       const namespace = options.projectNamespace || this.projectNamespace;
@@ -146,20 +194,14 @@ export class CompilerService {
         commentCollector.setTokenStream(tokenStream);
       }
 
-      // Parse the compilation unit
-      const isTrigger = fileName.endsWith('.trigger');
-      const compilationUnitContext = isTrigger
-        ? parser.triggerUnit()
-        : parser.compilationUnit();
-
       // Walk the tree with the main listener
       const walker = new ParseTreeWalker();
-      walker.walk(listener, compilationUnitContext);
+      walker.walk(listener, parseTree);
 
       // Walk the tree with comment collector if requested
       let comments: ApexComment[] = [];
       if (commentCollector) {
-        walker.walk(commentCollector, compilationUnitContext);
+        walker.walk(commentCollector, parseTree);
         comments = commentCollector.getResult();
       }
 
@@ -404,40 +446,4 @@ export class CompilerService {
 
     return results;
   }
-
-  private getCompilationUnit(
-    source: string,
-    errorListener?: ApexErrorListener,
-  ): CompilationUnitContext | TriggerUnitContext {
-    this.logger.debug('Creating compilation unit');
-    const inputStream = CharStreams.fromString(source);
-    const lexer = new ApexLexer(new CaseInsensitiveInputStream(inputStream));
-    const tokenStream = new CommonTokenStream(lexer);
-    const parser = new ApexParser(tokenStream);
-
-    // Add our custom error listener if provided
-    if (errorListener) {
-      this.logger.debug('Setting up custom error listeners');
-      // Remove default error listeners that print to console
-      parser.removeErrorListeners();
-      lexer.removeErrorListeners();
-
-      // Add our custom error listener
-      parser.addErrorListener(errorListener);
-      // Create and add lexer-specific error listener
-      const lexerErrorListener = new ApexLexerErrorListener(errorListener);
-      lexer.addErrorListener(lexerErrorListener);
-    }
-
-    // Check if this is a trigger file based on the file extension
-    const isTrigger =
-      errorListener?.getFilePath()?.endsWith('.trigger') ?? false;
-
-    // Parse the compilation unit or trigger based on file type
-    this.logger.debug('Parsing compilation unit');
-    const compilationUnitContext = isTrigger
-      ? parser.triggerUnit()
-      : parser.compilationUnit();
-    return compilationUnitContext;
-  }
 }