Skip to content

Commit 0f5288b

Browse files
SockworkOrangeSockworkOrange
authored
Added linting and some refactoring (#41)
* fix have workflow run always on PRs * removed unneeded files (GRPC protobuf, SqlcProtobuf project) * Refactored CodeGenerator class generate function * added dotnet linting
1 parent bc25e85 commit 0f5288b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1950
-7062
lines changed

‎.editorconfig

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
# Remove the line below if you want to inherit .editorconfig settings from higher directories
2+
root = true
3+
4+
# C# files
5+
[*.cs]
6+
7+
#### Core EditorConfig Options ####
8+
9+
# Indentation and spacing
10+
indent_size = 4
11+
indent_style = space
12+
tab_width = 4
13+
14+
# New line preferences
15+
end_of_line = crlf
16+
insert_final_newline = false
17+
18+
#### .NET Coding Conventions ####
19+
20+
# Organize usings
21+
dotnet_separate_import_directive_groups = false
22+
dotnet_sort_system_directives_first = false
23+
file_header_template = unset
24+
25+
# this. and Me. preferences
26+
dotnet_style_qualification_for_event = false
27+
dotnet_style_qualification_for_field = false
28+
dotnet_style_qualification_for_method = false
29+
dotnet_style_qualification_for_property = false
30+
31+
# Language keywords vs BCL types preferences
32+
dotnet_style_predefined_type_for_locals_parameters_members = true
33+
dotnet_style_predefined_type_for_member_access = true
34+
35+
# Parentheses preferences
36+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity
37+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity
38+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary
39+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity
40+
41+
# Modifier preferences
42+
dotnet_style_require_accessibility_modifiers = for_non_interface_members
43+
44+
# Expression-level preferences
45+
dotnet_style_coalesce_expression = true
46+
dotnet_style_collection_initializer = true
47+
dotnet_style_explicit_tuple_names = true
48+
dotnet_style_null_propagation = true
49+
dotnet_style_object_initializer = true
50+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
51+
dotnet_style_prefer_auto_properties = true
52+
dotnet_style_prefer_compound_assignment = true
53+
dotnet_style_prefer_conditional_expression_over_assignment = true
54+
dotnet_style_prefer_conditional_expression_over_return = true
55+
dotnet_style_prefer_inferred_anonymous_type_member_names = true
56+
dotnet_style_prefer_inferred_tuple_names = true
57+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true
58+
dotnet_style_prefer_simplified_boolean_expressions = true
59+
dotnet_style_prefer_simplified_interpolation = true
60+
61+
# Field preferences
62+
dotnet_style_readonly_field = true
63+
64+
# Parameter preferences
65+
dotnet_code_quality_unused_parameters = all:silent
66+
67+
#### C# Coding Conventions ####
68+
69+
# var preferences
70+
csharp_style_var_elsewhere = false
71+
csharp_style_var_for_built_in_types = false
72+
csharp_style_var_when_type_is_apparent = false
73+
74+
# Expression-bodied members
75+
csharp_style_expression_bodied_accessors = true
76+
csharp_style_expression_bodied_constructors = false
77+
csharp_style_expression_bodied_indexers = true
78+
csharp_style_expression_bodied_lambdas = true
79+
csharp_style_expression_bodied_local_functions = false
80+
csharp_style_expression_bodied_methods = false
81+
csharp_style_expression_bodied_operators = false
82+
csharp_style_expression_bodied_properties = true
83+
84+
# Pattern matching preferences
85+
csharp_style_pattern_matching_over_as_with_null_check = true
86+
csharp_style_pattern_matching_over_is_with_cast_check = true
87+
csharp_style_prefer_not_pattern = true
88+
csharp_style_prefer_pattern_matching = true
89+
csharp_style_prefer_switch_expression = true
90+
91+
# Null-checking preferences
92+
csharp_style_conditional_delegate_call = true
93+
94+
# Modifier preferences
95+
csharp_prefer_static_local_function = true
96+
csharp_preferred_modifier_order = public,private,protected,internal,file,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async
97+
98+
# Code-block preferences
99+
csharp_prefer_braces = true
100+
csharp_prefer_simple_using_statement = true
101+
102+
# Expression-level preferences
103+
csharp_prefer_simple_default_expression = true
104+
csharp_style_deconstructed_variable_declaration = true
105+
csharp_style_inlined_variable_declaration = true
106+
csharp_style_prefer_index_operator = true
107+
csharp_style_prefer_range_operator = true
108+
csharp_style_throw_expression = true
109+
csharp_style_unused_value_assignment_preference = discard_variable
110+
csharp_style_unused_value_expression_statement_preference = discard_variable
111+
112+
# 'using' directive preferences
113+
csharp_using_directive_placement = outside_namespace
114+
115+
#### C# Formatting Rules ####
116+
117+
# New line preferences
118+
csharp_new_line_before_catch = true
119+
csharp_new_line_before_else = true
120+
csharp_new_line_before_finally = true
121+
csharp_new_line_before_members_in_anonymous_types = true
122+
csharp_new_line_before_members_in_object_initializers = true
123+
csharp_new_line_before_open_brace = all
124+
csharp_new_line_between_query_expression_clauses = true
125+
126+
# Indentation preferences
127+
csharp_indent_block_contents = true
128+
csharp_indent_braces = false
129+
csharp_indent_case_contents = true
130+
csharp_indent_case_contents_when_block = true
131+
csharp_indent_labels = one_less_than_current
132+
csharp_indent_switch_labels = true
133+
134+
# Space preferences
135+
csharp_space_after_cast = false
136+
csharp_space_after_colon_in_inheritance_clause = true
137+
csharp_space_after_comma = true
138+
csharp_space_after_dot = false
139+
csharp_space_after_keywords_in_control_flow_statements = true
140+
csharp_space_after_semicolon_in_for_statement = true
141+
csharp_space_around_binary_operators = before_and_after
142+
csharp_space_around_declaration_statements = false
143+
csharp_space_before_colon_in_inheritance_clause = true
144+
csharp_space_before_comma = false
145+
csharp_space_before_dot = false
146+
csharp_space_before_open_square_brackets = false
147+
csharp_space_before_semicolon_in_for_statement = false
148+
csharp_space_between_empty_square_brackets = false
149+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
150+
csharp_space_between_method_call_name_and_opening_parenthesis = false
151+
csharp_space_between_method_call_parameter_list_parentheses = false
152+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
153+
csharp_space_between_method_declaration_name_and_open_parenthesis = false
154+
csharp_space_between_method_declaration_parameter_list_parentheses = false
155+
csharp_space_between_square_brackets = false
156+
157+
# Wrapping preferences
158+
csharp_preserve_single_line_blocks = true
159+
csharp_preserve_single_line_statements = true
160+
161+
#### Naming styles ####
162+
163+
# Naming rules
164+
165+
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
166+
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
167+
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
168+
169+
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
170+
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
171+
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
172+
173+
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
174+
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
175+
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
176+
177+
# Symbol specifications
178+
179+
dotnet_naming_symbols.interface.applicable_kinds = interface
180+
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
181+
dotnet_naming_symbols.interface.required_modifiers =
182+
183+
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
184+
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
185+
dotnet_naming_symbols.types.required_modifiers =
186+
187+
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
188+
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
189+
dotnet_naming_symbols.non_field_members.required_modifiers =
190+
191+
# Naming styles
192+
193+
dotnet_naming_style.pascal_case.required_prefix =
194+
dotnet_naming_style.pascal_case.required_suffix =
195+
dotnet_naming_style.pascal_case.word_separator =
196+
dotnet_naming_style.pascal_case.capitalization = pascal_case
197+
198+
dotnet_naming_style.begins_with_i.required_prefix = I
199+
dotnet_naming_style.begins_with_i.required_suffix =
200+
dotnet_naming_style.begins_with_i.word_separator =
201+
dotnet_naming_style.begins_with_i.capitalization = pascal_case

‎.github/workflows/main.yml

+28-1
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,38 @@ on:
77
push:
88
branches: [ "main" ]
99
pull_request:
10+
branches: [ "*" ]
1011
paths:
12+
- "**"
1113
- "!**.md"
1214

1315
jobs:
14-
test:
16+
17+
lint:
18+
name: Lint
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: Check out Git repository
23+
uses: actions/checkout@v3
24+
25+
- name: Set up .NET
26+
uses: actions/setup-dotnet@v1
27+
with:
28+
dotnet-version: "8.0.x"
29+
30+
- name: .NET Lint
31+
uses: zyactions/dotnet-lint@v1
32+
with:
33+
implicit-restore: true
34+
workspace: sqlc-gen-csharp.sln
35+
exclude: |
36+
GeneratedProtobuf
37+
MySqlConnectorExample
38+
NpgsqlExample
39+
40+
ci:
41+
name: CI
1542
runs-on: ${{ matrix.os }}
1643
if: ${{ always() }}
1744
strategy:

‎CodeGenerator/ClassMember.cs

+23-23
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
1-
using System;
2-
3-
namespace SqlcGenCsharp;
4-
5-
public enum ClassMember
6-
{
7-
Row,
8-
Args,
9-
Sql
10-
}
11-
12-
public static class ClassMemberTypeExtensions
13-
{
14-
public static string Name(this ClassMember me)
15-
{
16-
return me switch
17-
{
18-
ClassMember.Sql => "Sql",
19-
ClassMember.Row => "Row",
20-
ClassMember.Args => "Args",
21-
_ => throw new ArgumentOutOfRangeException(nameof(me), me, null)
22-
};
23-
}
1+
using System;
2+
3+
namespace SqlcGenCsharp;
4+
5+
public enum ClassMember
6+
{
7+
Row,
8+
Args,
9+
Sql
10+
}
11+
12+
public static class ClassMemberTypeExtensions
13+
{
14+
public static string Name(this ClassMember me)
15+
{
16+
return me switch
17+
{
18+
ClassMember.Sql => "Sql",
19+
ClassMember.Row => "Row",
20+
ClassMember.Args => "Args",
21+
_ => throw new ArgumentOutOfRangeException(nameof(me), me, null)
22+
};
23+
}
2424
}

0 commit comments

Comments
 (0)