Problem
Current standards define where to place formatting/type metadata (src/formats/*.Format.ps1xml, src/types/*.Types.ps1xml) but do not define output UX heuristics for default display behavior.
Teams can make inconsistent choices for:
- single object default view (list vs table),
- collection default view (table vs list),
- which properties are safe/appropriate for default display,
- handling sensitive fields in typed output objects.
Proposal
Add a normative section to MSXOrg/docs for output display policy:
- Default display goals
- Single object: optimized for inspection.
- Collections: optimized for scan/comparison.
- Recommended defaults
- Prefer list-oriented detail view for single object.
- Prefer concise table summary for collections.
- Safety rules
- Never include secrets/private key material in default views.
- Require explicit opt-in command/property for sensitive detail.
- Required artifacts
- When introducing public classes, provide matching
.Types.ps1xml and .Format.ps1xml.
- Test guidance
- Add tests validating default view shape and that sensitive properties are excluded.
Why now
This reduces UX drift across modules and prevents accidental sensitive-data display in terminal output/logs.
Problem
Current standards define where to place formatting/type metadata (
src/formats/*.Format.ps1xml,src/types/*.Types.ps1xml) but do not define output UX heuristics for default display behavior.Teams can make inconsistent choices for:
Proposal
Add a normative section to MSXOrg/docs for output display policy:
.Types.ps1xmland.Format.ps1xml.Why now
This reduces UX drift across modules and prevents accidental sensitive-data display in terminal output/logs.