Use unique declaration references #192
+88
−43
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -2,4 +2,4 @@ dist | ||
| node_modules | ||
| .eslintcache | ||
| yarn-error.log | ||
| snapshots/output/**/*.scip | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -65,7 +65,21 @@ export class FileIndexer { | ||
| if (ts.isIdentifier(node) || ts.isStringLiteralLike(node)) { | ||
| const sym = this.getTSSymbolAtLocation(node) | ||
| if (sym) { | ||
| /** | ||
|
There was a problem hiding this comment. I agree it's not super clear why |
||
| * For example: | ||
| * | ||
| * const a = 1 | ||
| * ^ node | ||
| * ^ node.parent.name | ||
| * ^^^^^ node.parent | ||
| */ | ||
| const isDefinition = this.declarationName(node.parent) === node | ||
|
|
||
| if (isDefinition) { | ||
| return this.visitDefinition(node, sym) | ||
| } | ||
|
|
||
| this.visitReference(node, sym) | ||
| } | ||
| } | ||
| ts.forEachChild(node, node => this.visit(node)) | ||
| @@ -97,42 +111,48 @@ export class FileIndexer { | ||
| return symbol | ||
| } | ||
|
|
||
| private visitDefinition(node: ts.Node, sym: ts.Symbol): void { | ||
|
There was a problem hiding this comment. I'm not convinced this refactoring is an improvement in maintainability. In the future, I want to add more symbol roles such as import and write and then the |
||
| const [declaration] = sym?.declarations || [] | ||
| const scipSymbol = this.scipSymbol(declaration) | ||
|
|
||
| if (scipSymbol.isEmpty()) { | ||
| return | ||
| } | ||
|
|
||
| const range = Range.fromNode(node).toLsif() | ||
|
|
||
| this.document.occurrences.push( | ||
| new scip.scip.Occurrence({ | ||
| range, | ||
| symbol: scipSymbol.value, | ||
| symbol_roles: scip.scip.SymbolRole.Definition, | ||
| }) | ||
| ) | ||
|
|
||
| this.addSymbolInformation(node, sym, declaration, scipSymbol) | ||
| this.handleShorthandPropertyDefinition(declaration, range) | ||
| this.handleObjectBindingPattern(node, range) | ||
| } | ||
|
|
||
| private visitReference(node: ts.Node, sym: ts.Symbol): void { | ||
| const range = Range.fromNode(node).toLsif() | ||
|
|
||
| for (const symbol of this.uniqueDeclarationSymbolValues(sym)) { | ||
| this.document.occurrences.push( | ||
| new scip.scip.Occurrence({ | ||
| range, | ||
| symbol, | ||
| symbol_roles: scip.scip.SymbolRole.UnspecifiedSymbolRole, | ||
| }) | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Emits an additional definition occurrence when destructuring an object | ||
| * pattern. For example: | ||
| * ``` | ||
| * interface Props { property: number } | ||
| * const props: Props[] = [{ property: 42 }] | ||
| * props.map(({property}) => property) = {a} | ||
| * // ^^^^^^^^ references `Props.property` and defines a local parameter `property` | ||
| @@ -148,15 +168,11 @@ export class FileIndexer { | ||
| } | ||
| const tpe = this.checker.getTypeAtLocation(node.parent.parent) | ||
| const property = tpe.getProperty(node.getText()) | ||
| for (const symbol of this.uniqueDeclarationSymbolValues(property)) { | ||
| this.document.occurrences.push( | ||
| new scip.scip.Occurrence({ | ||
| range, | ||
| symbol, | ||
| }) | ||
| ) | ||
| } | ||
| @@ -233,6 +249,7 @@ export class FileIndexer { | ||
| ): scip.scip.Relationship[] { | ||
| const relationships: scip.scip.Relationship[] = [] | ||
| const isAddedSymbol = new Set<string>() | ||
|
|
||
| const pushImplementation = ( | ||
| node: ts.NamedDeclaration, | ||
| isReferences: boolean | ||
| @@ -305,7 +322,7 @@ export class FileIndexer { | ||
| return undefined | ||
| } | ||
|
|
||
| private scipSymbol = (node: ts.Node): ScipSymbol => { | ||
valerybugakov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const fromCache: ScipSymbol | undefined = | ||
| this.globalSymbolTable.get(node) || this.localSymbolTable.get(node) | ||
| if (fromCache) { | ||
| @@ -361,7 +378,7 @@ export class FileIndexer { | ||
| return this.scipSymbol(decl) | ||
| } | ||
| } catch { | ||
| // TODO: https://github.com/sourcegraph/scip-typescript/issues/34 | ||
| // continue regardless of error, the TypeScript compiler tends to | ||
| // trigger stack overflows in getTypeOfSymbolAtLocation and we | ||
| // don't know why yet. | ||
| @@ -378,7 +395,11 @@ export class FileIndexer { | ||
| return this.cached(node, this.scipSymbol(node.parent)) | ||
| } | ||
|
|
||
| if ( | ||
| ts.isImportSpecifier(node) || | ||
| ts.isImportClause(node) || | ||
| ts.isNamespaceImport(node) | ||
|
There was a problem hiding this comment. Is this change related to de-duplication? It would be nice to isolate this change and have a diff in the snapshot tests to better understand the exact motivation for this change. |
||
| ) { | ||
| const tpe = this.checker.getTypeAtLocation(node) | ||
| for (const declaration of tpe.symbol?.declarations || []) { | ||
| return this.scipSymbol(declaration) | ||
| @@ -608,6 +629,25 @@ export class FileIndexer { | ||
|
|
||
| return this.checker.getTypeAtLocation(node) | ||
| } | ||
|
|
||
| /** | ||
| * @param sym ts.Symbol with declarations to process. | ||
| * @returns an array of unique non-empty SCIP symbol values extracted | ||
| * from ts.Symbol declarations. | ||
| */ | ||
| private uniqueDeclarationSymbolValues(sym?: ts.Symbol): string[] { | ||
varungandhi-src marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (!sym?.declarations) { | ||
| return [] | ||
| } | ||
|
|
||
| return Array.from( | ||
|
There was a problem hiding this comment. This expression is fairly expensive considering it's in a very hot loop and that we can achieve a similar results with a single if condition, as is done in It's very important that we try to keep performance parity with |
||
| new Set( | ||
| sym.declarations | ||
| .map(declaration => this.scipSymbol(declaration).value) | ||
| .filter(Boolean) | ||
| ) | ||
| ) | ||
varungandhi-src marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
|
|
||
| function isAnonymousContainerOfSymbols(node: ts.Node): boolean { | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added new
test-fastandupdate-snapshots-fastscripts. I prefer to get the type errors in the terminal because typechecking is reasonably fast in this codebase and debugging runtime exceptions is slower than debugging type errors.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good! To clarify the reasoning behind this: while iterating on changes locally, I often have type errors because I want to test some logic but don't want to invest time into making Typescript happy about it because there's no intent to commit it. Type-checking slows down the process of trying different ideas on existing tests.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm +1 to adding these scripts to package.json as long as we keep the typechecking variants as well. For sg/sg, I appreciate that
sg startdoesn't typecheck because it's a big codebase slowing down the edit/reload/debug feedback loop. In scip-typescript, typechecking has been fast enough for my needs.