القائمة
Use when extracting and categorizing public members from a Scala data type for documentation completeness checks.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Write a how-to guide for practitioners accomplishing a specific task with a ZIO library. Guides are goal-oriented and task-focused, not pedagogical. Use when writing step-by-step practical guides.
Write a tutorial for newcomers learning a topic in a ZIO library. Tutorials teach concepts step-by-step in a linear path for learning-oriented, not task-oriented, purposes. Use when writing comprehensive learning guides.
Reference for mdoc code block modifiers and Docusaurus admonitions used in ZIO documentation. Use when writing or reviewing documentation with Scala code examples.
Write reference documentation for a module containing multiple related data types. Use when documenting a cohesive domain model (e.g. http-model, resource-management) where types work together as a system.
Write reference documentation for a specific ZIO data type. Research the type, write comprehensive documentation with examples, verify mdoc compilation, and integrate into docs.
Integration checklist for new ZIO docs pages. Handles sidebar wiring, index.md linking, and compilation gate (mdoc + Docusaurus build). Cross-referencing is handled separately by the integrate workflow (Phase 2).
| name | docs-data-type-list-members |
| description | Use when extracting and categorizing public members from a Scala data type for documentation completeness checks. |
Parses a Scala source file and prints public members of the named type, grouped into sections for easy auditing.
scala-cli ${CLAUDE_PLUGIN_ROOT}/skills/docs-data-type-list-members/extract-members.scala \
-- <source-file> [<type-name>]
Run with --help for the full usage.
Default text output sections (each preceded by a header line ending in ===):
Excludes private/protected members and internal helpers.
For machine-readable output (e.g., when piping into other scripts or filtering with jq), pass --json:
scala-cli ${CLAUDE_PLUGIN_ROOT}/skills/docs-data-type-list-members/extract-members.scala \
-- --json <source-file> [<type-name>] | jq '.publicApi'
The JSON schema is:
{
"sourceFile": "<path>",
"typeName": "<name> or null",
"companion": ["..."],
"publicApi": ["..."],
"inherited": []
}
Exit codes:
| Code | Meaning |
|---|---|
0 | Success — at least one public member was extracted. |
1 | No public members found in the file or named type. |
2 | Invocation error (missing arguments, file not found). |
Pipe the output into /docs-report-method-coverage to check whether all members appear in a reference doc.