search

diffix / explorer

Tool to automatically explore and generate stats on data anonymized using Diffix
MIT License
2 stars 1 forks source link

Let's not check in code producing warnings #240

Closed sebastian closed 4 years ago

sebastian commented 4 years ago

When starting explorer locally I get shown this wall of warnings:

JsonApi/Exceptions/ApiException.cs(4,18): warning CS1591: Missing XML comment for publicly visible type or member 'ApiException' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(6,16): warning CS1591: Missing XML comment for publicly visible type or member 'ApiException.ApiException()' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(7,16): warning CS1591: Missing XML comment for publicly visible type or member 'ApiException.ApiException(string)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(8,16): warning CS1591: Missing XML comment for publicly visible type or member 'ApiException.ApiException(string, Exception)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(9,19): warning CS1591: Missing XML comment for publicly visible type or member 'ApiException.ApiException(SerializationInfo, StreamingContext)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(4,18): warning CS1591: Missing XML comment for publicly visible type or member 'QueryException' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(6,16): warning CS1591: Missing XML comment for publicly visible type or member 'QueryException.QueryException()' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(7,16): warning CS1591: Missing XML comment for publicly visible type or member 'QueryException.QueryException(string)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(8,16): warning CS1591: Missing XML comment for publicly visible type or member 'QueryException.QueryException(string, Exception)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(9,19): warning CS1591: Missing XML comment for publicly visible type or member 'QueryException.QueryException(SerializationInfo, StreamingContext)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(4,18): warning CS1591: Missing XML comment for publicly visible type or member 'ResultException' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(6,16): warning CS1591: Missing XML comment for publicly visible type or member 'ResultException.ResultException()' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(7,16): warning CS1591: Missing XML comment for publicly visible type or member 'ResultException.ResultException(string)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(8,16): warning CS1591: Missing XML comment for publicly visible type or member 'ResultException.ResultException(string, Exception)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(9,19): warning CS1591: Missing XML comment for publicly visible type or member 'ResultException.ResultException(SerializationInfo, StreamingContext)' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(7,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(8,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(9,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(7,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(8,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(9,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(7,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(8,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(9,1): warning SA1516: Elements should be separated by blank line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/JsonApiClient.cs(360,38): warning SA1204: Static members should appear before non-static members [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/JsonApiClient.cs(256,43): warning SA1202: 'public' members should come before 'private' members [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/ResponseTypes/IsolatorStatus.cs(23,23): warning SA1623: The property's documentation summary text should begin with: 'Gets' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/ResponseTypes/IsolatorStatus.cs(29,21): warning SA1623: The property's documentation summary text should begin with: 'Gets a value indicating whether' [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(6,34): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(7,64): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(7,48): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(8,95): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(8,72): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(11,90): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ResultException.cs(11,68): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(6,33): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(7,63): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(7,47): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(8,94): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(8,71): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(11,90): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/QueryException.cs(11,68): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(6,31): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(7,61): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(7,45): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(8,92): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(8,69): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(11,90): warning SA1502: Element should not be on a single line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/Exceptions/ApiException.cs(11,68): warning SA1128: Put constructor initializers on their own line [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/JsonApiClient.cs(86,99): warning SA1629: Documentation text should end with a period [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/JsonApiClient.cs(153,99): warning SA1629: Documentation text should end with a period [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
JsonApi/JsonConversion/IsolatorStatusConverter.cs(9,20): warning CA1812: IsolatorStatusConverter is an internal class that is apparently never instantiated. If so, remove the code from the assembly. If this class is intended to contain only static members, make it static (Shared in Visual Basic). [/Users/sebastian/work-projects/explorer/src/aircloak/aircloak.csproj]
Components/ExplorationInfo.cs(29,54): warning CS1998: This async method lacks 'await' operators and will run synchronously. Consider using the 'await' operator to await non-blocking API calls, or 'await Task.Run(...)' to do CPU-bound work on a background thread. [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Common/BucketUtils.cs(2,1): warning SA1505: An opening brace should not be followed by a blank line. [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Common/HistogramBucket.cs(3,19): warning CA1815: HistogramBucket should override Equals. [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Common/HistogramBucket.cs(3,19): warning CA1815: HistogramBucket should override the equality (==) and inequality (!=) operators. [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Metrics/UntypedMetric.cs(5,19): warning CA1815: UntypedMetric should override Equals. [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Metrics/UntypedMetric.cs(5,19): warning CA1815: UntypedMetric should override the equality (==) and inequality (!=) operators. [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Common/IndexedGroupingSetsResult.cs(26,25): warning CA1819: Properties should not return arrays [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Components/DistributionAnalysisComponent.cs(86,27): warning SA1201: A property should not follow a method [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Queries/SingleColumnHistogram.cs(38,26): warning CA1819: Properties should not return arrays [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
LamarExtensions.cs(14,1): warning SA1137: Elements should have the same indentation [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Components/TextGeneratorComponent.cs(65,1): warning SA1137: Elements should have the same indentation [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Components/TextGeneratorComponent.cs(66,1): warning SA1137: Elements should have the same indentation [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Components/CategoricalSampleGenerator.cs(18,45): warning CA1823: Unused field 'JsonNullElement'. [/Users/sebastian/work-projects/explorer/src/explorer/explorer.csproj]
Models/ExploreResult.cs(42,9): warning SA1515: Single-line comment should be preceded by blank line [/Users/sebastian/work-projects/explorer/src/explorer.api/explorer.api.csproj]
Models/ExploreParams.cs(14,23): warning CA1056: Change the type of property ExploreParams.ApiUrl from string to System.Uri. [/Users/sebastian/work-projects/explorer/src/explorer.api/explorer.api.csproj]
Models/ExploreParams.cs(30,36): warning CA2227: Change 'Columns' to be read-only by removing the property setter. [/Users/sebastian/work-projects/explorer/src/explorer.api/explorer.api.csproj]
Controllers/ExploreController.cs(99,17): warning CA1031: Modify 'Result' to catch a more specific allowed exception type, or rethrow the exception. [/Users/sebastian/work-projects/explorer/src/explorer.api/explorer.api.csproj]

Let's add a check on Travis/Github actions that rejects a pull-request if it compiles with warnings.