TypeScript: Convert notices package to TypeScript #67670
+342
−202
Conversation
This file contains 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
manzoorwanijk
added
[Type] Code Quality
manzoorwanijk
requested review from
ajitbohra,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
|
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: +1 B (0%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
7 tasks
justlevine
reviewed
Dec 6, 2024
justlevine
reviewed
Dec 6, 2024
| export function removeNotice( id, context = DEFAULT_CONTEXT ) { | ||
| export function removeNotice( | ||
| id: string, | ||
| context = DEFAULT_CONTEXT |
There was a problem hiding this comment.
Not sure if there's a WPCS recommendation somewhere, but personally I'd provide an explicit type definition here (and elsewhere) instead of inferring types from a constant (let alone an imported one).
- It's more self-documenting.
- Makes it easier to guard internally against an unintentional backcompat type break somewhere else in the codebase, or in a similar vein spot discrepancies between the doc-block and the actual method.
- (Also, anecdotally so this could be a skills issue on my part, but type inference can sometimes be flaky in IDEs)
justlevine
reviewed
Dec 6, 2024
|
Flaky tests detected in 55701ba. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12515947683
|
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 #67565, which got closed after I deleted my fork 🤦
What?
Convert the
noticespackage to TypeScriptWhy?
To improve the DX
How?
By renaming the files and adding types
Testing Instructions
Testing Instructions for Keyboard
Screenshots or screencast