[NoQA] Add `CSpell` for spelling checks [Part 4] #61768

dominictb · 2025-05-09T09:59:26Z

cc @mountiny @ishpaul777

Explanation of Change

Fix spellings in src/libs. Github Action for CSpell has not been integrated here.

Fixed Issues

$ #54810
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

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 verified there are no new alerts related to the canBeMissing param for useOnyx
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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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.ts 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.
I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…p into feat/54810-4

…eat/54810-4

melvin-bot · 2025-05-13T04:27:22Z

@MariaHCD 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]

src/CONST.ts

src/libs/API/types.ts

MariaHCD · 2025-05-13T08:30:26Z

src/libs/SearchQueryUtils.ts

@@ -43,6 +43,7 @@ const operatorToCharMap = {
 /**
 * A mapping object that maps filter names from the internal codebase format to user-friendly names.
 */
+// cspell:disable


Why do we need to do this?

To disable for this line reportid:

App/src/libs/SearchQueryUtils.ts

Line 66 in 3d2b44f

reportID: 'reportid',

But I think cspell:disable-next-line is enough.

MariaHCD

Looks good to me so far. There still are some ESLint errors 👀

dominictb · 2025-05-13T15:12:06Z

Since these PRs touch too many files, I got a 🟢 light from @mountiny to skip fixing these lints #59249 (comment).

ishpaul777 · 2025-05-13T19:46:45Z

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 that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- 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 there are no new alerts related to the canBeMissing param for useOnyx
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 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 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 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.ts 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 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.
For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
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: HybridApp

Screen.Recording.2025-05-16.at.12.21.28.AM.mov

Android: mWeb Chrome

Screen.Recording.2025-05-16.at.12.23.25.AM.mov

iOS: HybridApp

Screen.Recording.2025-05-16.at.12.04.42.AM.mov

iOS: mWeb Safari

Screen.Recording.2025-05-16.at.12.07.02.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2025-05-15.at.11.55.09.PM.mov

MacOS: Desktop

Screen.Recording.2025-05-16.at.2.20.52.AM.mov

…eat/54810-4

mountiny · 2025-05-14T20:45:19Z

Yeah the failing eslint checks are optional and its not feasible to fix them in this PR as it would increase the chance for some regression a lot

mountiny · 2025-05-14T20:45:40Z

@ishpaul777 can you please complete the checklist?

…eat/54810-4

mountiny · 2025-05-15T17:31:05Z

@ishpaul777 @dominictb how is this looking?

ishpaul777 · 2025-05-15T17:32:43Z

@mountiny i'll prioritize and finish this today

ishpaul777 · 2025-05-15T18:59:02Z

@dominictb ~~jest test failing~~ and we have conflicts

looks like test passed but the operation was cancelled

MariaHCD

Looks good to me! We have some merge conflicts, however.

…eat/54810-4

MariaHCD · 2025-05-16T10:22:31Z

All yours @mountiny !

mountiny

thanks

melvin-bot · 2025-05-16T11:54:45Z

@mountiny 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.

mountiny · 2025-05-16T11:55:21Z

We touched many files in this change so this is mainly to avoid more regressions we did not fix all the lint changes

github-actions · 2025-05-20T10:28:08Z

🚀 Deployed to staging by https://github.com/mountiny in version: 9.1.47-0 🚀

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

github-actions · 2025-05-21T18:06:45Z

🚀 Deployed to production by https://github.com/arosiclair in version: 9.1.47-6 🚀

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

github-actions · 2025-05-21T19:09:11Z

🚀 Deployed to production by https://github.com/arosiclair in version: 9.1.47-6 🚀

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

github-actions · 2025-05-21T19:45:17Z

🚀 Deployed to production by https://github.com/arosiclair in version: 9.1.47-6 🚀

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

dominictb added 2 commits May 9, 2025 16:56

fix spellings in src/libs

7f27d61

Merge branch 'feat/54810-3' of g.yxqyang.asia-dominictb:dominictb/epsf-ap…

f77aace

…p into feat/54810-4

mountiny requested review from mountiny and ishpaul777 May 12, 2025 15:55

dominictb added 2 commits May 13, 2025 11:24

Merge branch 'feat/54810-3' of g.yxqyang.asia-dominictb:dominictb/epsf-ap…

fd803cf

…p into feat/54810-4

Merge branch 'main' of g.yxqyang.asia-dominictb:dominictb/epsf-app into f…

086c230

…eat/54810-4

dominictb marked this pull request as ready for review May 13, 2025 04:26

dominictb requested a review from a team as a code owner May 13, 2025 04:26

melvin-bot bot requested review from MariaHCD and removed request for a team May 13, 2025 04:27

MariaHCD requested changes May 13, 2025

View reviewed changes

feedbacks

3d2b44f

MariaHCD reviewed May 13, 2025

View reviewed changes

dominictb added 2 commits May 14, 2025 22:04

Merge branch 'main' of g.yxqyang.asia-dominictb:dominictb/epsf-app into f…

5d24614

…eat/54810-4

fix more words

5b07525

mountiny assigned dominictb May 14, 2025

dominictb mentioned this pull request May 15, 2025

[NoQA] Add CSpell for spelling checks [Part 5] #61835

Merged

51 tasks

Merge branch 'main' of g.yxqyang.asia-dominictb:dominictb/epsf-app into f…

577487f

…eat/54810-4

ishpaul777 approved these changes May 15, 2025

View reviewed changes

MariaHCD previously approved these changes May 16, 2025

View reviewed changes

Merge branch 'main' of g.yxqyang.asia-dominictb:dominictb/epsf-app into f…

4529af9

…eat/54810-4

dominictb dismissed MariaHCD’s stale review via 4529af9 May 16, 2025 09:50

MariaHCD approved these changes May 16, 2025

View reviewed changes

mountiny approved these changes May 16, 2025

View reviewed changes

mountiny merged commit cd17156 into Expensify:main May 16, 2025
17 of 18 checks passed

melvin-bot bot added the Emergency label May 16, 2025

mountiny removed the Emergency label May 16, 2025

This was referenced May 16, 2025

Investigate workflow job failing on main: test / test (job 1) #62209

Closed

Deploy Checklist: New Expensify 2025-05-20 #62353

Closed

melvin-bot bot mentioned this pull request May 21, 2025

[Due for payment 2025-05-30] [$250] Investigate spell checking action for App codebase #54810

Open

[NoQA] Add CSpell for spelling checks [Part 4] #61768

[NoQA] Add CSpell for spelling checks [Part 4] #61768

Uh oh!

Conversation

dominictb commented May 9, 2025

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented May 13, 2025

Uh oh!

Uh oh!

Uh oh!

MariaHCD May 13, 2025

Choose a reason for hiding this comment

Uh oh!

dominictb May 13, 2025

Choose a reason for hiding this comment

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

dominictb commented May 13, 2025

Uh oh!

ishpaul777 commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

mountiny commented May 14, 2025

Uh oh!

mountiny commented May 14, 2025

Uh oh!

mountiny commented May 15, 2025

Uh oh!

ishpaul777 commented May 15, 2025

Uh oh!

ishpaul777 commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MariaHCD left a comment

Choose a reason for hiding this comment

Uh oh!

MariaHCD commented May 16, 2025

Uh oh!

mountiny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

melvin-bot bot commented May 16, 2025

Uh oh!

mountiny commented May 16, 2025

Uh oh!

github-actions bot commented May 20, 2025

Uh oh!

github-actions bot commented May 21, 2025

Uh oh!

github-actions bot commented May 21, 2025

Uh oh!

github-actions bot commented May 21, 2025

Uh oh!

Uh oh!

[NoQA] Add `CSpell` for spelling checks [Part 4] #61768

[NoQA] Add `CSpell` for spelling checks [Part 4] #61768

ishpaul777 commented May 13, 2025 •

edited

Loading

ishpaul777 commented May 15, 2025 •

edited

Loading