Skip to main content

jsdocs

Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.

来源信息

仓库
Effect-TS/effect
最近来源活动
2026年10月7日 10:01
检测到的 SKILL.md 语言
英语
星标
17,222
分支
849

安装方式

默认使用会先检查来源的 Prompt;你也可以切换为直接命令,或下载本地副本。

检查来源文件

决定是否安装前,请先阅读 SKILL.md,以及 SkillsMP 当前展示的配套文件。

文件资源管理器
4 个文件

正在显示 SKILL.md

SKILL.md
来源说明 · 只读预览
name
jsdocs
description
Public API JSDoc. Use when authoring or reviewing Effect API documentation, refining a module's documentation, or fixing documentation related diagnostics.
## Workflow 1. Inspect the declaration, implementation, nearby JSDoc, tests, and call sites. 2. Select every applicable branch and load its reference before editing: - tags, modules, or links: [declarations.md](declarations.md); - categories: [categories.md](categories.md); - examples: [examples.md](examples.md). 3. Make a focused API fix or module refinement. Preserve verified facts and valuable examples rather than rewriting mechanically. 4. For module refinement or APIs with close alternatives, audit `@see` links and inspect implementation and tests for concrete `**Gotchas**`. 5. Run `pnpm jsdocs --check` and every applicable root validation command. `@internal` declarations and default exports are outside public JSDoc authoring. Checked files do not support exported enums or empty export declarations. Public declarations use a multiline block with one self-contained practical description paragraph. Start functions and methods with a present-tense action; match nearby noun-family phrasing for values. Optional non-empty sections appear once in this order: `**When to use**`, `**Details**`, `**Gotchas**`. Separate descriptions, sections, examples, and tags with one blank line. `**When to use**` states a positive use case distinct from the description; reserve `**Gotchas**` for concrete caveats and failure modes. The task is complete when every changed public declaration satisfies each applicable reference, the checker passes, runnable examples pass their targeted doctest, and all other applicable root checks pass or are reported as not run.
在 GitHub 查看