refactor: rename situations module to situations-and-notices#752
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
gorandalum
left a comment
There was a problem hiding this comment.
The changes look good, and I am for a renaming as the module doesn't just handle situations. But I am a little unsure about using the term "notifications" as it is already used for mobile notifications. What about just naming the module "situations-and-notices"?
Yes, I think the same. The reason I landed on |
|
I agree with @gorandalum here! I think push notifications when I read that word, but "situations-and-notices" works 👍 |
60ea633 to
ba63c64
Compare
ba63c64 to
34ea6db
Compare
Why
modules/situationsisn't situation-specific. It handles both situations andnotices — the two kinds of user-facing journey notifications — via
SituationOrNoticeIcon,getMsgTypeForMostCriticalSituationOrNotice,filterNotices, etc., and is consumed across assistant and departures whereverthese are shown. The name reflected only one of its two data types.
Per the review discussion, the module is named
situations-and-notices(rather thannotifications, which collides with mobile push-notification terminology).What
Pure rename, zero behavioral change:
git mv src/modules/situations→src/modules/situations-and-notices(internalfile/component names kept — they accurately describe specific renderers/helpers).
@atb/modules/situationsto@atb/modules/situations-and-notices.Extracted from the travel-card PR (#751) so the rename can be reviewed in isolation.