16 lines
1.1 KiB
Plaintext
16 lines
1.1 KiB
Plaintext
|
{
|
||
|
|
"enabled": true,
|
||
|
|
"name": "JSDoc Route Documentation",
|
||
|
|
"description": "On save of files in backend/routes/, ensures every exported route handler has a JSDoc comment documenting the HTTP method, path, query parameters, request body shape, and response shape. Uses the existing documentation style in the file. Does not add comments to internal helper functions.",
|
||
|
|
"version": "1",
|
||
|
|
"when": {
|
||
|
|
"type": "fileEdited",
|
||
|
|
"patterns": [
|
||
|
|
"backend/routes/*.js"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"then": {
|
||
|
|
"type": "askAgent",
|
||
|
|
"prompt": "Review the saved route file and ensure every exported route handler (e.g., router.get, router.post, router.put, router.patch, router.delete) has a JSDoc comment directly above it documenting: the HTTP method, the route path, any query parameters, the request body shape (if applicable), and the response shape. Match the existing documentation style already used in the file. Do NOT add JSDoc comments to internal helper functions that are not route handlers. Only add missing documentation — do not modify or remove existing JSDoc comments that are already correct."
|
||
|
|
}
|
||
|
|
}
|