-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
editor config naming style #15065
Merged
jmarolf
merged 8 commits into
dotnet:master
from
jmarolf:feature/editorconfig-namingstyle-options
Dec 21, 2016
Merged
editor config naming style #15065
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8178d9c
moving naming styles types into the workspace layer.
jmarolf d70c687
Implementing naming styles support for editorconfig
jmarolf aec0e29
responding to david's PR feedback
jmarolf a2107f6
responding to Jason's feedback
jmarolf 1aa1518
responding to Jason's feedback part 2
jmarolf 04621ac
addressing the latest set of comments from David
jmarolf 998425e
addressing Jason's comments
jmarolf 92e3d18
addressing Kevin's comments
jmarolf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
202 changes: 202 additions & 0 deletions
202
src/EditorFeatures/CSharpTest/Diagnostics/NamingStyles/EditorConfigNamingStyleParserTests.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,202 @@ | ||
// Copyright (c) Microsoft. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. | ||
|
||
using System.Collections.Generic; | ||
using System.Linq; | ||
using Microsoft.CodeAnalysis.Diagnostics.Analyzers.NamingStyles; | ||
using Roslyn.Test.Utilities; | ||
using Xunit; | ||
using static Microsoft.CodeAnalysis.Diagnostics.Analyzers.NamingStyles.EditorConfigNamingStyleParser; | ||
using static Microsoft.CodeAnalysis.Diagnostics.Analyzers.NamingStyles.SymbolSpecification; | ||
|
||
namespace Microsoft.CodeAnalysis.Editor.CSharp.UnitTests.Diagnostics.NamingStyles | ||
{ | ||
public partial class EditorConfigNamingStyleParserTests | ||
{ | ||
[Fact] | ||
public static void TestPascalCaseRule() | ||
{ | ||
var dictionary = new Dictionary<string, object>() | ||
{ | ||
["dotnet_naming_rule.methods_and_properties_must_be_pascal_case.severity"] = "warning", | ||
["dotnet_naming_rule.methods_and_properties_must_be_pascal_case.symbols"] = "method_and_property_symbols", | ||
["dotnet_naming_rule.methods_and_properties_must_be_pascal_case.style"] = "pascal_case_style", | ||
["dotnet_naming_symbols.method_and_property_symbols.applicable_kinds"] = "method,property", | ||
["dotnet_naming_symbols.method_and_property_symbols.applicable_accessibilities"] = "*", | ||
["dotnet_naming_style.pascal_case_style.capitalization"] = "pascal_case" | ||
}; | ||
var result = ParseDictionary(dictionary); | ||
Assert.Single(result.NamingRules); | ||
var namingRule = result.NamingRules.Single(); | ||
Assert.Single(result.NamingStyles); | ||
var namingStyle = result.NamingStyles.Single(); | ||
Assert.Single(result.SymbolSpecifications); | ||
var symbolSpec = result.SymbolSpecifications.Single(); | ||
Assert.Equal(namingStyle.ID, namingRule.NamingStyleID); | ||
Assert.Equal(symbolSpec.ID, namingRule.SymbolSpecificationID); | ||
Assert.Equal(DiagnosticSeverity.Warning, namingRule.EnforcementLevel); | ||
Assert.Equal("method_and_property_symbols", symbolSpec.Name); | ||
var expectedApplicableSymbolKindList = new[] | ||
{ | ||
new SymbolKindOrTypeKind(SymbolKind.Method), | ||
new SymbolKindOrTypeKind(SymbolKind.Property) | ||
}; | ||
AssertEx.SetEqual(expectedApplicableSymbolKindList, symbolSpec.ApplicableSymbolKindList); | ||
Assert.Empty(symbolSpec.RequiredModifierList); | ||
var expectedApplicableAccessibilityList = new[] | ||
{ | ||
Accessibility.Public, | ||
Accessibility.Internal, | ||
Accessibility.Private, | ||
Accessibility.Protected, | ||
Accessibility.ProtectedOrInternal | ||
}; | ||
AssertEx.SetEqual(expectedApplicableAccessibilityList, symbolSpec.ApplicableAccessibilityList); | ||
Assert.Equal("pascal_case_style", namingStyle.Name); | ||
Assert.Equal("", namingStyle.Prefix); | ||
Assert.Equal("", namingStyle.Suffix); | ||
Assert.Equal("", namingStyle.WordSeparator); | ||
Assert.Equal(Capitalization.PascalCase, namingStyle.CapitalizationScheme); | ||
} | ||
|
||
[Fact] | ||
public static void TestAsyncMethodsRule() | ||
{ | ||
var dictionary = new Dictionary<string, object>() | ||
{ | ||
["dotnet_naming_rule.async_methods_must_end_with_async.severity"] = "error", | ||
["dotnet_naming_rule.async_methods_must_end_with_async.symbols"] = "method_symbols", | ||
["dotnet_naming_rule.async_methods_must_end_with_async.style"] = "end_in_async_style", | ||
["dotnet_naming_symbols.method_symbols.applicable_kinds"] = "method", | ||
["dotnet_naming_symbols.method_symbols.required_modifiers"] = "async", | ||
["dotnet_naming_style.end_in_async_style.capitalization "] = "pascal_case", | ||
["dotnet_naming_style.end_in_async_style.required_suffix"] = "Async", | ||
}; | ||
var result = ParseDictionary(dictionary); | ||
Assert.Single(result.NamingRules); | ||
var namingRule = result.NamingRules.Single(); | ||
Assert.Single(result.NamingStyles); | ||
var namingStyle = result.NamingStyles.Single(); | ||
Assert.Single(result.SymbolSpecifications); | ||
var symbolSpec = result.SymbolSpecifications.Single(); | ||
Assert.Equal(namingStyle.ID, namingRule.NamingStyleID); | ||
Assert.Equal(symbolSpec.ID, namingRule.SymbolSpecificationID); | ||
Assert.Equal(DiagnosticSeverity.Error, namingRule.EnforcementLevel); | ||
Assert.Equal("method_symbols", symbolSpec.Name); | ||
Assert.Single(symbolSpec.ApplicableSymbolKindList); | ||
Assert.Contains(new SymbolKindOrTypeKind(SymbolKind.Method), symbolSpec.ApplicableSymbolKindList); | ||
Assert.Single(symbolSpec.RequiredModifierList); | ||
Assert.Contains(new ModifierKind(ModifierKindEnum.IsAsync), symbolSpec.RequiredModifierList); | ||
Assert.Empty(symbolSpec.ApplicableAccessibilityList); | ||
Assert.Equal("end_in_async_style", namingStyle.Name); | ||
Assert.Equal("", namingStyle.Prefix); | ||
Assert.Equal("Async", namingStyle.Suffix); | ||
Assert.Equal("", namingStyle.WordSeparator); | ||
Assert.Equal(Capitalization.PascalCase, namingStyle.CapitalizationScheme); | ||
} | ||
|
||
[Fact] | ||
public static void TestPublicMembersCapitalizedRule() | ||
{ | ||
var dictionary = new Dictionary<string, object>() | ||
{ | ||
["dotnet_naming_rule.public_members_must_be_capitalized.severity"] = "suggestion", | ||
["dotnet_naming_rule.public_members_must_be_capitalized.symbols"] = "public_symbols", | ||
["dotnet_naming_rule.public_members_must_be_capitalized.style"] = "first_word_upper_case_style", | ||
["dotnet_naming_symbols.public_symbols.applicable_kinds"] = "property,method,field,event,delegate", | ||
["dotnet_naming_symbols.public_symbols.applicable_accessibilities"] = "public,internal,protected,protected_internal", | ||
["dotnet_naming_style.first_word_upper_case_style.capitalization"] = "first_word_upper", | ||
}; | ||
var result = ParseDictionary(dictionary); | ||
Assert.Single(result.NamingRules); | ||
var namingRule = result.NamingRules.Single(); | ||
Assert.Single(result.NamingStyles); | ||
var namingStyle = result.NamingStyles.Single(); | ||
Assert.Single(result.SymbolSpecifications); | ||
var symbolSpec = result.SymbolSpecifications.Single(); | ||
Assert.Equal(namingStyle.ID, namingRule.NamingStyleID); | ||
Assert.Equal(symbolSpec.ID, namingRule.SymbolSpecificationID); | ||
Assert.Equal(DiagnosticSeverity.Info, namingRule.EnforcementLevel); | ||
Assert.Equal("public_symbols", symbolSpec.Name); | ||
var expectedApplicableSymbolKindList = new[] | ||
{ | ||
new SymbolKindOrTypeKind(SymbolKind.Property), | ||
new SymbolKindOrTypeKind(SymbolKind.Method), | ||
new SymbolKindOrTypeKind(SymbolKind.Field), | ||
new SymbolKindOrTypeKind(SymbolKind.Event), | ||
new SymbolKindOrTypeKind(TypeKind.Delegate) | ||
}; | ||
AssertEx.SetEqual(expectedApplicableSymbolKindList, symbolSpec.ApplicableSymbolKindList); | ||
var expectedApplicableAccessibilityList = new[] | ||
{ | ||
Accessibility.Public, | ||
Accessibility.Internal, | ||
Accessibility.Protected, | ||
Accessibility.ProtectedOrInternal | ||
}; | ||
AssertEx.SetEqual(expectedApplicableAccessibilityList, symbolSpec.ApplicableAccessibilityList); | ||
Assert.Empty(symbolSpec.RequiredModifierList); | ||
Assert.Equal("first_word_upper_case_style", namingStyle.Name); | ||
Assert.Equal("", namingStyle.Prefix); | ||
Assert.Equal("", namingStyle.Suffix); | ||
Assert.Equal("", namingStyle.WordSeparator); | ||
Assert.Equal(Capitalization.FirstUpper, namingStyle.CapitalizationScheme); | ||
} | ||
|
||
[Fact] | ||
public static void TestNonPublicMembersLowerCaseRule() | ||
{ | ||
var dictionary = new Dictionary<string, object>() | ||
{ | ||
["dotnet_naming_rule.non_public_members_must_be_lower_case.severity"] = "incorrect", | ||
["dotnet_naming_rule.non_public_members_must_be_lower_case.symbols "] = "non_public_symbols", | ||
["dotnet_naming_rule.non_public_members_must_be_lower_case.style "] = "all_lower_case_style", | ||
["dotnet_naming_symbols.non_public_symbols.applicable_kinds "] = "property,method,field,event,delegate", | ||
["dotnet_naming_symbols.non_public_symbols.applicable_accessibilities"] = "private", | ||
["dotnet_naming_style.all_lower_case_style.capitalization"] = "all_lower", | ||
}; | ||
var result = ParseDictionary(dictionary); | ||
Assert.Single(result.NamingRules); | ||
var namingRule = result.NamingRules.Single(); | ||
Assert.Single(result.NamingStyles); | ||
var namingStyle = result.NamingStyles.Single(); | ||
Assert.Single(result.SymbolSpecifications); | ||
var symbolSpec = result.SymbolSpecifications.Single(); | ||
Assert.Equal(namingStyle.ID, namingRule.NamingStyleID); | ||
Assert.Equal(symbolSpec.ID, namingRule.SymbolSpecificationID); | ||
Assert.Equal(DiagnosticSeverity.Hidden, namingRule.EnforcementLevel); | ||
Assert.Equal("non_public_symbols", symbolSpec.Name); | ||
var expectedApplicableSymbolKindList = new[] | ||
{ | ||
new SymbolKindOrTypeKind(SymbolKind.Property), | ||
new SymbolKindOrTypeKind(SymbolKind.Method), | ||
new SymbolKindOrTypeKind(SymbolKind.Field), | ||
new SymbolKindOrTypeKind(SymbolKind.Event), | ||
new SymbolKindOrTypeKind(TypeKind.Delegate) | ||
}; | ||
AssertEx.SetEqual(expectedApplicableSymbolKindList, symbolSpec.ApplicableSymbolKindList); | ||
Assert.Single(symbolSpec.ApplicableAccessibilityList); | ||
Assert.Contains(Accessibility.Private, symbolSpec.ApplicableAccessibilityList); | ||
Assert.Empty(symbolSpec.RequiredModifierList); | ||
Assert.Equal("all_lower_case_style", namingStyle.Name); | ||
Assert.Equal("", namingStyle.Prefix); | ||
Assert.Equal("", namingStyle.Suffix); | ||
Assert.Equal("", namingStyle.WordSeparator); | ||
Assert.Equal(Capitalization.AllLower, namingStyle.CapitalizationScheme); | ||
} | ||
|
||
[Fact] | ||
public static void TestNoRulesAreReturned() | ||
{ | ||
var dictionary = new Dictionary<string, object>() | ||
{ | ||
["dotnet_naming_symbols.non_public_symbols.applicable_kinds "] = "property,method,field,event,delegate", | ||
["dotnet_naming_symbols.non_public_symbols.applicable_accessibilities"] = "private", | ||
["dotnet_naming_style.all_lower_case_style.capitalization"] = "all_lower", | ||
}; | ||
var result = ParseDictionary(dictionary); | ||
Assert.Empty(result.NamingRules); | ||
Assert.Empty(result.NamingStyles); | ||
Assert.Empty(result.SymbolSpecifications); | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should these have more meaningful names? Where do they show up?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
They are not visible to the user. These are only used to group specifications in ediorconfig