🔧 Refactor: Use More Descriptive, Expressive Naming Across Frontend (#133) #143
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
- Rename currNamespace → currentNamespace - Rename nsSub → namespaceSubscription - Rename pollSub → pollingSubscription - Rename svc → inferenceService throughout codebase - Rename svcPrv → inferenceServicePrivate - Rename config → dialogConfig/snackConfig (context-specific) - Rename res → dialogResponse - Rename currLogs → currentLogs Updated 13 files including TypeScript components, HTML templates, and test specs to use more expressive and pronounceable variable names while maintaining all functionality. Signed-off-by: Hijanhv <[email protected]>
Signed-off-by: Hijanhv <[email protected]>
Contributor
|
this looks good and clean, one thing tho, you can expand Config -> Configuration. |
Signed-off-by: Hijanhv <[email protected]>
Author
done ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
📌 Summary
This PR refactors the frontend codebase to replace shortened or abbreviated variable/function names with longer, expressive, and self-documenting names.
The goal is to improve readability, maintainability, and consistency across the project.
No logic or behavioral changes were made.
✨ Changes Included
🔤 Variable & Function Renames
📁 Files Updated (15 Files)
TypeScript
index.component.tsconfig.tsserver-info.component.tsevents.component.tsoverview.component.tsdetails.component.tslogs.component.tsyamls.component.tsbackend.service.tsHTML Templates
server-info.component.htmllogs.component.htmlTests
details.component.spec.tsoverview.component.spec.ts✅ Verification & Safety
✔️ All references updated correctly
✔️ No TypeScript errors
✔️ HTML bindings updated
✔️ Test files updated and passing
✔️ No logic changes
✔️ Backwards-compatible
🧠 Motivation
This PR addresses Issue #133 – Improve Code Readability with More Descriptive Naming by ensuring the codebase uses clear, pronounceable names instead of ambiguous abbreviations.
This empowers future contributors, reduces onboarding friction, and makes the codebase more self-documenting.
📝 Notes
Only naming changes have been made.
No behavioral, architectural, or UI changes are included.