Unused styles translation script #26969

gedu · 2023-09-07T15:14:23Z

Details

Bash scripts that you can run manually and will run on the GH flow to look for unused styles.

It collects all the keys from styles.js and also from styles/utilities/

It goes through the whole codebase, looking for the usage of styles.XXXX or usage of any of the utilities.

What does it look for?

The parent of the object. Example:

   fullscreenCardMediumScreen: {
        left: '-15%',
        top: '-30%',
        width: '145%',
    },

it will look for the usage of styles.fullscreenCardMediumScreen so if fullscreenCardMediumScreen is deleted, it will highlight it, if you just delete the left or any of the inner fields it will not mark the styles as unused.

If a field is being used directly, and not the parent

pv1: {
        paddingVertical: 4,
    },

if that style is being used like styles.pv1.paddingVertical, I will assume that the parent pv1 is being used so it will marked as used.

utilities files, any of the styles like sizing, display, flex, etc, will be looked at twice, one for styles usage, like

styles.pv2
styles.w50

and others for direct usage, like

sizing.w50
positioning.l2

Will use the name of the arrow function field:

Example:

pickerSmall: (backgroundColor = themeColors.highlightBG) => ({
    done: {
            color: themeColors.text,
        },
        doneDepressed: {
            fontSize: defaultPickerStyles.done.fontSize,
        },
        modalViewMiddle: {
            backgroundColor: themeColors.border,
            borderTopWidth: 0,
        },
        modalViewBottom: {
            backgroundColor: themeColors.highlightBG,
        },
        }),

It will ignore the objects inside of pickerSmall and will try to look into the codebase the usage of styles.pickerSmall

To run the script you have to do npm run gh-actions-unused-styles

Also will run as part of the lint GH workflow when a PR is created.

style_bash_script_result.mp4

Fixed Issues

$ #22212
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

Screenshots/Videos

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

…and en/es files

scripts/find-unused-keys.sh

…ent moments, removed unused styles

gedu · 2023-09-14T17:42:31Z

Working on the conflicts, also those conflicts introduced a new way to create styles, so I have to update the script

# Conflicts: # package.json # src/styles/styles.js

gedu · 2023-09-15T16:20:18Z

Almost have the new style format working with the script

…g in style.js file

melvin-bot · 2023-09-19T05:41:30Z

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

luacmartins · 2023-09-20T03:05:39Z

@fedirjh do you think you'll be able to review this today?

.github/scripts/findUnusedKeys.sh

# Conflicts: # src/styles/styles.js

gedu · 2023-09-21T10:17:26Z

@luacmartins Comments fixed and conflicts solved

luacmartins

LGTM!

luacmartins · 2023-09-22T01:15:32Z

Since this doesn't touch any used code, I'll merge it without C+ approval

luacmartins · 2023-09-22T01:16:17Z

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 / Chrome
- iOS / native
- iOS / 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(themeColors.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 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

N/A we're just removing unused code

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

OSBotify · 2023-09-22T01:28:11Z

✋ 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 · 2023-09-22T13:59:38Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.73-0 🚀

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

OSBotify · 2023-09-25T09:34:29Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.73-1 🚀

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

OSBotify · 2023-09-25T10:06:30Z

🚀 Deployed to staging by https://github.com/luacmartins in version: 1.3.74-0 🚀

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

OSBotify · 2023-09-28T18:48:51Z

🚀 Deployed to production by https://github.com/chiragsalian in version: 1.3.74-3 🚀

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

gedu and others added 8 commits August 16, 2023 10:19

adding script to find unused keys

6baddfe

Separated into 2 functions to find and parse the object names styles …

d798ea6

…and en/es files

Going through the codebase and get keys from the files

4ff465f

showing unused style keys

fd39606

removed translation code

d779eec

getting keys from utilities folder to find unused styles

c04114b

Code clean up + improvements to the output

c2ea419

Clean up, used builtins and improved code readability

3042c9a

BeeMargarida reviewed Sep 7, 2023

View reviewed changes

scripts/find-unused-keys.sh Outdated Show resolved Hide resolved

gedu added 2 commits September 7, 2023 18:09

Fixed lint issues

6fa51d0

typo fixed

3424140

luacmartins self-requested a review September 7, 2023 20:49

gedu added 8 commits September 8, 2023 11:59

fixed some lint errors + clean ups

ac8aea2

Merge branch 'main' into edu/22212_unused_styles_translation_script

640ea4b

removed unused variable

ff2174b

moved unused style script into workflow actions

261adb0

added find unused styles into lint.yml workflow

82cf626

fixed some lint issues

d47feee

Merge branch 'main' into edu/22212_unused_styles_translation_script

5bf6fec

Improved script find objects and fields with arrow function on differ…

ebf2e66

…ent moments, removed unused styles

Merge branch 'main' into edu/22212_unused_styles_translation_script

21d380b

# Conflicts: # package.json # src/styles/styles.js

gedu added 4 commits September 18, 2023 13:18

Updated script to handle styles with theme function, and obj spreadin…

6756074

…g in style.js file

fixed some lint issues

54e786c

Merge branch 'main' into edu/22212_unused_styles_translation_script

e1cad0a

removed unused style

24e4db5

gedu marked this pull request as ready for review September 19, 2023 05:41

gedu requested a review from a team as a code owner September 19, 2023 05:41

melvin-bot bot removed the request for review from a team September 19, 2023 05:41

melvin-bot bot requested a review from fedirjh September 19, 2023 05:41

luacmartins requested a review from BeeMargarida September 20, 2023 05:43

luacmartins previously approved these changes Sep 20, 2023

View reviewed changes

.github/scripts/findUnusedKeys.sh Outdated Show resolved Hide resolved

Merge branch 'main' into edu/22212_unused_styles_translation_script

89f3c2b

# Conflicts: # src/styles/styles.js

gedu dismissed luacmartins’s stale review via 89f3c2b September 21, 2023 10:11

luacmartins approved these changes Sep 22, 2023

View reviewed changes

luacmartins assigned gedu Sep 22, 2023

luacmartins merged commit b50dfac into Expensify:main Sep 22, 2023
15 of 17 checks passed

OSBotify mentioned this pull request Sep 22, 2023

Deploy Checklist: New Expensify 2023-09-22 #28013

Closed

96 tasks

This was referenced Sep 25, 2023

Deploy Checklist: New Expensify DUPE 2023-09-25 #28118

Closed

Deploy Checklist: New Expensify 2023-09-25 #28119

Closed

melvin-bot bot mentioned this pull request Sep 25, 2023

[HOLD for payment 2023-10-02] [$1000] Create a lint rule for unused styles and translation keys #22212

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unused styles translation script #26969

Unused styles translation script #26969

gedu commented Sep 7, 2023 •

edited

Loading

gedu commented Sep 14, 2023

gedu commented Sep 15, 2023

melvin-bot bot commented Sep 19, 2023

luacmartins commented Sep 20, 2023 •

edited

Loading

gedu commented Sep 21, 2023

luacmartins left a comment

luacmartins commented Sep 22, 2023

luacmartins commented Sep 22, 2023 •

edited

Loading

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

Unused styles translation script #26969

Unused styles translation script #26969

Conversation

gedu commented Sep 7, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

gedu commented Sep 14, 2023

gedu commented Sep 15, 2023

melvin-bot bot commented Sep 19, 2023

luacmartins commented Sep 20, 2023 • edited Loading

gedu commented Sep 21, 2023

luacmartins left a comment

Choose a reason for hiding this comment

luacmartins commented Sep 22, 2023

luacmartins commented Sep 22, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

OSBotify commented Sep 22, 2023

OSBotify commented Sep 22, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 25, 2023

OSBotify commented Sep 28, 2023

gedu commented Sep 7, 2023 •

edited

Loading

luacmartins commented Sep 20, 2023 •

edited

Loading

luacmartins commented Sep 22, 2023 •

edited

Loading