Implement a parser that reads comment-based help from functions/scripts in a module path and maps it into the canonical Core help model.
Scope constraints (M1)
-
Support scripts/modules from a filesystem path (examples folder).
-
Parse only what you need for “minimal valid MAML”:
- Synopsis
- Description
- Parameters (name + description)
- Examples (code + remarks) if present
-
If fields are missing, produce safe defaults (empty strings / empty lists), but do NOT scaffold placeholders yet (that’s later).
Definition of done
Acceptance checks
- Unit test against
examples/with-comment-help ensures at least 1 command discovered and mapped.
Implement a parser that reads comment-based help from functions/scripts in a module path and maps it into the canonical Core help model.
Scope constraints (M1)
Support scripts/modules from a filesystem path (examples folder).
Parse only what you need for “minimal valid MAML”:
If fields are missing, produce safe defaults (empty strings / empty lists), but do NOT scaffold placeholders yet (that’s later).
Definition of done
Parser returns
ModuleHelpwith at least 1CommandHelp.At least one
CommandHelpincludes:Acceptance checks
examples/with-comment-helpensures at least 1 command discovered and mapped.