Writes compliant JSDoc for Effect public APIs to pass jsdocs oxlint rule.
npx skills add https://github.com/MapleTechLabs/maple --skill jsdocs
Please help me install this Agent Skill. Skill: jsdocs Source: https://github.com/MapleTechLabs/maple/tree/main/.context/effect/.agents/skills/jsdocs Command: npx skills add https://github.com/MapleTechLabs/maple --skill jsdocs
Writing JSDoc for Effect public APIs that complies with the jsdocs oxlint rule is time-consuming and error-prone due to strict structural, prose, and tag requirements. This Skill eliminates the guesswork by providing clear, actionable guidance to produce consistent, lint-passing API documentation.
Use the jsdocs skill to update the JSDoc for the public Effect API in src/Effect.ts to pass the jsdocs oxlint rule.
High-intent search queries and answers about installing and using this skill.
To write JSDoc for Effect public APIs that passes the jsdocs oxlint rule, follow the standardized structure including a mandatory short description, optional sections like When to use, Details, and Gotchas, plus properly formatted examples.
Your TypeScript JSDoc likely fails the jsdocs oxlint check due to incorrect tag ordering, improper prose tone, missing mandatory sections, or malformed example formatting required by the Effect ecosystem's strict documentation standards.
The required JSDoc structure for Effect public API documentation includes a mandatory short description, followed by optional When to use, Details, and Gotchas sections, concluding with properly formatted code examples.
To fix non-compliant JSDoc tags and formatting in your TypeScript project, apply guidelines for tag ordering, link formatting, and section sequencing to ensure consistency and satisfy strict linting requirements.
Yes, the jsdocs oxlint rule requires properly formatted examples within your JSDoc to ensure consistency across the Effect codebase, alongside standardized prose rules and tag usage.
Automated JSDoc generation may struggle with nuanced prose rules, contextual When to use sections, and specific Gotchas, requiring manual refinement to fully satisfy the jsdocs oxlint rule for Effect public APIs.
MakisuoGenerate standard-jsdoc compliant JSDoc for Effect public APIs.
tillysosoGenerate TypeScript documentation from JSDoc and TypeDoc annotations.
agentxmWrap Promise-based APIs for use within the Effect ecosystem.
giuseppe-trisciuoglioGenerate TypeScript API references and ADRs with TypeDoc and JSDoc.
