PowerShell / PowerShell/DSC

--parameters-file and --file have the same short alias -f

Open
#983 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Breaking Change CLI-UX Issue-Bug
Dominant language
Rust
Stars
523
Forks
75
Avg merge
3d 16h
Merged PRs (30d)
24

Description

Prerequisites
  • Write a descriptive title.
  • Make sure you are able to repro it on the latest version
  • Search the existing issues.
Summary

The short alias for both --file and --parameters-file are the same value -f.

Usage: dsc.exe config get [OPTIONS]

Options:
  -i, --input <INPUT>                  The input document as JSON or YAML to pass to the configuration or resource
  -f, --file <FILE>                    The path to a file used as input to the configuration or resource. Use '-' for the file to read from STDIN.
  -o, --output-format <OUTPUT_FORMAT>  The output format to use [possible values: json, pretty-json, yaml]
  -h, --help                           Print help
PS C:\Users\Thomas> dsc config --help
Apply a configuration document

Usage: dsc.exe config [OPTIONS] <COMMAND>

Commands:
  get     Retrieve the current configuration
  set     Set the current configuration
  test    Test the current configuration
  export  Export the current configuration
  help    Print this message or the help of the given subcommand(s)

Options:
  -p, --parameters <PARAMETERS>
          Parameters to pass to the configuration as JSON or YAML
  -f, --parameters-file <PARAMETERS_FILE>
          Parameters to pass to the configuration as a JSON or YAML file
  -r, --system-root <SYSTEM_ROOT>
          Specify the operating system root path if not targeting the current running OS
  -h, --help
          Print help
Steps to reproduce

n/a

Expected behavior
Different short parameter name
Actual behavior
Same short parameter name
Error details

Environment data
7.5-preview4
Version

3.2-preview2

Visuals

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the CLI option definitions for --file and --parameters-file, then inspect how their short aliases are assigned. Verify the generated dsc config get --help and dsc config --help output; done means the two options display different short parameter names without ambiguity.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.