Jsdoc

What it does

When your agent uses it

• Automatically write
• Fix JSDoc comments for JavaScript/TypeScript code

Example prompts

• “/jsdoc”

Workflow steps

7 steps, taken from the first numbered list in SKILL.md.

1. 1Follow JSDoc Specification: Use standard block comment format (/** ... */).
2. 2Document all inputs: Use the @param tag for every parameter.
3. 3Document the output: Use the @returns tag for the return value (unless the function returns void and it's obvious).
4. 4Document errors: If the function explicitly throws an error (e.g., throw new Error(...)), document it using the @throws tag.
5. 5NO Type Tags: The codebase uses TypeScript, so do NOT include types in the JSDoc tags. For example, use @param id The user ID instead of…
6. 6Imperative Verb Form: The description MUST use the imperative verb form. For example, use "Create a user", "Add an item", "Calculate the…
7. 7No Trailing Periods in Tags: Descriptions inside @param, @returns, and @throws tags must NOT end with a period. The main function…

What it can do on your machine

Read from SKILL.md and the folder at commit 7340aa2. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • gh

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use gh, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Jsdoc loads about 839 tokens when it runs. Until then it costs about 62 tokens; SKILL.md has 352 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~62

When it runs · the whole SKILL.md, loaded when a task matches

~839

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from yamcodes/arkenv at commit 7340aa2, republished under its MIT licence (© yamcodes). 352 words, ~839 tokens.

name

jsdoc

description

Use this skill to automatically write or fix JSDoc comments for JavaScript/TypeScript code. It handles requests to document code at any scope: a single function, all functions in a file, or just the new and changed functions in a pull request.

metadata.internal

true

export function calculateDiscountedPrice(basePrice: number, discountPercentage: number, taxRate?: number): number {
    if (basePrice < 0) throw new Error("Price cannot be negative");
    // ...
}

/**
 * Calculate the final price after applying a discount and optional tax.
 * 
 * @param basePrice The original price of the item
 * @param discountPercentage The discount to apply as a percentage (e.g., 20 for 20%)
 * @param taxRate The optional tax rate to apply after discount
 * @returns The final calculated price
 * @throws An error if the base price is negative
 */
export function calculateDiscountedPrice(basePrice: number, discountPercentage: number, taxRate?: number): number {
    if (basePrice < 0) throw new Error("Price cannot be negative");
    // ...
}

© yamcodes, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file in skills/jsdoc of yamcodes/arkenv.

• SKILL.md
• evals/evals.json

Open the folder on GitHubat commit 7340aa2