Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Convert warning package to TS #62557

Merged
merged 9 commits into from
Jun 14, 2024
Merged

Convert warning package to TS #62557

merged 9 commits into from
Jun 14, 2024

Conversation

up1512001
Copy link
Member

@up1512001 up1512001 commented Jun 13, 2024 •
edited by sirreal
Loading

What?

This PR converts the warning package to TypeScript.

Why?

Ensures package is fully type checked.

How?

  • converted files to .ts
  • added explicit return types for functions in index and utils files.

Testing Instructions

  • npm run test:unit -- packages/warning tests pass
  • npm run build:package-types returns a zero exit code

reference of this PR

Closes #61522

up1512001 and others added 4 commits June 14, 2024 01:07
@up1512001
chore: converted warnings index to ts
39329dc
@up1512001
chore: converted warning utils to ts
f91734a
@up1512001
chore: converted tests to ts
b94fb4b 
Co-authored-by: jpstevens <jpstevens@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org>
@up1512001 @youknowriad
@sirreal @jsnajdr
Co Author commit to give creadits
796449d 
Co-authored-by: jpstevens <jpstevens@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org>
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 13, 2024 •
edited
Loading

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: up1512001 <up1512001@git.wordpress.org>
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>

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

sirreal
sirreal requested changes Jun 14, 2024
View reviewed changes
Copy link
Member

@sirreal sirreal left a comment

Choose a reason for hiding this comment

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

Thanks for picking up this work. I've left some feedback, let's try to keep these changes as minimal as possible and ensure we're not changing any implementation when adding types unless it's justified.

packages/warning/src/index.ts Outdated
Comment on lines 7 to 12
return (
// eslint-disable-next-line @wordpress/wp-global-usage
typeof globalThis.SCRIPT_DEBUG !== 'undefined' &&
// eslint-disable-next-line @wordpress/wp-global-usage
globalThis.SCRIPT_DEBUG === true
);
Copy link
Member

Choose a reason for hiding this comment

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

The implementation should not change here.

packages/warning/src/test/index.ts Outdated
@@ -4,9 +4,7 @@
import warning from '..';
import { logged } from '../utils';

// eslint-disable-next-line eslint-comments/disable-enable-pair
Copy link
Member

Choose a reason for hiding this comment

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

This file doesn't seem to require any changes, can we revert them?

Copy link
Member Author

Choose a reason for hiding this comment

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

@sirreal change the isDev implementation back to original and revert the test file. Please review it now.

@up1512001 up1512001 requested a review from sirreal June 14, 2024 10:03
@sirreal sirreal added [Type] Code Quality Issues or PRs that relate to code quality [Package] Warning /packages/warning labels Jun 14, 2024
@sirreal
Copy link
Member

sirreal commented Jun 14, 2024 •
edited
Loading

This looks good, will you add a changelog entry please? Then I think we can merge.

#62569 has an example we can follow for this package.

@up1512001
Copy link
Member Author

@sirreal added a changelog entry.

sirreal
sirreal approved these changes Jun 14, 2024
View reviewed changes
Copy link
Member

@sirreal sirreal left a comment

Choose a reason for hiding this comment

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

Thanks!

@sirreal sirreal enabled auto-merge (squash) June 14, 2024 13:58
@sirreal sirreal merged commit fe61e1d into WordPress:trunk Jun 14, 2024
61 checks passed
@github-actions github-actions bot added this to the Gutenberg 18.6 milestone Jun 14, 2024
patil-vipul pushed a commit to patil-vipul/gutenberg that referenced this pull request Jun 17, 2024
@up1512001 @youknowriad
@sirreal @jsnajdr @patil-vipul
Warning: Convert package to TypeScript (WordPress#62557)
273c10b 
Co-authored-by: jpstevens <jpstevens@git.wordpress.org>
Co-authored-by: youknowriad <youknowriad@git.wordpress.org>
Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
Co-authored-by: jsnajdr <jsnajdr@git.wordpress.org>
Co-authored-by: up1512001 <up1512001@git.wordpress.org>
@fabiankaegy fabiankaegy mentioned this pull request Oct 1, 2024
Closed
97 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sirreal sirreal sirreal approved these changes

Assignees
No one assigned
Labels
[Package] Warning /packages/warning [Type] Code Quality Issues or PRs that relate to code quality
Projects
None yet
Milestone
Gutenberg 18.6
Development

Successfully merging this pull request may close these issues.
2 participants
@up1512001 @sirreal