microsoft/TypeScript
1
0
Fork 0
mirror of https://github.com/microsoft/TypeScript.git synced 2026-05-15 12:51:30 -05:00
Code Issues Packages Projects Releases 212 Wiki Activity

respond to comments

Browse Source
This commit is contained in:
Arthur Ozga
2017-06-26 10:55:04 -07:00
parent 485927b26a
commit 61af315778
6 changed files with 53 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
src/services/formatting/formatting.ts
View File

@@ -97,23 +97,21 @@ namespace ts.formatting {
}
export function formatOnSemicolon(position: number, sourceFile: SourceFile, rulesProvider: RulesProvider, options: FormatCodeSettings): TextChange[] {
const outermostParent = findOutermostParentWithinListLevelFromPosition(position, SyntaxKind.SemicolonToken, sourceFile);
return formatOutermostParent(outermostParent, sourceFile, options, rulesProvider, FormattingRequestKind.FormatOnSemicolon);
const semicolon = findImmediatelyPrecedingTokenOfKind(position, SyntaxKind.SemicolonToken, sourceFile);
return formatOutermostNodeWithinListLevel(semicolon, sourceFile, options, rulesProvider, FormattingRequestKind.FormatOnSemicolon);
}
export function formatOnOpeningCurly(position: number, sourceFile: SourceFile, rulesProvider: RulesProvider, options: FormatCodeSettings): TextChange[] {
const openingCurly = findPrecedingTokenOfKind(position, SyntaxKind.FirstPunctuation, sourceFile);
const block = openingCurly && openingCurly.parent;
if (!(block && isBlock(block))) {
return [];
}
const outermostParent = findOutermostParentWithinListLevel(block);
return formatOutermostParent(outermostParent, sourceFile, options, rulesProvider, FormattingRequestKind.FormatOnOpeningCurlyBrace);
const openingCurly = findImmediatelyPrecedingTokenOfKind(position, SyntaxKind.OpenBraceToken, sourceFile);
const curlyBraceRange = openingCurly && openingCurly.parent;
return curlyBraceRange ?
formatOutermostNodeWithinListLevel(curlyBraceRange, sourceFile, options, rulesProvider, FormattingRequestKind.FormatOnOpeningCurlyBrace) :
[];
}
export function formatOnClosingCurly(position: number, sourceFile: SourceFile, rulesProvider: RulesProvider, options: FormatCodeSettings): TextChange[] {
const outermostParent = findOutermostParentWithinListLevelFromPosition(position, SyntaxKind.CloseBraceToken, sourceFile);
return formatOutermostParent(outermostParent, sourceFile, options, rulesProvider, FormattingRequestKind.FormatOnClosingCurlyBrace);
const precedingToken = findImmediatelyPrecedingTokenOfKind(position, SyntaxKind.CloseBraceToken, sourceFile);
return formatOutermostNodeWithinListLevel(precedingToken, sourceFile, options, rulesProvider, FormattingRequestKind.FormatOnClosingCurlyBrace);
}
export function formatDocument(sourceFile: SourceFile, rulesProvider: RulesProvider, options: FormatCodeSettings): TextChange[] {
@@ -133,38 +131,21 @@ namespace ts.formatting {
return formatSpan(span, sourceFile, options, rulesProvider, FormattingRequestKind.FormatSelection);
}
function formatOutermostParent(parent: Node | undefined, sourceFile: SourceFile, options: FormatCodeSettings, rulesProvider: RulesProvider, requestKind: FormattingRequestKind): TextChange[] {
if (!parent) {
return [];
}
/**
* Validating `expectedLastToken` ensures the token was typed in the context we expect (eg: not a comment).
* @param expectedLastToken The last token constituting the desired parent node.
*/
function findImmediatelyPrecedingTokenOfKind(end: number, expectedTokenKind: SyntaxKind, sourceFile: SourceFile): Node | undefined {
const precedingToken = findPrecedingToken(end, sourceFile);
const span = {
pos: getLineStartPositionForPosition(parent.getStart(sourceFile), sourceFile),
end: parent.end
};
return formatSpan(span, sourceFile, options, rulesProvider, requestKind);
}
function findPrecedingTokenOfKind(position: number, expectedTokenKind: SyntaxKind, sourceFile: SourceFile): Node | undefined {
const precedingToken = findPrecedingToken(position, sourceFile);
return precedingToken && precedingToken.kind === expectedTokenKind && position === precedingToken.getEnd() ?
return precedingToken && precedingToken.kind === expectedTokenKind && end === precedingToken.getEnd() ?
precedingToken :
undefined;
}
/**
* Validating `expectedLastToken` ensures the token was typed in the context we expect (eg: not a comment).
* @param expectedLastToken The last token constituting the desired parent node.
*/
function findOutermostParentWithinListLevelFromPosition(position: number, expectedLastToken: SyntaxKind, sourceFile: SourceFile) {
const precedingToken = findPrecedingTokenOfKind(position, expectedLastToken, sourceFile);
return precedingToken && findOutermostParentWithinListLevel(precedingToken);
}
/**
* Finds the outermost parent within the same list level as the token at position.
* Finds and formats the highest node enclosing `position` whose end does not exceed the given position
* and is at the same list level as the token at `position`.
*
* Consider typing the following
* ```
@@ -175,18 +156,18 @@ namespace ts.formatting {
* Upon typing the closing curly, we want to format the entire `while`-statement, but not the preceding
* variable declaration.
*/
function findOutermostParentWithinListLevel(token: Node): Node {
function formatOutermostNodeWithinListLevel(node: Node, sourceFile: SourceFile, options: FormatCodeSettings, rulesProvider: RulesProvider, formattingRequestKind: FormattingRequestKind) {
// If we walk upwards searching for the parent that has the same end value, we'll end up with the whole source file.
// `isListElement` allows to stop on the list element level.
let current = token;
let current = node;
while (current &&
current.parent &&
current.parent.end === token.end &&
current.parent.end === node.end &&
!isListElement(current.parent, current)) {
current = current.parent;
}
return current;
return formatNodeLines(current, sourceFile, options, rulesProvider, formattingRequestKind);
}
// Returns true if node is a element in some list in parent
@@ -338,7 +319,7 @@ namespace ts.formatting {
}
/* @internal */
export function formatNode(node: Node, sourceFileLike: SourceFileLike, languageVariant: LanguageVariant, initialIndentation: number, delta: number, rulesProvider: RulesProvider): TextChange[] {
export function formatNodeGivenIndentation(node: Node, sourceFileLike: SourceFileLike, languageVariant: LanguageVariant, initialIndentation: number, delta: number, rulesProvider: RulesProvider): TextChange[] {
const range = { pos: 0, end: sourceFileLike.text.length };
return formatSpanWorker(
range,
@@ -353,6 +334,19 @@ namespace ts.formatting {
sourceFileLike);
}
function formatNodeLines(node: Node, sourceFile: SourceFile, options: FormatCodeSettings, rulesProvider: RulesProvider, requestKind: FormattingRequestKind): TextChange[] {
if (!node) {
return [];
}
const span = {
pos: getLineStartPositionForPosition(node.getStart(sourceFile), sourceFile),
end: node.end
};
return formatSpan(span, sourceFile, options, rulesProvider, requestKind);
}
function formatSpan(originalRange: TextRange,
sourceFile: SourceFile,
options: FormatCodeSettings,

8
src/services/formatting/formattingContext.ts
View File

@@ -47,6 +47,14 @@ namespace ts.formatting {
return this.contextNodeAllOnSameLine;
}
public NextNodeAllOnSameLine(): boolean {
if (this.nextNodeAllOnSameLine === undefined) {
this.nextNodeAllOnSameLine = this.NodeIsOnOneLine(this.nextTokenParent);
}
return this.nextNodeAllOnSameLine;
}
public TokensAreOnSameLine(): boolean {
if (this.tokensAreOnSameLine === undefined) {
const startLine = this.sourceFile.getLineAndCharacterOfPosition(this.currentTokenSpan.pos).line;

2
src/services/formatting/rules.ts
View File

@@ -654,7 +654,7 @@ namespace ts.formatting {
// This check is done before an open brace in a control construct, a function, or a typescript block declaration
static IsBeforeMultilineBlockContext(context: FormattingContext): boolean {
return Rules.IsBeforeBlockContext(context) && !(context.NextNodeBlockIsOnOneLine());
return Rules.IsBeforeBlockContext(context) && !(context.NextNodeAllOnSameLine() || context.NextNodeBlockIsOnOneLine());
}
static IsMultilineBlockContext(context: FormattingContext): boolean {

2
src/services/textChanges.ts
View File

@@ -512,7 +512,7 @@ namespace ts.textChanges {
lineMap,
getLineAndCharacterOfPosition: pos => computeLineAndCharacterOfPosition(lineMap, pos)
};
const changes = formatting.formatNode(nonFormattedText.node, file, sourceFile.languageVariant, initialIndentation, delta, rulesProvider);
const changes = formatting.formatNodeGivenIndentation(nonFormattedText.node, file, sourceFile.languageVariant, initialIndentation, delta, rulesProvider);
return applyChanges(nonFormattedText.text, changes);
}

6
tests/cases/fourslash/formatOnEnterOpenBraceAddNewLine.ts
View File

@@ -7,6 +7,12 @@
format.setOption("PlaceOpenBraceOnNewLineForControlBlocks", true);
goTo.marker("0");
edit.insertLine("");
verify.currentFileContentIs(
`if (true)
{
}
if(false){
}`);
goTo.marker("1");
edit.insertLine("");
verify.currentFileContentIs(

2
tests/cases/fourslash/semicolonFormattingNestedStatements.ts
View File

@@ -11,7 +11,7 @@
goTo.marker("innermost");
edit.insert(";");
// Adding smicolon should format the innermost statement
// Adding semicolon should format the innermost statement
verify.currentLineContentIs(' var x = 0;');
// Also should format any parent statement that is terminated by the semicolon