Refactor it i18n - #191
Open
ashleyl11 wants to merge 3 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
P1B: Starter Task: Refactoring PR
Use this pull request template to briefly answer the questions below in one to two sentences each.
Feel free to delete this text at the top after filling out the template.
1. Issue
Link to the associated GitHub issue: #49
Full path to the refactored file: packages/ui/src/i18n/it.ts
What do you think this file does?
(Your answer does not have to be 100% correct; give a reasonable, evidence‑based guess.)
This file holds translations of all text content on the UI in italian.
What is the scope of your refactoring within that file?
(Name specific functions/blocks/regions touched.)
Changing a bit of the formatting within the text so that qlty does not flag it as similar format to the other language files.
Which Qlty‑reported issue did you address?
(Name the rule/metric and include the BEFORE value; e.g., “Cognitive Complexity 18 in render()”.)
Found 203 lines of similar code in 5 locations (mass = 994)
2. Refactoring
How did the specific issue you chose impact the codebase’s maintainability?
There was a large chunk (~200 lines) of repeated code that was hard to read. Each line was a key that represented which text on the UI was being translated, and the value was the translated version in Italian.
What changes did you make to resolve the issue?
I grouped off a small section of some of the text that was translated in the it.ts file so that it is a bit more readable.
How do your changes improve maintainability? Did you consider alternatives?
My change helps make the file a bit more readable. Since the main problem was repeated code, I did consider making a new format, where each file does not have to repeat the key list, but I did not think it was appropriate for this task given the time constraints and the number of language files that would need to be changed.
3. Validation
How did you validate that the change is correct?
I found an existing test at ./packages/app/src/i18n/parity.test.ts that tested that all non-English locales (Italian in this case) had every English key and required plural variants. Since I changed it.ts, I ran this test to make sure that all translations were still matched properly.
Attach a screenshot of the test coverage showing the lines were executed by the tests.
Attach a screenshot showing the tests that cover the change passing during CI
Attach a screenshot of
qlty smells --no-snippets <full/path/to/file.ts>showing fewer reported issues after the changes.