Skip to content

code quality: use editorconfig to enforce code rules #436

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
root = true

[*.cs]
indent_size = 4
indent_style = space
trim_trailing_whitespace = true

# Avoid "this." and "Me." if not necessary
dotnet_style_qualification_for_field = false:suggestion
dotnet_style_qualification_for_property = false:suggestion
dotnet_style_qualification_for_method = false:suggestion
dotnet_style_qualification_for_event = false:suggestion

# Suggest more modern language features when available
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion

# Newline settings
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

# Xml project files
[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj}]
indent_size = 2
indent_style = space

# Xml config files
[*.{props,targets,ruleset,config,nuspec,resx,vsixmanifest,vsct}]
indent_size = 2
indent_style = space
9 changes: 9 additions & 0 deletions NRedisStack.sln
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{84D6210F
Directory.Packages.props = Directory.Packages.props
global.json = global.json
version.json = version.json
.editorconfig = .editorconfig
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{CBEB7980-923E-49D1-B8D5-561E313AF525}"
ProjectSection(SolutionItems) = preProject
src\.editorconfig = src\.editorconfig
EndProjectSection
EndProject
Global
Expand All @@ -39,4 +45,7 @@ Global
{F14F6342-14A0-4DDD-AB05-C425B1AD8001}.Release|Any CPU.ActiveCfg = Release|Any CPU
{F14F6342-14A0-4DDD-AB05-C425B1AD8001}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{CBEB7980-923E-49D1-B8D5-561E313AF525} = {84D6210F-9A65-427A-965F-57E7B76424AB}
EndGlobalSection
EndGlobal
2 changes: 2 additions & 0 deletions src/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[*.cs]
dotnet_sort_system_directives_first = false # we don't want this in docs, because of hidden sections
2 changes: 1 addition & 1 deletion src/NRedisStack/Bloom/BloomCommandBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using NRedisStack.Bloom.Literals;
using NRedisStack.RedisStackCommands;
using StackExchange.Redis;
using NRedisStack.Bloom.Literals;
namespace NRedisStack;

public static class BloomCommandBuilder
Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/CoreCommands/CoreCommandBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using NRedisStack.RedisStackCommands;
using NRedisStack.Core.Literals;
using NRedisStack.Core;
using NRedisStack.Core.DataTypes;
using NRedisStack.Core.Literals;
using NRedisStack.RedisStackCommands;
using StackExchange.Redis;

namespace NRedisStack;
Expand Down
14 changes: 7 additions & 7 deletions src/NRedisStack/ResponseParser.cs
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.Extensions;
using StackExchange.Redis;
using NRedisStack.Bloom.DataTypes;
using NRedisStack.Core.DataTypes;
using NRedisStack.CuckooFilter.DataTypes;
using NRedisStack.CountMinSketch.DataTypes;
using NRedisStack.TopK.DataTypes;
using NRedisStack.Tdigest.DataTypes;
using NRedisStack.CuckooFilter.DataTypes;
using NRedisStack.DataTypes;
using NRedisStack.Extensions;
using NRedisStack.Literals.Enums;
using NRedisStack.Search;
using NRedisStack.Tdigest.DataTypes;
using NRedisStack.TopK.DataTypes;
using StackExchange.Redis;

namespace NRedisStack;

Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/Search/Query.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using System.Globalization;
using NRedisStack.Search.Literals;
using NRedisStack.Search.Literals;
using StackExchange.Redis;
using System.Globalization;

namespace NRedisStack.Search;

Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/Search/Schema.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using System.Diagnostics;
using NRedisStack.Search.Literals;
using NRedisStack.Search.Literals;
using System.Diagnostics;
using static NRedisStack.Search.Schema.GeoShapeField;
using static NRedisStack.Search.Schema.VectorField;

Expand Down
2 changes: 1 addition & 1 deletion src/NRedisStack/Search/SearchCommandBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using NRedisStack.Search.Literals;
using NRedisStack.RedisStackCommands;
using NRedisStack.Search;
using NRedisStack.Search.Literals;
using StackExchange.Redis;
namespace NRedisStack;

Expand Down
2 changes: 1 addition & 1 deletion src/NRedisStack/Tdigest/TdigestCommandBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using NRedisStack.Literals;
using StackExchange.Redis;
using NRedisStack.RedisStackCommands;
using StackExchange.Redis;

namespace NRedisStack;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using System.Text.Json;
using NRedisStack.Literals.Enums;
using System.Text.Json;

namespace NRedisStack.DataTypes;

Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/TimeSeries/DataTypes/TimeSeriesRule.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using NRedisStack.Literals.Enums;
using NRedisStack.Extensions;
using NRedisStack.Extensions;
using NRedisStack.Literals.Enums;

namespace NRedisStack.DataTypes;

Expand Down
2 changes: 1 addition & 1 deletion src/NRedisStack/TimeSeries/ITimeSeriesCommands.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.Literals.Enums;
namespace NRedisStack;

public interface ITimeSeriesCommands
Expand Down
2 changes: 1 addition & 1 deletion src/NRedisStack/TimeSeries/ITimeSeriesCommandsAsync.cs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.Literals.Enums;
namespace NRedisStack;

public interface ITimeSeriesCommandsAsync
Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/TimeSeries/TimeSeriesAux.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using NRedisStack.Literals;
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.Extensions;
using NRedisStack.Literals;
using NRedisStack.Literals.Enums;

namespace NRedisStack;

Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/TimeSeries/TimeSeriesCommands.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using StackExchange.Redis;
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.Literals.Enums;
using StackExchange.Redis;
namespace NRedisStack;

public class TimeSeriesCommands : TimeSeriesCommandsAsync, ITimeSeriesCommands
Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/TimeSeries/TimeSeriesCommandsAsync.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using StackExchange.Redis;
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.Literals.Enums;
using StackExchange.Redis;
namespace NRedisStack;

public class TimeSeriesCommandsAsync : ITimeSeriesCommandsAsync
Expand Down
2 changes: 1 addition & 1 deletion src/NRedisStack/TimeSeries/TimeSeriesCommandsBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using NRedisStack.DataTypes;
using NRedisStack.Literals;
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.RedisStackCommands;

namespace NRedisStack;
Expand Down
4 changes: 2 additions & 2 deletions src/NRedisStack/TimeSeries/TimeSeriesParamsBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using NRedisStack.Literals;
using NRedisStack.Literals.Enums;
using NRedisStack.DataTypes;
using NRedisStack.Extensions;
using NRedisStack.Literals;
using NRedisStack.Literals.Enums;

namespace NRedisStack;

Expand Down
2 changes: 1 addition & 1 deletion src/NRedisStack/TopK/TopKCommandBuilder.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
using NRedisStack.RedisStackCommands;
using NRedisStack.TopK.Literals;
using StackExchange.Redis;
using NRedisStack.RedisStackCommands;

namespace NRedisStack;

Expand Down
4 changes: 4 additions & 0 deletions tests/Doc/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[*.cs]

# placeholder for editorconfig

Loading