Skip to content

Commit

Permalink
Merge pull request #901 from microsoftgraph/andrueastman/lintCleanup
Browse files Browse the repository at this point in the history
chore: lint code and keep consistent with other code.
  • Loading branch information
andrueastman authored Aug 28, 2024
2 parents 0364e8c + d323d37 commit 1432e1d
Show file tree
Hide file tree
Showing 97 changed files with 1,188 additions and 599 deletions.
127 changes: 127 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
###############################
# Core EditorConfig Options #
###############################
# All files
[*]
indent_style = space
# Code files
[*.{cs,csx,vb,vbx}]
indent_size = 4
insert_final_newline = true
charset = utf-8-bom
###############################
# .NET Coding Conventions #
###############################
[*.{cs,vb}]
# Organize usings
dotnet_sort_system_directives_first = true
# this. preferences
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_property = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_event = false:silent
# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
dotnet_style_predefined_type_for_member_access = true:silent
# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
dotnet_style_readonly_field = true:suggestion
# Expression-level preferences
dotnet_style_object_initializer = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_auto_properties = true:silent
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
###############################
# Naming Conventions #
###############################
# Style Definitions
dotnet_naming_style.pascal_case_style.capitalization = pascal_case
# Use PascalCase for constant fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols = constant_fields
dotnet_naming_rule.constant_fields_should_be_pascal_case.style = pascal_case_style
dotnet_naming_symbols.constant_fields.applicable_kinds = field
dotnet_naming_symbols.constant_fields.applicable_accessibilities = *
dotnet_naming_symbols.constant_fields.required_modifiers = const
###############################
# C# Coding Conventions #
###############################
[*.cs]
# var preferences
csharp_style_var_for_built_in_types = true:silent
csharp_style_var_when_type_is_apparent = true:silent
csharp_style_var_elsewhere = true:silent
# Expression-bodied members
csharp_style_expression_bodied_methods = false:silent
csharp_style_expression_bodied_constructors = false:silent
csharp_style_expression_bodied_operators = false:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
# Pattern matching preferences
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
# Null-checking preferences
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion
# Modifier preferences
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
# Expression-level preferences
csharp_prefer_braces = true:silent
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_prefer_simple_default_expression = true:suggestion
csharp_style_pattern_local_over_anonymous_function = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
###############################
# C# Formatting Rules #
###############################
# New line preferences
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
csharp_new_line_before_catch = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true
# Indentation preferences
csharp_indent_case_contents = true
csharp_indent_switch_labels = true
csharp_indent_labels = flush_left
# Space preferences
csharp_space_after_cast = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_around_binary_operators = before_and_after
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
# Wrapping preferences
csharp_preserve_single_line_statements = true
csharp_preserve_single_line_blocks = false
###############################
# VB Coding Conventions #
###############################
[*.vb]
# Modifier preferences
visual_basic_preferred_modifier_order = Partial,Default,Private,Protected,Public,Friend,NotOverridable,Overridable,MustOverride,Overloads,Overrides,MustInherit,NotInheritable,Static,Shared,Shadows,ReadOnly,WriteOnly,Dim,Const,WithEvents,Widening,Narrowing,Custom,Async:suggestion

[*.json]
indent_size = 2
insert_final_newline = true
3 changes: 3 additions & 0 deletions .github/workflows/validatePullRequest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ jobs:
- name: Install needed dotnet workloads
run: dotnet workload install android macos ios maccatalyst

- name: Lint the code
run: dotnet format --verify-no-changes

- name: Restore nuget dependencies
run: dotnet restore ${{ env.solutionName }}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
// ------------------------------------------------------------------------------
// ------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------

using Azure.Core;
using Microsoft.Kiota.Abstractions.Authentication;
using System;
using System.Linq;
using Azure.Core;
using Microsoft.Kiota.Abstractions.Authentication;

namespace Microsoft.Graph.Authentication;

/// <summary>
/// An overload of the Access Token Provider that has the defaults for Microsoft Graph.
/// </summary>
public class AzureIdentityAccessTokenProvider : Microsoft.Kiota.Authentication.Azure.AzureIdentityAccessTokenProvider {
public class AzureIdentityAccessTokenProvider : Microsoft.Kiota.Authentication.Azure.AzureIdentityAccessTokenProvider
{
/// <inheritdoc/>
public AzureIdentityAccessTokenProvider(TokenCredential credential, string [] allowedHosts = null, Microsoft.Kiota.Authentication.Azure.ObservabilityOptions observabilityOptions = null, bool isCaeEnabled = true, params string[] scopes)
: base(credential, allowedHosts, observabilityOptions, isCaeEnabled, scopes) {
if(!allowedHosts?.Any() ?? true)
public AzureIdentityAccessTokenProvider(TokenCredential credential, string[] allowedHosts = null, Microsoft.Kiota.Authentication.Azure.ObservabilityOptions observabilityOptions = null, bool isCaeEnabled = true, params string[] scopes)
: base(credential, allowedHosts, observabilityOptions, isCaeEnabled, scopes)
{
if (!allowedHosts?.Any() ?? true)
AllowedHostsValidator = new AllowedHostsValidator(new string[] { "graph.microsoft.com", "graph.microsoft.us", "dod-graph.microsoft.us", "graph.microsoft.de", "microsoftgraph.chinacloudapi.cn", "canary.graph.microsoft.com", "graph.microsoft-ppe.com" });
}
}

/// <inheritdoc/>
[Obsolete("This constructor is obsolete and will be removed in a future version. Use the constructor that takes an isCaeEnabled parameter instead.")]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// ------------------------------------------------------------------------------
// ------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------

Expand All @@ -22,7 +22,7 @@ public class AzureIdentityAuthenticationProvider : BaseBearerTokenAuthentication
/// <param name="isCaeEnabled">Determines if the Continuous Access Evaluation (CAE) is enabled.</param>
public AzureIdentityAuthenticationProvider(TokenCredential credential, string[] allowedHosts = null, Microsoft.Kiota.Authentication.Azure.ObservabilityOptions observabilityOptions = null, bool isCaeEnabled = true, params string[] scopes) : base(new AzureIdentityAccessTokenProvider(credential, allowedHosts, observabilityOptions, isCaeEnabled, scopes))
{
}
}
/// <summary>
/// The <see cref="AzureIdentityAuthenticationProvider"/> constructor
/// </summary>
Expand All @@ -33,5 +33,5 @@ public AzureIdentityAuthenticationProvider(TokenCredential credential, string[]
[Obsolete("Use the constructor that takes an isCaeEnabled parameter instead.")]
public AzureIdentityAuthenticationProvider(TokenCredential credential, string[] allowedHosts = null, Microsoft.Kiota.Authentication.Azure.ObservabilityOptions observabilityOptions = null, params string[] scopes) : this(credential, allowedHosts, observabilityOptions, true, scopes)
{
}
}
}
}
4 changes: 2 additions & 2 deletions src/Microsoft.Graph.Core/CoreConstants.cs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// ------------------------------------------------------------------------------
// ------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------

Expand All @@ -21,7 +21,7 @@ public static class Headers
{
/// Authorization bearer.
public const string Bearer = "Bearer";

/// SDK Version header
public const string SdkVersionHeaderName = "SdkVersion";

Expand Down
2 changes: 1 addition & 1 deletion src/Microsoft.Graph.Core/Exceptions/ClientException.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace Microsoft.Graph
{
using System;
using Microsoft.Kiota.Abstractions;

/// <summary>
/// Graph client exception.
/// </summary>
Expand Down
4 changes: 2 additions & 2 deletions src/Microsoft.Graph.Core/Exceptions/ErrorConstants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ internal static class Messages
internal static string BaseUrlMissing = "Base URL cannot be null or empty.";

internal static string InvalidTypeForDateConverter = "DateConverter can only serialize objects of type Date.";

internal static string InvalidTypeForDateTimeOffsetConverter = "DateTimeOffsetConverter can only serialize objects of type DateTimeOffset.";

internal static string LocationHeaderNotSetOnRedirect = "Location header not present in redirection response.";
Expand Down Expand Up @@ -76,7 +76,7 @@ internal static class Messages
internal static string NullValue = "{0} cannot be null.";

internal static string UnexpectedMsalException = "Unexpected exception returned from MSAL.";

internal static string UnexpectedException = "Unexpected exception occured while authenticating the request.";

internal static string MissingRetryAfterHeader = "Missing retry after header.";
Expand Down
35 changes: 22 additions & 13 deletions src/Microsoft.Graph.Core/Exceptions/ServiceException.cs
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
// ------------------------------------------------------------------------------
// ------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------

namespace Microsoft.Graph
{
using Microsoft.Kiota.Abstractions;
using Microsoft.Kiota.Abstractions.Serialization;
using System;
using System.Collections.Generic;
using Microsoft.Kiota.Abstractions;
using Microsoft.Kiota.Abstractions.Serialization;

/// <summary>
/// Graph service exception.
Expand Down Expand Up @@ -48,7 +48,7 @@ public ServiceException(string message, System.Net.Http.Headers.HttpResponseHead
/// <param name="rawResponseBody">The raw JSON response body.</param>
public ServiceException(string message,
System.Net.Http.Headers.HttpResponseHeaders responseHeaders,
int statusCode,
int statusCode,
string rawResponseBody,
Exception innerException = null)
: this(message, responseHeaders, statusCode, innerException)
Expand All @@ -61,15 +61,24 @@ public ServiceException(string message,
/// <summary>
/// The HTTP response headers from the response.
/// </summary>
public new System.Net.Http.Headers.HttpResponseHeaders ResponseHeaders { get; private set; }

public new System.Net.Http.Headers.HttpResponseHeaders ResponseHeaders
{
get; private set;
}

/// <summary>
/// Provide the raw JSON response body.
/// </summary>
public string RawResponseBody { get; private set; }
public string RawResponseBody
{
get; private set;
}

/// <summary>Stores additional data not described in the OpenAPI description found when deserializing. Can be used for serialization as well.</summary>
public IDictionary<string, object> AdditionalData { get; set; }
public IDictionary<string, object> AdditionalData
{
get; set;
}

/// <summary>
/// Checks if a given error code has been returned in the response at any level in the error stack.
Expand All @@ -82,13 +91,13 @@ public bool IsMatch(string errorCode)
{
throw new ArgumentException("errorCode cannot be null or empty", nameof(errorCode));
}
if (RawResponseBody is not null && RawResponseBody.IndexOf(errorCode,StringComparison.OrdinalIgnoreCase) >= 0)

if (RawResponseBody is not null && RawResponseBody.IndexOf(errorCode, StringComparison.OrdinalIgnoreCase) >= 0)
{
return true;
}
if (!string.IsNullOrWhiteSpace(Message) && Message.IndexOf(errorCode,StringComparison.OrdinalIgnoreCase) >= 0)

if (!string.IsNullOrWhiteSpace(Message) && Message.IndexOf(errorCode, StringComparison.OrdinalIgnoreCase) >= 0)
{
return true;
}
Expand Down Expand Up @@ -125,4 +134,4 @@ public void Serialize(ISerializationWriter writer)
writer.WriteAdditionalData(AdditionalData);
}
}
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// ------------------------------------------------------------------------------
// ------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------

Expand Down Expand Up @@ -33,7 +33,7 @@ internal static FeatureFlag GetFeatureFlags(this HttpRequestMessage httpRequestM

return featureFlag;
}

/// <summary>
/// Gets a <see cref="GraphRequestContext"/> from <see cref="HttpRequestMessage"/>
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
// ------------------------------------------------------------------------------
// ------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License in the project root for license information.
// ------------------------------------------------------------------------------

namespace Microsoft.Graph
{
using System.Text.Json;
using System;
using System.IO;
using System.Security.Cryptography;
using System.Security.Cryptography.X509Certificates;
using System.Text;
using System.Text.Json;
using System.Threading.Tasks;
using Microsoft.Kiota.Abstractions.Serialization;
using Microsoft.Kiota.Serialization.Json;
Expand Down
Loading

0 comments on commit 1432e1d

Please sign in to comment.