Fix(54375) : Removing extra new lines from move to file
#55073
Conversation
typescript-bot
added
Author: Team
For Milestone Bug
| @@ -1194,7 +1194,9 @@ function moveStatementsToTargetFile(changes: textChanges.ChangeTracker, program: | |||
| changes.insertNodesBefore(targetFile, lastReExport, statements, /*blankLineBetween*/ true); | |||
| } | |||
| else { | |||
| changes.insertNodesAfter(targetFile, targetFile.statements[targetFile.statements.length - 1], statements); | |||
| (isImportDeclaration(targetFile.statements[targetFile.statements.length - 1])) ? | |||
There was a problem hiding this comment.
| (isImportDeclaration(targetFile.statements[targetFile.statements.length - 1])) ? | |
| isImportDeclaration(targetFile.statements[targetFile.statements.length - 1]) ? |
| @@ -620,7 +620,8 @@ export class ChangeTracker { | |||
| private insertAtTopOfFile(sourceFile: SourceFile, insert: Statement | readonly Statement[], blankLineBetween: boolean): void { | |||
| const pos = getInsertionPositionAtSourceFileTop(sourceFile); | |||
| const options = { | |||
| prefix: pos === 0 ? undefined : this.newLineCharacter, | |||
| // While inserting import statements in a blank existing file, add a newline as a prefix only if the file is blank, or the import is added as the first statement without using importAdder. | |||
There was a problem hiding this comment.
Maybe this comment can be moved to where we call this function in moveToFile? Or modified to avoid referring to imports and importAdder, since if someone is looking solely at textChanges, without the context of moveToFile, it's hard to understand what this all means.
| "/bar.ts": | ||
| `import { a } from './a'; | ||
| import { b } from './other'; | ||
| import { d } from './other2'; |
There was a problem hiding this comment.
The other new test includes a blank line between the imports and the statement, and this one doesn't. Is there a reason why?
| @@ -634,18 +635,20 @@ export class ChangeTracker { | |||
| public insertNodesAtEndOfFile( | |||
| sourceFile: SourceFile, | |||
| newNodes: readonly Statement[], | |||
| blankLineBetween: boolean): void { | |||
| this.insertAtEndOfFile(sourceFile, newNodes, blankLineBetween); | |||
| blankLineSuffix: boolean, | |||
There was a problem hiding this comment.
This is an optional suggestion: I think it makes more sense to swap the order of blankLinePrefix and blankLineSuffix so that blankLinePrefix comes first, to prevent confusing the order of those when we call the function.
| @@ -247,10 +247,10 @@ function getNewStatementsAndRemoveFromOldFile( | |||
| moveStatementsToTargetFile(changes, program, body, targetFile, toMove); | |||
| } | |||
| else { | |||
| changes.insertNodesAtEndOfFile(targetFile, body, /*blankLineBetween*/ false); | |||
| changes.insertNodesAtEndOfFile(targetFile, body, /*blankLineSuffix*/ false, !imports || usage.oldImportsNeededByTargetFile.size === 0 ? true : false); | |||
There was a problem hiding this comment.
Can imports have length 0?
Could you add a comment explaining when we want to add a blank line prefix?
| } | ||
| if (imports.length > 0) { | ||
| insertImports(changes, targetFile, imports, /*blankLineBetween*/ true, preferences); | ||
| insertImports(changes, targetFile, imports, usage.oldImportsNeededByTargetFile.size === 0 ? true : false, preferences); |
There was a problem hiding this comment.
Same here, could you add a comment explaining this?
| @@ -1194,7 +1194,9 @@ function moveStatementsToTargetFile(changes: textChanges.ChangeTracker, program: | |||
| changes.insertNodesBefore(targetFile, lastReExport, statements, /*blankLineBetween*/ true); | |||
| } | |||
| else { | |||
| changes.insertNodesAfter(targetFile, targetFile.statements[targetFile.statements.length - 1], statements); | |||
| (isImportDeclaration(targetFile.statements[targetFile.statements.length - 1])) ? | |||
There was a problem hiding this comment.
Is it the case that targetFile.statements can't be empty at this point?
Fixes #54375