Remove dead code and simplify (#1856)

bergmeister · web-flow · commit bd79460c3d2d · 2023-09-11T13:07:38.000-07:00
* Remove unused variables

* simplify code and remove unused method

* remove unused member

* more cleanup

* more cleanup

* more

* more
diff --git a/Engine/CommandInfoCache.cs b/Engine/CommandInfoCache.cs
@@ -15,17 +15,15 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer
     internal class CommandInfoCache : IDisposable
     {
         private readonly ConcurrentDictionary<CommandLookupKey, Lazy<CommandInfo>> _commandInfoCache;
-        private readonly Helper _helperInstance;
         private readonly RunspacePool _runspacePool;
         private bool disposed = false;
 
         /// <summary>
         /// Create a fresh command info cache instance.
         /// </summary>
-        public CommandInfoCache(Helper pssaHelperInstance)
+        public CommandInfoCache()
         {
             _commandInfoCache = new ConcurrentDictionary<CommandLookupKey, Lazy<CommandInfo>>();
-            _helperInstance = pssaHelperInstance;
             _runspacePool = RunspaceFactory.CreateRunspacePool(1, 10);
             _runspacePool.Open();
         }
diff --git a/Engine/Commands/GetScriptAnalyzerRuleCommand.cs b/Engine/Commands/GetScriptAnalyzerRuleCommand.cs
@@ -84,13 +84,12 @@ protected override void BeginProcessing()
 
             // Initialize helper
             Helper.Instance = new Helper(
-                SessionState.InvokeCommand,
-                this);
+                SessionState.InvokeCommand);
             Helper.Instance.Initialize();
 
             string[] rulePaths = Helper.ProcessCustomRulePaths(customRulePath,
                 this.SessionState, recurseCustomRulePath);
-            ScriptAnalyzer.Instance.Initialize(this, rulePaths, null, null, null, null == rulePaths ? true : false);
+            ScriptAnalyzer.Instance.Initialize(this, rulePaths, null, null, null, null == rulePaths);
         }
 
         /// <summary>
diff --git a/Engine/Commands/InvokeFormatterCommand.cs b/Engine/Commands/InvokeFormatterCommand.cs
@@ -124,11 +124,5 @@ protected override void StopProcessing()
             ScriptAnalyzer.Instance.CleanUp();
             base.StopProcessing();
         }
-
-        private void ValidateInputSettings()
-        {
-            // todo implement this
-            return;
-        }
     }
 }
diff --git a/Engine/Commands/InvokeScriptAnalyzerCommand.cs b/Engine/Commands/InvokeScriptAnalyzerCommand.cs
@@ -285,8 +285,7 @@ protected override void BeginProcessing()
             }
 #endif
             Helper.Instance = new Helper(
-                SessionState.InvokeCommand,
-                this);
+                SessionState.InvokeCommand);
             Helper.Instance.Initialize();
 
             var psVersionTable = this.SessionState.PSVariable.GetValue("PSVersionTable") as Hashtable;
diff --git a/Engine/Formatter.cs b/Engine/Formatter.cs
@@ -32,7 +32,7 @@ public static string Format<TCmdlet>(
             ValidateNotNull(settings, "settings");
             ValidateNotNull(cmdlet, "cmdlet");
 
-            Helper.Instance = new Helper(cmdlet.SessionState.InvokeCommand, cmdlet);
+            Helper.Instance = new Helper(cmdlet.SessionState.InvokeCommand);
             Helper.Instance.Initialize();
 
             var ruleOrder = new string[]
diff --git a/Engine/Generic/ModuleDependencyHandler.cs b/Engine/Generic/ModuleDependencyHandler.cs
@@ -22,7 +22,6 @@ public class ModuleDependencyHandler : IDisposable
         private string moduleRepository;
         private string tempPath; // path to the user temporary directory 
         private string tempModulePath; // path to temp directory containing modules
-        Dictionary<string, PSObject> modulesFound;
         private string localAppdataPath;
         private string pssaAppDataPath;
         private const string symLinkName = "TempModuleDir";
@@ -271,8 +270,6 @@ public ModuleDependencyHandler(
                         ? "PSScriptAnalyzer"
                         : pssaAppDataPath);
 
-            modulesFound = new Dictionary<string, PSObject>(StringComparer.OrdinalIgnoreCase);            
-
             // TODO Add PSSA Version in the path
             symLinkPath = Path.Combine(pssaAppDataPath, symLinkName);
             SetupPSSAAppData();
diff --git a/Engine/Helper.cs b/Engine/Helper.cs
@@ -24,7 +24,6 @@ public class Helper
         #region Private members
 
         private CommandInvocationIntrinsics invokeCommand;
-        private IOutputWriter outputWriter;
         private readonly static Version minSupportedPSVersion = new Version(3, 0);
         private Dictionary<string, Dictionary<string, object>> ruleArguments;
         private PSVersionTable psVersionTable;
@@ -115,7 +114,7 @@ internal set
         /// </summary>
         private Helper()
         {
-            _commandInfoCacheLazy = new Lazy<CommandInfoCache>(() => new CommandInfoCache(pssaHelperInstance: this));
+            _commandInfoCacheLazy = new Lazy<CommandInfoCache>(() => new CommandInfoCache());
         }
 
         /// <summary>
@@ -125,16 +124,11 @@ private Helper()
         /// A CommandInvocationIntrinsics instance for use in gathering
         /// information about available commands and aliases.
         /// </param>
-        /// <param name="outputWriter">
-        /// An IOutputWriter instance for use in writing output
-        /// to the PowerShell environment.
-        /// </param>
         public Helper(
-            CommandInvocationIntrinsics invokeCommand,
-            IOutputWriter outputWriter) : this()
+            CommandInvocationIntrinsics invokeCommand
+            ): this()
         {
             this.invokeCommand = invokeCommand;
-            this.outputWriter = outputWriter;
         }
 
         #region Methods
diff --git a/Engine/ScriptAnalyzer.cs b/Engine/ScriptAnalyzer.cs
@@ -168,8 +168,7 @@ public void Initialize(
 
             //initialize helper
             Helper.Instance = new Helper(
-                runspace.SessionStateProxy.InvokeCommand,
-                outputWriter);
+                runspace.SessionStateProxy.InvokeCommand);
             Helper.Instance.Initialize();
 
             SuppressionPreference suppressionPreference = suppressedOnly
diff --git a/Engine/Settings.cs b/Engine/Settings.cs
@@ -285,17 +285,6 @@ private Dictionary<string, object> GetDictionaryFromHashtable(Hashtable hashtabl
             return dictionary;
         }
 
-        private bool IsStringOrStringArray(object val)
-        {
-            if (val is string)
-            {
-                return true;
-            }
-
-            var valArr = val as object[];
-            return val == null ? false : valArr.All(x => x is string);
-        }
-
         private List<string> GetData(object val, string key)
         {
             // value must be either string or or an array of strings
diff --git a/PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Collection/PlatformInformationCollector.cs b/PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Collection/PlatformInformationCollector.cs
@@ -351,18 +351,6 @@ private Architecture GetOSArchitecture()
 #endif
         }
 
-        private DotnetRuntime GetDotnetRuntime()
-        {
-#if CoreCLR
-            // Our CoreCLR is actuall .NET Standard, so we could be loaded into net47
-            return RuntimeInformation.FrameworkDescription.StartsWith(".NET Core")
-                ? DotnetRuntime.Core
-                : DotnetRuntime.Framework;
-#else
-            return DotnetRuntime.Framework;
-#endif
-        }
-
         /// <summary>
         /// Get the Windows SKU ID of the current PowerShell session.
         /// </summary>
diff --git a/PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Commands/CommandUtilities.cs b/PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Commands/CommandUtilities.cs
@@ -13,8 +13,6 @@ namespace Microsoft.PowerShell.CrossCompatibility.Commands
     /// </summary>
     internal static class CommandUtilities
     {
-        private const string COMPATIBILITY_ERROR_ID = "CompatibilityAnalysisError";
-
         public const string MODULE_PREFIX = "PSCompatibility";
 
         /// <summary>
diff --git a/Rules/AvoidUserNameAndPasswordParams.cs b/Rules/AvoidUserNameAndPasswordParams.cs
@@ -86,7 +86,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
                 {
                     yield return new DiagnosticRecord(
                         String.Format(CultureInfo.CurrentCulture, Strings.AvoidUsernameAndPasswordParamsError, funcAst.Name),
-                        GetExtent(usernameAst, passwordAst, ast), GetName(), DiagnosticSeverity.Error, fileName);
+                        GetExtent(usernameAst, passwordAst), GetName(), DiagnosticSeverity.Error, fileName);
                 }
             }
         }
@@ -111,7 +111,7 @@ private bool IsAttributeOfType(AttributeBaseAst attributeAst, Type type)
         /// <param name="usernameAst"></param>
         /// <param name="passwordAst"></param>
         /// <returns>IScriptExtent</returns>
-        private IScriptExtent GetExtent(ParameterAst usernameAst, ParameterAst passwordAst, Ast scriptAst)
+        private IScriptExtent GetExtent(ParameterAst usernameAst, ParameterAst passwordAst)
         {
             var usrExt = usernameAst.Extent;
             var pwdExt = passwordAst.Extent;
diff --git a/Rules/AvoidUsingDeprecatedManifestFields.cs b/Rules/AvoidUsingDeprecatedManifestFields.cs
@@ -70,10 +70,9 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
 
                                 if (value != null)
                                 {
-                                    Version psVersion = null;
 
                                     // get the version
-                                    if (Version.TryParse((value as StringConstantExpressionAst).Value, out psVersion))
+                                    if (Version.TryParse((value as StringConstantExpressionAst).Value, out Version psVersion))
                                     {
                                         // if version exists and version less than 3, don't raise rule
                                         if (psVersion.Major < 3)
diff --git a/Rules/CompatibilityRules/UseCompatibleCommands.cs b/Rules/CompatibilityRules/UseCompatibleCommands.cs
@@ -263,8 +263,7 @@ public static CommandCompatibilityDiagnostic CreateForParameter(
             PlatformData platform,
             IScriptExtent extent,
             string analyzedFileName,
-            IRule rule,
-            IEnumerable<CorrectionExtent> suggestedCorrections = null)
+            IRule rule)
         {
             string message = string.Format(
                 CultureInfo.CurrentCulture,
diff --git a/Rules/UseConsistentIndentation.cs b/Rules/UseConsistentIndentation.cs
@@ -563,11 +563,6 @@ private static int ClipNegative(int x)
             return x > 0 ? x : 0;
         }
 
-        private int GetIndentationColumnNumber(int indentationLevel)
-        {
-            return GetIndentation(indentationLevel) + 1;
-        }
-
         private int GetIndentation(int indentationLevel)
         {
             // todo if condition can be evaluated during rule configuration
diff --git a/Rules/UseIdenticalMandatoryParametersDSC.cs b/Rules/UseIdenticalMandatoryParametersDSC.cs
@@ -32,7 +32,6 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
     public class UseIdenticalMandatoryParametersDSC : IDSCResourceRule
     {
         private bool isDSCClassCacheInitialized = false;
-        private Ast ast;
         private string fileName;
         private IDictionary<string, string> propAttrDict;
         private IEnumerable<FunctionDefinitionAst> resourceFunctions;
@@ -94,7 +93,6 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName
             }
 
             // Get the keys in the corresponding mof file
-            this.ast = ast;
             this.fileName = fileName;
             this.propAttrDict = GetKeys(fileName);
             this.resourceFunctions = Helper.Instance.DscResourceFunctions(ast)
diff --git a/Rules/UseToExportFieldsInManifest.cs b/Rules/UseToExportFieldsInManifest.cs
@@ -69,7 +69,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
             foreach(string field in manifestFields)
             {
                 IScriptExtent extent;
-                if (!HasAcceptableExportField(field, hashtableAst, ast.Extent.Text, out extent) && extent != null)
+                if (!HasAcceptableExportField(field, hashtableAst, out extent) && extent != null)
                 {
                     yield return new DiagnosticRecord(
                         GetError(field), 
@@ -200,10 +200,9 @@ private bool HasNullInExpression(Ast ast)
         /// </summary>
         /// <param name="key"></param>
         /// <param name="hast"></param>
-        /// <param name="scriptText"></param>
         /// <param name="extent"></param>
         /// <returns>A boolean value indicating if the the ToExport fields are explicitly set to arrays or not.</returns>
-        private bool HasAcceptableExportField(string key, HashtableAst hast, string scriptText, out IScriptExtent extent)
+        private bool HasAcceptableExportField(string key, HashtableAst hast, out IScriptExtent extent)
         {
             extent = null;
             foreach (var pair in hast.KeyValuePairs)

Original file line number	Diff line number	Diff line change
`@@ -15,17 +15,15 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer`
`15`	`15`	`internal class CommandInfoCache : IDisposable`
`16`	`16`	`{`
`17`	`17`	`private readonly ConcurrentDictionary<CommandLookupKey, Lazy<CommandInfo>> _commandInfoCache;`
`18`		`- private readonly Helper _helperInstance;`
`19`	`18`	`private readonly RunspacePool _runspacePool;`
`20`	`19`	`private bool disposed = false;`
`21`	`20`
`22`	`21`	`/// <summary>`
`23`	`22`	`/// Create a fresh command info cache instance.`
`24`	`23`	`/// </summary>`
`25`		`- public CommandInfoCache(Helper pssaHelperInstance)`
	`24`	`+ public CommandInfoCache()`
`26`	`25`	`{`
`27`	`26`	`_commandInfoCache = new ConcurrentDictionary<CommandLookupKey, Lazy<CommandInfo>>();`
`28`		`- _helperInstance = pssaHelperInstance;`
`29`	`27`	`_runspacePool = RunspaceFactory.CreateRunspacePool(1, 10);`
`30`	`28`	`_runspacePool.Open();`
`31`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,11 +124,5 @@ protected override void StopProcessing()`
`124`	`124`	`ScriptAnalyzer.Instance.CleanUp();`
`125`	`125`	`base.StopProcessing();`
`126`	`126`	`}`
`127`		`-`
`128`		`- private void ValidateInputSettings()`
`129`		`- {`
`130`		`- // todo implement this`
`131`		`- return;`
`132`		`- }`
`133`	`127`	`}`
`134`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -285,8 +285,7 @@ protected override void BeginProcessing()`
`285`	`285`	`}`
`286`	`286`	`#endif`
`287`	`287`	`Helper.Instance = new Helper(`
`288`		`- SessionState.InvokeCommand,`
`289`		`- this);`
	`288`	`+ SessionState.InvokeCommand);`
`290`	`289`	`Helper.Instance.Initialize();`
`291`	`290`
`292`	`291`	`var psVersionTable = this.SessionState.PSVariable.GetValue("PSVersionTable") as Hashtable;`
Original file line number	Diff line number	Diff line change
`@@ -13,8 +13,6 @@ namespace Microsoft.PowerShell.CrossCompatibility.Commands`
`13`	`13`	`/// </summary>`
`14`	`14`	`internal static class CommandUtilities`
`15`	`15`	`{`
`16`		`- private const string COMPATIBILITY_ERROR_ID = "CompatibilityAnalysisError";`
`17`		`-`
`18`	`16`	`public const string MODULE_PREFIX = "PSCompatibility";`
`19`	`17`
`20`	`18`	`/// <summary>`
Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)`
`86`	`86`	`{`
`87`	`87`	`yield return new DiagnosticRecord(`
`88`	`88`	`String.Format(CultureInfo.CurrentCulture, Strings.AvoidUsernameAndPasswordParamsError, funcAst.Name),`
`89`		`- GetExtent(usernameAst, passwordAst, ast), GetName(), DiagnosticSeverity.Error, fileName);`
	`89`	`+ GetExtent(usernameAst, passwordAst), GetName(), DiagnosticSeverity.Error, fileName);`
`90`	`90`	`}`
`91`	`91`	`}`
`92`	`92`	`}`
`@@ -111,7 +111,7 @@ private bool IsAttributeOfType(AttributeBaseAst attributeAst, Type type)`
`111`	`111`	`/// <param name="usernameAst"></param>`
`112`	`112`	`/// <param name="passwordAst"></param>`
`113`	`113`	`/// <returns>IScriptExtent</returns>`
`114`		`- private IScriptExtent GetExtent(ParameterAst usernameAst, ParameterAst passwordAst, Ast scriptAst)`
	`114`	`+ private IScriptExtent GetExtent(ParameterAst usernameAst, ParameterAst passwordAst)`
`115`	`115`	`{`
`116`	`116`	`var usrExt = usernameAst.Extent;`
`117`	`117`	`var pwdExt = passwordAst.Extent;`
Original file line number	Diff line number	Diff line change
`@@ -70,10 +70,9 @@ public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)`
`70`	`70`
`71`	`71`	`if (value != null)`
`72`	`72`	`{`
`73`		`- Version psVersion = null;`
`74`	`73`
`75`	`74`	`// get the version`
`76`		`- if (Version.TryParse((value as StringConstantExpressionAst).Value, out psVersion))`
	`75`	`+ if (Version.TryParse((value as StringConstantExpressionAst).Value, out Version psVersion))`
`77`	`76`	`{`
`78`	`77`	`// if version exists and version less than 3, don't raise rule`
`79`	`78`	`if (psVersion.Major < 3)`
Original file line number	Diff line number	Diff line change
`@@ -563,11 +563,6 @@ private static int ClipNegative(int x)`
`563`	`563`	`return x > 0 ? x : 0;`
`564`	`564`	`}`
`565`	`565`
`566`		`- private int GetIndentationColumnNumber(int indentationLevel)`
`567`		`- {`
`568`		`- return GetIndentation(indentationLevel) + 1;`
`569`		`- }`
`570`		`-`
`571`	`566`	`private int GetIndentation(int indentationLevel)`
`572`	`567`	`{`
`573`	`568`	`// todo if condition can be evaluated during rule configuration`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,6 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules`
`32`	`32`	`public class UseIdenticalMandatoryParametersDSC : IDSCResourceRule`
`33`	`33`	`{`
`34`	`34`	`private bool isDSCClassCacheInitialized = false;`
`35`		`- private Ast ast;`
`36`	`35`	`private string fileName;`
`37`	`36`	`private IDictionary<string, string> propAttrDict;`
`38`	`37`	`private IEnumerable<FunctionDefinitionAst> resourceFunctions;`
`@@ -94,7 +93,6 @@ public IEnumerable<DiagnosticRecord> AnalyzeDSCResource(Ast ast, string fileName`
`94`	`93`	`}`
`95`	`94`
`96`	`95`	`// Get the keys in the corresponding mof file`
`97`		`- this.ast = ast;`
`98`	`96`	`this.fileName = fileName;`
`99`	`97`	`this.propAttrDict = GetKeys(fileName);`
`100`	`98`	`this.resourceFunctions = Helper.Instance.DscResourceFunctions(ast)`