[MOB-10141] make lint rules stricter by lposen · Pull Request #604 · Iterable/react-native-sdk

lposen · 2024-11-15T22:53:15Z

🔹 JIRA Ticket(s) if any

MOB-10141

✏️ Description

Made lint rules stricter, and made the appropriate code changes to reflect this.

…arser and plugin, and update rules

… to target src directory

…er type safety

…fety and consistency

…leHtmlInAppContent, and IterableInAppMessage; introduce IterableHtmlInAppContentRaw type for improved data handling

… to improve type safety; update animatedValue type in IterableInbox for consistency

… with 'unknown' and improve parameter types for better consistency

… rules and plugin usage for consistency

…-alpha/MOB-10141-make-lint-rules-stricter

github-actions · 2024-11-15T22:54:23Z

Lines	Statements	Branches	Functions
	38.11% (178/467)	11.42% (20/175)	32.46% (50/154)

…ts lint issues from js files.

…e file

…and integration-testing from eslintIgnore

…readability and alignment

…ved maintainability and readability and to conform to react-native/no-color-literals suggested rule.

… maintainability and consistency and to fix eslint rule react-native/no-color-literals

…maintainability and consistency and to conform to suggested eslint rules: react-native/no-color-literals and react-native/no-unused-styles

…stency for better maintainability and to fix recommended eslint rules react-native/no-color-literals and react-native/no-unused-styles

…proved maintainability and consistency; update User component styles for better alignment with design standards.

…arity and maintainability; add comments for future improvements.

…-alpha/MOB-10141-make-lint-rules-stricter

…t-rules-stricter

evantk91

Some comments and nit picks but otherwise looking good

evantk91 · 2024-12-12T20:10:16Z

src/inbox/components/IterableInbox.tsx

 // TODO: Comment
-export interface IterableInboxProps {
+export interface IterableInboxProps
+  extends Pick<IterableInboxMessageListProps, 'messageListItemLayout'> {


What does this change do?

Ah I see. It simplifies the props by extended the other props. Nice!

evantk91 · 2024-12-12T20:44:23Z

src/inApp/classes/IterableInAppTrigger.ts

+  static fromDict(dict: {
+    type: IterableInAppTriggerType;
+  }): IterableInAppTrigger {
+    return new IterableInAppTrigger(dict.type);


Should we add to this as follows:
return new IterableInAppTrigger(dict.type ?? IterableInAppTriggerType.immediate)
So that the type of dict falls back to IterableInAppTriggerType.immediate if dict is null or undefined

Nevermind, I think this way is more stricter and controlled.

evantk91 · 2024-12-12T21:09:16Z

src/core/classes/IterableConfig.ts

   * By default, the SDK will not enforce encryption and may fallback to unencrypted storage in case the encryption fails.
   */
-  encryptionEnforced: boolean = false;
+  encryptionEnforced = false;


Good simplifications. Can we do the same for pushPlatform, dataRegion, allowedProtocols, and logLevel?

You can only do this if it's a primitive type (bool, string etc), so unfortunately we can't do that.

evantk91 · 2024-12-12T21:11:58Z

src/inApp/classes/IterableInAppMessage.ts

    saveToInbox: boolean,
    inboxMetadata: IterableInboxMetadata | undefined,
-    customPayload: any | undefined,
+    customPayload: unknown | undefined,


Nice type safety update.

evantk91 · 2024-12-12T21:22:06Z

src/inApp/classes/IterableInAppMessage.ts

+    };
+    customPayload: unknown;
+    read: boolean;
+    priorityLevel: number;


Seems like this should have a type like was done for IterableHtmlInAppContentRaw.

evantk91 · 2024-12-13T16:40:51Z

src/inbox/components/IterableInboxMessageDisplay.tsx

-    : returnButtonContainer;
-
  const JS = `
      const links = document.querySelectorAll('a')


Maybe this can be put into a constant in another file.

evantk91 · 2024-12-13T18:49:19Z

src/inbox/components/IterableInboxMessageCell.tsx

-
-  deleteSlider = isPortrait
-    ? deleteSlider
-    : { ...deleteSlider, paddingRight: 40 };


nice refactor

evantk91 · 2024-12-13T18:51:42Z

src/inbox/components/IterableInboxEmptyState.tsx

+            ? height - navTitleHeight - tabBarHeight - tabBarPadding
+            : height - navTitleHeight,
+        },
+      ]}


Nice refactor

src/inbox/components/IterableInbox.tsx

evantk91 · 2024-12-13T19:56:30Z

src/inbox/components/IterableInbox.tsx

      marginTop: 0,
      paddingBottom: 10,
-      paddingLeft: 30,
+      paddingLeft: isPortrait ? 30 : 70,


I think these can be given constants too.

lposen added 15 commits November 7, 2024 12:57

Add ESLint configuration file and remove inline config from package.json

2ce56ae

Enhance ESLint configuration for TypeScript support: add TypeScript p…

1d73a8d

…arser and plugin, and update rules

Enhance ESLint configuration: add jest plugin and update lint command…

b6797da

… to target src directory

Fixed autofixabe lint issues

0bd3f0c

Fixed linting issues for IterableInboxMessageCell

46c5710

eslint fixes

bc32769

Add IterableEdgeInsetDetails type and update related classes for bett…

6f87314

…er type safety

Refactor IterableConfig and IterableInAppMessage for improved type sa…

61d143d

…fety and consistency

Enhance type safety by refining types in IterableCommerceItem, Iterab…

888ee75

…leHtmlInAppContent, and IterableInAppMessage; introduce IterableHtmlInAppContentRaw type for improved data handling

Refactor fromDict methods in IterableAction and IterableActionContext…

a8ac6a1

… to improve type safety; update animatedValue type in IterableInbox for consistency

Refactor Iterable class methods to enhance type safety; replace 'any'…

7b0104a

… with 'unknown' and improve parameter types for better consistency

Allow requires for package.json and in tests

ad2cf2d

Refactor ESLint configuration for improved TypeScript support; update…

9cbfc82

… rules and plugin usage for consistency

Merge branch '2.0.0-alpha/MOB-9995-reorganize-source-code' into 2.0.0…

4b20c6e

…-alpha/MOB-10141-make-lint-rules-stricter

Merge branch '2.0.0-alpha/MOB-9995-reorganize-source-code' into 2.0.0…

6ebc953

…-alpha/MOB-10141-make-lint-rules-stricter

lposen and others added 13 commits November 15, 2024 16:19

Refactor ESLint configuration and improve type definitions. Excluded …

d76e662

…ts lint issues from js files.

Refactor ESLint configuration and move Prettier settings to a separat…

5d96ec5

…e file

Update ESLint configuration and ignore settings; remove node_modules …

cc96da8

…and integration-testing from eslintIgnore

Enhance ESLint configuration and improve component styles for better …

d029374

…readability and alignment

Refactor IterableInboxMessageDisplay to use color constants for impro…

c556a9f

…ved maintainability and readability and to conform to react-native/no-color-literals suggested rule.

Refactor IterableInboxMessageCell to use color constants for improved…

835786f

… maintainability and consistency and to fix eslint rule react-native/no-color-literals

Refactor IterableInboxEmptyState to use color constants for improved …

52a6422

…maintainability and consistency and to conform to suggested eslint rules: react-native/no-color-literals and react-native/no-unused-styles

Refactor IterableInbox to use color constants and improve style consi…

e2ebcf1

…stency for better maintainability and to fix recommended eslint rules react-native/no-color-literals and react-native/no-unused-styles

Refactor Commerce and Login components to use shadow constants for im…

241c5f6

…proved maintainability and consistency; update User component styles for better alignment with design standards.

Update ESLint configuration to use the full plugin path for better cl…

15add53

…arity and maintainability; add comments for future improvements.

Merge branch '2.0.0-alpha/MOB-9995-reorganize-source-code' into 2.0.0…

575cfbf

…-alpha/MOB-10141-make-lint-rules-stricter

Merge branch '2.0.0-alpha/MOB-9995-reorganize-source-code' into 2.0.0…

989dead

…-alpha/MOB-10141-make-lint-rules-stricter

Merge branch '2.0.0-alpha/MOB-9995-reorganize-source-code' into 2.0.0…

e5ade24

…-alpha/MOB-10141-make-lint-rules-stricter

Base automatically changed from 2.0.0-alpha/MOB-9995-reorganize-source-code to 2.0.0-alpha/master December 3, 2024 21:08

evantk91 and others added 2 commits December 6, 2024 14:08

Merge branch '2.0.0-alpha/master' into 2.0.0-alpha/MOB-10141-make-lin…

89ac82b

…t-rules-stricter

Merge branch '2.0.0-alpha/master' into 2.0.0-alpha/MOB-10141-make-lin…

cbc3418

…t-rules-stricter

lposen requested a review from evantk91 December 11, 2024 22:08

evantk91 reviewed Dec 13, 2024

View reviewed changes

evantk91 approved these changes Dec 13, 2024

View reviewed changes

refactor: added constants instead of values as per PR review

f2f5122

lposen merged commit 9186467 into 2.0.0-alpha/master Dec 13, 2024

lposen deleted the 2.0.0-alpha/MOB-10141-make-lint-rules-stricter branch December 13, 2024 21:01

Conversation

lposen commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔹 JIRA Ticket(s) if any

✏️ Description

Uh oh!

github-actions bot commented Nov 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

evantk91 left a comment

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!

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!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lposen commented Nov 15, 2024 •

edited

Loading

github-actions bot commented Nov 15, 2024 •

edited

Loading