Skip to content

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on as const satisfies #10315

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 9 commits into from
Nov 16, 2024
Merged

fix(eslint-plugin): [explicit-module-boundary-types] and [explicit-function-return-type] don't report on as const satisfies #10315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4921307
initial implementation
ronami Nov 9, 2024
6075552
add tests
ronami Nov 9, 2024
78caf05
Update packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts
ronami Nov 10, 2024
492be7d
simplify tests, one test per case
ronami Nov 10, 2024
dbaf9fa
fix failing tests
ronami Nov 10, 2024
b39e189
Update packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts
ronami Nov 11, 2024
6e64bee
add tests for nested satisfies statements
ronami Nov 11, 2024
d7a9183
use valid typescript code for tests
ronami Nov 11, 2024
f34addc
Update explicit-function-return-type.test.ts
bradzacher Nov 16, 2024
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
29 changes: 17 additions & 12 deletions packages/eslint-plugin/src/util/explicitReturnTypeUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,15 +176,12 @@ function doesImmediatelyReturnFunctionExpression({
/**
* Checks if a function belongs to:
* ```
* () => ({ action: 'xxx' } as const)
* ({ action: 'xxx' } as const)
* ```
*/
function returnsConstAssertionDirectly(
node: TSESTree.ArrowFunctionExpression,
): boolean {
const { body } = node;
if (isTypeAssertion(body)) {
const { typeAnnotation } = body;
function isConstAssertion(node: TSESTree.Node): boolean {
if (isTypeAssertion(node)) {
const { typeAnnotation } = node;
if (typeAnnotation.type === AST_NODE_TYPES.TSTypeReference) {
const { typeName } = typeAnnotation;
if (
Expand Down Expand Up @@ -256,11 +253,19 @@ function isValidFunctionExpressionReturnType(
}

// https://github.com/typescript-eslint/typescript-eslint/issues/653
return (
options.allowDirectConstAssertionInArrowFunctions === true &&
node.type === AST_NODE_TYPES.ArrowFunctionExpression &&
returnsConstAssertionDirectly(node)
);
if (
!options.allowDirectConstAssertionInArrowFunctions ||
node.type !== AST_NODE_TYPES.ArrowFunctionExpression
) {
return false;
}

let body = node.body;
while (body.type === AST_NODE_TYPES.TSSatisfiesExpression) {
body = body.expression;
}

return isConstAssertion(body);
}

/**
Expand Down
71 changes: 71 additions & 0 deletions packages/eslint-plugin/tests/rules/explicit-function-return-type.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,53 @@ const func = (value: number) => x as const;
},
{
code: `
interface R {
type: string;
value: number;
}

const func = (value: number) => ({ type: 'X', value }) as const satisfies R;
`,
options: [
{
allowDirectConstAssertionInArrowFunctions: true,
},
],
},
{
code: `
interface R {
type: string;
value: number;
}

const func = (value: number) =>
({ type: 'X', value }) as const satisfies R satisfies R;
`,
options: [
{
allowDirectConstAssertionInArrowFunctions: true,
},
],
},
{
code: `
interface R {
type: string;
value: number;
}

const func = (value: number) =>
({ type: 'X', value }) as const satisfies R satisfies R satisfies R;
`,
options: [
{
allowDirectConstAssertionInArrowFunctions: true,
},
],
},
{
code: `
new Promise(resolve => {});
new Foo(1, () => {});
`,
Expand Down Expand Up @@ -1731,6 +1778,30 @@ const func = (value: number) => ({ type: 'X', value }) as const;
},
],
},
{
code: `
interface R {
type: string;
value: number;
}

const func = (value: number) => ({ type: 'X', value }) as const satisfies R;
`,
errors: [
{
column: 30,
endColumn: 32,
endLine: 7,
line: 7,
messageId: 'missingReturnType',
},
],
options: [
{
allowDirectConstAssertionInArrowFunctions: false,
},
],
},
{
code: 'const log = (message: string) => void console.log(message);',
errors: [
Expand Down
73 changes: 73 additions & 0 deletions packages/eslint-plugin/tests/rules/explicit-module-boundary-types.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -367,6 +367,54 @@ export const func4 = (value: number) => x as const;
},
{
code: `
interface R {
type: string;
value: number;
}

export const func = (value: number) =>
({ type: 'X', value }) as const satisfies R;
`,
options: [
{
allowDirectConstAssertionInArrowFunctions: true,
},
],
},
{
code: `
interface R {
type: string;
value: number;
}

export const func = (value: number) =>
({ type: 'X', value }) as const satisfies R satisfies R;
`,
options: [
{
allowDirectConstAssertionInArrowFunctions: true,
},
],
},
{
code: `
interface R {
type: string;
value: number;
}

export const func = (value: number) =>
({ type: 'X', value }) as const satisfies R satisfies R satisfies R;
`,
options: [
{
allowDirectConstAssertionInArrowFunctions: true,
},
],
},
{
code: `
export const func1 = (value: string) => value;
export const func2 = (value: number) => ({ type: 'X', value });
`,
Expand Down Expand Up @@ -1204,6 +1252,31 @@ export const func = (value: number) => ({ type: 'X', value }) as const;
},
{
code: `
interface R {
type: string;
value: number;
}

export const func = (value: number) =>
({ type: 'X', value }) as const satisfies R;
`,
errors: [
{
column: 37,
endColumn: 39,
endLine: 7,
line: 7,
messageId: 'missingReturnType',
},
],
options: [
{
allowDirectConstAssertionInArrowFunctions: false,
},
],
},
{
code: `
export class Test {
constructor() {}
get prop() {
Expand Down
Loading