Merge pull request #777 from PowerShell/kapilmb/fix-formatter

Fix minor issues with Invoke-Formatter

Author: Kapil Borle

Engine/Commands/InvokeFormatterCommand.cs

@@ -25,24 +25,23 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Commands
     public class InvokeFormatterCommand : PSCmdlet, IOutputWriter
     {
         private const string defaultSettingsPreset = "CodeFormatting";
-        private Settings defaultSettings;
         private Settings inputSettings;
 
         /// <summary>
         /// The script text to be formated.
         ///
         /// *NOTE*: Unlike ScriptBlock parameter, the ScriptDefinition parameter require a string value.
         /// </summary>
-        [ParameterAttribute(Mandatory = true)]
+        [ParameterAttribute(Mandatory = true, Position = 1)]
         [ValidateNotNull]
         public string ScriptDefinition { get; set; }
 
         /// <summary>
         /// A settings hashtable or a path to a PowerShell data file (.psd1) file that contains the settings.
         /// </summary>
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, Position = 2)]
         [ValidateNotNull]
-        public object Settings { get; set; }
+        public object Settings { get; set; } = defaultSettingsPreset;
 
 #if DEBUG
         [Parameter(Mandatory = false)]
@@ -88,18 +87,26 @@ protected override void BeginProcessing()
 
             try
             {
-                inputSettings = PSSASettings.Create(Settings, null, this);
-                if (inputSettings == null)
-                {
-                    inputSettings = new PSSASettings(
-                        defaultSettingsPreset,
-                        PSSASettings.GetSettingPresetFilePath);
-                }
+                inputSettings = PSSASettings.Create(Settings, this.MyInvocation.PSScriptRoot, this);
             }
-            catch
+            catch (Exception e)
+            {
+                this.ThrowTerminatingError(new ErrorRecord(
+                        e,
+                        "SETTNGS_ERROR",
+                        ErrorCategory.InvalidData,
+                        Settings));
+            }
+
+            if (inputSettings == null)
             {
-                this.WriteWarning(String.Format(CultureInfo.CurrentCulture, Strings.SettingsNotParsable));
-                return;
+                this.ThrowTerminatingError(new ErrorRecord(
+                    new ArgumentException(String.Format(
+                        CultureInfo.CurrentCulture,
+                        Strings.SettingsNotParsable)),
+                    "SETTINGS_ERROR",
+                    ErrorCategory.InvalidArgument,
+                    Settings));
             }
         }
 

Tests/Engine/InvokeFormatter.tests.ps1

@@ -5,6 +5,32 @@ Import-Module PSScriptAnalyzer
 Import-Module (Join-Path $testRootDirectory "PSScriptAnalyzerTestHelper.psm1")
 
 Describe "Invoke-Formatter Cmdlet" {
+    Context "When positional parameters are given" {
+        It "Should use the positional parameters" {
+            $def = @"
+function foo {
+"abc"
+}
+"@
+
+            $expected = @"
+function foo {
+    "abc"
+}
+"@
+
+            $settings = @{
+                IncludeRules = @('PSUseConsistentIndentation')
+                Rules        = @{
+                    PSUseConsistentIndentation = @{
+                        Enable = $true
+                    }
+                }
+            }
+
+            Invoke-Formatter $def $settings | Should Be $expected
+        }
+    }
     Context "When no settings are given" {
         It "Should format using default settings" {
             $def = @'

docs/markdown/Invoke-Formatter.md

@@ -4,7 +4,6 @@ schema: 2.0.0
 ---
 
 # Invoke-Formatter
-
 ## SYNOPSIS
 Formats a script text based on the input settings or default settings.
 
@@ -61,7 +60,7 @@ This command formats the input script text using the settings defined in the `$s
 
 ### -------------------------- EXAMPLE 3 --------------------------
 ```
-S> Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings /path/to/settings.psd1
+Invoke-Formatter -ScriptDefinition $scriptDefinition -Settings /path/to/settings.psd1
 ```
 
 This command formats the input script text using the settings defined in the `settings.psd1` file.
@@ -75,11 +74,11 @@ The script text to be formated.
 
 ```yaml
 Type: String
-Parameter Sets:
+Parameter Sets: (All)
 Aliases:
 
 Required: True
-Position: Named
+Position: 1
 Default value:
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -90,11 +89,11 @@ A settings hashtable or a path to a PowerShell data file (.psd1) file that conta
 
 ```yaml
 Type: Object
-Parameter Sets:
+Parameter Sets: (All)
 
 Required: False
-Position: Named
-Default value:
+Position: 2
+Default value: CodeFormatting
 Accept pipeline input: False
 Accept wildcard characters: False
 ```