Add -ExcludeProperty parameter to Format-* cmdlets (PowerShell#26514)

Author: yotsuda

src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/format-object/Format-Object.cs

@@ -41,6 +41,12 @@ public object[] Property
 
         private object[] _props;
 
+        /// <summary>
+        /// Gets or sets the properties to exclude from formatting.
+        /// </summary>
+        [Parameter]
+        public string[] ExcludeProperty { get; set; }
+
         /// <summary>
         /// </summary>
         /// <value></value>
@@ -61,22 +67,36 @@ internal override FormattingCommandLineParameters GetCommandLineParameters()
         {
             FormattingCommandLineParameters parameters = new();
 
+            // Check View conflicts first (before any auto-expansion)
+            if (!string.IsNullOrEmpty(this.View))
+            {
+                // View cannot be used with Property or ExcludeProperty
+                if ((_props is not null && _props.Length != 0) || (ExcludeProperty is not null && ExcludeProperty.Length != 0))
+                {
+                    ReportCannotSpecifyViewAndProperty();
+                }
+
+                parameters.viewName = this.View;
+            }
+
             if (_props != null)
             {
                 ParameterProcessor processor = new(new FormatObjectParameterDefinition());
                 TerminatingErrorContext invocationContext = new(this);
                 parameters.mshParameterList = processor.ProcessParameters(_props, invocationContext);
             }
 
-            if (!string.IsNullOrEmpty(this.View))
+            if (ExcludeProperty is not null)
             {
-                // we have a view command line switch
-                if (parameters.mshParameterList.Count != 0)
+                parameters.excludePropertyFilter = new PSPropertyExpressionFilter(ExcludeProperty);
+
+                // ExcludeProperty implies -Property * for better UX
+                if (_props is null || _props.Length == 0)
                 {
-                    ReportCannotSpecifyViewAndProperty();
+                    ParameterProcessor processor = new(new FormatObjectParameterDefinition());
+                    TerminatingErrorContext invocationContext = new(this);
+                    parameters.mshParameterList = processor.ProcessParameters(new object[] { "*" }, invocationContext);
                 }
-
-                parameters.viewName = this.View;
             }
 
             parameters.groupByParameter = this.ProcessGroupByParameter();

src/Microsoft.PowerShell.Commands.Utility/commands/utility/FormatAndOutput/format-wide/Format-Wide.cs

@@ -42,9 +42,14 @@ public object Property
         private object _prop;
 
         /// <summary>
-        /// Optional, non positional parameter.
+        /// Gets or sets the properties to exclude from formatting.
+        /// </summary>
+        [Parameter]
+        public string[] ExcludeProperty { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to autosize the output.
         /// </summary>
-        /// <value></value>
         [Parameter]
         public SwitchParameter AutoSize
         {
@@ -74,22 +79,36 @@ internal override FormattingCommandLineParameters GetCommandLineParameters()
         {
             FormattingCommandLineParameters parameters = new();
 
+            // Check View conflicts first (before any auto-expansion)
+            if (!string.IsNullOrEmpty(this.View))
+            {
+                // View cannot be used with Property or ExcludeProperty
+                if (_prop is not null || (ExcludeProperty is not null && ExcludeProperty.Length != 0))
+                {
+                    ReportCannotSpecifyViewAndProperty();
+                }
+
+                parameters.viewName = this.View;
+            }
+
             if (_prop != null)
             {
                 ParameterProcessor processor = new(new FormatWideParameterDefinition());
                 TerminatingErrorContext invocationContext = new(this);
                 parameters.mshParameterList = processor.ProcessParameters(new object[] { _prop }, invocationContext);
             }
 
-            if (!string.IsNullOrEmpty(this.View))
+            if (ExcludeProperty is not null)
             {
-                // we have a view command line switch
-                if (parameters.mshParameterList.Count != 0)
+                parameters.excludePropertyFilter = new PSPropertyExpressionFilter(ExcludeProperty);
+
+                // ExcludeProperty implies -Property * for better UX
+                if (_prop is null)
                 {
-                    ReportCannotSpecifyViewAndProperty();
+                    ParameterProcessor processor = new(new FormatWideParameterDefinition());
+                    TerminatingErrorContext invocationContext = new(this);
+                    parameters.mshParameterList = processor.ProcessParameters(new object[] { "*" }, invocationContext);
                 }
-
-                parameters.viewName = this.View;
             }
 
             // we cannot specify -column and -autosize, they are mutually exclusive

src/Microsoft.PowerShell.Commands.Utility/commands/utility/Select-Object.cs

@@ -12,47 +12,6 @@
 
 namespace Microsoft.PowerShell.Commands
 {
-    /// <summary>
-    /// Helper class to do wildcard matching on PSPropertyExpressions.
-    /// </summary>
-    internal sealed class PSPropertyExpressionFilter
-    {
-        /// <summary>
-        /// Initializes a new instance of the <see cref="PSPropertyExpressionFilter"/> class
-        /// with the specified array of patterns.
-        /// </summary>
-        /// <param name="wildcardPatternsStrings">Array of pattern strings to use.</param>
-        internal PSPropertyExpressionFilter(string[] wildcardPatternsStrings)
-        {
-            ArgumentNullException.ThrowIfNull(wildcardPatternsStrings);
-
-            _wildcardPatterns = new WildcardPattern[wildcardPatternsStrings.Length];
-            for (int k = 0; k < wildcardPatternsStrings.Length; k++)
-            {
-                _wildcardPatterns[k] = WildcardPattern.Get(wildcardPatternsStrings[k], WildcardOptions.IgnoreCase);
-            }
-        }
-
-        /// <summary>
-        /// Try to match the expression against the array of wildcard patterns.
-        /// The first match shortcircuits the search.
-        /// </summary>
-        /// <param name="expression">PSPropertyExpression to test against.</param>
-        /// <returns>True if there is a match, else false.</returns>
-        internal bool IsMatch(PSPropertyExpression expression)
-        {
-            for (int k = 0; k < _wildcardPatterns.Length; k++)
-            {
-                if (_wildcardPatterns[k].IsMatch(expression.ToString()))
-                    return true;
-            }
-
-            return false;
-        }
-
-        private readonly WildcardPattern[] _wildcardPatterns;
-    }
-
     internal sealed class SelectObjectExpressionParameterDefinition : CommandParameterDefinition
     {
         protected override void SetEntries()

src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommand.cs

@@ -9,6 +9,7 @@
 using System.Management.Automation;
 using System.Management.Automation.Internal;
 using System.Management.Automation.Runspaces;
+using Microsoft.PowerShell.Commands;
 
 namespace Microsoft.PowerShell.Commands.Internal.Format
 {
@@ -729,6 +730,12 @@ public class OuterFormatTableAndListBase : OuterFormatShapeCommandBase
         [Parameter(Position = 0)]
         public object[] Property { get; set; }
 
+        /// <summary>
+        /// Optional parameter for excluding properties from formatting.
+        /// </summary>
+        [Parameter]
+        public string[] ExcludeProperty { get; set; }
+
         #endregion
 
         internal override FormattingCommandLineParameters GetCommandLineParameters()
@@ -751,6 +758,18 @@ internal override FormattingCommandLineParameters GetCommandLineParameters()
 
         internal void GetCommandLineProperties(FormattingCommandLineParameters parameters, bool isTable)
         {
+            // Check View conflicts first (before any auto-expansion)
+            if (!string.IsNullOrEmpty(this.View))
+            {
+                // View cannot be used with Property or ExcludeProperty
+                if ((Property is not null && Property.Length != 0) || (ExcludeProperty is not null && ExcludeProperty.Length != 0))
+                {
+                    ReportCannotSpecifyViewAndProperty();
+                }
+
+                parameters.viewName = this.View;
+            }
+
             if (Property != null)
             {
                 CommandParameterDefinition def;
@@ -765,15 +784,21 @@ internal void GetCommandLineProperties(FormattingCommandLineParameters parameter
                 parameters.mshParameterList = processor.ProcessParameters(Property, invocationContext);
             }
 
-            if (!string.IsNullOrEmpty(this.View))
+            if (ExcludeProperty is not null)
             {
-                // we have a view command line switch
-                if (parameters.mshParameterList.Count != 0)
+                parameters.excludePropertyFilter = new PSPropertyExpressionFilter(ExcludeProperty);
+
+                // ExcludeProperty implies -Property * for better UX
+                if (Property is null || Property.Length == 0)
                 {
-                    ReportCannotSpecifyViewAndProperty();
-                }
+                    CommandParameterDefinition def = isTable
+                        ? new FormatTableParameterDefinition()
+                        : new FormatListParameterDefinition();
+                    ParameterProcessor processor = new ParameterProcessor(def);
+                    TerminatingErrorContext invocationContext = new TerminatingErrorContext(this);
 
-                parameters.viewName = this.View;
+                    parameters.mshParameterList = processor.ProcessParameters(new object[] { "*" }, invocationContext);
+                }
             }
         }
     }

src/System.Management.Automation/FormatAndOutput/common/BaseFormattingCommandParameters.cs

@@ -70,6 +70,11 @@ internal sealed class FormattingCommandLineParameters
         /// Extension mechanism for shape specific parameters.
         /// </summary>
         internal ShapeSpecificParameters shapeParameters = null;
+
+        /// <summary>
+        /// Filter for excluding properties from formatting.
+        /// </summary>
+        internal PSPropertyExpressionFilter excludePropertyFilter = null;
     }
 
     /// <summary>

src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System.Collections.Generic;
+using System.Linq;
 using System.Collections.ObjectModel;
 using System.Management.Automation;
 using System.Management.Automation.Internal;
@@ -348,7 +349,19 @@ protected class DataBaseInfo
         protected DataBaseInfo dataBaseInfo = new DataBaseInfo();
 
         protected List<MshResolvedExpressionParameterAssociation> activeAssociationList = null;
-        protected FormattingCommandLineParameters inputParameters = null;
+        /// <summary>
+        /// Apply ExcludeProperty filter to activeAssociationList if specified.
+        /// This method filters and updates "activeAssociationList" instance property.
+        /// </summary>
+        protected void ApplyExcludePropertyFilter()
+        {
+            if (this.parameters is not null && this.parameters.excludePropertyFilter is not null)
+            {
+                this.activeAssociationList = this.activeAssociationList
+                    .Where(item => !this.parameters.excludePropertyFilter.IsMatch(item.ResolvedExpression))
+                    .ToList();
+            }
+        }
 
         protected string GetExpressionDisplayValue(PSObject so, int enumerationLimit, PSPropertyExpression ex,
                     FieldFormattingDirective directive)

src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_Complex.cs

@@ -3,6 +3,7 @@
 
 using System.Collections;
 using System.Collections.Generic;
+using System.Linq;
 using System.Collections.ObjectModel;
 using System.Management.Automation;
 using System.Management.Automation.Internal;
@@ -16,7 +17,6 @@ internal override void Initialize(TerminatingErrorContext errorContext, PSProper
             PSObject so, TypeInfoDataBase db, FormattingCommandLineParameters parameters)
         {
             base.Initialize(errorContext, expressionFactory, so, db, parameters);
-            this.inputParameters = parameters;
         }
 
         internal override FormatStartData GenerateStartData(PSObject so)
@@ -40,7 +40,7 @@ internal override FormatEntryData GeneratePayload(PSObject so, int enumerationLi
         private ComplexViewEntry GenerateComplexViewEntryFromProperties(PSObject so, int enumerationLimit)
         {
             ComplexViewObjectBrowser browser = new ComplexViewObjectBrowser(this.ErrorManager, this.expressionFactory, enumerationLimit);
-            return browser.GenerateView(so, this.inputParameters);
+            return browser.GenerateView(so, this.parameters);
         }
 
         private ComplexViewEntry GenerateComplexViewEntryFromDataBaseInfo(PSObject so, int enumerationLimit)
@@ -425,17 +425,18 @@ internal ComplexViewObjectBrowser(FormatErrorManager resultErrorManager, PSPrope
         /// of the object.
         /// </summary>
         /// <param name="so">Object to process.</param>
-        /// <param name="inputParameters">Parameters from the command line.</param>
+        /// <param name="parameters">Parameters from the command line.</param>
         /// <returns>Complex view entry to send to the output command.</returns>
-        internal ComplexViewEntry GenerateView(PSObject so, FormattingCommandLineParameters inputParameters)
+        internal ComplexViewEntry GenerateView(PSObject so, FormattingCommandLineParameters parameters)
         {
-            _complexSpecificParameters = (ComplexSpecificParameters)inputParameters.shapeParameters;
+            _parameters = parameters;
+            _complexSpecificParameters = (ComplexSpecificParameters)parameters.shapeParameters;
 
             int maxDepth = _complexSpecificParameters.maxDepth;
             TraversalInfo level = new TraversalInfo(0, maxDepth);
 
             List<MshParameter> mshParameterList = null;
-            mshParameterList = inputParameters.mshParameterList;
+            mshParameterList = parameters.mshParameterList;
 
             // create a top level entry as root of the tree
             ComplexViewEntry cve = new ComplexViewEntry();
@@ -513,6 +514,14 @@ private void DisplayObject(PSObject so, TraversalInfo currentLevel, List<MshPara
             List<MshResolvedExpressionParameterAssociation> activeAssociationList =
                         AssociationManager.SetupActiveProperties(parameterList, so, _expressionFactory);
 
+            // Apply ExcludeProperty filter if specified
+            if (_parameters != null && _parameters.excludePropertyFilter != null)
+            {
+                activeAssociationList = activeAssociationList
+                    .Where(item => !_parameters.excludePropertyFilter.IsMatch(item.ResolvedExpression))
+                    .ToList();
+            }
+
             // create a format entry
             FormatEntry fe = new FormatEntry();
             formatValueList.Add(fe);
@@ -758,6 +767,7 @@ private List<FormatValue> AddIndentationLevel(List<FormatValue> formatValueList)
             return feFrame.formatValueList;
         }
 
+        private FormattingCommandLineParameters _parameters;
         private ComplexSpecificParameters _complexSpecificParameters;
 
         /// <summary>

src/System.Management.Automation/FormatAndOutput/common/FormatViewGenerator_List.cs

@@ -31,7 +31,7 @@ internal override void Initialize(TerminatingErrorContext errorContext, PSProper
                 _listBody = (ListControlBody)this.dataBaseInfo.view.mainControl;
             }
 
-            this.inputParameters = parameters;
+            this.parameters = parameters;
             SetUpActiveProperties(so);
         }
 
@@ -227,10 +227,12 @@ private void SetUpActiveProperties(PSObject so)
         {
             List<MshParameter> mshParameterList = null;
 
-            if (this.inputParameters != null)
-                mshParameterList = this.inputParameters.mshParameterList;
+            if (this.parameters != null)
+                mshParameterList = this.parameters.mshParameterList;
 
             this.activeAssociationList = AssociationManager.SetupActiveProperties(mshParameterList, so, this.expressionFactory);
+
+            ApplyExcludePropertyFilter();
         }
     }
 }