Static analysis: expand PowerShell rules catalog

.github/workflows/review-intelligencex.yml

@@ -76,6 +76,19 @@ jobs:
           fi
           echo "Changed files: $(wc -l < artifacts/changed-files.txt)"
 
+      - name: Tune reviewer budgets for large PRs
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          changed="$(wc -l < artifacts/changed-files.txt | tr -d ' ')"
+          catalog="$(grep -cE '^Analysis/Catalog/(rules|overrides)/' artifacts/changed-files.txt || true)"
+          if [ "${changed:-0}" -gt 30 ] || [ "${catalog:-0}" -gt 10 ]; then
+            echo "Detected large diff (changed=${changed}, catalog=${catalog}); expanding reviewer context limits."
+            echo "INPUT_MAX_FILES=200" >> "$GITHUB_ENV"
+            echo "INPUT_MAX_PATCH_CHARS=120000" >> "$GITHUB_ENV"
+          else
+            echo "Diff size within default limits (changed=${changed}, catalog=${catalog}); using defaults."
+          fi
+
       - name: Static analysis gate
         run: dotnet run --project IntelligenceX.Cli/IntelligenceX.Cli.csproj --framework net8.0 -- analyze gate --config .intelligencex/reviewer.json --workspace . --changed-files artifacts/changed-files.txt
 

Analysis/Catalog/overrides/powershell/PSAvoidDefaultValueForMandatoryParameter.json

@@ -0,0 +1,4 @@
+{
+  "id": "PSAvoidDefaultValueForMandatoryParameter",
+  "description": "Mandatory parameters should not be initialized with a default value in the param block because this value will be ignored. To fix a violation of this rule, avoid initializing a value for mandatory parameters in the param block."
+}

Analysis/Catalog/overrides/powershell/PSAvoidDefaultValueSwitchParameter.json

@@ -0,0 +1,4 @@
+{
+  "id": "PSAvoidDefaultValueSwitchParameter",
+  "description": "Switch parameters should not default to true."
+}

Analysis/Catalog/overrides/powershell/PSAvoidMultipleTypeAttributes.json

@@ -0,0 +1,4 @@
+{
+  "id": "PSAvoidMultipleTypeAttributes",
+  "description": "Parameters should not have more than one type specifier."
+}

Analysis/Catalog/overrides/powershell/PSUseConsistentIndentation.json

@@ -0,0 +1,5 @@
+{
+  "id": "PSUseConsistentIndentation",
+  "title": "Use Consistent Indentation",
+  "description": "Each statement block should have consistent indentation."
+}

Analysis/Catalog/rules/powershell/PSAlignAssignmentStatement.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAlignAssignmentStatement",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAlignAssignmentStatement",
+  "title": "Align Assignment Statements",
+  "description": "Line up assignment statements so that the assignment operators are aligned.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/alignassignmentstatement"
+}

Analysis/Catalog/rules/powershell/PSAvoidAssignmentToAutomaticVariable.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidAssignmentToAutomaticVariable",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidAssignmentToAutomaticVariable",
+  "title": "Changing automatic variables might have undesired side effects",
+  "description": "Automatic variables are built into PowerShell and are read-only. Avoid assigning to them.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidassignmenttoautomaticvariable"
+}

Analysis/Catalog/rules/powershell/PSAvoidDefaultValueForMandatoryParameter.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidDefaultValueForMandatoryParameter",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidDefaultValueForMandatoryParameter",
+  "title": "Avoid Default Value For Mandatory Parameter",
+  "description": "Mandatory parameter should not be initialized with a default value in the param block because this value will be ignored. To fix a violation of this rule, please avoid initializing a value for the mandatory parameter in the param block.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoiddefaultvalueformandatoryparameter"
+}

Analysis/Catalog/rules/powershell/PSAvoidDefaultValueSwitchParameter.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidDefaultValueSwitchParameter",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidDefaultValueSwitchParameter",
+  "title": "Switch Parameters Should Not Default To True",
+  "description": "Switch parameter should not default to true.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoiddefaultvalueswitchparameter"
+}

Analysis/Catalog/rules/powershell/PSAvoidExclaimOperator.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidExclaimOperator",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidExclaimOperator",
+  "title": "Avoid exclaim operator",
+  "description": "The negation operator ! should not be used for readability purposes. Use -not instead.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidexclaimoperator"
+}

Analysis/Catalog/rules/powershell/PSAvoidGlobalAliases.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidGlobalAliases",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidGlobalAliases",
+  "title": "Avoid global aliases.",
+  "description": "Checks that global aliases are not used. Global aliases are strongly discouraged as they overwrite desired aliases with name conflicts.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidglobalaliases"
+}

Analysis/Catalog/rules/powershell/PSAvoidGlobalFunctions.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidGlobalFunctions",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidGlobalFunctions",
+  "title": "Avoid global functions and aliases",
+  "description": "Checks that global functions and aliases are not used. Global functions are strongly discouraged as they can cause errors across different systems.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidglobalfunctions"
+}

Analysis/Catalog/rules/powershell/PSAvoidGlobalVars.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidGlobalVars",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidGlobalVars",
+  "title": "No Global Variables",
+  "description": "Checks that global variables are not used. Global variables are strongly discouraged as they can cause errors across different systems.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidglobalvars"
+}

Analysis/Catalog/rules/powershell/PSAvoidInvokingEmptyMembers.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidInvokingEmptyMembers",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidInvokingEmptyMembers",
+  "title": "Avoid Invoking Empty Members",
+  "description": "Invoking non-constant members would cause potential bugs. Please double check the syntax to make sure members invoked are non-constant.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidinvokingemptymembers"
+}

Analysis/Catalog/rules/powershell/PSAvoidLongLines.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidLongLines",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidLongLines",
+  "title": "Avoid long lines",
+  "description": "Line lengths should be less than the configured maximum.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidlonglines"
+}

Analysis/Catalog/rules/powershell/PSAvoidMultipleTypeAttributes.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidMultipleTypeAttributes",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidMultipleTypeAttributes",
+  "title": "Avoid multiple type specifiers on parameters",
+  "description": "Parameter should not have more than one type specifier.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidmultipletypeattributes"
+}

Analysis/Catalog/rules/powershell/PSAvoidNullOrEmptyHelpMessageAttribute.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidNullOrEmptyHelpMessageAttribute",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidNullOrEmptyHelpMessageAttribute",
+  "title": "Avoid using null or empty HelpMessage parameter attribute.",
+  "description": "Setting the HelpMessage attribute to an empty string or null value causes PowerShell interpreter to throw an error while executing the corresponding function.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidnulloremptyhelpmessageattribute"
+}

Analysis/Catalog/rules/powershell/PSAvoidOverwritingBuiltInCmdlets.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidOverwritingBuiltInCmdlets",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidOverwritingBuiltInCmdlets",
+  "title": "Avoid overwriting built in cmdlets",
+  "description": "Do not overwrite the definition of a cmdlet that is included with PowerShell.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidoverwritingbuiltincmdlets"
+}

Analysis/Catalog/rules/powershell/PSAvoidSemicolonsAsLineTerminators.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidSemicolonsAsLineTerminators",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidSemicolonsAsLineTerminators",
+  "title": "Avoid semicolons as line terminators",
+  "description": "Line should not end with a semicolon.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidsemicolonsaslineterminators"
+}

Analysis/Catalog/rules/powershell/PSAvoidShouldContinueWithoutForce.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidShouldContinueWithoutForce",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidShouldContinueWithoutForce",
+  "title": "Avoid Using ShouldContinue Without Boolean Force Parameter",
+  "description": "Functions that use ShouldContinue should have a boolean force parameter to allow user to bypass it.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidshouldcontinuewithoutforce"
+}

Analysis/Catalog/rules/powershell/PSAvoidTrailingWhitespace.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidTrailingWhitespace",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidTrailingWhitespace",
+  "title": "Avoid trailing whitespace",
+  "description": "Each line should have no trailing whitespace.",
+  "category": "BestPractices",
+  "defaultSeverity": "info",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidtrailingwhitespace"
+}

Analysis/Catalog/rules/powershell/PSAvoidUsingAllowUnencryptedAuthentication.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidUsingAllowUnencryptedAuthentication",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidUsingAllowUnencryptedAuthentication",
+  "title": "Avoid AllowUnencryptedAuthentication Switch",
+  "description": "Avoid sending credentials and secrets over unencrypted connections.",
+  "category": "Security",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "security"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidusingallowunencryptedauthentication"
+}

Analysis/Catalog/rules/powershell/PSAvoidUsingBrokenHashAlgorithms.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidUsingBrokenHashAlgorithms",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidUsingBrokenHashAlgorithms",
+  "title": "Avoid Using Broken Hash Algorithms",
+  "description": "Avoid using the broken algorithms MD5 or SHA-1.",
+  "category": "Security",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "security"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidusingbrokenhashalgorithms"
+}

Analysis/Catalog/rules/powershell/PSAvoidUsingCmdletAliases.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidUsingCmdletAliases",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidUsingCmdletAliases",
+  "title": "Avoid Using Cmdlet Aliases or omitting the 'Get-' prefix.",
+  "description": "An alias is an alternate name or nickname for a cmdlet or for a command element, such as a function, script, file, or executable file. An implicit alias is also the omission of the 'Get-' prefix for commands with this prefix. But when writing scripts that will potentially need to be maintained over time, either by the original author or another Windows PowerShell scripter, please consider using full cmdlet name instead of alias. Aliases can introduce these problems, readability, understandability and availability.",
+  "category": "BestPractices",
+  "defaultSeverity": "warning",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidusingcmdletaliases"
+}

Analysis/Catalog/rules/powershell/PSAvoidUsingComputerNameHardcoded.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidUsingComputerNameHardcoded",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidUsingComputerNameHardcoded",
+  "title": "Avoid Using ComputerName Hardcoded",
+  "description": "The ComputerName parameter of a cmdlet should not be hardcoded as this will expose sensitive information about the system.",
+  "category": "BestPractices",
+  "defaultSeverity": "error",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "best-practices"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidusingcomputernamehardcoded"
+}

Analysis/Catalog/rules/powershell/PSAvoidUsingConvertToSecureStringWithPlainText.json

@@ -0,0 +1,16 @@
+{
+  "id": "PSAvoidUsingConvertToSecureStringWithPlainText",
+  "language": "powershell",
+  "tool": "PSScriptAnalyzer",
+  "toolRuleId": "PSAvoidUsingConvertToSecureStringWithPlainText",
+  "title": "Avoid Using SecureString With Plain Text",
+  "description": "Using ConvertTo-SecureString with plain text will expose secure information.",
+  "category": "Security",
+  "defaultSeverity": "error",
+  "tags": [
+    "powershell",
+    "psscriptanalyzer",
+    "security"
+  ],
+  "docs": "https://learn.microsoft.com/powershell/utility-modules/psscriptanalyzer/rules/avoidusingconverttosecurestringwithplaintext"
+}