From 8e7bf0b6f24d7daadf070a29cd170e4c861ab7a5 Mon Sep 17 00:00:00 2001 From: Boshi Lian Date: Wed, 22 Apr 2020 13:41:45 -0700 Subject: [PATCH] Stylecop (#428) * add auto generate header * run gen * introduce first style analyizer * fix tab --- Directory.Build.props | 6 ++++ Directory.Build.targets | 11 +++++++ .../IKubernetes.Watch.cs.template | 5 +++ .../Kubernetes.Watch.cs.template | 5 +++ .../ModelExtensions.cs.template | 5 +++ kubernetes-client.ruleset | 8 +++++ .../generated/IKubernetes.Watch.cs | 5 +++ .../generated/Kubernetes.Watch.cs | 5 +++ .../generated/ModelExtensions.cs | 5 +++ stylecop.json | 5 +++ .../Logging/TestOutputLogger.cs | 32 +++++++++---------- .../Logging/TestOutputLoggerProvider.cs | 6 ++-- 12 files changed, 79 insertions(+), 19 deletions(-) create mode 100644 Directory.Build.props create mode 100644 Directory.Build.targets create mode 100644 kubernetes-client.ruleset create mode 100644 stylecop.json diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 0000000..bfa551f --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,6 @@ + + + + $(MSBuildThisFileDirectory)\kubernetes-client.ruleset + + diff --git a/Directory.Build.targets b/Directory.Build.targets new file mode 100644 index 0000000..0c78449 --- /dev/null +++ b/Directory.Build.targets @@ -0,0 +1,11 @@ + + + + All + + + + All + + + diff --git a/gen/KubernetesWatchGenerator/IKubernetes.Watch.cs.template b/gen/KubernetesWatchGenerator/IKubernetes.Watch.cs.template index e174234..973d276 100644 --- a/gen/KubernetesWatchGenerator/IKubernetes.Watch.cs.template +++ b/gen/KubernetesWatchGenerator/IKubernetes.Watch.cs.template @@ -1,3 +1,8 @@ +// +// Code generated by gen/KubernetesWatchGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// using k8s.Models; using System; using System.Collections.Generic; diff --git a/gen/KubernetesWatchGenerator/Kubernetes.Watch.cs.template b/gen/KubernetesWatchGenerator/Kubernetes.Watch.cs.template index 6894b78..4beea20 100644 --- a/gen/KubernetesWatchGenerator/Kubernetes.Watch.cs.template +++ b/gen/KubernetesWatchGenerator/Kubernetes.Watch.cs.template @@ -1,3 +1,8 @@ +// +// Code generated by gen/KubernetesWatchGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// using k8s.Models; using System; using System.Collections.Generic; diff --git a/gen/KubernetesWatchGenerator/ModelExtensions.cs.template b/gen/KubernetesWatchGenerator/ModelExtensions.cs.template index ad91d0f..82093df 100644 --- a/gen/KubernetesWatchGenerator/ModelExtensions.cs.template +++ b/gen/KubernetesWatchGenerator/ModelExtensions.cs.template @@ -1,3 +1,8 @@ +// +// Code generated by gen/KubernetesWatchGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// namespace k8s.Models { {{#.}} diff --git a/kubernetes-client.ruleset b/kubernetes-client.ruleset new file mode 100644 index 0000000..bafbb4e --- /dev/null +++ b/kubernetes-client.ruleset @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/src/KubernetesClient/generated/IKubernetes.Watch.cs b/src/KubernetesClient/generated/IKubernetes.Watch.cs index 6c9e640..c8ac799 100644 --- a/src/KubernetesClient/generated/IKubernetes.Watch.cs +++ b/src/KubernetesClient/generated/IKubernetes.Watch.cs @@ -1,3 +1,8 @@ +// +// Code generated by gen/KubernetesWatchGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// using k8s.Models; using System; using System.Collections.Generic; diff --git a/src/KubernetesClient/generated/Kubernetes.Watch.cs b/src/KubernetesClient/generated/Kubernetes.Watch.cs index f27d6f5..7744310 100644 --- a/src/KubernetesClient/generated/Kubernetes.Watch.cs +++ b/src/KubernetesClient/generated/Kubernetes.Watch.cs @@ -1,3 +1,8 @@ +// +// Code generated by gen/KubernetesWatchGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// using k8s.Models; using System; using System.Collections.Generic; diff --git a/src/KubernetesClient/generated/ModelExtensions.cs b/src/KubernetesClient/generated/ModelExtensions.cs index a28a8a7..d909da3 100644 --- a/src/KubernetesClient/generated/ModelExtensions.cs +++ b/src/KubernetesClient/generated/ModelExtensions.cs @@ -1,3 +1,8 @@ +// +// Code generated by gen/KubernetesWatchGenerator +// Changes may cause incorrect behavior and will be lost if the code is +// regenerated. +// namespace k8s.Models { [KubernetesEntity(Group="admissionregistration.k8s.io", Kind="MutatingWebhookConfiguration", ApiVersion="v1", PluralName="mutatingwebhookconfigurations")] diff --git a/stylecop.json b/stylecop.json new file mode 100644 index 0000000..0d68ceb --- /dev/null +++ b/stylecop.json @@ -0,0 +1,5 @@ +{ + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "settings": { + } +} diff --git a/tests/KubernetesClient.Tests/Logging/TestOutputLogger.cs b/tests/KubernetesClient.Tests/Logging/TestOutputLogger.cs index 98e7483..5d4ac9d 100644 --- a/tests/KubernetesClient.Tests/Logging/TestOutputLogger.cs +++ b/tests/KubernetesClient.Tests/Logging/TestOutputLogger.cs @@ -6,13 +6,13 @@ using Xunit.Abstractions; namespace k8s.Tests.Logging { /// - /// An implementation of that writes to the output of the current Xunit test. + /// An implementation of that writes to the output of the current Xunit test. /// sealed class TestOutputLogger : ILogger { /// - /// Create a new . + /// Create a new . /// /// /// The output for the current test. @@ -21,7 +21,7 @@ namespace k8s.Tests.Logging /// The logger's category name. /// /// - /// The logger's minimum log level. + /// The logger's minimum log level. /// public TestOutputLogger(ITestOutputHelper testOutput, string loggerCategory, LogLevel minLogLevel) { @@ -47,27 +47,27 @@ namespace k8s.Tests.Logging public string LoggerCategory { get; } /// - /// The logger's minimum log level. + /// The logger's minimum log level. /// public LogLevel MinLogLevel { get; } /// - /// Emit a log entry. + /// Emit a log entry. /// /// - /// The log entry's level. + /// The log entry's level. /// /// - /// The log entry's associated event Id. + /// The log entry's associated event Id. /// /// - /// The log entry to be written. Can be also an object. + /// The log entry to be written. Can be also an object. /// /// - /// The exception (if any) related to the log entry. + /// The exception (if any) related to the log entry. /// /// - /// A function that creates a string log message from the and . + /// A function that creates a string log message from the and . /// public void Log(LogLevel level, EventId eventId, TState state, Exception exception, Func formatter) { @@ -89,24 +89,24 @@ namespace k8s.Tests.Logging } /// - /// Check if the given is enabled. + /// Check if the given is enabled. /// /// - /// The level to be checked. + /// The level to be checked. /// /// - /// true if enabled; otherwise, false. + /// true if enabled; otherwise, false. /// public bool IsEnabled(LogLevel logLevel) => logLevel >= MinLogLevel; /// - /// Begin a logical operation scope. + /// Begin a logical operation scope. /// /// - /// An identifier for the scope. + /// An identifier for the scope. /// /// - /// An that ends the logical operation scope when disposed. + /// An that ends the logical operation scope when disposed. /// public IDisposable BeginScope(TState state) => Disposable.Empty; } diff --git a/tests/KubernetesClient.Tests/Logging/TestOutputLoggerProvider.cs b/tests/KubernetesClient.Tests/Logging/TestOutputLoggerProvider.cs index 7e336e2..08ae794 100644 --- a/tests/KubernetesClient.Tests/Logging/TestOutputLoggerProvider.cs +++ b/tests/KubernetesClient.Tests/Logging/TestOutputLoggerProvider.cs @@ -11,13 +11,13 @@ namespace k8s.Tests.Logging : ILoggerProvider { /// - /// Create a new . + /// Create a new . /// /// /// The output for the current test. /// /// - /// The logger's minimum log level. + /// The logger's minimum log level. /// public TestOutputLoggerProvider(ITestOutputHelper testOutput, LogLevel minLogLevel) { @@ -41,7 +41,7 @@ namespace k8s.Tests.Logging ITestOutputHelper TestOutput { get; } /// - /// The logger's minimum log level. + /// The logger's minimum log level. /// public LogLevel MinLogLevel { get; }