jsdoc-comments Cursor ruleA
jsdoc-comments from thedaviddias/llms-txt-hub is a Cursor rule: instructions the Cursor agent follows in that repo.
mdr add thedaviddias/llms-txt-hub/.cursor/rules/jsdoc-comments.mdc@git:20250224.001a864Pins git:20250224.001a864 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 14 of 14 checks passed
- Kind
- Cursor rule
- Repository
- thedaviddias/llms-txt-hub
- Path
.cursor/rules/jsdoc-comments.mdc- Versions recorded
- 1
- Latest version
- git:20250224.001a864, committed Feb 24, 2025
- Size
- 1,822 bytes
- Repository stars
- 914
- License
- a license file GitHub does not identify
add jsdoc comments to components and methods.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# JSDoc Documentation Standards
<rule>
name: component_documentation
description: Standards for documenting React components and methods
filters:
- type: file_extension
pattern: "\\.(ts|tsx)$"
- type: content
pattern: "(function|const).*=.*\\(.*\\).*=>"
actions:
- type: suggest
message: |
When documenting components and methods:
1. **Component Documentation**
```typescript
/**
* A brief description of the component's purpose
*
* @param props - Component props
* @param props.prop1 - Description of prop1
* @param props.prop2 - Description of prop2
* @returns - React component
*
* @example
* ```tsx
* <MyComponent prop1="value" prop2={42} />
* ```
*/
```
2. **Utility Function Documentation**
```typescript
/**
* Brief description of the function's purpose
*
* @param param1 - Description of param1
* @param param2 - Description of param2
*
* @returns Description of return value
*
…Read the whole file at its exact version.
How to install
mdr add thedaviddias/llms-txt-hub/.cursor/rules/jsdoc-comments.mdc@sha256:179c400b4ca5c987The line at the top of this page pins the label git:20250224.001a864, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_neep5ihknuumxttd)
5 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Feb 24, 2025.
Audit of the latest version
- pass: Size between 200 bytes and 200 KB (1822 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
thedaviddias/llms-txt-hub · 914 stars · license a license file GitHub does not identify · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_neep5ihknuumxttd GET https://markdownregistry.com/api/v1/resolve?ref=thedaviddias/llms-txt-hub/.cursor/rules/jsdoc-comments.mdc GET https://markdownregistry.com/api/v1/blob/179c400b4ca5c98743e72d5ea577b28e1a959b0b73f5e36b17cbf6ae6ebfc87f
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: Cursor rules vs AGENTS.md · which agent file does what.