Skip to content

findAllReferences inital port #882

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Conversation

iisaduan
Copy link
Member

@iisaduan iisaduan commented May 20, 2025

This port focuses on the logic needed to resolving symbols within a single file.

Todos after this PR:

  • Search for references through module resolving
  • Search for references through imported and exported symbol resolving
    • Some imported and global symbols return references, but it is hard to test with the current lstestutil capabilities.
  • Jsdoc references (not sure how much of the currently un-ported parts will be needed, since @sandersn has been working to simplify jsdoc checking)
  • Special cases for object literals
  • Special cases for classes and keywords
  • String references

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR ports the findAllReferences functionality and updates various components across the codebase. Key changes include:

  • Adding new APIs and handlers (e.g. ResolveTripleslashReference in the path package and handleReferences in the LSP server) to support reference lookup.
  • Replacing usage of older APIs (like GetAssignmentDeclarationKind) with new ones (GetJSDocAssignmentDeclarationKind) and renaming several utility functions for better export visibility.
  • Introducing new testing files for findAllReferences and new core utilities (FlatMap and CoalesceList).

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
internal/tspath/path.go Added ResolveTripleslashReference for triple-slash path resolution.
internal/parser/reparser.go Updated assignment declaration kind calls to use GetJSDocAssignmentDeclarationKind.
internal/lsp/server.go Added handling for ReferenceParams and a new handleReferences function.
internal/ls/findallreferencesexport_test.go New test file for export reference lookups.
internal/ls/findallreferences_test.go New tests covering various findAllReferences scenarios.
internal/core/core.go Introduced FlatMap and CoalesceList utility functions.
internal/compiler/program.go Added functions for module resolution improvements and extension handling.
internal/checker/utilities.go Renamed internal helper functions (e.g. HasModifier, GetSingleVariableOfVariableStatement).
internal/checker/services.go Added GetSymbolsOfParameterPropertyDeclaration for parameter-property handling.
internal/checker/printer.go Updated modifier check call in expression printing.
internal/checker/exports.go Added exported helper functions for type operations and symbol merging.
internal/checker/checker.go Replaced legacy modifier and assignment kind calls with their updated versions.
internal/binder/nameresolver.go Updated internal module/enum checks and exported GetLocalSymbolForExportDefault.
internal/binder/binder.go Switched to use GetJSDocAssignmentDeclarationKind in assignment binding logic.
internal/astnav/tokens.go Added GetTouchingToken as an alternative for token retrieval in AST.
internal/ast/utilities.go Introduced several new AST helper functions and renamed utility methods.

@@ -1029,6 +1029,26 @@ func IsStatic(node *Node) bool {
return IsClassElement(node) && HasStaticModifier(node) || IsClassStaticBlockDeclaration(node)
}

func CanHaveSymbol(node *Node) bool {
switch node.Kind {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the JSDoc tags should be dropped from here, replaced with JSExportAssignment JSTypeAliasDeclaration, CommonJSExport (I think).
Also I'm pretty sure Identifier is JS-only and unsupported in Corsa, so can be dropped as well.

@@ -1290,6 +1314,37 @@ func IsThisParameter(node *Node) bool {
return IsParameter(node) && node.Name() != nil && IsThisIdentifier(node.Name())
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a lot of this syntax isn't supported, or supported yet, in Corsa. Merge fom main and use GetAssignmentDeclarationKind as-is.

Copy link
Member

@sandersn sandersn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't read findallreferences.go yet but here are my comments for the rest. I focussed on changes needed for JS. I'll follow up with comments for the big file tomorrow.


// PropertyAccessKinds
// F.prototype = { ... }
JSDeclarationKindPrototype
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JSDeclarationKindPrototype isn't supported in Corsa, and Object.defineProperty is at the very bottom of my TODO list. Same advice as above.

Copy link
Member Author

@iisaduan iisaduan May 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I also just replace GetAssignmentDeclarationPropertyAccessKind with GetAssignmentDeclarationKind?

@@ -2456,6 +2596,10 @@ func GetDeclarationContainer(node *Node) *Node {
}).Parent
}

func IsPrototypeAccess(node *Node) bool {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same advice as above

return res
}

/**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the Go format for doc comments is just //. Not certain though.

Comment on lines +1556 to +1558
* @param result an array of symbol of found property symbols
* @param previousIterationSymbolsCache a cache of symbol from previous iterations of calling this function to prevent infinite revisiting of the same symbol.
* The value of previousIterationSymbol is undefined when the function is first called.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these don't appear to match the current parameters

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

huh. It's directly copied over from strada, and it appears to be equally wrong there lol

Copy link
Member

@sandersn sandersn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments on findallreferences.go, nothing substantive.

// If this is private property or method, the scope is the containing class
if symbol.Flags&(ast.SymbolFlagsProperty|ast.SymbolFlagsMethod) != 0 {
privateDeclaration := core.Find(declarations, func(d *ast.Node) bool {
return checker.HasModifier(d, ast.ModifierFlagsPrivate) || ast.IsPrivateIdentifierClassElementDeclaration(d)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

aside--if this port didn't skip any Strada jsdoc checks for @private, then Corsa's going to be more a lot more accurate for JS, since my next PR is to convert @private into ModifierFlagsPrivate. (Nothing for you to do here, just an observation.)

searchSpaceNode = searchSpaceNode.Parent // re-assign to be the owning class
break
case ast.KindSourceFile:
if ast.IsExternalModule(searchSpaceNode.AsSourceFile()) || isParameterName(thisOrSuperKeyword) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see how GetThisContainer could return a SourceFile for a parameter name but also this never fails to surprise me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants