Convert date package to TypeScript #67665
Merged
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
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: 0 B Total Size: 1.92 MB ℹ️ View Unchanged
|
|
Flaky tests detected in dbefff5. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/17251058880
|
There was a problem hiding this comment.
Pull Request Overview
This PR converts the date package from JavaScript to TypeScript, introducing explicit type definitions and updating function signatures and documentation accordingly.
- Adds a
types.tsfile with TS type definitions for date settings and localization. - Converts
index.tsto TypeScript by adding type annotations, removing legacy JSDoc typedefs, and updating function signatures. - Updates
README.mdandCHANGELOG.mdto reflect the new TypeScript types and APIs.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/date/src/types.ts | New TypeScript type definitions for all date configs and settings. |
| packages/date/src/index.ts | Migrated core logic to TS, added type annotations on imports, functions, and variables. |
| packages/date/README.md | Updated parameter and return type docs for TS signatures. |
| packages/date/CHANGELOG.md | Added changelog entry for improved TypeScript definitions. |
Comments suppressed due to low confidence (4)
packages/date/src/index.ts:612
- Using a truthiness check means a zero offset (0) will be treated as falsy and skip this branch. Consider checking for undefined or null explicitly (e.g.,
if ( timezone != null && isUTCOffset( timezone ) )) to handle 0 correctly.
if ( timezone && isUTCOffset( timezone ) ) {
packages/date/src/types.ts:64
- [nitpick] The property name
stringis confusing and collides with a primitive type name. Consider renaming it to something more descriptive likezoneNameorname.
string: string;
packages/date/README.md:125
- The
_to_parameter is optional in the implementation (to?: ...), but the docs don't indicate it's optional. Mark it as_to_?or note that it can be omitted to match the function signature.
_to_ `Moment | Date | string | number`: To date, formatted in the WP timezone.
packages/date/src/index.ts:399
- [nitpick] The JSDoc
@paramtags omit a hyphen between the parameter name and description. For consistency and readability, consider using@param dateFormat - PHP-style formatting string.or removing redundant JSDoc since TypeScript already enforces the type.
* @param dateFormat PHP-style formatting string.
dmsnell
approved these changes
Aug 26, 2025
Member
dmsnell
left a comment
There was a problem hiding this comment.
Thanks for your persistence on all these types.
Like with #67667 I see no obvious issue with this. Before merging I ask that we make sure it’s updated and tests pass, also that if you are willing, to add additional explanatory comments in the TS docblock comments for the settings/DateSettings type so that when someone hovers over it, they have some clue what to expect.
For example, months could be any number of things, but seeing ["January", "February", ...] gives a clear expectation that regardless of the translation, we have the full month names.
Member
Author
|
Yes, thank you for the review. I have already added explanatory examples to those. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Supercedes #67573, which got closed after I deleted my fork 🤦
What?
Why?
How?
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast