', 'Dir', 'Dir2']);
assertFileNames(refs, ['app.ts', 'dir.ts', 'dir2.ts']);
});
it('finds rename locations for all matching directives', () => {
- const renameLocations = getRenameLocationsAtPosition(_('/app.ts'), cursor)!;
+ const renameLocations = getRenameLocationsAtPosition(file)!;
expect(renameLocations).toBeUndefined();
// TODO(atscott): We could consider supporting rename for directive selectors in the future
// expect(renameLocations.length).toBe(3);
@@ -1257,30 +1300,34 @@ describe('find references and rename locations', () => {
});
describe('when cursor is on generic directive selector in template', () => {
- let cursor: number;
+ let file: OpenBuffer;
beforeEach(() => {
- const cursorInfo = extractCursorInfo(`
+ const files = {
+ 'app.ts': `
import {Component, NgModule} from '@angular/core';
- @Component({template: '
'})
+ @Component({template: '
'})
export class AppCmp {
items = [];
}
- `);
- cursor = cursorInfo.cursor;
- const appFile = {name: _('/app.ts'), contents: cursorInfo.text};
- env = createModuleWithDeclarations([appFile]);
+ `
+ };
+
+ env = LanguageServiceTestEnv.setup();
+ const project = createModuleAndProjectWithDeclarations(env, 'test', files);
+ file = project.openFile('app.ts');
+ file.moveCursorToText('*ngF¦or');
});
it('should be able to request references', () => {
- const refs = getReferencesAtPosition(_('/app.ts'), cursor)!;
+ const refs = getReferencesAtPosition(file)!;
expect(refs.length).toBe(6);
assertTextSpans(refs, ['
', 'NgForOf']);
assertFileNames(refs, ['index.d.ts', 'app.ts']);
});
it('should not support rename if directive is in a dts file', () => {
- const renameLocations = getRenameLocationsAtPosition(_('/app.ts'), cursor);
+ const renameLocations = getRenameLocationsAtPosition(file);
expect(renameLocations).toBeUndefined();
});
});
@@ -1288,13 +1335,13 @@ describe('find references and rename locations', () => {
describe('components', () => {
describe('when cursor is on component class', () => {
- let cursor: number;
+ let file: OpenBuffer;
beforeEach(() => {
- const cursorInfo = extractCursorInfo(`
+ const myComp = `
import {Component} from '@angular/core';
@Component({selector: 'my-comp', template: ''})
- export class MyCo¦mp {}`);
+ export class MyComp {}`;
const appFile = `
import {Component, NgModule} from '@angular/core';
import {MyComp} from './comp';
@@ -1306,15 +1353,14 @@ describe('find references and rename locations', () => {
@NgModule({declarations: [AppCmp, MyComp]})
export class AppModule {}
`;
- cursor = cursorInfo.cursor;
- env = LanguageServiceTestEnvironment.setup([
- {name: _('/app.ts'), contents: appFile, isRoot: true},
- {name: _('/comp.ts'), contents: cursorInfo.text},
- ]);
+ env = LanguageServiceTestEnv.setup();
+ const project = env.addProject('test', {'comp.ts': myComp, 'app.ts': appFile});
+ file = project.openFile('comp.ts');
+ file.moveCursorToText('MyCo¦mp');
});
it('finds references', () => {
- const refs = getReferencesAtPosition(_('/comp.ts'), cursor)!;
+ const refs = getReferencesAtPosition(file)!;
// 4 references are: class declaration, template usage, app import and use in declarations
// list.
expect(refs.length).toBe(4);
@@ -1323,7 +1369,7 @@ describe('find references and rename locations', () => {
});
it('gets rename locations', () => {
- const renameLocations = getRenameLocationsAtPosition(_('/comp.ts'), cursor)!;
+ const renameLocations = getRenameLocationsAtPosition(file)!;
expect(renameLocations).toBeUndefined();
// TODO(atscott): If we register as an exclusive provider for TS, we may need to return
// results here and should exclude the template results.
@@ -1334,33 +1380,32 @@ describe('find references and rename locations', () => {
});
describe('when cursor is on the element tag', () => {
- let cursor: number;
+ let file: OpenBuffer;
beforeEach(() => {
const compFile = `
import {Component} from '@angular/core';
@Component({selector: 'my-comp', template: ''})
export class MyComp {}`;
- const cursorInfo = extractCursorInfo(`
+ const app = `
import {Component, NgModule} from '@angular/core';
import {MyComp} from './comp';
- @Component({template: '
'})
+ @Component({template: ''})
export class AppCmp {
}
@NgModule({declarations: [AppCmp, MyComp]})
export class AppModule {}
- `);
- cursor = cursorInfo.cursor;
- env = LanguageServiceTestEnvironment.setup([
- {name: _('/app.ts'), contents: cursorInfo.text, isRoot: true},
- {name: _('/comp.ts'), contents: compFile},
- ]);
+ `;
+ env = LanguageServiceTestEnv.setup();
+ const project = env.addProject('test', {'app.ts': app, 'comp.ts': compFile});
+ file = project.openFile('app.ts');
+ file.moveCursorToText('');
});
it('gets references', () => {
- const refs = getReferencesAtPosition(_('/app.ts'), cursor)!;
+ const refs = getReferencesAtPosition(file)!;
// 4 references are: class declaration, template usage, app import and use in declarations
// list.
expect(refs.length).toBe(4);
@@ -1369,7 +1414,7 @@ describe('find references and rename locations', () => {
});
it('finds rename locations', () => {
- const renameLocations = getRenameLocationsAtPosition(_('/app.ts'), cursor)!;
+ const renameLocations = getRenameLocationsAtPosition(file)!;
expect(renameLocations).toBeUndefined();
// TODO(atscott): We may consider supporting rename of component selector in the future
// expect(renameLocations.length).toBe(2);
@@ -1382,46 +1427,58 @@ describe('find references and rename locations', () => {
describe('get rename info', () => {
it('indicates inability to rename when cursor is outside template and in a string literal',
() => {
- const {cursor, text} = extractCursorInfo(`
+ const comp = `
import {Component} from '@angular/core';
@Component({selector: 'my-comp', template: ''})
export class MyComp {
- myProp = 'cannot rena¦me me';
- }`);
- env = createModuleWithDeclarations([{name: _('/my-comp.ts'), contents: text}]);
+ myProp = 'cannot rename me';
+ }`;
+ env = LanguageServiceTestEnv.setup();
+ const project = createModuleAndProjectWithDeclarations(env, 'test', {'my-comp.ts': comp});
env.expectNoSourceDiagnostics();
- const result = env.ngLS.getRenameInfo(_('/my-comp.ts'), cursor);
+
+ const file = project.openFile('my-comp.ts');
+ file.moveCursorToText('cannot rena¦me me');
+ const result = file.getRenameInfo();
expect(result.canRename).toEqual(false);
});
it('gets rename info when cursor is outside template', () => {
- const {cursor, text} = extractCursorInfo(`
+ const comp = `
import {Component, Input} from '@angular/core';
@Component({name: 'my-comp', template: ''})
export class MyComp {
- @Input() m¦yProp!: string;
- }`);
- env = createModuleWithDeclarations([{name: _('/my-comp.ts'), contents: text}]);
+ @Input() myProp!: string;
+ }`;
+ env = LanguageServiceTestEnv.setup();
+ const project = createModuleAndProjectWithDeclarations(env, 'test', {'my-comp.ts': comp});
env.expectNoSourceDiagnostics();
- const result = env.ngLS.getRenameInfo(_('/my-comp.ts'), cursor) as ts.RenameInfoSuccess;
+
+ const file = project.openFile('my-comp.ts');
+ file.moveCursorToText('m¦yProp!');
+ const result = file.getRenameInfo() as ts.RenameInfoSuccess;
expect(result.canRename).toEqual(true);
expect(result.displayName).toEqual('myProp');
expect(result.kind).toEqual('property');
});
it('gets rename info on keyed read', () => {
- const {cursor, text} = extractCursorInfo(`
+ const text = `
import {Component} from '@angular/core';
- @Component({name: 'my-comp', template: '{{ myObj["my¦Prop"] }}'})
+ @Component({name: 'my-comp', template: '{{ myObj["myProp"] }}'})
export class MyComp {
readonly myObj = {'myProp': 'hello world'};
- }`);
- env = createModuleWithDeclarations([{name: _('/my-comp.ts'), contents: text}]);
+ }`;
+ env = LanguageServiceTestEnv.setup();
+ const project = createModuleAndProjectWithDeclarations(env, 'test', {'my-comp.ts': text});
env.expectNoSourceDiagnostics();
- const result = env.ngLS.getRenameInfo(_('/my-comp.ts'), cursor) as ts.RenameInfoSuccess;
+ const file = project.openFile('my-comp.ts');
+ file.moveCursorToText('myObj["my¦Prop"]');
+
+ const result = file.getRenameInfo() as ts.RenameInfoSuccess;
expect(result.canRename).toEqual(true);
expect(result.displayName).toEqual('myProp');
expect(result.kind).toEqual('property');
@@ -1429,48 +1486,51 @@ describe('find references and rename locations', () => {
result.triggerSpan.start, result.triggerSpan.start + result.triggerSpan.length))
.toBe('myProp');
// re-queries also work
- const {triggerSpan, displayName} =
- env.ngLS.getRenameInfo(_('/my-comp.ts'), cursor) as ts.RenameInfoSuccess;
+ const {triggerSpan, displayName} = file.getRenameInfo() as ts.RenameInfoSuccess;
expect(displayName).toEqual('myProp');
expect(text.substring(triggerSpan.start, triggerSpan.start + triggerSpan.length))
.toBe('myProp');
});
it('gets rename info when cursor is on a directive input in a template', () => {
- const dirFile = {
- name: _('/dir.ts'),
- contents: `
+ const files = {
+ 'dir.ts': `
import {Directive, Input} from '@angular/core';
@Directive({selector: '[dir]'})
export class MyDir {
@Input() dir!: any;
- }`
- };
- const {cursor, text} = extractCursorInfo(`
+ }`,
+ 'my-comp.ts': `
import {Component, Input} from '@angular/core';
- @Component({name: 'my-comp', template: ''})
+ @Component({name: 'my-comp', template: ''})
export class MyComp {
@Input() myProp!: string;
- }`);
- env = createModuleWithDeclarations([{name: _('/my-comp.ts'), contents: text}, dirFile]);
+ }`
+ };
+
+ env = LanguageServiceTestEnv.setup();
+ const project = createModuleAndProjectWithDeclarations(env, 'test', files);
env.expectNoSourceDiagnostics();
- const result = env.ngLS.getRenameInfo(_('/my-comp.ts'), cursor) as ts.RenameInfoSuccess;
+
+ const file = project.openFile('my-comp.ts');
+ file.moveCursorToText('di¦r="something"');
+ const result = file.getRenameInfo() as ts.RenameInfoSuccess;
expect(result.canRename).toEqual(true);
expect(result.displayName).toEqual('dir');
expect(result.kind).toEqual('property');
});
});
- function getReferencesAtPosition(fileName: string, position: number) {
+ function getReferencesAtPosition(file: OpenBuffer) {
env.expectNoSourceDiagnostics();
- const result = env.ngLS.getReferencesAtPosition(fileName, position);
+ const result = file.getReferencesAtPosition();
return result?.map((item) => humanizeDocumentSpanLike(item, env));
}
- function getRenameLocationsAtPosition(fileName: string, position: number) {
+ function getRenameLocationsAtPosition(file: OpenBuffer) {
env.expectNoSourceDiagnostics();
- const result = env.ngLS.findRenameLocations(fileName, position);
+ const result = file.fineRenameLocations();
return result?.map((item) => humanizeDocumentSpanLike(item, env));
}
});
diff --git a/packages/language-service/ivy/testing/src/buffer.ts b/packages/language-service/ivy/testing/src/buffer.ts
index b17c869c8d..aa7a49eb9e 100644
--- a/packages/language-service/ivy/testing/src/buffer.ts
+++ b/packages/language-service/ivy/testing/src/buffer.ts
@@ -88,4 +88,16 @@ export class OpenBuffer {
getTypeDefinitionAtPosition() {
return this.ngLS.getTypeDefinitionAtPosition(this.scriptInfo.fileName, this._cursor);
}
+
+ getReferencesAtPosition() {
+ return this.ngLS.getReferencesAtPosition(this.scriptInfo.fileName, this._cursor);
+ }
+
+ fineRenameLocations() {
+ return this.ngLS.findRenameLocations(this.scriptInfo.fileName, this._cursor);
+ }
+
+ getRenameInfo() {
+ return this.ngLS.getRenameInfo(this.scriptInfo.fileName, this._cursor);
+ }
}
diff --git a/packages/language-service/ivy/testing/src/project.ts b/packages/language-service/ivy/testing/src/project.ts
index b79d903916..8838b5b229 100644
--- a/packages/language-service/ivy/testing/src/project.ts
+++ b/packages/language-service/ivy/testing/src/project.ts
@@ -98,9 +98,14 @@ export class Project {
openFile(projectFileName: string): OpenBuffer {
if (!this.buffers.has(projectFileName)) {
const fileName = absoluteFrom(`/${this.name}/${projectFileName}`);
+ let scriptInfo = this.tsProject.getScriptInfo(fileName);
this.projectService.openClientFile(fileName);
+ // Mark the project as dirty because the act of opening a file may result in the version
+ // changing since TypeScript will `switchToScriptVersionCache` when a file is opened.
+ // Note that this emulates what we have to do in the server/extension as well.
+ this.tsProject.markAsDirty();
- const scriptInfo = this.tsProject.getScriptInfo(fileName);
+ scriptInfo = this.tsProject.getScriptInfo(fileName);
if (scriptInfo === undefined) {
throw new Error(
`Unable to open ScriptInfo for ${projectFileName} in project ${this.tsConfigPath}`);
diff --git a/packages/language-service/ivy/testing/src/util.ts b/packages/language-service/ivy/testing/src/util.ts
index 50208c58f5..780ad53853 100644
--- a/packages/language-service/ivy/testing/src/util.ts
+++ b/packages/language-service/ivy/testing/src/util.ts
@@ -45,6 +45,11 @@ export function assertFileNames(refs: Array<{fileName: string}>, expectedFileNam
expect(new Set(actualFileNames)).toEqual(new Set(expectedFileNames));
}
+export function assertTextSpans(items: Array<{textSpan: string}>, expectedTextSpans: string[]) {
+ const actualSpans = items.map(item => item.textSpan);
+ expect(new Set(actualSpans)).toEqual(new Set(expectedTextSpans));
+}
+
/**
* Returns whether the given `ts.Diagnostic` is of a type only produced by the Angular compiler (as
* opposed to being an upstream TypeScript diagnostic).