Refactoring logging

README.md

@@ -318,10 +318,6 @@ The following conceptual topics exist in the `PSRule` module:
   - [Input.ObjectPath](https://aka.ms/ps-rule/options#inputobjectpath)
   - [Input.PathIgnore](https://aka.ms/ps-rule/options#inputpathignore)
   - [Input.TargetType](https://aka.ms/ps-rule/options#inputtargettype)
-  - [Logging.LimitDebug](https://aka.ms/ps-rule/options#logginglimitdebug)
-  - [Logging.LimitVerbose](https://aka.ms/ps-rule/options#logginglimitverbose)
-  - [Logging.RuleFail](https://aka.ms/ps-rule/options#loggingrulefail)
-  - [Logging.RulePass](https://aka.ms/ps-rule/options#loggingrulepass)
   - [Output.As](https://aka.ms/ps-rule/options#outputas)
   - [Output.Banner](https://aka.ms/ps-rule/options#outputbanner)
   - [Output.Culture](https://aka.ms/ps-rule/options#outputculture)

docs/changelog.md

@@ -45,6 +45,10 @@ What's changed since pre-release v3.0.0-B0453:
 What's changed since pre-release v3.0.0-B0416:
 
 - Engineering:
+  - **Important change**: Remove legacy log scopes by @BernieWhite.
+    [#2891](https://github.com/microsoft/PSRule/issues/2891)
+  - **Important change**: Remove pass fail streams by @BernieWhite.
+    [#2892](https://github.com/microsoft/PSRule/issues/2892)
   - Bump System.Drawing.Common to v9.0.3.
     [#2808](https://github.com/microsoft/PSRule/pull/2808)
   - Bump NuGet.Protocol to v6.13.2.

docs/commands/PSRule/en-US/New-PSRuleOption.md

@@ -30,8 +30,7 @@ New-PSRuleOption [[-Path] <String>] [-Configuration <ConfigurationOption>]
  [-IncludePath <String[]>] [-InputFileObjects <Boolean>] [-InputStringFormat <String>]
  [-InputIgnoreGitPath <Boolean>] [-InputIgnoreRepositoryCommon <Boolean>] [-InputIgnoreObjectSource <Boolean>]
  [-InputIgnoreUnchangedPath <Boolean>] [-ObjectPath <String>] [-InputTargetType <String[]>]
- [-InputPathIgnore <String[]>] [-LoggingLimitDebug <String[]>] [-LoggingLimitVerbose <String[]>]
- [-LoggingRuleFail <OutcomeLogStream>] [-LoggingRulePass <OutcomeLogStream>] [-OutputAs <ResultFormat>]
+ [-InputPathIgnore <String[]>] [-OutputAs <ResultFormat>]
  [-OutputBanner <BannerFormat>] [-OutputCulture <String[]>] [-OutputEncoding <OutputEncoding>]
  [-OutputFooter <FooterFormat>] [-OutputFormat <OutputFormat>] [-OutputJobSummaryPath <String>]
  [-OutputJsonIndent <Int32>] [-OutputOutcome <RuleOutcome>] [-OutputPath <String>]
@@ -57,8 +56,7 @@ New-PSRuleOption [-Option] <PSRuleOption> [-Configuration <ConfigurationOption>]
  [-IncludePath <String[]>] [-InputFileObjects <Boolean>] [-InputStringFormat <String>]
  [-InputIgnoreGitPath <Boolean>] [-InputIgnoreRepositoryCommon <Boolean>] [-InputIgnoreObjectSource <Boolean>]
  [-InputIgnoreUnchangedPath <Boolean>] [-ObjectPath <String>] [-InputTargetType <String[]>]
- [-InputPathIgnore <String[]>] [-LoggingLimitDebug <String[]>] [-LoggingLimitVerbose <String[]>]
- [-LoggingRuleFail <OutcomeLogStream>] [-LoggingRulePass <OutcomeLogStream>] [-OutputAs <ResultFormat>]
+ [-InputPathIgnore <String[]>] [-OutputAs <ResultFormat>]
  [-OutputBanner <BannerFormat>] [-OutputCulture <String[]>] [-OutputEncoding <OutputEncoding>]
  [-OutputFooter <FooterFormat>] [-OutputFormat <OutputFormat>] [-OutputJobSummaryPath <String>]
  [-OutputJsonIndent <Int32>] [-OutputOutcome <RuleOutcome>] [-OutputPath <String>]
@@ -84,8 +82,7 @@ New-PSRuleOption [-Default] [-Configuration <ConfigurationOption>] [-SuppressTar
  [-IncludePath <String[]>] [-InputFileObjects <Boolean>] [-InputStringFormat <String>]
  [-InputIgnoreGitPath <Boolean>] [-InputIgnoreRepositoryCommon <Boolean>] [-InputIgnoreObjectSource <Boolean>]
  [-InputIgnoreUnchangedPath <Boolean>] [-ObjectPath <String>] [-InputTargetType <String[]>]
- [-InputPathIgnore <String[]>] [-LoggingLimitDebug <String[]>] [-LoggingLimitVerbose <String[]>]
- [-LoggingRuleFail <OutcomeLogStream>] [-LoggingRulePass <OutcomeLogStream>] [-OutputAs <ResultFormat>]
+ [-InputPathIgnore <String[]>] [-OutputAs <ResultFormat>]
  [-OutputBanner <BannerFormat>] [-OutputCulture <String[]>] [-OutputEncoding <OutputEncoding>]
  [-OutputFooter <FooterFormat>] [-OutputFormat <OutputFormat>] [-OutputJobSummaryPath <String>]
  [-OutputJsonIndent <Int32>] [-OutputOutcome <RuleOutcome>] [-OutputPath <String>]
@@ -606,74 +603,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -LoggingLimitDebug
-
-Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes.
-See about_PSRule_Options for more information.
-
-```yaml
-Type: String[]
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -LoggingLimitVerbose
-
-Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes.
-See about_PSRule_Options for more information.
-
-```yaml
-Type: String[]
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -LoggingRuleFail
-
-Sets the `Logging.RuleFail` option to generate an informational message for each rule fail.
-See about_PSRule_Options for more information.
-
-```yaml
-Type: OutcomeLogStream
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -LoggingRulePass
-
-Sets the `Logging.RulePass` option to generate an informational message for each rule pass.
-See about_PSRule_Options for more information.
-
-```yaml
-Type: OutcomeLogStream
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -OutputAs
 
 Sets the option `Output.As`.

docs/commands/PSRule/en-US/Set-PSRuleOption.md

@@ -28,8 +28,7 @@ Set-PSRuleOption [[-Path] <String>] [-Option <PSRuleOption>] [-PassThru] [-Force
  [-IncludePath <String[]>] [-InputFileObjects <Boolean>] [-InputStringFormat <String>]
  [-InputIgnoreGitPath <Boolean>] [-InputIgnoreObjectSource <Boolean>] [-InputIgnoreRepositoryCommon <Boolean>]
  [-InputIgnoreUnchangedPath <Boolean>] [-ObjectPath <String>] [-InputPathIgnore <String[]>]
- [-InputTargetType <String[]>] [-LoggingLimitDebug <String[]>] [-LoggingLimitVerbose <String[]>]
- [-LoggingRuleFail <OutcomeLogStream>] [-LoggingRulePass <OutcomeLogStream>] [-OutputAs <ResultFormat>]
+ [-InputTargetType <String[]>] [-OutputAs <ResultFormat>]
  [-OutputBanner <BannerFormat>] [-OutputCulture <String[]>] [-OutputEncoding <OutputEncoding>]
  [-OutputFooter <FooterFormat>] [-OutputFormat <OutputFormat>] [-OutputJobSummaryPath <String>]
  [-OutputJsonIndent <Int32>] [-OutputOutcome <RuleOutcome>] [-OutputPath <String>]
@@ -542,72 +541,6 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -LoggingLimitDebug
-
-Sets the `Logging.LimitDebug` option to limit debug messages to a list of named debug scopes.
-
-```yaml
-Type: String[]
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -LoggingLimitVerbose
-
-Sets the `Logging.LimitVerbose` option to limit verbose messages to a list of named verbose scopes.
-
-```yaml
-Type: String[]
-Parameter Sets: (All)
-Aliases:
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -LoggingRuleFail
-
-Sets the `Logging.RuleFail` option to generate an informational message for each rule fail.
-
-```yaml
-Type: OutcomeLogStream
-Parameter Sets: (All)
-Aliases:
-Accepted values: None, Error, Warning, Information
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -LoggingRulePass
-
-Sets the `Logging.RulePass` option to generate an informational message for each rule pass.
-
-```yaml
-Type: OutcomeLogStream
-Parameter Sets: (All)
-Aliases:
-Accepted values: None, Error, Warning, Information
-
-Required: False
-Position: Named
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
 ### -OutputAs
 
 Sets the option `Output.As`.

docs/concepts/PSRule/en-US/about_PSRule_Options.md

@@ -48,10 +48,6 @@ The following workspace options are available for use:
 - [Input.ObjectPath](#inputobjectpath)
 - [Input.PathIgnore](#inputpathignore)
 - [Input.TargetType](#inputtargettype)
-- [Logging.LimitDebug](#logginglimitdebug)
-- [Logging.LimitVerbose](#logginglimitverbose)
-- [Logging.RuleFail](#loggingrulefail)
-- [Logging.RulePass](#loggingrulepass)
 - [Output.As](#outputas)
 - [Output.Banner](#outputbanner)
 - [Output.Culture](#outputculture)
@@ -2369,166 +2365,6 @@ variables:
   value: virtualMachine;virtualNetwork
 ```
 
-### Logging.LimitDebug
-
-Limits debug messages to a list of named debug scopes.
-
-When using the `-Debug` switch or preference variable, by default PSRule cmdlets log all debug output.
-When using debug output for debugging a specific rule, it may be helpful to limit debug message to a specific rule.
-
-To identify a rule to include in debug output use the rule name.
-
-The following built-in scopes exist in addition to rule names:
-
-- `[Discovery.Source]` - Discovery messages for `.Rule.ps1` files and rule modules.
-- `[Discovery.Rule]` - Discovery messages for individual rules within `.Rule.ps1` files.
-
-This option can be specified using:
-
-```powershell
-# PowerShell: Using the LoggingLimitDebug parameter
-$option = New-PSRuleOption -LoggingLimitDebug Rule1, Rule2;
-```
-
-```powershell
-# PowerShell: Using the Logging.LimitDebug hashtable key
-$option = New-PSRuleOption -Option @{ 'Logging.LimitDebug' = Rule1, Rule2 };
-```
-
-```powershell
-# PowerShell: Using the LoggingLimitDebug parameter to set YAML
-Set-PSRuleOption -LoggingLimitDebug Rule1, Rule2;
-```
-
-```yaml
-# YAML: Using the logging/limitDebug property
-logging:
-  limitDebug:
-  - Rule1
-  - Rule2
-```
-
-### Logging.LimitVerbose
-
-Limits verbose messages to a list of named verbose scopes.
-
-When using the `-Verbose` switch or preference variable, by default PSRule cmdlets log all verbose output.
-When using verbose output for troubleshooting a specific rule,
-it may be helpful to limit verbose messages to a specific rule.
-
-To identify a rule to include in verbose output use the rule name.
-
-The following built-in scopes exist in addition to rule names:
-
-- `[Discovery.Source]` - Discovery messages for `.Rule.ps1` files and rule modules.
-- `[Discovery.Rule]` - Discovery messages for individual rules within `.Rule.ps1` files.
-
-This option can be specified using:
-
-```powershell
-# PowerShell: Using the LoggingLimitVerbose parameter
-$option = New-PSRuleOption -LoggingLimitVerbose Rule1, Rule2;
-```
-
-```powershell
-# PowerShell: Using the Logging.LimitVerbose hashtable key
-$option = New-PSRuleOption -Option @{ 'Logging.LimitVerbose' = Rule1, Rule2 };
-```
-
-```powershell
-# PowerShell: Using the LoggingLimitVerbose parameter to set YAML
-Set-PSRuleOption -LoggingLimitVerbose Rule1, Rule2;
-```
-
-```yaml
-# YAML: Using the logging/limitVerbose property
-logging:
-  limitVerbose:
-  - Rule1
-  - Rule2
-```
-
-### Logging.RuleFail
-
-When an object fails a rule condition the results are written to output as a structured object marked with the outcome of _Fail_.
-If the rule executed successfully regardless of outcome no other informational messages are shown by default.
-
-In some circumstances such as a continuous integration (CI) pipeline,
-it may be preferable to see informational messages or abort the CI process if one or more _Fail_ outcomes are returned.
-
-By settings this option, error, warning or information messages will be generated for each rule _fail_ outcome in addition to structured output.
-By default, outcomes are not logged to an informational stream (i.e. None).
-
-The following streams available:
-
-- None
-- Error
-- Warning
-- Information
-
-This option can be specified using:
-
-```powershell
-# PowerShell: Using the LoggingRuleFail parameter
-$option = New-PSRuleOption -LoggingRuleFail Error;
-```
-
-```powershell
-# PowerShell: Using the Logging.RuleFail hashtable key
-$option = New-PSRuleOption -Option @{ 'Logging.RuleFail' = 'Error' };
-```
-
-```powershell
-# PowerShell: Using the LoggingRuleFail parameter to set YAML
-Set-PSRuleOption -LoggingRuleFail Error;
-```
-
-```yaml
-# YAML: Using the logging/ruleFail property
-logging:
-  ruleFail: Error
-```
-
-### Logging.RulePass
-
-When an object passes a rule condition the results are written to output as a structured object marked with the outcome of _Pass_.
-If the rule executed successfully regardless of outcome no other informational messages are shown by default.
-
-In some circumstances such as a continuous integration (CI) pipeline, it may be preferable to see informational messages.
-
-By settings this option, error, warning or information messages will be generated for each rule _pass_ outcome in addition to structured output.
-By default, outcomes are not logged to an informational stream (i.e. None).
-
-The following streams available:
-
-- None
-- Error
-- Warning
-- Information
-
-This option can be specified using:
-
-```powershell
-# PowerShell: Using the LoggingRulePass parameter
-$option = New-PSRuleOption -LoggingRulePass Information;
-```
-
-```powershell
-# PowerShell: Using the Logging.RulePass hashtable key
-$option = New-PSRuleOption -Option @{ 'Logging.RulePass' = 'Information' };
-```
-
-```powershell
-# PowerShell: Using the LoggingRulePass parameter to set YAML
-Set-PSRuleOption -LoggingRulePass Information;
-```
-
-```yaml
-# YAML: Using the logging/rulePass property
-logging:
-  rulePass: Information
-```
-
 ### Output.As
 
 Configures the type of results to produce.