Skip to content

TypeScript: migrate is-shallow-equal package to TS #70407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Conversation

kushagra-goyal-14
Copy link
Contributor

What?

Part of #67691

Migrating the is-shallow-equal package to Typescript.

Why?

To enhance DX and add type safety

How?

By porting the code to TypeScript

Testing Instructions

Typecheck and unit tests.

Copy link

github-actions bot commented Jun 13, 2025

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: kushagra-goyal-14 <kush123@git.wordpress.org>
Co-authored-by: manzoorwanijk <manzoorwanijk@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Jun 13, 2025
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @kushagra-goyal-14! In case you missed it, we'd love to have you join us in our Slack community.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@t-hamano t-hamano added [Type] Code Quality Issues or PRs that relate to code quality [Package] is-shallow-equal /packages/is-shallow-equal labels Jun 14, 2025
Copy link
Member

@manzoorwanijk manzoorwanijk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. Thank you for your contribution.

Let us remove the types for params and return type inside JSDoc blocks.

- * @param {unknown[]} a First array to compare.
+ * @param a First array to compare.

@kushagra-goyal-14
Copy link
Contributor Author

Updated the JS doc comments

Copy link
Member

@manzoorwanijk manzoorwanijk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for making the changes. A good first contribution

@manzoorwanijk manzoorwanijk enabled auto-merge (squash) June 17, 2025 10:53
@kushagra-goyal-14
Copy link
Contributor Author

Thank you

@manzoorwanijk manzoorwanijk merged commit 08921f0 into WordPress:trunk Jun 18, 2025
59 checks passed
@github-actions github-actions bot added this to the Gutenberg 21.1 milestone Jun 18, 2025
@t-hamano t-hamano mentioned this pull request Jun 24, 2025
27 tasks
chriszarate pushed a commit to chriszarate/gutenberg that referenced this pull request Jul 1, 2025
…ss#70407)

* refactor: migrate is-shallow-equal package from js to ts for type safety

* docs: remove jsDoc types as used ts
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Package] is-shallow-equal /packages/is-shallow-equal [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants