Skip to content

(fix) don't rename props name when triggered in shorthand #1877

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Feb 17, 2023
Merged

(fix) don't rename props name when triggered in shorthand #1877

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions packages/language-server/src/plugins/typescript/features/RenameProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,13 @@ import {
isInHTMLTagRange,
getNodeIfIsInHTMLStartTag
} from '../../../lib/documents';
import { filterAsync, isNotNullOrUndefined, pathToUrl, unique } from '../../../utils';
import {
createGetCanonicalFileName,
filterAsync,
isNotNullOrUndefined,
pathToUrl,
unique
} from '../../../utils';
import { RenameProvider } from '../../interfaces';
import { DocumentSnapshot, SvelteDocumentSnapshot } from '../DocumentSnapshot';
import { convertRange } from '../utils';
Expand All @@ -18,7 +24,6 @@ import {
isAfterSvelte2TsxPropsReturn,
isTextSpanInGeneratedCode,
SnapshotMap,
findContainingNode,
isStoreVariableIn$storeDeclaration,
get$storeOffsetOf$storeDeclaration,
getStoreOffsetOf$storeDeclaration,
Expand Down Expand Up @@ -113,7 +118,8 @@ export class RenameProviderImpl implements RenameProvider {
: await this.getAdditionalLocationsForRenameOfPropInsideOtherComponent(
convertedRenameLocations,
docs,
lang
lang,
tsDoc.filePath
);
convertedRenameLocations = [
...convertedRenameLocations,
Expand Down Expand Up @@ -211,7 +217,7 @@ export class RenameProviderImpl implements RenameProvider {
if (
isStoreVariableIn$storeDeclaration(snapshot.getFullText(), loc.textSpan.start)
) {
// User renamed store, also rename correspondig $store locations
// User renamed store, also rename corresponding $store locations
const storeRenameLocations = lang.findRenameLocations(
snapshot.filePath,
get$storeOffsetOf$storeDeclaration(
Expand Down Expand Up @@ -268,8 +274,14 @@ export class RenameProviderImpl implements RenameProvider {
) {
// First find out if it's really the "rename prop inside component with that prop" case
// Use original document for that because only there the `export` is present.
// ':' for typescript's type operator (`export let bla: boolean`)
// '//' and '/*' for comments (`export let bla// comment` or `export let bla/* comment */`)
const regex = new RegExp(
`export\\s+let\\s+${this.getVariableAtPosition(tsDoc, lang, position)}($|\\s|;|:)` // ':' for typescript's type operator (`export let bla: boolean`)
`export\\s+let\\s+${this.getVariableAtPosition(
tsDoc,
lang,
position
)}($|\\s|;|:|\/\*|\/\/)`
);
const isRenameInsideComponentWithProp = regex.test(
getLineAtPosition(position, document.getText())
Expand Down Expand Up @@ -395,7 +407,8 @@ export class RenameProviderImpl implements RenameProvider {
private async getAdditionalLocationsForRenameOfPropInsideOtherComponent(
convertedRenameLocations: TsRenameLocation[],
snapshots: SnapshotMap,
lang: ts.LanguageService
lang: ts.LanguageService,
requestedFileName: string
) {
// Check if it's a prop rename
const updatePropLocation = this.findLocationWhichWantsToUpdatePropName(
Expand All @@ -405,6 +418,13 @@ export class RenameProviderImpl implements RenameProvider {
if (!updatePropLocation) {
return [];
}
const getCanonicalFileName = createGetCanonicalFileName(ts.sys.useCaseSensitiveFileNames);
if (
getCanonicalFileName(updatePropLocation.fileName) ===
getCanonicalFileName(requestedFileName)
) {
return [];
}
// Find generated `export let`
const doc = <SvelteDocumentSnapshot>snapshots.get(updatePropLocation.fileName);
const match = this.matchGeneratedExportLet(doc, updatePropLocation);
Expand All @@ -430,12 +450,13 @@ export class RenameProviderImpl implements RenameProvider {
) {
const regex = new RegExp(
// no 'export let', only 'let', because that's what it's translated to in svelte2tsx
// '//' and '/*' for comments (`let bla/*Ωignore_startΩ*/`)
`\\s+let\\s+(${snapshot
.getFullText()
.substring(
updatePropLocation.textSpan.start,
updatePropLocation.textSpan.start + updatePropLocation.textSpan.length
)})($|\\s|;|:)`
)})($|\\s|;|:|\/\*|\/\/)`
);
const match = snapshot.getFullText().match(regex);
return match;
Expand Down Expand Up @@ -585,7 +606,7 @@ export class RenameProviderImpl implements RenameProvider {
let rangeStart = parent.offsetAt(location.range.start);
let prefixText = location.prefixText?.trimRight();

// rename needs to be prefixed in case of a bind shortand on a HTML element
// rename needs to be prefixed in case of a bind shorthand on a HTML element
if (!prefixText) {
const original = parent.getText({
start: Position.create(
Expand Down Expand Up @@ -634,7 +655,7 @@ export class RenameProviderImpl implements RenameProvider {
suffixText: '}'
};

// rename range needs to be adjusted in case of an attribute shortand
// rename range needs to be adjusted in case of an attribute shorthand
if (snapshot.getOriginalText().charAt(rangeStart - 1) === '{') {
rangeStart--;
const rangeEnd = parent.offsetAt(location.range.end) + 1;
Expand Down
52 changes: 50 additions & 2 deletions packages/language-server/test/plugins/typescript/features/RenameProvider.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,46 @@ describe('RenameProvider', () => {
});
});

it('should do rename of prop without type of component A in component B', async () => {
const { provider, renameDoc2 } = await setup();
const result = await provider.rename(renameDoc2, Position.create(6, 11), 'newName');

assert.deepStrictEqual(result, {
changes: {
[getUri('rename2.svelte')]: [
{
newText: 'newName',
range: {
start: {
character: 9,
line: 6
},
end: {
character: 27,
line: 6
}
}
}
],
[getUri('rename3.svelte')]: [
{
newText: 'newName',
range: {
start: {
character: 15,
line: 1
},
end: {
character: 33,
line: 1
}
}
}
]
}
});
});

it('should do rename of svelte component', async () => {
const { provider, renameDoc4 } = await setup();
const result = await provider.rename(renameDoc4, Position.create(1, 12), 'ChildNew');
Expand Down Expand Up @@ -701,9 +741,17 @@ describe('RenameProvider', () => {
});

it('can rename shorthand props without breaking value-passing', async () => {
await testShorthand(Position.create(3, 16));
});

it('can rename shorthand props without breaking value-passing (triggers from shorthand)', async () => {
await testShorthand(Position.create(7, 9));
});

async function testShorthand(position: Position) {
const { provider, renameDocShorthand } = await setup();

const result = await provider.rename(renameDocShorthand, Position.create(3, 16), 'newName');
const result = await provider.rename(renameDocShorthand, position, 'newName');

assert.deepStrictEqual(result, {
changes: {
Expand Down Expand Up @@ -776,7 +824,7 @@ describe('RenameProvider', () => {
]
}
});
});
}

it('can rename slot let to an alias', async () => {
const { provider, renameSlotLet } = await setup();
Expand Down