Support AllowLongFourSlashCommentLines for #8.

Support AllowLongUriLines in the XML schema (missed in 28e705a).
menees · Aug 6, 2022 · 594a754 · 594a754
1 parent 6fbf272
commit 594a754
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 3 deletions.
diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -22,7 +22,7 @@
 
 		<!-- Make the assembly, file, and NuGet package versions the same. -->
 		<!-- NOTE: Change the version in Vsix\source.extension.vsixmanifest to match this! -->
-		<Version>3.0.8</Version>
+		<Version>3.0.9</Version>
 	</PropertyGroup>
 
 	<PropertyGroup Condition="'$(Configuration)'=='Debug'">

diff --git a/src/Menees.Analyzers/Men002LineTooLong.cs b/src/Menees.Analyzers/Men002LineTooLong.cs
@@ -143,10 +143,13 @@ private void TryReport(
 			int thresholdIndex)
 		{
 			bool report = true;
-			if (this.Settings.AllowLongUriLines)
+
+			string? trimmed = null;
+			if (report && this.Settings.AllowLongUriLines)
 			{
 				// Ignore if the whole line minus comment delimiters passes Uri.TryCreate(absolute) (e.g., for http or UNC URLs).
-				string scrubbed = lineText.Trim();
+				trimmed ??= lineText.Trim();
+				string scrubbed = trimmed;
 				if (scrubbed.StartsWith("//"))
 				{
 					// Ignore multiple leading '/' in case the URL is inside a doc comment.
@@ -161,6 +164,12 @@ private void TryReport(
 				report = !Uri.TryCreate(scrubbed, UriKind.Absolute, out _);
 			}
 
+			if (report && this.Settings.AllowLongFourSlashCommentLines)
+			{
+				trimmed ??= lineText.Trim();
+				report = !trimmed.StartsWith("////");
+			}
+
 			if (report)
 			{
 				TextSpan excess = TextSpan.FromBounds(lineSpan.Start + thresholdIndex, lineSpan.End);

diff --git a/src/Menees.Analyzers/Menees.Analyzers.Settings.xsd b/src/Menees.Analyzers/Menees.Analyzers.Settings.xsd
@@ -16,6 +16,8 @@
 				<xs:element name="MaxPropertyAccessorLines" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/>
 				<xs:element name="MaxFileLines" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/>
 				<xs:element name="MaxUnregionedLines" type="xs:nonNegativeInteger" minOccurs="0" maxOccurs="1"/>
+				<xs:element name="AllowLongUriLines" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
+				<xs:element name="AllowLongFourSlashCommentLines" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
 
 				<xs:element name="AnalyzeFileNameExclusions" minOccurs="0" maxOccurs="1">
 					<xs:complexType>

diff --git a/src/Menees.Analyzers/Settings.cs b/src/Menees.Analyzers/Settings.cs
@@ -103,6 +103,7 @@ private Settings(XElement xml)
 			this.MaxFileLines = GetSetting(xml, nameof(this.MaxFileLines), this.MaxFileLines);
 			this.MaxUnregionedLines = GetSetting(xml, nameof(this.MaxUnregionedLines), this.MaxUnregionedLines);
 			this.AllowLongUriLines = GetSetting(xml, nameof(this.AllowLongUriLines), this.AllowLongUriLines);
+			this.AllowLongFourSlashCommentLines = GetSetting(xml, nameof(this.AllowLongFourSlashCommentLines), this.AllowLongFourSlashCommentLines);
 
 			this.analyzeFileNameExclusions = GetFileNameExclusions(xml, "AnalyzeFileNameExclusions", DefaultAnalyzeFileNameExclusions);
 			this.typeFileNameExclusions = GetFileNameExclusions(xml, "TypeFileNameExclusions", DefaultTypeFileNameExclusions);
@@ -190,6 +191,8 @@ private enum NumberBase
 
 		public bool AllowLongUriLines { get; } = true;
 
+		public bool AllowLongFourSlashCommentLines { get; }
+
 		#endregion
 
 		#region Public Methods

diff --git a/tests/Menees.Analyzers.Test/Men002UnitTests.cs b/tests/Menees.Analyzers.Test/Men002UnitTests.cs
@@ -27,6 +27,7 @@ class Testing
 		public Testing()
 		{
 			// LongUriLines=true
+			//// This is a long line preceded by four slashes. Setting AllowLongFourSlashCommentLines=true makes it valid.
 			// https://www.amazon.com/Brain-Games%C2%AE-Large-Print-Searches/dp/1640304606/ref=sr_1_2?crid=3KP7CV3HBJADN&keywords=big+long+search+text&qid=1645375366&sprefix=big+long+search+text%2Caps%2C72&sr=8-2
 			/// https://www.amazon.com/Brain-Games%C2%AE-Large-Print-Searches/dp/1640304606/ref=sr_1_2?crid=3KP7CV3HBJADN&keywords=big+long+search+text&qid=1645375366&sprefix=big+long+search+text%2Caps%2C72&sr=8-2
 			//// https://www.amazon.com/Brain-Games%C2%AE-Large-Print-Searches/dp/1640304606/ref=sr_1_2?crid=3KP7CV3HBJADN&keywords=big+long+search+text&qid=1645375366&sprefix=big+long+search+text%2Caps%2C72&sr=8-2

diff --git a/tests/Menees.Analyzers.Test/Menees.Analyzers.Settings.xml b/tests/Menees.Analyzers.Test/Menees.Analyzers.Settings.xml
@@ -10,6 +10,7 @@
 	<MaxPropertyAccessorLines>5</MaxPropertyAccessorLines>
 	<MaxFileLines>20</MaxFileLines>
 	<MaxUnregionedLines>20</MaxUnregionedLines>
+	<AllowLongFourSlashCommentLines>true</AllowLongFourSlashCommentLines>
 
 	<AnalyzeFileNameExclusions>
 		<FileName>Test21.cs</FileName>