feat: Add type safety for timeZone parameter #359
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@A7med3bdulBaset is attempting to deploy a commit to the next-intl Team on Vercel. A member of the Team first needs to authorize it. |
| | "UTC" | ||
| | "W-SU" | ||
| | "WET" | ||
| | "Zulu"; |
There was a problem hiding this comment.
I'm wondering if we should allow unknown strings here too (see this trick).
The benefit of allowing unknown strings is that we don't have to publish a new version in case our list gets outdated. This might even be critical for users on outdated versions, if we've released breaking changes in the meantime, otherwise we'd have to backport changed time zones. AFAIK React does this too, e.g. for ARIA roles.
The downside is of course that we don't fail for invalid time zones.
However, JavaScript runtimes throw an error for unknown time zones:
(I've supplied "Unknown" in this example)
Therefore, I'd say we should support unknown strings.
| import useIntlContext from './useIntlContext'; | ||
|
|
||
| export default function useTimeZone() { | ||
| export default function useTimeZone(): TimeZone { |
There was a problem hiding this comment.
The return type is wrong, also undefined is allowed. Better just let TypeScript infer the return type and don't annotate it additionally!
TODOs:
|
Since You are using spaces for indentation not tabs, and no space inside curly braces, I think this is the best way to go. In general, It's OPEN-SOURCE, so We have to have a consistent config file
🔴 Move out of utils 🔴 Use default export/import 🔴 Rename file to be singular 🔴 Allow unknown strings
- Change import to default - fix linting errors
- Change import to default - Edit import path to exclude `utils` - fix linting errors
- Change import to default - Edit import path to exclude `utils` - fix linting errors
- Change import to default - Edit import path to exclude `utils` - fix linting errors
|
All Done and Ready for Review I ran locally pnpm build && pnpm lint && pnpm testand all tests passed. |
|
Looks great, will be released in a minute! Are you interested in adopting this in the RSC support branch as well (e.g. |
WIP |
|
It seems like Eslint doesn't have configurations for I still propose to include config files for formatting, linting, and settings. In the final It's OPEN-source. Also, in the |
This PR introduces type safety for the
timeZoneparameter instead of usingstringas the type. It enhances the developer experience by ensuring that only valid time zone values are accepted and providing better code completion and type-checking support.Changes Made:
TimeZonetype that is a union of all valid time zone values in/use-intl/src/core/utils/TimeZones.tsxtimeZoneparameter in these files:IntlConfigDateTimeFormatOptionscreateFormatterconvertFormatsToIntlMessageFormatsData Source:
Time zone values sourced from tz database.