Skip to content

Add short aliases for YAML conversion commands #70

Description

Context

Short aliases are a PowerShell usability feature for interactive work. The conversion commands are frequently used in pipelines, so concise aliases can improve discoverability and ergonomics when they follow PowerShell conventions.

Reference:

Current State

The module exports descriptive command names. Short conversion aliases are specified but not yet part of the public command surface.

Objective

Add documented short aliases for conversion commands without reducing script clarity or conflicting with existing commands.

PowerShell Design Considerations

  • Aliases should primarily help interactive use; documentation should continue to teach full command names for scripts.
  • Aliases must not conflict with common built-in PowerShell aliases or commands.
  • Exported aliases should be included in packaging and help metadata.
  • Consider whether aliases should exist only for conversion commands or also for file/stream commands; keep scope minimal unless there is a clear user need.

Tasks

  • Add the specified conversion command aliases.
  • Validate there are no conflicts with built-in aliases in supported PowerShell versions.
  • Document aliases in help and command reference.
  • Ensure aliases are exported in module packaging.

Benefits

  • Improves interactive pipeline ergonomics.
  • Keeps scripts readable by retaining full command documentation as the primary guidance.
  • Aligns public command surface with the spec folder.

Acceptance Criteria

  • Aliases resolve to the intended conversion commands after module import.
  • Aliases are exported and packaged consistently.
  • Help and documentation mention aliases without replacing full command names.
  • Tests verify alias availability and target command mapping.

Related

  • Spec folder: spec/Command-Aliases.md

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions