-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
feat(language-service): TS references from template items #37437
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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 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 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 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 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 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 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 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 |
---|---|---|
@@ -0,0 +1,78 @@ | ||
/** | ||
* @license | ||
* Copyright Google LLC All Rights Reserved. | ||
* | ||
* Use of this source code is governed by an MIT-style license that can be | ||
* found in the LICENSE file at https://angular.io/license | ||
*/ | ||
|
||
import * as ts from 'typescript'; | ||
|
||
import {createLanguageService} from '../src/language_service'; | ||
import {TypeScriptServiceHost} from '../src/typescript_host'; | ||
|
||
import {MockTypescriptHost} from './test_utils'; | ||
|
||
const APP_COMPONENT = '/app/app.component.ts'; | ||
const TEST_TEMPLATE = '/app/test.ng'; | ||
|
||
describe('references', () => { | ||
const mockHost = new MockTypescriptHost(['/app/main.ts']); | ||
const tsLS = ts.createLanguageService(mockHost); | ||
const ngHost = new TypeScriptServiceHost(mockHost, tsLS); | ||
const ngLS = createLanguageService(ngHost); | ||
|
||
beforeEach(() => { | ||
mockHost.reset(); | ||
}); | ||
|
||
for (const templateStrategy of ['inline', 'external'] as const) { | ||
describe(`template: ${templateStrategy}`, () => { | ||
describe('component members', () => { | ||
it('should get TS references for a member in template', () => { | ||
const fileName = overrideTemplate('{{«title»}}'); | ||
const marker = mockHost.getReferenceMarkerFor(fileName, 'title'); | ||
const references = ngLS.getReferencesAtPosition(fileName, marker.start)!; | ||
|
||
expect(references).toBeDefined(); | ||
expect(references.length).toBe(2); | ||
|
||
for (let i = 0; i < references.length; ++i) { | ||
// The first reference is declared as a class member. | ||
// The second is in `setTitle`. | ||
const ref = references[i]; | ||
expect(getSource(ref)).toBe('title'); | ||
if (i == 0) { | ||
// The first reference is the member declaration, so it should | ||
// have a context span pointing to the whole declaration. | ||
expect(getSource(ref, 'contextSpan')).toBe('title = \'Tour of Heroes\';'); | ||
} | ||
} | ||
}); | ||
}); | ||
}); | ||
|
||
// TODO: override parsing-cases#TemplateReference for inline templates. | ||
const overrideTemplate = (template: string): string => { | ||
kyliau marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if (templateStrategy === 'inline') { | ||
mockHost.overrideInlineTemplate(APP_COMPONENT, template); | ||
return APP_COMPONENT; | ||
} else { | ||
mockHost.override(TEST_TEMPLATE, template); | ||
return TEST_TEMPLATE; | ||
} | ||
}; | ||
} | ||
|
||
/** | ||
* Gets the source code of a reference entry. By default the reference | ||
* `textSpan` is checked, but this can be overridden by specifying `spanKind`. | ||
*/ | ||
function getSource( | ||
reference: ts.ReferenceEntry, spanKind: 'textSpan'|'contextSpan' = 'textSpan'): string { | ||
const span = reference[spanKind]!; | ||
const fileName = reference.fileName; | ||
const content = mockHost.readFile(fileName)!; | ||
return content.substring(span.start, span.start + span.length); | ||
} | ||
}); |
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.
This'd be nice,
TemplateReference
already has an external template though..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.
yeah but we can just overwrite and replace
templateUrl