Skip to content

Commit

Permalink
Better .editorconfig
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuriy committed Oct 27, 2019
1 parent 102deff commit 46df62b
Show file tree
Hide file tree
Showing 12 changed files with 242 additions and 29 deletions.
200 changes: 199 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
root=true
root = true

[*]
indent_style = space
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true
end_of_line = crlf

[*.csproj]
indent_size = 2
Expand All @@ -21,3 +24,198 @@ indent_size = 2

[*.json]
indent_size = 2

# C# files
[*.cs]

#### Core EditorConfig Options ####

# Indentation and spacing
indent_size = 4
indent_style = space
tab_width = 4

# New line preferences
end_of_line = crlf
insert_final_newline = false

#### .NET Coding Conventions ####

# Organize usings
dotnet_separate_import_directive_groups = false
dotnet_sort_system_directives_first = true

# this. and Me. preferences
dotnet_style_qualification_for_event = false:silent
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_property = 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_other_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent

# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent

# Expression-level preferences
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_style_inlined_variable_declaration = true:silent
csharp_style_throw_expression = true:suggestion
dotnet_style_coalesce_expression = true:silent
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_null_propagation = true:silent
dotnet_style_object_initializer = true:suggestion
dotnet_style_prefer_auto_properties = true:silent
dotnet_style_prefer_compound_assignment = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent

# Field preferences
dotnet_style_readonly_field = true:suggestion

# Parameter preferences
dotnet_code_quality_unused_parameters = all:suggestion

#### C# Coding Conventions ####

# var preferences
csharp_style_var_elsewhere = false:silent
csharp_style_var_for_built_in_types = false:silent
csharp_style_var_when_type_is_apparent = true:silent

# Expression-bodied members
csharp_style_expression_bodied_accessors = true:silent
csharp_style_expression_bodied_constructors = when_on_single_line:silent
csharp_style_expression_bodied_indexers = when_on_single_line:silent
csharp_style_expression_bodied_lambdas = when_on_single_line:silent
csharp_style_expression_bodied_local_functions = false:silent
csharp_style_expression_bodied_methods = when_on_single_line:silent
csharp_style_expression_bodied_operators = when_on_single_line:silent
csharp_style_expression_bodied_properties = when_on_single_line:silent

# Pattern matching preferences
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_prefer_switch_expression = true:suggestion

# Null-checking preferences
csharp_style_conditional_delegate_call = true:silent

# Modifier preferences
csharp_prefer_static_local_function = true:suggestion
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async

# Code-block preferences
csharp_prefer_braces = when_multiline:silent
csharp_prefer_simple_using_statement = true:suggestion

# Expression-level preferences
csharp_prefer_simple_default_expression = true:silent
csharp_style_pattern_local_over_anonymous_function = true:suggestion
csharp_style_prefer_index_operator = true:suggestion
csharp_style_prefer_range_operator = true:suggestion
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
csharp_style_unused_value_expression_statement_preference = discard_variable:silent

# 'using' directive preferences
csharp_using_directive_placement = outside_namespace:silent

#### C# Formatting Rules ####

# New line preferences
csharp_new_line_before_catch = true
csharp_new_line_before_else = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_open_brace = all
csharp_new_line_between_query_expression_clauses = true

# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = false
csharp_indent_labels = one_less_than_current
csharp_indent_switch_labels = true

# Space preferences
csharp_space_after_cast = true
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_semicolon_in_for_statement = true
csharp_space_around_binary_operators = before_and_after
csharp_space_around_declaration_statements = false
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_open_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false

# Wrapping preferences
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = false

#### Naming styles ####

# Naming rules

dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i

dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case

dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case

# Symbol specifications

dotnet_naming_symbols.interface.applicable_kinds = interface
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.interface.required_modifiers =

dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.types.required_modifiers =

dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.non_field_members.required_modifiers =

# Naming styles

dotnet_naming_style.pascal_case.required_prefix =
dotnet_naming_style.pascal_case.required_suffix =
dotnet_naming_style.pascal_case.word_separator =
dotnet_naming_style.pascal_case.capitalization = pascal_case

dotnet_naming_style.begins_with_i.required_prefix = I
dotnet_naming_style.begins_with_i.required_suffix =
dotnet_naming_style.begins_with_i.word_separator =
dotnet_naming_style.begins_with_i.capitalization = pascal_case
15 changes: 15 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
* text=auto

*.sln text eol=crlf
*.csproj text eol=crlf
*.shproj text eol=crlf
*.projitems text eol=crlf

*.sh text eol=lf
*.yml text eol=lf
*.yaml text eol=lf

Dockerfile text eol=lf
Vagrantfile text eol=lf
gradlew text eol=lf

2 changes: 1 addition & 1 deletion src/build/Commands/ShowCommand.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
using Elastic.Installer;

namespace ElastiBuild.Commands
{
{
[Verb("show", HelpText = "Show products that we can build")]
public class ShowCommand : IElastiBuildCommand
{
Expand Down
2 changes: 1 addition & 1 deletion src/build/Infra/ArifactFilter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ public class ArtifactFilter
public bool ShowOss { get; set; }
public eBitness Bitness { get; set; }
}
}
}
4 changes: 2 additions & 2 deletions src/build/Infra/ArtifactContainer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public class ArtifactContainer

internal ArtifactContainer(string name_, bool isBranch_ = false, bool isVersion_ = false, bool isAlias_ = false)
{
Debug.Assert(isBranch_ || isVersion_ || isAlias_,
Debug.Assert(isBranch_ || isVersion_ || isAlias_,
$"Must specify one of {nameof(isBranch_)}, {nameof(isVersion_)}, {nameof(isAlias_)}, ");

Name = name_;
Expand All @@ -20,4 +20,4 @@ internal ArtifactContainer(string name_, bool isBranch_ = false, bool isVersion_
IsAlias = isAlias_;
}
}
}
}
16 changes: 8 additions & 8 deletions src/build/Infra/ArtifactsApi.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public static async Task<IEnumerable<ArtifactContainer>> ListNamedContainers()
var data = js.Deserialize<JToken>(jtr);

foreach (var itm in data[MagicStrings.ArtifactsApi.Branches] ?? new JArray())
namedItems.Add(new ArtifactContainer((string)itm, isBranch_: true));
namedItems.Add(new ArtifactContainer((string) itm, isBranch_: true));
}

using (var stm = await http.GetStreamAsync(MagicStrings.ArtifactsApi.Versions))
Expand All @@ -46,10 +46,10 @@ public static async Task<IEnumerable<ArtifactContainer>> ListNamedContainers()
var data = js.Deserialize<JToken>(jtr);

foreach (var itm in data[MagicStrings.ArtifactsApi.Versions] ?? new JArray())
namedItems.Add(new ArtifactContainer((string)itm, isVersion_: true));
namedItems.Add(new ArtifactContainer((string) itm, isVersion_: true));

foreach (var itm in data[MagicStrings.ArtifactsApi.Aliases] ?? new JArray())
namedItems.Add(new ArtifactContainer((string)itm, isAlias_: true));
namedItems.Add(new ArtifactContainer((string) itm, isAlias_: true));
}

return namedItems;
Expand Down Expand Up @@ -95,14 +95,14 @@ public static async Task<IEnumerable<ArtifactPackage>> FindArtifact(
continue;

if (filter.Bitness == eBitness.x64 &&
(string)itm.Value[MagicStrings.ArtifactsApi.Architecture] != MagicStrings.Arch.x86_64)
(string) itm.Value[MagicStrings.ArtifactsApi.Architecture] != MagicStrings.Arch.x86_64)
{
continue;
}

var package = new ArtifactPackage(
itm.Name,
(string)itm.Value[MagicStrings.ArtifactsApi.Url] ?? string.Empty);
(string) itm.Value[MagicStrings.ArtifactsApi.Url] ?? string.Empty);

packages.Add(package);
}
Expand Down Expand Up @@ -152,17 +152,17 @@ public static async Task FetchArtifact(BuildContext ctx_, ArtifactPackage ap_)
public static Task UnpackArtifact(BuildContext ctx_, ArtifactPackage ap_)
{
var unpackedDir = Path.Combine(
ctx_.InDir,
ctx_.InDir,
Path.GetFileNameWithoutExtension(ap_.FileName));

if (Directory.Exists(unpackedDir))
return Task.CompletedTask;

return Task.Run(() =>
return Task.Run(() =>
ZipFile.ExtractToDirectory(
Path.Combine(ctx_.InDir, Path.GetFileName(ap_.FileName)),
Path.Combine(ctx_.InDir),
overwriteFiles: true));
}
}
}
}
2 changes: 1 addition & 1 deletion src/build/Infra/StringExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ public static string JoinTo(this string value_, params string[] others_)
return builder.ToString();
}
}
}
}
20 changes: 10 additions & 10 deletions src/build/Infra/TweakedSentenceBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -32,45 +32,45 @@ public class TweakedSentenceBuilder : SentenceBuilder
switch (error.Tag)
{
case ErrorType.BadFormatTokenError:
return "Token '".JoinTo(((BadFormatTokenError)error).Token, "' is not recognized.");
return "Token '".JoinTo(((BadFormatTokenError) error).Token, "' is not recognized.");

case ErrorType.MissingValueOptionError:
return "Option '".JoinTo(((MissingValueOptionError)error).NameInfo.NameText, "' has no value.");
return "Option '".JoinTo(((MissingValueOptionError) error).NameInfo.NameText, "' has no value.");

case ErrorType.UnknownOptionError:
return "Option '".JoinTo(((UnknownOptionError)error).Token, "' is unknown.");
return "Option '".JoinTo(((UnknownOptionError) error).Token, "' is unknown.");

case ErrorType.MissingRequiredOptionError:
var errMisssing = ((MissingRequiredOptionError)error);
var errMisssing = ((MissingRequiredOptionError) error);
return errMisssing.NameInfo.Equals(NameInfo.EmptyName)
? "PRODUCT missing."
: "Required option '".JoinTo(errMisssing.NameInfo.NameText, "' is missing.");

case ErrorType.BadFormatConversionError:
var badFormat = ((BadFormatConversionError)error);
var badFormat = ((BadFormatConversionError) error);
return badFormat.NameInfo.Equals(NameInfo.EmptyName)
? "A target name is defined with a bad format."
: "Option '".JoinTo(badFormat.NameInfo.NameText, "' is defined with a bad format.");

case ErrorType.SequenceOutOfRangeError:
var seqOutRange = ((SequenceOutOfRangeError)error);
var seqOutRange = ((SequenceOutOfRangeError) error);
return seqOutRange.NameInfo.Equals(NameInfo.EmptyName)
? "A free sequence value is defined with few items than required."
: "A sequence option '".JoinTo(seqOutRange.NameInfo.NameText,
"' is defined with fewer or more items than required.");

case ErrorType.BadVerbSelectedError:
return "Command '".JoinTo(((BadVerbSelectedError)error).Token, "' is not recognized.");
return "Command '".JoinTo(((BadVerbSelectedError) error).Token, "' is not recognized.");

case ErrorType.NoVerbSelectedError:
return "No command selected.";

case ErrorType.RepeatedOptionError:
return "Option '".JoinTo(((RepeatedOptionError)error).NameInfo.NameText,
return "Option '".JoinTo(((RepeatedOptionError) error).NameInfo.NameText,
"' is defined multiple times.");

case ErrorType.SetValueExceptionError:
var setValueError = (SetValueExceptionError)error;
var setValueError = (SetValueExceptionError) error;
return "Error setting value to option '".JoinTo(setValueError.NameInfo.NameText, "': ", setValueError.Exception.Message);
}
throw new InvalidOperationException();
Expand Down Expand Up @@ -113,4 +113,4 @@ group e by e.SetName into g
return string.Join(Environment.NewLine, msgs);
};
}
}
}
2 changes: 1 addition & 1 deletion src/installer/BeatPackageCompiler/BeatPackageCompiler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ static void Main(string[] args_)
.GetDirectories()
.Select(dirName => dirName.Name)
.Except(pi.MutableDirs)
.Select(dirName =>
.Select(dirName =>
new Dir(dirName, new Files(Path.Combine(opts.InDir, dirName, MagicStrings.Files.All)))));

elements.Add(pi.IsWindowsService ? service : null);
Expand Down
Loading

0 comments on commit 46df62b

Please sign in to comment.