[No QA] Standardize type-only imports #32475

chrispader · 2023-12-05T13:43:04Z

@roryabraham @hayata-suenaga @blazejkustra @fabioh8010

Details

Enable TS ESLint rules to ESLint rule to be standardize type-only imports in the codebase.

Enabled rules:

'@typescript-eslint/consistent-type-imports': [
    'error',
    {
        prefer: 'type-imports',
        fixStyle: 'separate-type-imports',
    },
],
'@typescript-eslint/no-import-type-side-effects': 'error',
'@typescript-eslint/consistent-type-exports': [
    'error',
    {
        fixMixedExportsWithInlineTypeSpecifier: false,
    },
],
'import/consistent-type-specifier-style': ['error', 'prefer-top-level'],

Fixed Issues

$ #32368
PROPOSAL:

Tests

Verify that no errors appear in the JS console

This change only affects TypeScript, not JavaScript. Therefore, it has no effect on the app at runtime. The only tests that should be needed are to run npm run typecheck and npm run lint and verify that both pass.

Offline tests

Not needed.

QA Steps

Verify that no errors appear in the JS console

No QA.

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

chrispader · 2023-12-05T13:43:52Z

Lots of changes due to eslint --fix... The main change is just in .eslintrc.js

melvin-bot · 2023-12-05T13:44:28Z

@Santhosh-Sellavel Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

chrispader · 2023-12-05T13:46:12Z

do we need screenshots & QA here? @roryabraham

blazejkustra · 2023-12-05T14:08:46Z

Prettier is failing @chrispader

blazejkustra

LGTM! One comment but not a blocker

src/ROUTES.ts

fabioh8010

@chrispader Could you add a section in our TS guidelines about these import rules?

blazejkustra · 2023-12-05T14:15:03Z

@chrispader Could you add a section in our TS guidelines about these import rules?

I'm not sure it's needed as this is enforced with ESLint 🤔

fabioh8010 · 2023-12-05T14:16:16Z

Well we have a couple of rules that are enforced by ESLint but they are also detailed in the guidelines 🤷‍♂️

hayata-suenaga · 2023-12-05T16:59:32Z

yep I agree. we should also write about this in the guideline 👍

contributingGuides/TS_STYLE.md

src/ROUTES.ts

blazejkustra · 2023-12-05T17:11:56Z

@chrispader Please unresolve this thread 🙏

Santhosh-Sellavel · 2023-12-06T17:59:59Z

Conflicts & tests fails

chrispader · 2023-12-14T13:51:48Z

Just for clarification: We decided to wait (for me) to create an upstream PR to fix a problem with this rule, where the type keyword is not placed consistently when auto-fixing

#32475 (comment)

chrispader · 2023-12-30T14:55:53Z

Turns out, we don't need an upstream change 🎉 There's a rule for enforcing type specifier style:

https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/consistent-type-specifier-style.md

roryabraham · 2024-01-01T19:57:23Z

Great, @blazejkustra @fabioh8010 @Santhosh-Sellavel back to you for review

blazejkustra

This is still an issue. Both exports work:

export type {LocaleContextProps};
// or 
export {type LocaleContextProps};

For imports:

import type {WithCurrentUserPersonalDetailsProps} from './withCurrentUserPersonalDetails';
import withCurrentUserPersonalDetails from './withCurrentUserPersonalDetails';
// or
import withCurrentUserPersonalDetails, {type WithCurrentUserPersonalDetailsProps} from './withCurrentUserPersonalDetails';

That being said, I don't consider it as huge issue, I'm good with merging as it is now 👍

chrispader · 2024-01-02T11:50:24Z

This is still an issue. Both exports work:

export type {LocaleContextProps};
// or 
export {type LocaleContextProps};

For imports:

import type {WithCurrentUserPersonalDetailsProps} from './withCurrentUserPersonalDetails';
import withCurrentUserPersonalDetails from './withCurrentUserPersonalDetails';
// or
import withCurrentUserPersonalDetails, {type WithCurrentUserPersonalDetailsProps} from './withCurrentUserPersonalDetails';

That being said, I don't consider it as huge issue, I'm good with merging as it is now 👍

Yes it is unfortunately. I can't find any rule that enforces this though.. So also in favor of merging anyway

chrispader · 2024-01-02T11:52:00Z

Merged main and resolved conflicts. Ready for review and merge :)

cc @roryabraham

roryabraham · 2024-01-02T22:25:19Z

@chrispader unfortunately we got a toooon of conflicts here. I think we need to sync up in slack and time the merge to happen as soon as conflicts are resolved next time.

roryabraham

Thoroughly reviewed the whole diff, LGTM 👍🏼

roryabraham · 2024-01-03T18:12:51Z

Though, lint is failing

roryabraham · 2024-01-03T18:17:22Z

It looks like when you resolved conflicts you accidentally got rid of your changes in package.json and package-lock.json / forgot to reinstall the new eslint packages

Santhosh-Sellavel · 2024-01-03T18:43:35Z

@roryabraham
Not sure whether this additionally requires a C+ here as you did most of the work & it [No QA] as well only the checklist is left out. Let me know if a C+ review is needed, I'll continue once the lint error is resolved, otherwise, we are good to go here, thanks!

chrispader · 2024-01-03T18:54:25Z

It looks like when you resolved conflicts you accidentally got rid of your changes in package.json and package-lock.json / forgot to reinstall the new eslint packages

yes i did. Just added it back

roryabraham · 2024-01-03T19:02:39Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible 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 checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (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
- 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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 verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
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
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

roryabraham · 2024-01-03T21:40:59Z

Merging even though reassure tests aren't done because:

This is a compile-time change, shouldn't affect runtime performance
reassure tests are taking like an hour, and we're seeing conflicts more regularly than that
They had previously passed just fine before resolving conflicts

melvin-bot · 2024-01-03T21:41:27Z

@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-01-03T21:41:41Z

Not an emergency – see last comment

OSBotify · 2024-01-03T21:46:31Z

✋ 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-01-04T19:02:57Z

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

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

OSBotify · 2024-01-04T20:10:34Z

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

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

OSBotify · 2024-01-09T05:19:14Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.22-6 🚀

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

chrispader mentioned this pull request Dec 5, 2023

Standardize on type-only imports #32368

Closed

chrispader marked this pull request as ready for review December 5, 2023 13:44

chrispader requested a review from a team as a code owner December 5, 2023 13:44

melvin-bot bot requested review from Santhosh-Sellavel and removed request for a team December 5, 2023 13:44

blazejkustra approved these changes Dec 5, 2023

View reviewed changes

src/ROUTES.ts Outdated Show resolved Hide resolved

fabioh8010 reviewed Dec 5, 2023

View reviewed changes

chrispader requested review from blazejkustra and fabioh8010 December 5, 2023 14:58

blazejkustra suggested changes Dec 5, 2023

View reviewed changes

contributingGuides/TS_STYLE.md Outdated Show resolved Hide resolved

src/ROUTES.ts Outdated Show resolved Hide resolved

chrispader changed the title ~~Standardize type-only imports~~ [HOLD on upstream PR]Standardize type-only imports Dec 14, 2023

chrispader changed the title ~~[HOLD on upstream PR]Standardize type-only imports~~ [HOLD on upstream PR] Standardize type-only imports Dec 14, 2023

chrispader changed the title ~~[HOLD on upstream PR] Standardize type-only imports~~ Standardize type-only imports Dec 30, 2023

chrispader force-pushed the @chrispader/standardize-type-only-imports branch from 4a93919 to c24c897 Compare December 30, 2023 14:55

blazejkustra approved these changes Jan 2, 2024

View reviewed changes

Christoph Pader added 3 commits January 3, 2024 19:04

add TS_STYLE update

62c85a1

add lint changes

82b76c1

fix: more errors

19eb210

chrispader force-pushed the @chrispader/standardize-type-only-imports branch from 04821e3 to 19eb210 Compare January 3, 2024 18:06

Christoph Pader added 2 commits January 3, 2024 19:06

fix: prettier

8aec07c

remove extra type keyword

062c106

roryabraham previously approved these changes Jan 3, 2024

View reviewed changes

add eslint-plugin-import

e48bd27

chrispader dismissed roryabraham’s stale review via e48bd27 January 3, 2024 18:53

Christoph Pader added 2 commits January 3, 2024 21:22

Merge branch 'main' into @chrispader/standardize-type-only-imports

6817b6d

fix: eslint

8c5f3a7

roryabraham approved these changes Jan 3, 2024

View reviewed changes

roryabraham merged commit e6616e3 into Expensify:main Jan 3, 2024
16 of 18 checks passed

melvin-bot bot added the Emergency label Jan 3, 2024

roryabraham removed the Emergency label Jan 3, 2024

This was referenced Jan 3, 2024

[TS migration] Migrate 'User.js' lib to TypeScript #28695

Merged

🍒 Cherry pick PR #33896 to staging 🍒 #33917

Merged

github-actions bot mentioned this pull request Jan 4, 2024

Deploy Checklist: New Expensify 2024-01-04 #33973

Closed

74 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[No QA] Standardize type-only imports #32475

[No QA] Standardize type-only imports #32475

chrispader commented Dec 5, 2023 •

edited

Loading

chrispader commented Dec 5, 2023

melvin-bot bot commented Dec 5, 2023

chrispader commented Dec 5, 2023

blazejkustra commented Dec 5, 2023 •

edited

Loading

blazejkustra left a comment

fabioh8010 left a comment

blazejkustra commented Dec 5, 2023

fabioh8010 commented Dec 5, 2023

hayata-suenaga commented Dec 5, 2023

blazejkustra commented Dec 5, 2023

Santhosh-Sellavel commented Dec 6, 2023

chrispader commented Dec 14, 2023

chrispader commented Dec 30, 2023

roryabraham commented Jan 1, 2024

blazejkustra left a comment •

edited

Loading

chrispader commented Jan 2, 2024

chrispader commented Jan 2, 2024

roryabraham commented Jan 2, 2024

roryabraham left a comment

roryabraham commented Jan 3, 2024

roryabraham commented Jan 3, 2024

Santhosh-Sellavel commented Jan 3, 2024

chrispader commented Jan 3, 2024

roryabraham commented Jan 3, 2024 •

edited

Loading

roryabraham commented Jan 3, 2024 •

edited

Loading

melvin-bot bot commented Jan 3, 2024

roryabraham commented Jan 3, 2024

OSBotify commented Jan 3, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 9, 2024

[No QA] Standardize type-only imports #32475

[No QA] Standardize type-only imports #32475

Conversation

chrispader commented Dec 5, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

chrispader commented Dec 5, 2023

melvin-bot bot commented Dec 5, 2023

chrispader commented Dec 5, 2023

blazejkustra commented Dec 5, 2023 • edited Loading

blazejkustra left a comment

Choose a reason for hiding this comment

fabioh8010 left a comment

Choose a reason for hiding this comment

blazejkustra commented Dec 5, 2023

fabioh8010 commented Dec 5, 2023

hayata-suenaga commented Dec 5, 2023

blazejkustra commented Dec 5, 2023

Santhosh-Sellavel commented Dec 6, 2023

chrispader commented Dec 14, 2023

chrispader commented Dec 30, 2023

roryabraham commented Jan 1, 2024

blazejkustra left a comment • edited Loading

Choose a reason for hiding this comment

chrispader commented Jan 2, 2024

chrispader commented Jan 2, 2024

roryabraham commented Jan 2, 2024

roryabraham left a comment

Choose a reason for hiding this comment

roryabraham commented Jan 3, 2024

roryabraham commented Jan 3, 2024

Santhosh-Sellavel commented Jan 3, 2024

chrispader commented Jan 3, 2024

roryabraham commented Jan 3, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

roryabraham commented Jan 3, 2024 • edited Loading

melvin-bot bot commented Jan 3, 2024

roryabraham commented Jan 3, 2024

OSBotify commented Jan 3, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 4, 2024

OSBotify commented Jan 9, 2024

chrispader commented Dec 5, 2023 •

edited

Loading

blazejkustra commented Dec 5, 2023 •

edited

Loading

blazejkustra left a comment •

edited

Loading

roryabraham commented Jan 3, 2024 •

edited

Loading

roryabraham commented Jan 3, 2024 •

edited

Loading