[NoQA] Use periods at the end of error messages with ESLint check #39988

ShridharGoel · 2024-04-10T06:42:49Z

Details

Use periods at the end of error messages with ESLint check.

Fixed Issues

$ #38989
PROPOSAL: #38989 (comment)

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

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

melvin-bot · 2024-04-10T06:42:54Z

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

getusha · 2024-04-10T14:09:31Z

src/languages/en.ts

        currentPassword: 'Current password',
        newPassword: 'New password',
        newPasswordPrompt: 'New password must be different than your old password, have at least 8 characters, 1 capital letter, 1 lowercase letter, and 1 number.',
-        errors: {


I don't think this is a good idea, lets modify the eslint rule instead of doing this.

These were unused, so isn't it a good idea to delete them?

These were unused, so isn't it a good idea to delete them?

Didn't notice they were unused, thought you moved them 👍

ShridharGoel · 2024-04-10T18:50:44Z

src/languages/en.ts

            customTaxName: 'Custom tax name',
            value: 'Value',
-            errors: {
+            error: {


Only a few places used the plural form, so changed them to singular one for consistency.

ShridharGoel · 2024-04-11T16:27:50Z

@grgia Can you start the lint check again? It shows unrelated lint fixes.

ShridharGoel · 2024-04-12T18:12:01Z

@getusha Can you have a look when possible?

getusha · 2024-04-15T09:05:33Z

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

getusha · 2024-04-15T10:00:46Z

@grgia Can you start the lint check again? It shows unrelated lint fixes.

I tried it locally and it's failing

…fyApp into eslint_dots

getusha · 2024-04-15T11:19:29Z

package.json

    "eslint": "^7.6.0",
    "eslint-config-airbnb-typescript": "^17.1.0",
-    "eslint-config-expensify": "^2.0.44",
+    "eslint-config-expensify": "^2.0.45",


Suggested change

"eslint-config-expensify": "^2.0.45",

"eslint-config-expensify": "^2.0.46",

i think this should be 2.0.46 based on Expensify/eslint-config-expensify#88 (comment)

grgia · 2024-04-15T16:10:02Z

Runing lint

ShridharGoel · 2024-04-15T18:09:25Z

@getusha Checks are passing now, had to switch off check for this: #39942

getusha · 2024-04-15T18:11:25Z

@getusha Checks are passing now, had to switch off check for this: #39942

@ShridharGoel do we know the reason why it was failing in the first place?

ShridharGoel · 2024-04-15T18:46:39Z

@getusha Because Expensify/eslint-config-expensify#89 got deployed in 2.0.45 but E/App changes seem to be pending.

getusha · 2024-04-15T19:12:10Z

@ShridharGoel lets also add . to error messages that are not placed inside the error key like:

App/src/languages/en.ts

Line 340 in 74a6195

    
           errorWhileSelectingCorruptedImage: 'An error occurred while selecting a corrupted attachment, please try another file',

getusha

Looks good thanks!

grgia · 2024-04-29T11:46:20Z

Apologies for the delay, could you merge main @ShridharGoel and I'll merge this :)

grgia

LGTM, thank you!

OSBotify · 2024-05-01T03:01:22Z

🚀 Deployed to staging by https://github.com/grgia in version: 1.4.69-0 🚀

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

OSBotify · 2024-05-02T13:04:57Z

🚀 Deployed to production by https://github.com/Beamanator in version: 1.4.69-2 🚀

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

Use periods at the end of error messages

53e97e3

ShridharGoel requested a review from a team as a code owner April 10, 2024 06:42

melvin-bot bot requested review from getusha and removed request for a team April 10, 2024 06:42

ShridharGoel added 6 commits April 10, 2024 12:15

Use periods at the end of error messages

4a3822e

Update package-lock.json

f76a57d

Update package.json

b11176e

Update to use 2.0.45

fa80eac

Update en.ts

981c453

Update es.ts

36d3036

getusha reviewed Apr 10, 2024

View reviewed changes

ShridharGoel commented Apr 10, 2024

View reviewed changes

ShridharGoel added 2 commits April 15, 2024 15:38

Merge branch 'main' of https://github.com/Expensify/App into eslint_dots

37b608b

Merge branch 'eslint_dots' of https://github.com/ShridharGoel/Expensi…

ced7a43

…fyApp into eslint_dots

getusha reviewed Apr 15, 2024

View reviewed changes

Update

9b2fa94

ShridharGoel added 4 commits April 19, 2024 16:27

Update en.ts

4a8ff63

Update es.ts

36549a8

Merge

5df30ad

Enable

eac61ee

ShridharGoel force-pushed the eslint_dots branch 2 times, most recently from 006d035 to c838ec0 Compare April 19, 2024 19:23

ShridharGoel requested a review from getusha April 19, 2024 19:24

Update

2373860

ShridharGoel force-pushed the eslint_dots branch from c838ec0 to 2373860 Compare April 19, 2024 19:57

getusha approved these changes Apr 21, 2024

View reviewed changes

melvin-bot bot requested a review from grgia April 21, 2024 20:12

grgia previously approved these changes Apr 29, 2024

View reviewed changes

Merge branch 'main' into eslint_dots

83ba368

ShridharGoel dismissed grgia’s stale review via 83ba368 April 29, 2024 15:20

ShridharGoel added 3 commits April 30, 2024 13:00

Update en.ts

8133745

Update en.ts

d4de57d

Fix lint

748a529

grgia approved these changes Apr 30, 2024

View reviewed changes

grgia merged commit e1e77ba into Expensify:main Apr 30, 2024

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

Deploy Checklist: New Expensify 2024-05-01 #41376

Closed

59 tasks

melvin-bot bot mentioned this pull request May 2, 2024

[HOLD for payment 2024-05-09] [$250] Standardize Error Periods #38989

Closed

	"eslint-config-expensify": "^2.0.45",
	"eslint-config-expensify": "^2.0.46",

[NoQA] Use periods at the end of error messages with ESLint check #39988

[NoQA] Use periods at the end of error messages with ESLint check #39988

Uh oh!

Conversation

ShridharGoel commented Apr 10, 2024

Details

Fixed Issues

PR Author Checklist

Screenshots/Videos

Uh oh!

melvin-bot bot commented Apr 10, 2024

Uh oh!

getusha Apr 10, 2024

Choose a reason for hiding this comment

Uh oh!

ShridharGoel Apr 10, 2024

Choose a reason for hiding this comment

Uh oh!

getusha Apr 10, 2024

Choose a reason for hiding this comment

Uh oh!

ShridharGoel Apr 10, 2024

Choose a reason for hiding this comment

Uh oh!

ShridharGoel commented Apr 11, 2024

Uh oh!

ShridharGoel commented Apr 12, 2024

Uh oh!

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

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

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

Uh oh!

Uh oh!

getusha Apr 15, 2024

Choose a reason for hiding this comment

Uh oh!

grgia commented Apr 15, 2024

Uh oh!

ShridharGoel commented Apr 15, 2024

Uh oh!

getusha commented Apr 15, 2024

Uh oh!

ShridharGoel commented Apr 15, 2024

Uh oh!

getusha commented Apr 15, 2024

Uh oh!

getusha left a comment

Choose a reason for hiding this comment

Uh oh!

grgia commented Apr 29, 2024

Uh oh!

grgia left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OSBotify commented May 1, 2024

Uh oh!

OSBotify commented May 2, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

getusha commented Apr 15, 2024 •

edited

Loading

getusha commented Apr 15, 2024 •

edited

Loading

grgia left a comment •

edited

Loading