Change -Path parameter alias from -f to -p #99 (#100)

* Add accepted values of InputFormat * Change path alias from -f to -p #99
microsoft · Mar 1, 2019 · e4de52e · e4de52e
1 parent 49d2417
commit e4de52e
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 21 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 ## Unreleased
 
 - Added support for input deserialization from FileInfo objects [#95](https://github.com/BernieWhite/PSRule/issues/95)
+- **Breaking change** - Changed parameter alias for `-Path` from `-f` to `-p` [#99](https://github.com/BernieWhite/PSRule/issues/99)
 
 ## v0.3.0-B190231 (pre-release)
 

diff --git a/PSRule.build.ps1 b/PSRule.build.ps1
@@ -134,7 +134,7 @@ task BuildHelp BuildModule, PlatyPS, {
     $Null = Copy-Item -Path out/docs/PSRule/* -Destination out/modules/PSRule/en-AU;
 }
 
-task ScaffoldHelp BuildModule, {
+task ScaffoldHelp Build, {
 
     Import-Module (Join-Path -Path $PWD -ChildPath out/modules/PSRule) -Force;
 

diff --git a/docs/commands/PSRule/en-US/Get-PSRule.md b/docs/commands/PSRule/en-US/Get-PSRule.md
@@ -67,7 +67,7 @@ If the `-Module` parameter is used, rule definitions from the currently working
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: f
+Aliases: p
 
 Required: False
 Position: 0

diff --git a/docs/commands/PSRule/en-US/Invoke-PSRule.md b/docs/commands/PSRule/en-US/Invoke-PSRule.md
@@ -133,7 +133,7 @@ If the `-Module` parameter is used, rule definitions from the currently working
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: f
+Aliases: p
 
 Required: False
 Position: 0
@@ -237,16 +237,11 @@ Accept wildcard characters: False
 
 Configures the input format for when a string is passed in as a target object. By default, strings are just treated as raw text. However, when set strings can be read as YAML or JSON and converted to an object.
 
-The following formats are available:
-
-- None
-- Yaml
-- Json
-
 ```yaml
 Type: InputFormat
 Parameter Sets: (All)
 Aliases:
+Accepted values: None, Yaml, Json
 
 Required: False
 Position: Named

diff --git a/docs/commands/PSRule/en-US/Test-PSRuleTarget.md b/docs/commands/PSRule/en-US/Test-PSRuleTarget.md
@@ -55,7 +55,7 @@ If the `-Module` parameter is used, rule definitions from the currently working
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: f
+Aliases: p
 
 Required: False
 Position: 1
@@ -136,16 +136,11 @@ Accept wildcard characters: False
 
 Configures the input format for when a string is passed in as a target object. By default, strings are just treated as raw text. However, when set strings can be read as YAML or JSON and converted to an object.
 
-The following formats are available:
-
-- None
-- Yaml
-- Json
-
 ```yaml
 Type: InputFormat
 Parameter Sets: (All)
 Aliases:
+Accepted values: None, Yaml, Json
 
 Required: False
 Position: Named

diff --git a/src/PSRule/PSRule.psm1 b/src/PSRule/PSRule.psm1
@@ -45,7 +45,7 @@ function Invoke-PSRule {
     param (
         # A list of paths to check for rule definitions
         [Parameter(Position = 0)]
-        [Alias('f')]
+        [Alias('p')]
         [String[]]$Path = $PWD,
 
         # Filter to rules with the following names
@@ -71,7 +71,7 @@ function Invoke-PSRule {
         [PSRule.Configuration.ResultFormat]$As = [PSRule.Configuration.ResultFormat]::Detail,
 
         [Parameter(Mandatory = $False)]
-        [ValidateSet('Yaml', 'Json')]
+        [ValidateSet('None', 'Yaml', 'Json')]
         [PSRule.Configuration.InputFormat]$Format,
 
         [Parameter(Mandatory = $False)]
@@ -182,7 +182,7 @@ function Test-PSRuleTarget {
     param (
         # A list of paths to check for rule definitions
         [Parameter(Position = 0)]
-        [Alias('f')]
+        [Alias('p')]
         [String[]]$Path = $PWD,
 
         # Filter to rules with the following names
@@ -201,7 +201,7 @@ function Test-PSRuleTarget {
         [PSRule.Configuration.PSRuleOption]$Option,
 
         [Parameter(Mandatory = $False)]
-        [ValidateSet('Yaml', 'Json')]
+        [ValidateSet('None', 'Yaml', 'Json')]
         [PSRule.Configuration.InputFormat]$Format,
 
         [Parameter(Mandatory = $False)]
@@ -301,7 +301,7 @@ function Get-PSRule {
     param (
         # A list of paths to check for rule definitions
         [Parameter(Position = 0, Mandatory = $False)]
-        [Alias('f')]
+        [Alias('p')]
         [String[]]$Path = $PWD,
 
         # Filter to rules with the following names