TWNTY-3794 - ESLint rule: only take explicit boolean predicates in if statements #4354

gitstart-app · 2024-03-07T09:52:16Z

This PR was created by GitStart to address the requirements from this ticket: TWNTY-3794.
This ticket was imported from: TWNTY-3794

Description

ESLint rule: only take explicit boolean predicates in if statements

Refs

#3794

DEMO

https://jam.dev/c/be8b6da7-c49e-4b9d-8ed7-d98f9831b605

Fixes #3794

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

lucasbordeau

Nice work,

Some minor comments.

Please don't hesitate to deactivate the rule and put a TODO where it seems hazardous to refactor.

Could you create isNotDefined ?

lucasbordeau · 2024-03-08T19:38:11Z

packages/twenty-front/src/utils/isNullable.ts

@@ -0,0 +1,4 @@
+import { isNull, isUndefined } from '@sniptt/guards';
+
+export const isNullable = (value: any): value is null | undefined =>


We already have a isDefined util, could we use that instead ?

isNullable => isNotDefined
isNonNullable => isDefined

Hey @lucasbordeau,
Can't seem to find this isDefined util? If you may kindly direct me to where it is located?

Actually I believe isDefined was there but got removed in a previous commit and replaced with isNonNullable(I'm not so sure about the commit/PR this was done in). Found this example in the commit history:

The only new util here is isNullable and it makes more sense to define it this way than negating isNonNullable i.e isNullable(value) >>>> !isNonNullable(value)

However, we can still get rid of isNullable if you prefer it that way.

For reference :

isDefined has been removed but shouldn't have been, we'll fix it thanks !

isNullable feels wrong because we actually have a TypeScript utility type Nullable and we don't want to check if it's Nullable but check if the runtime value is null | undefined, that's two separate concepts even if close.

lucasbordeau · 2024-03-08T19:41:26Z

packages/twenty-front/src/utils/isTruthy.ts

@@ -0,0 +1 @@
+export const isTruthy = Boolean;


We should avoid creating utils like this as it circumvents the rule by applying the same behavior as an if.

We want to prevent implicit boolean coercion : https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean#boolean_coercion

lucasbordeau · 2024-03-08T19:46:13Z

packages/twenty-front/src/utils/date-utils.ts

@@ -122,11 +124,12 @@ export const beautifyDateDiff = (
    ['years', 'days'],
  );
  let result = '';
-  if (dateDiff.years) result = result + `${dateDiff.years} year`;
+  if (isTruthy(dateDiff.years)) result = result + `${dateDiff.years} year`;


You can disable the rule here and add a TODO

lucasbordeau · 2024-03-08T19:56:18Z

I'm waiting for your modifications and will extensively test the application after that.

…thub.com/twentyhq/twenty into TWNTY-3794

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

charlesBochet

@gitstart-twenty Thank you! I'm going to merge it could you open another PR (same ticket) to add a test?

… statements (twentyhq#4354) * ESLint rule: only take explicit boolean predicates in if statements Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]> * Merge main Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]> * Fix frontend linter errors Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]> * Fix jest Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]> * Refactor according to review Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]> * Refactor according to review Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]> * Fix lint on new code Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]> --------- Co-authored-by: gitstart-twenty <[email protected]> Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

ESLint rule: only take explicit boolean predicates in if statements

ee76082

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

charlesBochet added -PR: awaiting author -PR: wip labels Mar 7, 2024

gitstart-twenty and others added 4 commits March 7, 2024 17:08

Refactor according to review

e9fd77d

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

Merge main

dca3b20

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

Fix frontend linter errors

8ef9d9d

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

Fix jest

0c21143

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

gitstart-twenty marked this pull request as ready for review March 7, 2024 17:43

gitstart-twenty added -PR: awaiting review and removed -PR: wip -PR: awaiting author labels Mar 7, 2024

charlesBochet assigned lucasbordeau Mar 8, 2024

charlesBochet requested a review from martmull March 8, 2024 18:01

charlesBochet assigned charlesBochet and unassigned lucasbordeau Mar 8, 2024

lucasbordeau reviewed Mar 8, 2024

View reviewed changes

lucasbordeau added -PR: awaiting author and removed -PR: awaiting review labels Mar 8, 2024

gitstart-twenty and others added 4 commits March 9, 2024 00:19

Merge commit '40bea0d95e81e9fee09d6d8d1ba41e459b1d0770' of https://gi…

7a5f525

…thub.com/twentyhq/twenty into TWNTY-3794

Refactor according to review

2e9cf1f

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

Refactor according to review

9a0f1c8

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

Fix lint on new code

9d18e07

Co-authored-by: v1b3m <[email protected]> Co-authored-by: Toledodev <[email protected]>

charlesBochet approved these changes Mar 9, 2024

View reviewed changes

charlesBochet merged commit 17511be into main Mar 9, 2024
15 checks passed

charlesBochet deleted the TWNTY-3794 branch March 9, 2024 09:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TWNTY-3794 - ESLint rule: only take explicit boolean predicates in if statements #4354

TWNTY-3794 - ESLint rule: only take explicit boolean predicates in if statements #4354

gitstart-app bot commented Mar 7, 2024

lucasbordeau left a comment

lucasbordeau Mar 8, 2024

lucasbordeau Mar 8, 2024

gitstart-twenty Mar 8, 2024 •

edited

Loading

gitstart-twenty Mar 9, 2024 •

edited

Loading

lucasbordeau Mar 11, 2024

lucasbordeau Mar 8, 2024

lucasbordeau Mar 8, 2024

gitstart-twenty Mar 9, 2024

lucasbordeau Mar 8, 2024

gitstart-twenty Mar 8, 2024

lucasbordeau commented Mar 8, 2024

charlesBochet left a comment

		@@ -0,0 +1,4 @@
		import { isNull, isUndefined } from '@sniptt/guards';

		export const isNullable = (value: any): value is null \| undefined =>

TWNTY-3794 - ESLint rule: only take explicit boolean predicates in if statements #4354

TWNTY-3794 - ESLint rule: only take explicit boolean predicates in if statements #4354

Conversation

gitstart-app bot commented Mar 7, 2024

Description

Refs

DEMO

lucasbordeau left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gitstart-twenty Mar 8, 2024 • edited Loading

Choose a reason for hiding this comment

gitstart-twenty Mar 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lucasbordeau commented Mar 8, 2024

charlesBochet left a comment

Choose a reason for hiding this comment

gitstart-twenty Mar 8, 2024 •

edited

Loading

gitstart-twenty Mar 9, 2024 •

edited

Loading