-
Notifications
You must be signed in to change notification settings - Fork 2k
Capitalize jsdoc array and object types #72348
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
|
This PR modifies the release build for editing-toolkit To test your changes on WordPress.com, run To deploy your changes after merging, see the documentation: PCYsg-mMA-p2 |
WunderBart
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fastest ~3k lines review ever 🚢 😎
tyxla
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚢 Thank you!
I almost missed this as I was reviewing #72308 first.
I appreciate it that we maintain consistency with Gutenberg's codebase.
🚀
8b21ce0 to
8af0c6e
Compare
|
This PR modifies the release build for happy-blocks To test your changes on WordPress.com, run To deploy your changes after merging, see the documentation: PCYsg-r7r-p2 |
|
This PR modifies the release build for wpcom-block-editor To test your changes on WordPress.com, run To deploy your changes after merging, see the documentation: PCYsg-l4k-p2 |
8af0c6e to
d6c8a5a
Compare
|
This PR does not affect the size of JS and CSS bundles shipped to the user's browser. Generated by performance advisor bot at iscalypsofastyet.com. |
0fd1feb to
7b48568
Compare
7b48568 to
60f70ce
Compare
|
I had to ignore a couple of existing problems in order to get everything passing. But I added |
|
I'll look into why translate is timing out next :) |
60f70ce to
c4e9452
Compare
I think it's just because the number of files changing is very large. The script loops through every changed file, and then every changed line. But I'll keep an eye on it after merging |
Fix other eslint issues in impacted files Update eslint-plugin-jsdoc again Set unify paraent child type checks to true
c4e9452 to
84a1da4
Compare
84a1da4 to
6ec03cf
Compare
Proposed Changes
Split from #72308, this PR would enforce capitalized types for
Objectin jsdoc. E.g.:Note that
Arrayis capitalized by default.Why? This is what WordPress coding style uses, because it's what the JSdoc standard uses. Thankfully, with a minimal rule change, this is completely autofixable. And if you accidentally write a lower-case variant, it should be auto-fixed in the editor if you lint on save :)
The counterpoint to this is the documentation here: https://github.com/gajus/eslint-plugin-jsdoc/tree/v39.0.0#why-not-capital-case-everything.
Testing Instructions
Verify code and rule changes make sense.