JSDoc Integration

[BenLloydPearson]

Enforce JSDoc Requirements for New Classes

Automation Name: review_new_class_jsdoc

Require JSDoc for all new JavaScript classes.

Conditions (all must be true):

• The PR creates a new JavaScript class.
  • {{ is.javascript and is.new | some }}
• The PR lacks JSDoc content. Use this regex: to detect:
  • \/\*\*([\s\S]*?)\*\/

Automation Actions:

• Request changes, and post a comment explaining that JSDoc is required
  • JSDoc is required for all JavaScript classes. Please add JSDocs to all new classes in this PR.
• Apply a yellow ⚠️ Missing JSDoc label.

Assign JSDoc Reviewer

Automation Name: assign_jsdoc_only

Assign reviewers for PRs that only contain changes to JSDoc.

Conditions (all must be true):

• The PR only affects JavaScript and TypeScript files.
• The PR only contains changes to JSDoc content. Use this regex:
  • \/\*\*([\s\S]*?)\*\/

Automation Actions:

• Assign the ORG/tech-writersteam.
• Apply a green 📓 JSDoc Only label
• Approve the PR

Review JSDoc Input Parameters

Automation Name: review_jsdoc_input

Warn PR authors when they change JavaScript function or constructor input parameters without updating JSDoc content./

Conditions (all must be true):

• The PR changes an input parameter in one or more JavaScript methods. Use the following regex filters to detect this. These should be contained in a custom expression:
  • /(?:function\s*[^(\n]*\(|\([^()]*\)\s*=>|function\s*[^(\n]*\{|[^:\n]*:\s*function\s*\()([^)]*)\)/g
  • constructor\s*\(([^)]*)\)
• The PR lacks changes to ‘@param’ declarations. Use the following regex to detect this:
  • \* @param

Automation Actions:

• Post a comment warning the user to review the method’s JSDoc to identify necessary updates.
  • This PR modifies method input parameters, but is missing JSDoc changes. Please check to ensure no JSDoc changes are necessary.

Note: This example may not trigger for 100% of input parameter changes, so validate the regex used in this example against your organization's requirements.

Review JSDoc for Large Changes

Automation Name: review_jsdoc_large

Require more extensive reviews for large JavaScript changes that lack JSDoc updates.

Conditions (all must be true):

• The PR changes more than 25% of a JavaScript class.
  • Use this example as a starting point.
• The PR lacks JSDoc changes.

Automation Actions:

• Post a comment asking the author to review all relevant JSDoc to identify necessary updates.
  • This PR makes major changes to JavaScript classes, but is missing updates to JSDoc. Please double check for any necessary JSDoc updates.
• Require a review from the ORG/tech-writers team.
• Apply a yellow ⚠️ Missing JSDoc Label

Additional Resources

Here are some additional examples you should incorporate into these automations:

• Colors custom expression - Use for all automations that implement color-coded labels. Only include the colors that are used in the automation.

[BenLloydPearson]

https://docs.gitstream.cm/integrations/jsdoc/