[BREAKING CHANGE] Enable various analyzer rules (#2006)

* Enable various analyzer rules

* Update lib/PuppeteerSharp/BrowserFetcherOptions.cs

* Update lib/PuppeteerSharp/LauncherBase.cs

* Document tasks

* Move DefaultArgs property

Co-authored-by: Darío Kondratiuk <[email protected]>

Author: tbaslyk

lib/PuppeteerSharp.Tests/OOPIFTests/OOPIFTests.cs

@@ -350,6 +350,6 @@ public async Task ShouldSupportLazyOopframes()
             Assert.Single(Page.Frames.Where(frame => !frame.HasStartedLoading));
         }
 
-        private IEnumerable<Target> Oopifs => Context.Targets().Where(target => target.TargetInfo.Type == TargetType.iFrame);
+        private IEnumerable<Target> Oopifs => Context.Targets().Where(target => target.TargetInfo.Type == TargetType.IFrame);
     }
 }

lib/PuppeteerSharp.ruleset

@@ -19,26 +19,26 @@
     <Rule Id="SA1210" Action="Error" /> <!-- Error SA1210: Using directives should be ordered alphabetically by the namespaces. (SA1210)-->
     <Rule Id="SA1208" Action="Error" /> <!-- Error SA1208: Order usings-->
     <Rule Id="SA1204" Action="None" /> <!-- Error SA1204: Static members should appear before non-static members (SA1204)-->
-    <Rule Id="SA1004" Action="None" /> <!-- Error SA1004: Documentation line should begin with a space. (SA1004)-->
+    <Rule Id="SA1004" Action="Error" /> <!-- Error SA1004: Documentation line should begin with a space. (SA1004)-->
     <Rule Id="SA1513" Action="None" /> <!-- Error SA1513: Closing brace should be followed by blank line (SA1513)-->
     <Rule Id="SA1124" Action="Error" /> <!-- Error SA1124: Don't use regions-->
     <Rule Id="SA1009" Action="Error" /> <!-- Error SA1009: Closing parenthesis should not be preceded by a space. (SA1009)-->
     <Rule Id="SA1413" Action="None" /> <!-- Error SA1413: Use trailing comma in multi-line initializers (SA1413)-->
     <Rule Id="SA1602" Action="None" /> <!-- Error SA1602: Enumeration items should be documented (SA1602)-->
     <Rule Id="SA1005" Action="Error" /> <!-- Error SA1005: Single line comment should begin with a space. (SA1005)-->
-    <Rule Id="SA1203" Action="None" /> <!-- Error SA1203: Constant fields should appear before non-constant fields (SA1203)-->
-    <Rule Id="SA1720" Action="None" /> <!-- Error SA1720: Name contains type-->
-    <Rule Id="SA1300" Action="None" /> <!-- Error SA1300: Element 'iFrame' should begin with an uppercase letter (SA1300)-->
-    <Rule Id="SA1500" Action="None" /> <!-- Error SA1500: Braces for multi-line statements should not share line (SA1500)-->
+    <Rule Id="SA1203" Action="Error" /> <!-- Error SA1203: Constant fields should appear before non-constant fields (SA1203)-->
+    <Rule Id="SA1720" Action="Error" /> <!-- Error SA1720: Name contains type-->
+    <Rule Id="SA1300" Action="Error" /> <!-- Error SA1300: Element 'iFrame' should begin with an uppercase letter (SA1300)-->
+    <Rule Id="SA1500" Action="Error" /> <!-- Error SA1500: Braces for multi-line statements should not share line (SA1500)-->
     <Rule Id="SA1214" Action="Error" /> <!-- Error SA1214: Readonly fields should appear before non-readonly fields (SA1214)-->
-    <Rule Id="SA1642" Action="None" /> <!-- Error SA1642: Constructor summary documentation should begin with standard text (SA1642) (PuppeteerSharp)-->
+    <Rule Id="SA1642" Action="Error" /> <!-- Error SA1642: Constructor summary documentation should begin with standard text (SA1642) (PuppeteerSharp)-->
     <Rule Id="SA1013" Action="Error" /> <!-- Error SA1013: Closing brace should be preceded by a space. (SA1013) -->
     <Rule Id="SA1515" Action="Error" /> <!-- Error SA1515: Single-line comment should be preceded by blank line (SA1515) -->
     <Rule Id="SA1518" Action="None" /> <!-- Error SA1518: File is required to end with a single newline character (SA1518)-->
     <Rule Id="SA1012" Action="Error" /> <!-- Error SA1012: Opening brace should be followed by a space. (SA1012) -->
-    <Rule Id="SA1512" Action="None" /> <!-- Error SA1502: Element should not be on a single line (SA1502) -->
+    <Rule Id="SA1512" Action="Error" /> <!-- Error SA1502: Element should not be on a single line (SA1502) -->
     <Rule Id="SA1648" Action="None" /> <!-- Error SA1648: inheritdoc should be used with inheriting class (SA1648) -->
-    <Rule Id="SA1616" Action="None" /> <!-- Error SA1616: Element return value documentation should have text (SA1616)-->
+    <Rule Id="SA1616" Action="Error" /> <!-- Error SA1616: Element return value documentation should have text (SA1616)-->
     <Rule Id="SA1627" Action="Error" /> <!-- Error SA1627: The documentation text within the \'exception\' tag should not be empty. (SA1627)-->
     <Rule Id="SA1643" Action="Error" /> <!-- Error SA1643: Destructor summary documentation should begin with standard text (SA1643) -->
     <Rule Id="SA1614" Action="Error" /> <!-- Error SA1614: Element parameter documentation should have text (SA1614)-->

lib/PuppeteerSharp/BoundingBox.cs

@@ -10,7 +10,7 @@ namespace PuppeteerSharp
     public class BoundingBox : IEquatable<BoundingBox>
     {
         /// <summary>
-        /// Initializes a new instance of the <see cref="T:PuppeteerSharp.BoundingBox"/> class.
+        /// Initializes a new instance of the <see cref="BoundingBox"/> class.
         /// </summary>
         public BoundingBox()
         {

lib/PuppeteerSharp/Browser.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Concurrent;
 using System.Collections.Generic;
 using System.Diagnostics;

lib/PuppeteerSharp/BrowserFetcherOptions.cs

@@ -13,7 +13,7 @@ public class BrowserFetcherOptions
         /// </summary>
         /// <param name="address">address</param>
         /// <param name="fileName">fileName</param>
-        /// <returns></returns>
+        /// <returns>A Task that resolves when the download finishes.</returns>
         public delegate Task CustomFileDownloadAction(string address, string fileName);
 
         /// <summary>

lib/PuppeteerSharp/CDPSession.cs

@@ -162,7 +162,7 @@ public async Task<JObject> SendAsync(string method, object args = null, bool wai
         /// <summary>
         /// Detaches session from target. Once detached, session won't emit any events and can't be used to send messages.
         /// </summary>
-        /// <returns></returns>
+        /// <returns>Task</returns>
         /// <exception cref="T:PuppeteerSharp.PuppeteerException">If the <see cref="Connection"/> is closed.</exception>
         public Task DetachAsync()
         {

lib/PuppeteerSharp/ChromiumLauncher.cs

@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Linq;
-using Microsoft.Extensions.Logging;
 using PuppeteerSharp.Helpers;
 
 namespace PuppeteerSharp
@@ -13,7 +12,27 @@ namespace PuppeteerSharp
     /// </summary>
     public class ChromiumLauncher : LauncherBase
     {
-        internal static readonly string[] DefaultArgs = {
+        private const string UserDataDirArgument = "--user-data-dir";
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ChromiumLauncher"/> class.
+        /// </summary>
+        /// <param name="executable">Full path of executable.</param>
+        /// <param name="options">Options for launching Chromium.</param>
+        public ChromiumLauncher(string executable, LaunchOptions options)
+            : base(executable, options)
+        {
+            List<string> chromiumArgs;
+            (chromiumArgs, TempUserDataDir) = PrepareChromiumArgs(options);
+
+            Process.StartInfo.Arguments = string.Join(" ", chromiumArgs);
+        }
+
+        /// <summary>
+        /// The default flags that Chromium will be launched with.
+        /// </summary>
+        internal static string[] DefaultArgs { get; } =
+        {
             "--disable-background-networking",
             "--enable-features=NetworkService,NetworkServiceInProcess",
             "--disable-background-timer-throttling",
@@ -40,22 +59,6 @@ public class ChromiumLauncher : LauncherBase
             "--enable-blink-features=IdleDetection",
         };
 
-        private const string UserDataDirArgument = "--user-data-dir";
-
-        /// <summary>
-        /// Creates a new <see cref="ChromiumLauncher"/> instance.
-        /// </summary>
-        /// <param name="executable">Full path of executable.</param>
-        /// <param name="options">Options for launching Chromium.</param>
-        public ChromiumLauncher(string executable, LaunchOptions options)
-            : base(executable, options)
-        {
-            List<string> chromiumArgs;
-            (chromiumArgs, TempUserDataDir) = PrepareChromiumArgs(options);
-
-            Process.StartInfo.Arguments = string.Join(" ", chromiumArgs);
-        }
-
         /// <inheritdoc />
         public override string ToString() => $"Chromium process; EndPoint={EndPoint}; State={CurrentState}";
 
@@ -109,7 +112,8 @@ internal static string[] GetDefaultArgs(LaunchOptions options)
 
             if (options.Headless)
             {
-                chromiumArguments.AddRange(new[] {
+                chromiumArguments.AddRange(new[]
+                {
                     "--headless",
                     "--hide-scrollbars",
                     "--mute-audio"

lib/PuppeteerSharp/ChromiumProcessException.cs

@@ -18,15 +18,15 @@ public ChromiumProcessException()
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ProcessException"/> class.
+        /// Initializes a new instance of the <see cref="ChromiumProcessException"/> class.
         /// </summary>
         /// <param name="message">Message.</param>
         public ChromiumProcessException(string message) : base(message)
         {
         }
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ProcessException"/> class.
+        /// Initializes a new instance of the <see cref="ChromiumProcessException"/> class.
         /// </summary>
         /// <param name="message">Message.</param>
         /// <param name="innerException">Inner exception.</param>

lib/PuppeteerSharp/Dialog.cs

@@ -9,8 +9,8 @@ namespace PuppeteerSharp
     /// </summary>
     /// <example>
     /// An example of using Dialog class:
-    ///<code>
-    ///<![CDATA[
+    /// <code>
+    /// <![CDATA[
     /// Page.Dialog += async (sender, e) =>
     /// {
     ///     await e.Dialog.Accept();

lib/PuppeteerSharp/ElementHandle.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
@@ -363,7 +363,7 @@ public async Task TypeAsync(string text, TypeOptions options = null)
         /// <remarks>
         /// If <c>key</c> is a single character and no modifier keys besides <c>Shift</c> are being held down, a <c>keypress</c>/<c>input</c> event will also be generated. The <see cref="DownOptions.Text"/> option can be specified to force an input event to be generated.
         /// </remarks>
-        /// <returns></returns>
+        /// <returns>Task which resolves when the key is successfully pressed</returns>
         public async Task PressAsync(string key, PressOptions options = null)
         {
             await FocusAsync().ConfigureAwait(false);
@@ -475,7 +475,7 @@ public async Task<BoxModel> BoxModelAsync()
         }
 
         /// <summary>
-        ///Content frame for element handles referencing iframe nodes, or null otherwise.
+        /// Content frame for element handles referencing iframe nodes, or null otherwise.
         /// </summary>
         /// <returns>Resolves to the content frame</returns>
         public async Task<Frame> ContentFrameAsync()
@@ -686,7 +686,8 @@ public async Task<BoxModelPoint> ClickablePointAsync(BoxModelPoint? offset = nul
                 // Return the point of the first quad identified by offset.
                 var minX = decimal.MaxValue;
                 var minY = decimal.MaxValue;
-                foreach (var point in quad) {
+                foreach (var point in quad)
+                {
                     if (point.X < minX)
                     {
                         minX = point.X;
@@ -700,10 +701,11 @@ public async Task<BoxModelPoint> ClickablePointAsync(BoxModelPoint? offset = nul
                   minX != decimal.MaxValue &&
                   minY != decimal.MaxValue)
                 {
-                    return new BoxModelPoint() {
+                    return new BoxModelPoint()
+                    {
                         X = minX + offset.Value.X,
                         Y = minY + offset.Value.Y
-                     };
+                    };
                 }
             }
             var x = 0m;
@@ -715,7 +717,8 @@ public async Task<BoxModelPoint> ClickablePointAsync(BoxModelPoint? offset = nul
                 y += point.Y;
             }
 
-            return new BoxModelPoint() {
+            return new BoxModelPoint()
+            {
                 X = x / 4,
                 Y = y / 4
             };