Skip to content

Commit fa1a091

Browse files
authored
Separate example projects from library solution (#405)
* Separate examples into their own top-level folder and solution. * This will make the examples more visible to library users. * It also makes the purpose of the src folder more clear - it is where the package code is. * Change to ubuntu for CI-tests workflow * Rename developer docs to follow naming conventions * Remove build project from primary project
1 parent df9234b commit fa1a091

Some content is hidden

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

46 files changed

+334
-112
lines changed
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
name: Continuous Integration - Build all and run tests
1+
name: CI - Run all tests
22

33
on: [push]
44

55
jobs:
66
build:
77

8-
runs-on: windows-latest
8+
runs-on: ubuntu-latest
99

1010
steps:
1111
- uses: actions/checkout@v4
1212
with:
1313
lfs: true
1414

1515
- name: Build all and run tests
16-
run: .\build.cmd Test
16+
run: ./build.sh Test

README.md

Lines changed: 1 addition & 1 deletion

docs/libplctag.NativeImport.md

Lines changed: 1 addition & 1 deletion

docs/libplctag.md

Lines changed: 5 additions & 5 deletions

examples/.editorconfig

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
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+
file_header_template = Copyright (c) libplctag.NET contributors\nhttps://github.com/libplctag/libplctag.NET\n\nThis Source Code Form is subject to the terms of the Mozilla Public\nLicense, v. 2.0. If a copy of the MPL was not distributed with this\nfile, You can obtain one at https://mozilla.org/MPL/2.0/.
19+
20+
#### .NET Coding Conventions ####
21+
22+
# Organize usings
23+
dotnet_separate_import_directive_groups = false
24+
dotnet_sort_system_directives_first = false
25+
file_header_template = unset
26+
27+
# this. and Me. preferences
28+
dotnet_style_qualification_for_event = false
29+
dotnet_style_qualification_for_field = false
30+
dotnet_style_qualification_for_method = false
31+
dotnet_style_qualification_for_property = false
32+
33+
# Language keywords vs BCL types preferences
34+
dotnet_style_predefined_type_for_locals_parameters_members = true
35+
dotnet_style_predefined_type_for_member_access = true
36+
37+
# Parentheses preferences
38+
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity
39+
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity
40+
dotnet_style_parentheses_in_other_operators = never_if_unnecessary
41+
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity
42+
43+
# Modifier preferences
44+
dotnet_style_require_accessibility_modifiers = for_non_interface_members
45+
46+
# Expression-level preferences
47+
dotnet_style_coalesce_expression = true
48+
dotnet_style_collection_initializer = true
49+
dotnet_style_explicit_tuple_names = true
50+
dotnet_style_namespace_match_folder = true
51+
dotnet_style_null_propagation = true
52+
dotnet_style_object_initializer = true
53+
dotnet_style_operator_placement_when_wrapping = beginning_of_line
54+
dotnet_style_prefer_auto_properties = true
55+
dotnet_style_prefer_compound_assignment = true
56+
dotnet_style_prefer_conditional_expression_over_assignment = true
57+
dotnet_style_prefer_conditional_expression_over_return = true
58+
dotnet_style_prefer_foreach_explicit_cast_in_source = when_strongly_typed
59+
dotnet_style_prefer_inferred_anonymous_type_member_names = true
60+
dotnet_style_prefer_inferred_tuple_names = true
61+
dotnet_style_prefer_is_null_check_over_reference_equality_method = true
62+
dotnet_style_prefer_simplified_boolean_expressions = true
63+
dotnet_style_prefer_simplified_interpolation = true
64+
65+
# Field preferences
66+
dotnet_style_readonly_field = true
67+
68+
# Parameter preferences
69+
dotnet_code_quality_unused_parameters = all
70+
71+
# Suppression preferences
72+
dotnet_remove_unnecessary_suppression_exclusions = none
73+
74+
# New line preferences
75+
dotnet_style_allow_multiple_blank_lines_experimental = true
76+
dotnet_style_allow_statement_immediately_after_block_experimental = true
77+
78+
#### C# Coding Conventions ####
79+
80+
# var preferences
81+
csharp_style_var_elsewhere = false
82+
csharp_style_var_for_built_in_types = false
83+
csharp_style_var_when_type_is_apparent = false
84+
85+
# Expression-bodied members
86+
csharp_style_expression_bodied_accessors = true
87+
csharp_style_expression_bodied_constructors = false
88+
csharp_style_expression_bodied_indexers = true
89+
csharp_style_expression_bodied_lambdas = true
90+
csharp_style_expression_bodied_local_functions = false
91+
csharp_style_expression_bodied_methods = false
92+
csharp_style_expression_bodied_operators = false
93+
csharp_style_expression_bodied_properties = true
94+
95+
# Pattern matching preferences
96+
csharp_style_pattern_matching_over_as_with_null_check = true
97+
csharp_style_pattern_matching_over_is_with_cast_check = true
98+
csharp_style_prefer_extended_property_pattern = true
99+
csharp_style_prefer_not_pattern = true
100+
csharp_style_prefer_pattern_matching = true
101+
csharp_style_prefer_switch_expression = true
102+
103+
# Null-checking preferences
104+
csharp_style_conditional_delegate_call = true
105+
106+
# Modifier preferences
107+
csharp_prefer_static_local_function = true
108+
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,required,volatile,async
109+
110+
# Code-block preferences
111+
csharp_prefer_braces = true
112+
csharp_prefer_simple_using_statement = true
113+
csharp_style_namespace_declarations = block_scoped
114+
csharp_style_prefer_method_group_conversion = true
115+
csharp_style_prefer_top_level_statements = true
116+
117+
# Expression-level preferences
118+
csharp_prefer_simple_default_expression = true
119+
csharp_style_deconstructed_variable_declaration = true
120+
csharp_style_implicit_object_creation_when_type_is_apparent = true
121+
csharp_style_inlined_variable_declaration = true
122+
csharp_style_prefer_index_operator = true
123+
csharp_style_prefer_local_over_anonymous_function = true
124+
csharp_style_prefer_null_check_over_type_check = true
125+
csharp_style_prefer_range_operator = true
126+
csharp_style_prefer_tuple_swap = true
127+
csharp_style_prefer_utf8_string_literals = true
128+
csharp_style_throw_expression = true
129+
csharp_style_unused_value_assignment_preference = discard_variable
130+
csharp_style_unused_value_expression_statement_preference = discard_variable
131+
132+
# 'using' directive preferences
133+
csharp_using_directive_placement = outside_namespace
134+
135+
# New line preferences
136+
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true
137+
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true
138+
csharp_style_allow_embedded_statements_on_same_line_experimental = true
139+
140+
#### C# Formatting Rules ####
141+
142+
# New line preferences
143+
csharp_new_line_before_catch = true
144+
csharp_new_line_before_else = true
145+
csharp_new_line_before_finally = true
146+
csharp_new_line_before_members_in_anonymous_types = true
147+
csharp_new_line_before_members_in_object_initializers = true
148+
csharp_new_line_before_open_brace = all
149+
csharp_new_line_between_query_expression_clauses = true
150+
151+
# Indentation preferences
152+
csharp_indent_block_contents = true
153+
csharp_indent_braces = false
154+
csharp_indent_case_contents = true
155+
csharp_indent_case_contents_when_block = true
156+
csharp_indent_labels = one_less_than_current
157+
csharp_indent_switch_labels = true
158+
159+
# Space preferences
160+
csharp_space_after_cast = false
161+
csharp_space_after_colon_in_inheritance_clause = true
162+
csharp_space_after_comma = true
163+
csharp_space_after_dot = false
164+
csharp_space_after_keywords_in_control_flow_statements = true
165+
csharp_space_after_semicolon_in_for_statement = true
166+
csharp_space_around_binary_operators = before_and_after
167+
csharp_space_around_declaration_statements = false
168+
csharp_space_before_colon_in_inheritance_clause = true
169+
csharp_space_before_comma = false
170+
csharp_space_before_dot = false
171+
csharp_space_before_open_square_brackets = false
172+
csharp_space_before_semicolon_in_for_statement = false
173+
csharp_space_between_empty_square_brackets = false
174+
csharp_space_between_method_call_empty_parameter_list_parentheses = false
175+
csharp_space_between_method_call_name_and_opening_parenthesis = false
176+
csharp_space_between_method_call_parameter_list_parentheses = false
177+
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
178+
csharp_space_between_method_declaration_name_and_open_parenthesis = false
179+
csharp_space_between_method_declaration_parameter_list_parentheses = false
180+
csharp_space_between_parentheses = false
181+
csharp_space_between_square_brackets = false
182+
183+
# Wrapping preferences
184+
csharp_preserve_single_line_blocks = true
185+
csharp_preserve_single_line_statements = true
186+
187+
#### Naming styles ####
188+
189+
# Naming rules
190+
191+
dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
192+
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
193+
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i
194+
195+
dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
196+
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
197+
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case
198+
199+
dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
200+
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
201+
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case
202+
203+
# Symbol specifications
204+
205+
dotnet_naming_symbols.interface.applicable_kinds = interface
206+
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
207+
dotnet_naming_symbols.interface.required_modifiers =
208+
209+
dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
210+
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
211+
dotnet_naming_symbols.types.required_modifiers =
212+
213+
dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
214+
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
215+
dotnet_naming_symbols.non_field_members.required_modifiers =
216+
217+
# Naming styles
218+
219+
dotnet_naming_style.pascal_case.required_prefix =
220+
dotnet_naming_style.pascal_case.required_suffix =
221+
dotnet_naming_style.pascal_case.word_separator =
222+
dotnet_naming_style.pascal_case.capitalization = pascal_case
223+
224+
dotnet_naming_style.begins_with_i.required_prefix = I
225+
dotnet_naming_style.begins_with_i.required_suffix =
226+
dotnet_naming_style.begins_with_i.word_separator =
227+
dotnet_naming_style.begins_with_i.capitalization = pascal_case
228+
229+
#
230+
[*.{cs}]
231+
dotnet_diagnostic.CS1591.severity=silent # Ignore Missing XML documentation

src/Examples/CSharp DotNetCore/CSharp DotNetCore.csproj renamed to examples/CSharp DotNetCore/CSharp DotNetCore.csproj

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,12 @@
88
<ItemGroup>
99
<PackageReference Include="CompareNETObjects" Version="4.66.0" />
1010
<PackageReference Include="ConsoleTables" Version="2.4.2" />
11+
<PackageReference Include="libplctag" Version="1.5.1" />
1112
<PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="5.0.0" />
1213
<PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="5.0.0" />
1314
<PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.0" />
1415
<PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="5.0.0" />
1516
<PackageReference Include="RandomTestValues" Version="2.0.5.1" />
1617
</ItemGroup>
1718

18-
<ItemGroup>
19-
<ProjectReference Include="..\..\libplctag\libplctag.csproj" />
20-
</ItemGroup>
21-
2219
</Project>

src/Examples/CSharp DotNetFramework/CSharp DotNetFramework.csproj renamed to examples/CSharp DotNetFramework/CSharp DotNetFramework.csproj

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@
3333
<WarningLevel>4</WarningLevel>
3434
</PropertyGroup>
3535
<ItemGroup>
36+
<Reference Include="libplctag, Version=1.5.1.0, Culture=neutral, processorArchitecture=MSIL">
37+
<HintPath>..\packages\libplctag.1.5.1\lib\netstandard2.0\libplctag.dll</HintPath>
38+
<Private>True</Private>
39+
</Reference>
3640
<Reference Include="System" />
3741
<Reference Include="System.Core" />
3842
<Reference Include="System.Xml.Linq" />
@@ -50,12 +54,7 @@
5054
</ItemGroup>
5155
<ItemGroup>
5256
<None Include="App.config" />
53-
</ItemGroup>
54-
<ItemGroup>
55-
<ProjectReference Include="..\..\libplctag\libplctag.csproj">
56-
<Project>{A488D8F2-712F-440E-9024-F27A75FEB171}</Project>
57-
<Name>libplctag</Name>
58-
</ProjectReference>
57+
<None Include="packages.config" />
5958
</ItemGroup>
6059
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
6160
</Project>
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<packages>
3+
<package id="libplctag" version="1.5.1" targetFramework="net472" />
4+
<package id="libplctag.NativeImport" version="1.0.40" targetFramework="net472" />
5+
<package id="System.Net.Primitives" version="4.3.1" targetFramework="net472" />
6+
</packages>

src/Examples/CSharp NativeImport/CSharp NativeImport.csproj renamed to examples/CSharp NativeImport/CSharp NativeImport.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</PropertyGroup>
88

99
<ItemGroup>
10-
<ProjectReference Include="..\..\libplctag.NativeImport\libplctag.NativeImport.csproj" />
10+
<PackageReference Include="libplctag.NativeImport" Version="1.0.40" />
1111
</ItemGroup>
1212

1313
</Project>

src/LibplctagReadBenchmark/LibplctagReadBenchmark.csproj renamed to examples/LibplctagReadBenchmark/LibplctagReadBenchmark.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
</PropertyGroup>
99

1010
<ItemGroup>
11-
<ProjectReference Include="..\libplctag\libplctag.csproj" />
11+
<PackageReference Include="libplctag" Version="1.5.1" />
1212
</ItemGroup>
1313

1414
</Project>

0 commit comments

Comments
 (0)