jsx-eslint/eslint-plugin-reactPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star9.2k

[New] add`no-render-return-undefined`: disallow components rendering undefined#3750

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Draft

akulsr0 wants to merge14 commits intojsx-eslint:master

base:master

Choose a base branch

fromakulsr0:akul/no-render-return-undefined

Draft

[New] add`no-render-return-undefined`: disallow components rendering undefined#3750

akulsr0 wants to merge14 commits intojsx-eslint:masterfromakulsr0:akul/no-render-return-undefined

Conversation

Copy link

Contributor

akulsr0 commentedMay 8, 2024•
edited
Loading

Closes#3020

[Feat] no-render-return-undefined: initital commit

499e261

Copy link

codecovbot commentedMay 8, 2024•
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.45%. Comparing base(cef8123) to head(94e9817).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@##           master    #3750      +/-   ##==========================================- Coverage   97.62%   94.45%   -3.18%==========================================  Files         134      135       +1       Lines        9617     9708      +91       Branches     3488     3535      +47     ==========================================- Hits         9389     9170     -219- Misses        228      538     +310

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report?Share it here.

akulsr0 added4 commits

May 8, 2024 14:27

chore: add more test cases

86d7ac8

chore: add test cases

61981c7

chore: add tc for class components

34b6a94

chore: handle returning call expressions

56e7436

akulsr0 marked this pull request as ready for review

May 15, 2024 10:35

chore: handle returning logical expressions

9202a30

ljharb marked this pull request as draft

May 15, 2024 17:23

docs: add rule documentation

639f15f

Copy link

ContributorAuthor

akulsr0 commentedMay 16, 2024

@ljharb Let me know your thoughts on this!

chore: handle map callbacks

8aec646

akulsr0 marked this pull request as ready for review

May 18, 2024 14:50

ljharb added the new rule label

May 24, 2024

ljharb requested changes

May 24, 2024

View reviewed changes

docs/rules/no-render-return-undefined.mdShow resolvedHide resolved

docs/rules/no-render-return-undefined.md Outdated


		<!-- end auto-generated rule header -->

		> In React 18, components may render undefined, and React will render nothing to the DOM instead of throwing an error. However, accidentally rendering nothing in a component could still cause surprises. This rule will warn if the `return` statement in a React Component returns undefined.

Copy link

Member

ljharbMay 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	>InReact 18, components may render undefined, and React will render nothing to the DOM instead of throwing an error. However, accidentally rendering nothing in a component could still cause surprises. This rule will warn if the`return` statement in a React Component returns undefined.
	>Starting inReact 18, components may render`undefined`, and React will render nothing to the DOM instead of throwing an error. However, accidentally rendering nothing in a component could still cause surprises. This rule will warn if the`return` statement in a React Component returns`undefined`.

docs/rules/no-render-return-undefined.md Outdated


		> In React 18, components may render undefined, and React will render nothing to the DOM instead of throwing an error. However, accidentally rendering nothing in a component could still cause surprises. This rule will warn if the `return` statement in a React Component returns undefined.

		Issue: [#3020](https://github.com/jsx-eslint/eslint-plugin-react/issues/3020)

Copy link

Member

ljharbMay 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

i'm not sure linking to the issue is needed

docs/rules/no-render-return-undefined.md Outdated


		## Rule Details

		This rule will warn if the `return` statement in a React component returns undefined.

Copy link

Member

ljharbMay 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	This rule will warn if the`return` statement in a React component returns undefined.
	This rule will warn if the`return` statement in a React component returns`undefined`.

docs/rules/no-render-return-undefined.md


		This rule will warn if the `return` statement in a React component returns undefined.

		Examples of incorrect code for this rule:

Copy link

Member

ljharbMay 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

let's add one that usesvoid

Copy link

Member

ljharbJul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

ping

lib/rules/no-render-return-undefined.js OutdatedShow resolvedHide resolved

package.json OutdatedShow resolvedHide resolved

ljharb marked this pull request as draft

May 24, 2024 16:34

refactor: pr review changes

d1814c1

akulsr0 force-pushed theakul/no-render-return-undefined branch from6d3cfec tod1814c1Compare

May 25, 2024 05:13

akulsr0 added3 commits

May 25, 2024 17:01

Merge branch 'master' into akul/no-render-return-undefined

7905adf

fix: failing tests

b7ca1dd

chore: pr review change

f4983ae

Copy link

ContributorAuthor

akulsr0 commentedMay 29, 2024

I've pushed the review changes

akulsr0 marked this pull request as ready for review

June 6, 2024 16:31

Copy link

ContributorAuthor

akulsr0 commentedJun 20, 2024

Bumping this up!

ljharb requested changes

Jun 20, 2024

View reviewed changes

Copy link

Member

ljharb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

There's still some unaddressed comments on the docs.

lib/rules/index.js OutdatedShow resolvedHide resolved

ljharb marked this pull request as draft

June 20, 2024 20:47

ljharb changed the title~~[Feat]no-render-return-undefined: disallow components rendering undefined~~[New] addno-render-return-undefined: disallow components rendering undefined

Jun 20, 2024

akulsr0 added2 commits

June 21, 2024 08:11

refactor: sort rules index alphabetically

0b56b09

Merge branch 'master' into akul/no-render-return-undefined

94e9817

ljharb force-pushed themaster branch frombe61e18 to380e32cCompare

July 4, 2024 04:21

ljharb force-pushed themaster branch from380e32c to51d342bCompare

July 4, 2024 15:25

ljharb requested changes

Jul 11, 2024

View reviewed changes

docs/rules/no-render-return-undefined.md


		This rule will warn if the `return` statement in a React component returns undefined.

		Examples of incorrect code for this rule:

Copy link

Member

ljharbJul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

ping

docs/rules/no-render-return-undefined.md

Comment on lines +31 to +38

		function getUI() {
		if (condition) return <h1>Hello</h1>;
		}
		function App() {
		return getUI();
		}

Copy link

Member

ljharbJul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Yes, I don't think we necessarily have to support this - I'm saying that the docs should be updated to reflect the caveats.

lib/rules/no-render-return-undefined.js

Comment on lines +33 to +35

		const value = returnIdentifierVar.defs[0].node.init;
		if (
		returnIdentifierVar.defs[0].node

Copy link

Member

ljharbJul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

if line 35 is nullish, then line 33 will throw - i think this needs to be checked before accessing.init

lib/rules/no-render-return-undefined.js

		const isCalleeObjArray = calleeObjNode.defs[0].node.init.type === 'ArrayExpression';
		const isMapCall = isCalleeObjArray && calleePropertyName === 'map';
		if (isMapCall) {
		const mapCallback = returnNode.arguments[0];

Copy link

Member

ljharbJul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

can you add a test for an SFC that omitsreturn entirely?

lib/rules/no-render-return-undefined.js

		return value;
		}

		switch (returnNode.type) {

Copy link

Member

ljharbJul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

let's use an if/else here instead of a switch

tests/lib/rules/no-render-return-undefined.js

Comment on lines +188 to +191

		function App() {
		return null;
		}
		`,

Copy link

Member

ljharbJul 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	functionApp(){
	returnnull;
	}
	`,
	functionApp(){
	returnnull;
	}
	`,

similar changes on all the code snippets

mgamis-msft mentioned this pull request

Oct 24, 2024

Breakout rooms banner fix for react 17 and lowerAzure/communication-ui-library#5358

Merged

3 tasks

ljharb force-pushed themaster branch from301a48d to2c0b10cCompare

December 9, 2024 20:26

Labels

new rule

2 participants

Movatterモバイル変換

Uh oh!

[New] addno-render-return-undefined: disallow components rendering undefined#3750

Are you sure you want to change the base?

[New] addno-render-return-undefined: disallow components rendering undefined#3750

Uh oh!

Conversation

akulsr0 commentedMay 8, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

codecovbot commentedMay 8, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

akulsr0 commentedMay 16, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

akulsr0 commentedMay 29, 2024

Uh oh!

akulsr0 commentedJun 20, 2024

Uh oh!

ljharb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

[New] add`no-render-return-undefined`: disallow components rendering undefined#3750

[New] add`no-render-return-undefined`: disallow components rendering undefined#3750

akulsr0 commentedMay 8, 2024•
edited
Loading

codecovbot commentedMay 8, 2024•
edited
Loading