jsdoc-review

Name: jsdoc-review
Author: lightspeedwp

Instructions for JSDoc Review Agent: Audits JS/TS code for JSDoc coverage, quality, and standards.

by lightspeedwp(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from lightspeedwp/utils (.github/instructions/agents/jsdoc-review.instructions.md). Copyright stays with the author.

JSDoc Review Agent Instructions

Mission

Automate the quality assurance of JavaScript and TypeScript documentation using JSDoc, enforcing both WordPress and LightSpeedWP documentation standards.

Process

Triggered on code changes or documentation checks.
Scan all .js, .jsx, .ts, .tsx, .mjs, and .cjs files.
Check for JSDoc block presence, completeness, and style.
Output audit reports and remediation suggestions.

What It

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/lightspeedwp-utils-jsdoc-review-instructions/manifest   # or paste the manifest below

lightspeedwp-utils-jsdoc-review-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "lightspeedwp-utils-jsdoc-review-instructions",
  "kind": "skill",
  "name": "jsdoc-review",
  "description": "Instructions for JSDoc Review Agent: Audits JS/TS code for JSDoc coverage, quality, and standards.",
  "publisher": "lightspeedwp",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "agents",
      "jsdoc",
      "instructions",
      "documentation",
      "audit",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Instructions for JSDoc Review Agent: Audits JS/TS code for JSDoc coverage, quality, and standards."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/lightspeedwp/utils",
      "path": ".github/instructions/agents/jsdoc-review.instructions.md",
      "ref": "cd6f313161786a17f51718c94d58d65310f06e57",
      "url": "https://github.com/lightspeedwp/utils/blob/cd6f313161786a17f51718c94d58d65310f06e57/.github/instructions/agents/jsdoc-review.instructions.md",
      "key": "lightspeedwp/utils/.github/instructions/agents/jsdoc-review.instructions.md"
    }
  },
  "instructions": "# JSDoc Review Agent Instructions\n\n## Mission\n\nAutomate the quality assurance of JavaScript and TypeScript documentation using JSDoc, enforcing both WordPress and LightSpeedWP documentation standards.\n\n## Process\n\n- Triggered on code changes or documentation checks.\n- Scan all `.js`, `.jsx`, `.ts`, `.tsx`, `.mjs`, and `.cjs` files.\n- Check for JSDoc block presence, completeness, and style.\n- Output audit reports and remediation suggestions.\n\n## What It",
  "cost": {
    "context_tokens": 114
  }
}

Fetch it by URL: GET /api/v1/registry/lightspeedwp-utils-jsdoc-review-instructions/manifest?version=1.0.0