Skip to content

🚀 [Feature]: Short aliases for YAML conversion commands - #73

Open
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
issue-70-command-alias-tests
Open

🚀 [Feature]: Short aliases for YAML conversion commands#73
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
issue-70-command-alias-tests

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Aug 7, 2026

Copy link
Copy Markdown
Member

Use cfy and cty as quick aliases for ConvertFrom-Yaml and ConvertTo-Yaml commands. These short aliases reduce typing in interactive sessions while the full command names remain available for scripts and documentation.

New: Interactive command aliases

The cfy alias converts from YAML to PowerShell objects, and cty converts from PowerShell objects to YAML. Both are fully compatible with the standard command parameters and can be used interchangeably:

# Convert YAML string to object
$data = @"
name: example
value: 123
"@ | cfy

# Convert object back to YAML
$data | cty

The full ConvertFrom-Yaml and ConvertTo-Yaml command names continue to work unchanged for scripts and documented examples.


Technical details
  • Added cfy and cty aliases in the module manifest (PSModule.yml)
  • Aliases are exported via AliasesToExport in the module metadata
  • Built-in command conflict checks validate that aliases don't collide with existing PowerShell commands
  • Alias target mappings and manifest metadata updated in packaging configuration
  • Implementation plan progress: Closes Add short aliases for YAML conversion commands #70
Changed surface Standards checked Framework docs checked Result
src/** (PowerShell) Naming, Functions Module source layout Aligned
Relevant issues (or links)

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Add tests for YAML conversion aliases Add short YAML conversion aliases Aug 7, 2026
@MariusStorhaug
Marius Storhaug (MariusStorhaug) marked this pull request as ready for review August 7, 2026 21:30
@MariusStorhaug Marius Storhaug (MariusStorhaug) changed the title Add short YAML conversion aliases 🚀 [Feature]: Short aliases for YAML conversion commands Aug 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add short aliases for YAML conversion commands

1 participant