Skip to content

feat(38225): Fix diagnostic with "body block braces" #38226

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
May 12, 2020
Merged

feat(38225): Fix diagnostic with "body block braces" #38226

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
6 changes: 3 additions & 3 deletions src/compiler/diagnosticMessages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5633,7 +5633,7 @@
"category": "Message",
"code": 95111
},
"Remove block body braces": {
"Remove braces from arrow function body": {
"category": "Message",
"code": 95112
},
Expand All @@ -5645,15 +5645,15 @@
"category": "Message",
"code": 95114
},
"Remove all incorrect body block braces": {
"Remove braces from all arrow function bodies with relevant issues": {
"category": "Message",
"code": 95115
},
"Wrap all object literal with parentheses": {
"category": "Message",
"code": 95116
},

"No value exists in scope for the shorthand property '{0}'. Either declare one or provide an initializer.": {
"category": "Error",
"code": 18004
Expand Down
12 changes: 6 additions & 6 deletions src/services/codefixes/returnValueCorrect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
namespace ts.codefix {
const fixId = "returnValueCorrect";
const fixIdAddReturnStatement = "fixAddReturnStatement";
const fixIdRemoveBlockBodyBrace = "fixRemoveBlockBodyBrace";
const fixRemoveBracesFromArrowFunctionBody = "fixRemoveBracesFromArrowFunctionBody";
const fixIdWrapTheBlockWithParen = "fixWrapTheBlockWithParen";
const errorCodes = [
Diagnostics.A_function_whose_declared_type_is_neither_void_nor_any_must_return_a_value.code,
Expand Down Expand Up @@ -35,7 +35,7 @@ namespace ts.codefix {

registerCodeFix({
errorCodes,
fixIds: [fixIdAddReturnStatement, fixIdRemoveBlockBodyBrace, fixIdWrapTheBlockWithParen],
fixIds: [fixIdAddReturnStatement, fixRemoveBracesFromArrowFunctionBody, fixIdWrapTheBlockWithParen],
getCodeActions: context => {
const { program, sourceFile, span: { start }, errorCode } = context;
const info = getInfo(program.getTypeChecker(), sourceFile, start, errorCode);
Expand All @@ -44,7 +44,7 @@ namespace ts.codefix {
if (info.kind === ProblemKind.MissingReturnStatement) {
return append(
[getActionForfixAddReturnStatement(context, info.expression, info.statement)],
isArrowFunction(info.declaration) ? getActionForfixRemoveBlockBodyBrace(context, info.declaration, info.expression, info.commentSource): undefined);
isArrowFunction(info.declaration) ? getActionForFixRemoveBracesFromArrowFunctionBody(context, info.declaration, info.expression, info.commentSource): undefined);
}
else {
return [getActionForfixWrapTheBlockWithParen(context, info.declaration, info.expression)];
Expand All @@ -58,7 +58,7 @@ namespace ts.codefix {
case fixIdAddReturnStatement:
addReturnStatement(changes, diag.file, info.expression, info.statement);
break;
case fixIdRemoveBlockBodyBrace:
case fixRemoveBracesFromArrowFunctionBody:
if (!isArrowFunction(info.declaration)) return undefined;
removeBlockBodyBrace(changes, diag.file, info.declaration, info.expression, info.commentSource, /* withParen */ false);
break;
Expand Down Expand Up @@ -196,9 +196,9 @@ namespace ts.codefix {
return createCodeFixAction(fixId, changes, Diagnostics.Add_a_return_statement, fixIdAddReturnStatement, Diagnostics.Add_all_missing_return_statement);
}

function getActionForfixRemoveBlockBodyBrace(context: CodeFixContext, declaration: ArrowFunction, expression: Expression, commentSource: Node) {
function getActionForFixRemoveBracesFromArrowFunctionBody(context: CodeFixContext, declaration: ArrowFunction, expression: Expression, commentSource: Node) {
const changes = textChanges.ChangeTracker.with(context, t => removeBlockBodyBrace(t, context.sourceFile, declaration, expression, commentSource, /* withParen */ false));
return createCodeFixAction(fixId, changes, Diagnostics.Remove_block_body_braces, fixIdRemoveBlockBodyBrace, Diagnostics.Remove_all_incorrect_body_block_braces);
return createCodeFixAction(fixId, changes, Diagnostics.Remove_braces_from_arrow_function_body, fixRemoveBracesFromArrowFunctionBody, Diagnostics.Remove_braces_from_all_arrow_function_bodies_with_relevant_issues);
}

function getActionForfixWrapTheBlockWithParen(context: CodeFixContext, declaration: ArrowFunction, expression: Expression) {
Expand Down
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue10.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
//// const a: ((() => number) | (() => undefined)) = () => { 1 }

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' }
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message }
]);
6 changes: 3 additions & 3 deletions tests/cases/fourslash/codeFixCorrectReturnValue12.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
//// })

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' },
{ description: 'Remove unused label' },
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message },
{ description: ts.Diagnostics.Remove_unused_label.message }
]);
6 changes: 3 additions & 3 deletions tests/cases/fourslash/codeFixCorrectReturnValue13.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
//// }

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' },
{ description: 'Remove unused label' },
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message },
{ description: ts.Diagnostics.Remove_unused_label.message }
]);

interface A {
Expand Down
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue18.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
//// var x = <Comp t={() => { 1 }} />;

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' },
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message },
{ description: `Infer type of 'props' from usage` }
]);
6 changes: 3 additions & 3 deletions tests/cases/fourslash/codeFixCorrectReturnValue20.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
//// }} />;

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' },
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message },
{ description: `Infer type of 'props' from usage` },
{ description: 'Remove unused label' },
{ description: ts.Diagnostics.Remove_unused_label.message },
]);
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue21.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@
//// }

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' },
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message }
]);
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue22.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@
//// }

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' },
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message }
]);
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue23.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
//// }

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' }
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message }
]);
2 changes: 1 addition & 1 deletion tests/cases/fourslash/codeFixCorrectReturnValue25.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//// Foo(() => { /* leading */ 1 /* trailing */ })

verify.codeFix({
description: "Remove block body braces",
description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message,
index: 1,
newFileContent:
`function Foo (a: () => number) { a() }
Expand Down
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue7.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
//// Foo(() => { 1 })

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' }
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message }
]);
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue8.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
//// Foo(() => { 1 })

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' }
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message }
]);
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue9.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
//// const a: () => number = () => { 1 }

verify.codeFixAvailable([
{ description: 'Add a return statement' },
{ description: 'Remove block body braces' }
{ description: ts.Diagnostics.Add_a_return_statement.message },
{ description: ts.Diagnostics.Remove_braces_from_arrow_function_body.message }
]);
4 changes: 2 additions & 2 deletions tests/cases/fourslash/codeFixCorrectReturnValue_all2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@
//// const test: { a: () => A } = { a: () => { bar: '1' } }

verify.codeFixAll({
fixId: "fixRemoveBlockBodyBrace",
fixAllDescription: "Remove all incorrect body block braces",
fixId: "fixRemoveBracesFromArrowFunctionBody",
fixAllDescription: ts.Diagnostics.Remove_braces_from_all_arrow_function_bodies_with_relevant_issues.message,
newFileContent:
`interface A {
bar: string
Expand Down