refactor: rename wn component to match file name #490
Conversation
WalkthroughRenamed the WnStickyHeadsUp widget to WnHeadsUp in core UI and updated references in chat_list_screen. The top “No Relays Connected” banner now uses WnHeadsUp without animation. The bottom overlay was switched to WnHeadsUp and given a fade-in animation. No parameter changes to the widget. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant ChatListScreen
participant WnHeadsUp
participant Animation
User->>ChatListScreen: Open screen / state changes
ChatListScreen->>WnHeadsUp: Show top "No Relays Connected" (no animation)
ChatListScreen->>WnHeadsUp: Show bottom overlay
WnHeadsUp->>Animation: Apply fadeIn()
Animation-->>User: Faded-in bottom overlay visible
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
josefinalliende
force-pushed
the
refactor/rename-wn-component
branch
from
e2782ce to
43be832
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
lib/ui/core/ui/wn_heads_up.dart (1)
7-8: NoWnStickyHeadsUpreferences found; optional deprecated alias availableI ran
rg -nP '\bWnStickyHeadsUp\b' -C3across the repo and found zero occurrences of the old widget name. Renaming
WnStickyHeadsUp→WnHeadsUpwill not break any internal call sites.• File under review: lib/ui/core/ui/wn_heads_up.dart
If this is part of your public API and you want to smooth external upgrades, you can add a one-release deprecated alias at the bottom of that file:
@Deprecated('Use WnHeadsUp instead. Will be removed in a future release.') class WnStickyHeadsUp extends WnHeadsUp { const WnStickyHeadsUp({ super.key, required super.title, required super.subtitle, super.type, super.iconAsset, super.action, }); }Optionally update your CHANGELOG:
### Changed - Renamed `WnStickyHeadsUp` → `WnHeadsUp`; added deprecated alias for one release.[optional_refactors_recommended]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
lib/ui/contact_list/chat_list_screen.dart(1 hunks)lib/ui/core/ui/wn_heads_up.dart(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.dart
📄 CodeRabbit Inference Engine (.cursor/rules/flutter.mdc)
**/*.dart: Always declare the type of each variable and function (parameters and return value). Avoid using 'any'. Create necessary types.
Don't leave blank lines within a function.
One export per file.
Use PascalCase for classes.
Use camelCase for variables, functions, and methods.
Use underscores_case for file and directory names.
Use UPPERCASE for environment variables. Avoid magic numbers and define constants.
Start each function with a verb.
Use verbs for boolean variables. Example: isLoading, hasError, canDelete, etc.
Use complete words instead of abbreviations and correct spelling, except for standard and well-known abbreviations (API, URL, i, j, err, ctx, req, res, next).
Write short functions with a single purpose. Less than 20 instructions.
Name functions with a verb and something else. If it returns a boolean, use isX or hasX, canX, etc. If it doesn't return anything, use executeX or saveX, etc.
Avoid nesting blocks by early checks and returns, or extraction to utility functions.
Use higher-order functions (map, filter, reduce, etc.) to avoid function nesting. Use arrow functions for simple functions (less than 3 instructions). Use named functions for non-simple functions.
Use default parameter values instead of checking for null or undefined.
Reduce function parameters using RO-RO: use an object to pass multiple parameters and to return results. Declare necessary types for input arguments and output.
Use a single level of abstraction in functions.
Don't abuse primitive types and encapsulate data in composite types.
Avoid data validations in functions and use classes with internal validation.
Prefer immutability for data. Use readonly for data that doesn't change. Use 'as const' for literals that don't change.
Declare interfaces to define contracts.
Write small classes with a single purpose. Less than 200 instructions, less than 10 public methods, less than 10 properties.
Use exceptions to handle errors you don't expect. If you catch an exception, it sh...
Files:
lib/ui/core/ui/wn_heads_up.dartlib/ui/contact_list/chat_list_screen.dart
🔇 Additional comments (3)
lib/ui/core/ui/wn_heads_up.dart (1)
7-8: Rename aligns class with file name — LGTMThe class and constructor rename to WnHeadsUp is clear and matches the file name. No functional changes introduced here.
lib/ui/contact_list/chat_list_screen.dart (2)
426-441: Usage update to WnHeadsUp looks correctImport and instantiation align with the renamed widget. Parameters remain unchanged and consistent with the previous usage.
426-441: Confirm: fade-in animation is an intentional scope expansionPR summary states this is a rename-only refactor. The added .animate().fadeIn() introduces a UI behavior change (albeit minor). Please confirm whether this was intended; if not, drop the animation to keep the PR strictly a rename.
If you decide to keep this PR strictly about the rename, apply:
- ).animate().fadeIn(), + ),If it’s intended, consider updating the PR description and CHANGELOG to reflect the behavior change.
|
PS: To test how it looks (which should be the same) just delete all kinds of relay in network screen, go back to chat list and the component should appear (and look the same, nothing else should've changed) |
Description
Just renames
WnStickyHeadsUptoWnHeadsUpto match the name of file (that way it easier to find components and it is more consisten)Type of Change
Checklist
just precommitto ensure that formatting and linting are correctCHANGELOG.mdfile with your changesSummary by CodeRabbit
Style
Refactor