Skip to content

Commit

Permalink
Add linter, editorconfig and prettier (#211)
Browse files Browse the repository at this point in the history
* Add linter and basic config

* First pass lint fixes

* Rewrite getLogo in Export to fix linter error

* WIP second pass of fixing linter errors

* WIP: Enforce and fix more linting rules

* Final pass of lint fixes and disable linting for errors that cannot be fixed

* Add basic editorconfig and apply suggestions

* Apply additional editorconfig rules

- Applied No empty lines between braces
- Applied remove unneccsary usings

* Fix liniting errors from merge

* Add prettier and configure

* Apply prettier changes

* Add watcher for prettier and intergrate with vs project open

* Update NuGet packages

* Fix and update linter and editorconfigs

- remove unnecessary plugin from eslint config
- fix prettier watch script
- update editorconfig to align with prettier defaults

* Fix up final issues and revert changes to editorconfig
  • Loading branch information
RobQuincey-DC authored Jan 9, 2024
1 parent 7452a3c commit 6640074
Show file tree
Hide file tree
Showing 200 changed files with 19,297 additions and 15,242 deletions.
136 changes: 136 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,136 @@

[*.{cs,vb}]
#### 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.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

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.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_style_coalesce_expression = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
dotnet_style_prefer_auto_properties = true:silent
dotnet_style_object_initializer = true:suggestion
dotnet_style_prefer_collection_expression = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_compound_assignment = true:suggestion
dotnet_style_prefer_simplified_interpolation = true:suggestion
dotnet_style_namespace_match_folder = true:suggestion
dotnet_style_operator_placement_when_wrapping = beginning_of_line
tab_width = 4
indent_size = 4
end_of_line = crlf
indent_style = tab
dotnet_style_readonly_field = true:suggestion
dotnet_style_predefined_type_for_locals_parameters_members = true:silent
dotnet_style_predefined_type_for_member_access = true:silent
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
dotnet_style_allow_multiple_blank_lines_experimental = false:suggestion
dotnet_style_allow_statement_immediately_after_block_experimental = true:silent
dotnet_code_quality_unused_parameters = all:suggestion
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_relational_binary_operators = always_for_clarity:silent
dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
dotnet_style_qualification_for_field = false:silent
dotnet_style_qualification_for_property = false:silent
dotnet_style_qualification_for_method = false:silent
dotnet_style_qualification_for_event = false:silent

[*.cs]
csharp_using_directive_placement = outside_namespace:silent
csharp_prefer_simple_using_statement = true:suggestion
csharp_prefer_braces = true:silent
csharp_style_namespace_declarations = block_scoped:silent
csharp_style_prefer_method_group_conversion = true:silent
csharp_style_prefer_top_level_statements = true:silent
csharp_style_prefer_primary_constructors = true:suggestion
csharp_style_expression_bodied_methods = false:silent
csharp_style_expression_bodied_constructors = false:silent
csharp_style_expression_bodied_operators = false:silent
csharp_style_expression_bodied_properties = true:silent
csharp_style_expression_bodied_indexers = true:silent
csharp_style_expression_bodied_accessors = true:silent
csharp_style_expression_bodied_lambdas = true:silent
csharp_style_expression_bodied_local_functions = false:silent
csharp_style_throw_expression = true:suggestion
csharp_style_prefer_null_check_over_type_check = true:suggestion
csharp_prefer_simple_default_expression = true:suggestion
csharp_indent_labels = one_less_than_current
csharp_style_prefer_local_over_anonymous_function = true:suggestion
csharp_space_around_binary_operators = before_and_after
csharp_style_prefer_index_operator = true:suggestion
csharp_style_prefer_range_operator = true:suggestion
csharp_style_implicit_object_creation_when_type_is_apparent = true:suggestion
csharp_style_prefer_tuple_swap = true:suggestion
csharp_style_prefer_utf8_string_literals = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
csharp_style_unused_value_expression_statement_preference = discard_variable:silent
csharp_prefer_static_local_function = true:suggestion
csharp_style_prefer_readonly_struct = true:suggestion
csharp_style_prefer_readonly_struct_member = true:suggestion
csharp_style_allow_embedded_statements_on_same_line_experimental = true:silent
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = false:suggestion
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = true:silent
csharp_style_allow_blank_line_after_token_in_conditional_expression_experimental = true:silent
csharp_style_allow_blank_line_after_token_in_arrow_expression_clause_experimental = true:silent
csharp_style_conditional_delegate_call = true:suggestion
csharp_style_prefer_switch_expression = true:suggestion
csharp_style_prefer_pattern_matching = true:silent
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_prefer_not_pattern = true:suggestion
csharp_style_prefer_extended_property_pattern = true:suggestion
csharp_style_var_when_type_is_apparent = false:silent
csharp_style_var_for_built_in_types = false:silent
csharp_style_var_elsewhere = false:silent

dotnet_diagnostic.IDE0005.severity = suggestion
4 changes: 1 addition & 3 deletions GIFrameworkMap.Data/CoordHelper.cs
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
using System;
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using System.Text;
using System.Text.RegularExpressions;
[assembly: InternalsVisibleTo("GIFrameworkMaps.Tests")]
namespace GIFrameworkMaps.Data
{
public partial class CoordHelper
public partial class CoordHelper
{
/// <summary>
/// Checks whether a BNG 12 figure grid ref pair is within the UK
Expand Down
5 changes: 1 addition & 4 deletions GIFrameworkMap.Data/Data/CommonRepository.cs
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,6 @@ private static string CreateSlug(params string[] slugParts)
version.HelpURL = generalVersion!.HelpURL;
}


// Cache the results so they can be used next time we call this function.
_memoryCache.Set(cacheKey, version, TimeSpan.FromMinutes(10));
return version;
Expand All @@ -158,7 +157,7 @@ public Models.ViewModels.VersionViewModel GetVersionViewModel(Models.Version ver
_mapper.Map<List<Data.Models.VersionCategory>, List<Data.Models.ViewModels.CategoryViewModel>>(version.VersionCategories);

//remove duplicates
var allLayers = (from cat in version.VersionCategories from layers in cat.Category.Layers select layers).ToList();
var allLayers = (from cat in version.VersionCategories from layers in cat.Category!.Layers select layers).ToList();
var dupes = allLayers.GroupBy(l => l.LayerId).Where(l => l.Count() > 1).ToList();
foreach(var duplicate in dupes)
{
Expand Down Expand Up @@ -188,7 +187,6 @@ public Models.ViewModels.VersionViewModel GetVersionViewModel(Models.Version ver
matchedLayer.MaxZoom = (customisation.MaxZoom == null ? matchedLayer.MaxZoom : customisation.MaxZoom);
}
}

}

var viewModel = _mapper.Map<Data.Models.ViewModels.VersionViewModel>(version);
Expand Down Expand Up @@ -275,7 +273,6 @@ public List<ProxyAllowedHost> GetProxyAllowedHosts()
{
return cacheValue;
}

}

var allowedHosts = _context.ProxyAllowedHosts.AsNoTracking().ToList();
Expand Down
8 changes: 2 additions & 6 deletions GIFrameworkMap.Data/Data/IPrintRepository.cs
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
using System;
using System.Collections.Generic;
using System.Text;

namespace GIFrameworkMaps.Data
namespace GIFrameworkMaps.Data
{
public interface IPrintRepository
public interface IPrintRepository
{
Models.VersionPrintConfiguration GetPrintConfigurationByVersion(int versionId);
}
Expand Down
6 changes: 2 additions & 4 deletions GIFrameworkMap.Data/Data/ISearchRepository.cs
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
using System;
using System.Collections.Generic;
using System.Text;
using System.Collections.Generic;

namespace GIFrameworkMaps.Data
{
public interface ISearchRepository
public interface ISearchRepository
{
List<Models.VersionSearchDefinition> GetSearchDefinitionsByVersion(int versionId);
Models.Search.SearchResults Search(string searchTerm, List<Models.Search.RequiredSearch> requiredSearchesList);
Expand Down
7 changes: 1 addition & 6 deletions GIFrameworkMap.Data/Data/ManagementRepository.cs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
using GIFrameworkMaps.Data.Models.Search;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.Caching.Memory;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
Expand All @@ -14,7 +13,7 @@

namespace GIFrameworkMaps.Data
{
public class ManagementRepository : IManagementRepository
public class ManagementRepository : IManagementRepository
{
//dependancy injection
private readonly IApplicationDbContext _context;
Expand Down Expand Up @@ -213,7 +212,6 @@ public async Task<List<TourStep>> GetSteps()
return step;
}


public async Task<Category?> GetLayerCategory(int id)
{
var layerCategory = await _context.Category
Expand Down Expand Up @@ -335,8 +333,6 @@ public async Task<List<LocalSearchDefinition>> GetLocalSearchDefinitions()
skipLink = nextPage.OdataNextLink;
hasNextPage = !string.IsNullOrEmpty(skipLink);
}


}
}
else
Expand Down Expand Up @@ -368,7 +364,6 @@ public async Task<List<LocalSearchDefinition>> GetLocalSearchDefinitions()
{
var scopes = new[] { "https://graph.microsoft.com/.default" };


var tenantId = _configuration.GetSection("AzureAd")["TenantId"];
var clientId = _configuration.GetSection("AzureAd")["ClientId"];
var clientSecret = _configuration.GetSection("AzureAd")["ClientSecret"];
Expand Down
4 changes: 1 addition & 3 deletions GIFrameworkMap.Data/Data/Models/Attribution.cs
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;
using System.Text;

namespace GIFrameworkMaps.Data.Models
{
public class Attribution
public class Attribution
{
public int Id { get; set; }
[Required]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ComponentModel.DataAnnotations;

namespace GIFrameworkMaps.Data.Models.Authorization
{
public class ApplicationRole
public class ApplicationRole
{
public int Id { get; set; }
[MaxLength(200)]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ComponentModel.DataAnnotations;

namespace GIFrameworkMaps.Data.Models.Authorization
{
public class ApplicationUserRole
public class ApplicationUserRole
{
[Required]
public required string UserId { get; set; }
Expand Down
5 changes: 1 addition & 4 deletions GIFrameworkMap.Data/Data/Models/AutoMapping.cs
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
using AutoMapper;
using GIFrameworkMaps.Data.Models;
using GIFrameworkMaps.Data.Models.ViewModels;
using System.Collections.Generic;

namespace GIFrameworkMaps.Data
{
public class AutoMapping : Profile
public class AutoMapping : Profile
{
public AutoMapping()
{
Expand Down Expand Up @@ -50,8 +49,6 @@ public AutoMapping()
.ForMember(cl => cl.ProxyMapRequests, lvm => lvm.MapFrom(s => s.Layer!.ProxyMapRequests))
.ForMember(cl => cl.ProxyMetaRequests, lvm => lvm.MapFrom(s => s.Layer!.ProxyMetaRequests));


}

}
}
9 changes: 2 additions & 7 deletions GIFrameworkMap.Data/Data/Models/Basemap.cs
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.ComponentModel.DataAnnotations;

namespace GIFrameworkMaps.Data.Models
{
public class Basemap
public class Basemap
{
public int Id { get; set; }
[MaxLength(200)]
Expand Down
6 changes: 1 addition & 5 deletions GIFrameworkMap.Data/Data/Models/Bookmark.cs
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
using System;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace GIFrameworkMaps.Data.Models
{
public class Bookmark
public class Bookmark
{
public int Id { get; set;}
[Required, MaxLength(50)]
Expand Down
1 change: 0 additions & 1 deletion GIFrameworkMap.Data/Data/Models/Bound.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,5 @@ public class Bound
[DisplayName("Top right Y co-ordinate")]
[Range(-20048966.1, 20048966.1)]
public decimal TopRightY { get; set; }

}
}
8 changes: 2 additions & 6 deletions GIFrameworkMap.Data/Data/Models/Category.cs
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
using System;
using System.Collections.Generic;
using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace GIFrameworkMaps.Data.Models
{
public class Category
public class Category
{
public int Id { get; set; }
[MaxLength(200)]
Expand Down
10 changes: 2 additions & 8 deletions GIFrameworkMap.Data/Data/Models/CategoryLayer.cs
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace GIFrameworkMaps.Data.Models
namespace GIFrameworkMaps.Data.Models
{
public class CategoryLayer
public class CategoryLayer
{
public int LayerId { get; set; }
public int CategoryId { get; set; }
Expand Down
Loading

0 comments on commit 6640074

Please sign in to comment.