Changeset 63775

Timestamp:

09/21/2026 05:28:42 PM (9 hours ago)

Author:

afercia

Message:

General: Enable the JSDoc rules related to the property tag.

Enables the following JSDoc rules:

• jsdoc/check-property-names
• jsdoc/require-property
• jsdoc/require-property-name
• jsdoc/require-property-description
• jsdoc/require-property-type

Fixes all the related violations.
Part of the effort to improve JS inline documentation for 7.2.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13632

See #66033.

Location:

trunk

Files:

• .eslintrc-jsdoc.js (modified) (2 diffs)
• src/js/_enqueues/lib/emoji-loader.js (modified) (3 diffs)
• src/js/_enqueues/wp/updates.js (modified) (2 diffs)
• src/js/media/controllers/region.js (modified) (1 diff)

trunk/.eslintrc-jsdoc.js

@@ -53 +53 @@
                         } ],
                         'jsdoc/check-param-names': 'error',
+                        'jsdoc/check-property-names': 'error',
                         'jsdoc/check-syntax': 'error',
                         'jsdoc/check-tag-names': [ 'error', {
@@ -74 +75 @@
                         'jsdoc/require-param-name': 'error',
                         'jsdoc/require-param-type': 'error',
+                        'jsdoc/require-property': 'error',
+                        'jsdoc/require-property-name': 'error',
+                        'jsdoc/require-property-description': 'error',
+                        'jsdoc/require-property-type': 'error',
                         'jsdoc/require-returns': 'error',
                         'jsdoc/require-returns-check': 'error',

trunk/src/js/_enqueues/lib/emoji-loader.js

@@ -9 +9 @@
  * @typedef WPEmojiSettings
  * @type {Object}
- * @property {?object} source
- * @property {?string} source.concatemoji
- * @property {?string} source.twemoji
- * @property {?string} source.wpemoji
+ * @property {?object} source             The source object containing emoji-related URLs.
+ * @property {?string} source.concatemoji The URL for the concatenated emoji script.
+ * @property {?string} source.twemoji     The URL for the Twemoji script.
+ * @property {?string} source.wpemoji     The URL for the WP Emoji script.
  */
 
@@ -29 +29 @@
  * @typedef SupportTests
  * @type {Object}
- * @property {?boolean} flag
- * @property {?boolean} emoji
+ * @property {?boolean} flag  Whether the browser supports flag emojis.
+ * @property {?boolean} emoji Whether the browser supports general emojis.
  */
 
@@ -58 +58 @@
  * @typedef SessionSupportTests
  * @type {Object}
- * @property {number}       timestamp
- * @property {SupportTests} supportTests
+ * @property {number}       timestamp    The timestamp when the support tests were last updated.
+ * @property {SupportTests} supportTests The support tests for the browser.
  */
 

trunk/src/js/_enqueues/wp/updates.js

@@ -168 +168 @@
          *
          * @type {Object}
+         * @property {Object}  filesystemCredentials                    Holds all filesystem credentials.
          * @property {Object}  filesystemCredentials.ftp                Holds FTP credentials.
          * @property {string}  filesystemCredentials.ftp.host           FTP host. Default empty string.
@@ -3305 +3306 @@
                                 // Called from `wp-admin/includes/class-wp-upgrader-skins.php`.
                                 case 'decrementUpdateCount':
-                                        /** @property {string} message.upgradeType */
+                                        /**
+                                         * @property {string} message             The message associated with the update.
+                                         * @property {string} message.upgradeType The type of upgrade being performed.
+                                         */
                                         wp.updates.decrementCount( message.upgradeType );
                                         break;

trunk/src/js/media/controllers/region.js

@@ -96 +96 @@
                  * @event wp.media.controller.Region#create
                  * @type {Object}
-                 * @property {Object} view
+                 * @property {Object} view The view object for the region.
                  */
                 this.trigger( 'create', set );