Skip to content

fix(no-misused-observables): false positive for JSX attributes #239

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
Jun 26, 2025
Merged

fix(no-misused-observables): false positive for JSX attributes #239

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
20 changes: 15 additions & 5 deletions src/rules/no-misused-observables.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,11 +180,21 @@ export const noMisusedObservablesRule = ruleCreator({
}

function checkJSXAttribute(node: es.JSXAttribute): void {
if (!node.value || !isJSXExpressionContainer(node.value)) {
if (
node.value == null
|| !isJSXExpressionContainer(node.value)
) {
return;
}

if (couldReturnObservable(node.value.expression)) {
const expressionContainer = esTreeNodeToTSNodeMap.get(
node.value,
);
const contextualType = checker.getContextualType(expressionContainer);
if (
contextualType != null
&& isVoidReturningFunctionType(contextualType)
&& couldReturnObservable(node.value.expression)
) {
context.report({
messageId: 'forbiddenVoidReturnAttribute',
node: node.value,
Expand Down Expand Up @@ -336,8 +346,8 @@ export const noMisusedObservablesRule = ruleCreator({
const tsNode = esTreeNodeToTSNodeMap.get(node);
if (
tsNode.initializer == null
|| !node.init
|| !node.id.typeAnnotation
|| node.init == null
|| node.id.typeAnnotation == null
) {
return;
}
Expand Down
77 changes: 44 additions & 33 deletions tests/rules/no-misused-observables.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,30 +49,43 @@ ruleTester({ types: true }).run('no-misused-observables', noMisusedObservablesRu
{
code: stripIndent`
// void return attribute; explicitly allowed
import { Observable, of } from "rxjs";
import React, { FC } from "react";
import { of } from "rxjs";

const Component: FC<{ foo: () => void }> = () => <div />;
const App = () => {
return (
<Component foo={() => of(42)} />
);
};
interface Props {
foo: () => void;
}
declare function Component(props: Props): any;

const _ = <Component foo={() => of(42)} />;
`,
options: [{ checksVoidReturn: { attributes: false } }],
languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
},
{
code: stripIndent`
// void return attribute; not void
import { Observable, of } from "rxjs";

interface Props {
foo: () => Observable<number>;
}
declare function Component(props: Props): any;

const _ = <Component foo={() => of(42)} />;
`,
languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
},
{
code: stripIndent`
// void return attribute; unrelated
import React, { FC } from "react";

const Component: FC<{ foo: () => void, bar: boolean }> = () => <div />;
const App = () => {
return (
<Component foo={() => 42} bar />
);
};
interface Props {
foo: () => void;
bar: boolean;
}
declare function Component(props: Props): any;

const _ = <Component foo={() => 42} bar />;
`,
languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
},
Expand Down Expand Up @@ -339,15 +352,14 @@ ruleTester({ types: true }).run('no-misused-observables', noMisusedObservablesRu
stripIndent`
// void return attribute; block body
import { Observable, of } from "rxjs";
import React, { FC } from "react";

const Component: FC<{ foo: () => void }> = () => <div />;
const App = () => {
return (
<Component foo={(): Observable<number> => { return of(42); }} />
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [forbiddenVoidReturnAttribute]
);
};

interface Props {
foo: () => void;
}
declare function Component(props: Props): any;

const _ = <Component foo={(): Observable<number> => { return of(42); }} />;
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ [forbiddenVoidReturnAttribute]
`,
{
languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
Expand All @@ -357,15 +369,14 @@ ruleTester({ types: true }).run('no-misused-observables', noMisusedObservablesRu
stripIndent`
// void return attribute; inline body
import { Observable, of } from "rxjs";
import React, { FC } from "react";

const Component: FC<{ foo: () => void }> = () => <div />;
const App = () => {
return (
<Component foo={() => of(42)} />
~~~~~~~~~~~~~~ [forbiddenVoidReturnAttribute]
);
};

interface Props {
foo: () => void;
}
declare function Component(props: Props): any;

const _ = <Component foo={() => of(42)} />;
~~~~~~~~~~~~~~ [forbiddenVoidReturnAttribute]
`,
{
languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } },
Expand Down