Changeset 63600 for trunk/src/js/_enqueues/lib/codemirror/javascript-lint.js

Timestamp:

09/11/2026 10:50:50 AM (13 hours ago)

Author:

afercia

Message:

General: Fix indentation and alignments in JavaScript inline documentation blocks.

Enables the following JSDoc rules:

• jsdoc/check-alignment
• jsdoc/check-indentation
• jsdoc/check-line-alignment
• jsdoc/require-hyphen-before-param-description -> never

Fixes all the reported violations. Also removes hyphens before descriptions.

Part of the effort to improve JS inline documentation for 7.2.

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

Props afercia, mukesh27.
See #66033.

File:

• trunk/src/js/_enqueues/lib/codemirror/javascript-lint.js (modified) (3 diffs)

trunk/src/js/_enqueues/lib/codemirror/javascript-lint.js

@@ -13 +13 @@
  *
  * @typedef {Object} CodeMirrorLintError
- * @property {string} message Error message.
- * @property {'error'} severity Severity.
- * @property {CodeMirror.Position} from From position.
- * @property {CodeMirror.Position} to To position.
+ * @property {string}              message  Error message.
+ * @property {'error'}             severity Severity.
+ * @property {CodeMirror.Position} from     From position.
+ * @property {CodeMirror.Position} to       To position.
  */
 
@@ -26 +26 @@
  *
  * @typedef {Object} SupportedJSHintOptions
- * @property {import('espree').Options['ecmaVersion']} [esversion] "This option is used to specify the ECMAScript version to which the code must adhere."
- * @property {boolean} [es5] "This option enables syntax first defined in the ECMAScript 5.1 specification. This includes allowing reserved keywords as object properties."
- * @property {boolean} [es3] "This option tells JSHint that your code needs to adhere to ECMAScript 3 specification. Use this option if you need your program to be executable in older browsers—such as Internet Explorer 6/7/8/9—and other legacy JavaScript environments."
- * @property {boolean} [module] "This option informs JSHint that the input code describes an ECMAScript 6 module. All module code is interpreted as strict mode code."
- * @property {'implied'} [strict] "This option requires the code to run in ECMAScript 5's strict mode."
- * @property {string} [espreeModuleUrl] The URL to the espree script module.
+ * @property {import('espree').Options['ecmaVersion']} [esversion]       "This option is used to specify the ECMAScript version to which the code must adhere."
+ * @property {boolean}                                 [es5]             "This option enables syntax first defined in the ECMAScript 5.1 specification. This includes allowing reserved keywords as object properties."
+ * @property {boolean}                                 [es3]             "This option tells JSHint that your code needs to adhere to ECMAScript 3 specification. Use this option if you need your program to be executable in older browsers—such as Internet Explorer 6/7/8/9—and other legacy JavaScript environments."
+ * @property {boolean}                                 [module]          "This option informs JSHint that the input code describes an ECMAScript 6 module. All module code is interpreted as strict mode code."
+ * @property {'implied'}                               [strict]          "This option requires the code to run in ECMAScript 5's strict mode."
+ * @property {string}                                  [espreeModuleUrl] The URL to the espree script module.
  */
 
@@ -39 +39 @@
  * @since 7.0.0
  *
- * @param {string} text Source.
+ * @param {string}                 text    Source.
  * @param {SupportedJSHintOptions} options Linting options.
  * @return {Promise<CodeMirrorLintError[]>} Linting errors.