Skip to content

M1: Parse comment-based help from scripts/modules into canonical model #27

@jeffpatton1971

Description

@jeffpatton1971

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

  • Parser returns ModuleHelp with at least 1 CommandHelp.

  • At least one CommandHelp includes:

    • Name
    • Synopsis (fallback allowed)
    • Parameter list (can be empty)

Acceptance checks

  • Unit test against examples/with-comment-help ensures at least 1 command discovered and mapped.

Metadata

Metadata

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions