[No QA][TS migration] Adjust ESLint and TS configs #40778

blazejkustra · 2024-04-23T11:46:03Z

Details

Fixed Issues

$ #39119
PROPOSAL: N/A

Tests

Open the code, try to change the code in multiple places and verify that:
- It works reliably every time
- Performance is as usual
- ESLint and TS catches errors according to rules/options in configs

Offline tests

N/A

QA Steps

N/A

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

N/A

.eslintrc.js

fabioh8010 · 2024-04-23T14:42:43Z

.github/actions/javascript/authorChecklist/index.js

I'm curious, why did these generated files change?

I have no idea what caused this, I only changed eslint and TS configs. Any idea? 😅

I guess it's because of the .eslintrc.js added?

But let's make sure workflow tests are passing and watch for regressions 👀

BartoszGrajdek

Left a few comments 👀

web/gtm.js

tsconfig.json

src/components/OptionsSelector/BaseOptionsSelector.js

src/pages/iou/request/MoneyTemporaryForRefactorRequestParticipantsSelector.js

BartoszGrajdek

LGTM

roryabraham

High-level request: rather than making all these changes here in our .eslintrc.js, can we update our base eslint-config-expensify to include all the rules (dynamically for JS and TS)?

blazejkustra · 2024-05-09T15:10:05Z

@roryabraham While I agree that it would be nice to move the majority of rules to eslint-config-expensify; I don't think it's worth the effort for now.

This won't be as easy as moving all the rules from E/App .eslintrc.js to eslint-config-expensify. This would be rather a big refactor of eslint-config-expensify with a lot of testing in different repos to make sure TS/React/RN rules are applied to E/App while a different set of rules is used in react-native-onyx and the same goes for other repos that Expensify maintains (old mobile/old web/live-markdown/expensify-common etc).

I'm worried that it would take too much time and won't bring much value.

How about creating a backlog ticket for this? / Or just do nothing for now.
An alternative approach would be to pick all rules that are both used in onyx and E/App and move them to eslint-config-expensify.

roryabraham · 2024-05-10T14:00:50Z

I'm confused why it would be a big refactor in eslint-config-expensify, given that most/all the rules here are specific to either TS files or React Native. I'd think that would mean it would have minimal effect on our other repos unless they start using TS or RN.

That said, if you investigated and feel strongly then it's NAB, because as I said I'd expect the effect on other repos to be very limited.

roryabraham · 2024-05-10T16:15:52Z

There are conflicts and failing TS checks here, btw

roryabraham

overall this seems good

roryabraham · 2024-05-10T16:18:55Z

.eslintignore

-**/dist/*
-android/**/build/*
-.github/actions/**/index.js"
+.*


question: does this line ignore anything that starts with .? If yes, great change! I was going to ask that we ignore .bundle and .expo too but it seems like that's covered.

Yes! I thought it was clever but turns out here are two caveats:

With this approach .github and .storybook weren't linted (it's more complicated because we want to lint .github but not .github/actions/**/index.js)

Turns out dot files/directories are automatically omitted so no need for .*, instead I did this:

!.storybook !.github

@parasharrajat I checked it myself but could you double check that correct directories are linted (.github, .storybook, src, web, desktop etc) and correct are omitted (.github/actions/**/index.js, configs, dist, .expo, .git)? Thank you!

It looks good to me.

Some files are still showing errors via ts compiler though the EsLint is not triggered.

.eslintrc.js

blazejkustra · 2024-05-13T10:48:45Z

There are conflicts and failing TS checks here, btw

@roryabraham Left an explanation here

mountiny

Looks good to me, the TS failures are expected for now

@roryabraham all yours

parasharrajat · 2024-05-13T12:41:45Z

Conflict again @blazejkustra

parasharrajat · 2024-05-13T14:04:28Z

Noticed a thing. Not sure if I am only affected from it.

Shouldn't the following comments throw a warning as we are not putting new lines before them? This Expensify.tsx file.

blazejkustra · 2024-05-13T14:25:05Z

Shouldn't the following comments throw a warning as we are not putting new lines before them? This Expensify.tsx file.

@parasharrajat I believe we don't have a rule for it 🤔

parasharrajat · 2024-05-13T15:08:16Z

Aha, I see.

blazejkustra · 2024-05-14T09:04:19Z

I'm confused why it would be a big refactor in eslint-config-expensify, given that most/all the rules here are specific to either TS files or React Native. I'd think that would mean it would have minimal effect on our other repos unless they start using TS or RN.

You're correct, that most of these rules are indeed specific to TS and RN, but also specific to NewDot. These rules might impact other projects that have different coding styles (Onyx as an example). Such impact might go unnoticed unless thoroughly checked. This leads to the need to restructure and possibly add another preset to eslint-config-expensify. Rather than extending from 'expensify' in .eslintrc.js as shown below:

extends: [ 'expensify', ...

We would have something like this instead:

extends ['expensify-typescript', ...

Breaking it down, this implies:

Reorganization of the rules, potentially reshaping a significant part of the eslint-config-expensify repository
Collaborative agreement on rules to be applicable across all JS/TS repositories (which could also entail deprecating some JS rules)
Extensive testing across various repositories, a few of which I don't have access to

That's where the potential time consumption and complexity arises from. @roryabraham Let me your thoughts + please have a final look at the PR 😄

roryabraham

LGTM 👍🏼

TypeCheck is failing because of the addition of a new .js file, but it's a .eslintrc.js, so not a concern. Going to merge.

melvin-bot · 2024-05-14T17:31:47Z

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

roryabraham · 2024-05-14T17:32:02Z

not an emergency - see last comment

OSBotify · 2024-05-14T17:39:54Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-05-15T10:12:50Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.74-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2024-05-22T23:57:51Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.4.74-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

blazejkustra added 13 commits April 23, 2024 11:03

Update .github eslint config

51f2ed3

Update tests eslint config

422e872

Create workflow tests eslint config

8d61837

Remove overrides for workflow tests

df3e91c

Remove overrides for tests

bce33e4

Move no-restricted-imports to common ruleset

b65414b

fix no-restricted-imports, put it in the right section

0748762

Remove ignorePatterns from eslint config and update eslintignore

2d214d7

Fix android build ignore line

6e8a2be

Clean up eslint config

c5a1f72

Add temporary config for js files

25b2935

Ignore config files and docs/assets

af17bf5

Ignore other js eslint errors

b6f605d

blazejkustra changed the title ~~[TS migration] Adjust ESLint and TS configs~~ [No QA][TS migration] Adjust ESLint and TS configs Apr 23, 2024

blazejkustra added 3 commits April 23, 2024 14:01

Clean up tsconfig

57d2950

Fix imports inside eslint config

56395cd

Add missing endline

76b1780

blazejkustra mentioned this pull request Apr 23, 2024

[HOLD for payment 2024-07-22] [HOLD for payment 2024-07-17] [HOLD for payment 2024-07-10] [$500] [TS Migration] Adjust eslint config, TS config #39119

Closed

Build GH actions

a06de12

fabioh8010 reviewed Apr 23, 2024

View reviewed changes

BartoszGrajdek reviewed Apr 24, 2024

View reviewed changes

web/gtm.js Outdated Show resolved Hide resolved

tsconfig.json Show resolved Hide resolved

src/components/OptionsSelector/BaseOptionsSelector.js Outdated Show resolved Hide resolved

src/pages/iou/request/MoneyTemporaryForRefactorRequestParticipantsSelector.js Outdated Show resolved Hide resolved

blazejkustra added 3 commits April 24, 2024 15:16

Add gtm.js to eslintignore

85ff452

Add comments with explanation about last JS components

b47c28b

Merge branch 'main' into ts/eslint-typescript-config

88a1e5b

blazejkustra requested review from BartoszGrajdek and fabioh8010 April 24, 2024 13:57

BartoszGrajdek approved these changes Apr 24, 2024

View reviewed changes

fabioh8010 approved these changes Apr 24, 2024

View reviewed changes

blazejkustra marked this pull request as ready for review April 24, 2024 16:15

blazejkustra requested a review from a team as a code owner April 24, 2024 16:15

roryabraham reviewed May 8, 2024

View reviewed changes

roryabraham previously approved these changes May 10, 2024

View reviewed changes

Merge branch 'main' into ts/eslint-typescript-config

5ebca88

blazejkustra dismissed roryabraham’s stale review via 5ebca88 May 13, 2024 08:30

Adjust ESLint configuration

7f6763c

mountiny previously approved these changes May 13, 2024

View reviewed changes

rinej mentioned this pull request May 13, 2024

import emoji async draft #41097

Merged

48 tasks

Merge branch 'main' into ts/eslint-typescript-config

6f2f703

blazejkustra dismissed mountiny’s stale review via 6f2f703 May 13, 2024 12:49

mountiny approved these changes May 13, 2024

View reviewed changes

blazejkustra requested a review from roryabraham May 13, 2024 14:40

roryabraham approved these changes May 14, 2024

View reviewed changes

roryabraham merged commit b7dcc5e into Expensify:main May 14, 2024
22 of 23 checks passed

melvin-bot bot added the Emergency label May 14, 2024

roryabraham removed the Emergency label May 14, 2024

github-actions bot mentioned this pull request May 15, 2024

Deploy Checklist: New Expensify 2024-05-15 #42185

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA][TS migration] Adjust ESLint and TS configs #40778

[No QA][TS migration] Adjust ESLint and TS configs #40778

blazejkustra commented Apr 23, 2024 •

edited

Loading

fabioh8010 Apr 23, 2024

blazejkustra Apr 24, 2024

fabioh8010 Apr 24, 2024

fabioh8010 Apr 24, 2024

BartoszGrajdek left a comment

BartoszGrajdek left a comment

roryabraham left a comment

blazejkustra commented May 9, 2024

roryabraham commented May 10, 2024

roryabraham commented May 10, 2024

roryabraham left a comment

roryabraham May 10, 2024

blazejkustra May 13, 2024

blazejkustra May 13, 2024

parasharrajat May 13, 2024

parasharrajat May 13, 2024

parasharrajat May 13, 2024 •

edited

Loading

blazejkustra commented May 13, 2024

mountiny left a comment

parasharrajat commented May 13, 2024

parasharrajat commented May 13, 2024 •

edited

Loading

blazejkustra commented May 13, 2024

parasharrajat commented May 13, 2024

blazejkustra commented May 14, 2024

roryabraham left a comment •

edited

Loading

melvin-bot bot commented May 14, 2024

roryabraham commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

[No QA][TS migration] Adjust ESLint and TS configs #40778

[No QA][TS migration] Adjust ESLint and TS configs #40778

Conversation

blazejkustra commented Apr 23, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

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

BartoszGrajdek left a comment

Choose a reason for hiding this comment

BartoszGrajdek left a comment

Choose a reason for hiding this comment

roryabraham left a comment

Choose a reason for hiding this comment

blazejkustra commented May 9, 2024

roryabraham commented May 10, 2024

roryabraham commented May 10, 2024

roryabraham left a 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

parasharrajat May 13, 2024 • edited Loading

Choose a reason for hiding this comment

blazejkustra commented May 13, 2024

mountiny left a comment

Choose a reason for hiding this comment

parasharrajat commented May 13, 2024

parasharrajat commented May 13, 2024 • edited Loading

blazejkustra commented May 13, 2024

parasharrajat commented May 13, 2024

blazejkustra commented May 14, 2024

roryabraham left a comment • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented May 14, 2024

roryabraham commented May 14, 2024

OSBotify commented May 14, 2024

OSBotify commented May 15, 2024

OSBotify commented May 22, 2024

blazejkustra commented Apr 23, 2024 •

edited

Loading

parasharrajat May 13, 2024 •

edited

Loading

parasharrajat commented May 13, 2024 •

edited

Loading

roryabraham left a comment •

edited

Loading