11 |
12 | -green?logo=github)
13 |
14 |
15 |
16 |
13 |
14 | Code-style Rules for C#/.NET EditorConfig
4 |This page lists the rules that are currently supported, their options, and corresponding code samples.
5 |6 | 7 | 8 |
-
9 | @foreach (var codeStyleRule in FilteredCodeStyleRules)
10 | {
11 | @foreach (var option in codeStyleRule.Options)
12 | {
13 |
-
14 | 15 |48 |
16 |
18 | @if (option.ValueOptions is OneOfManyValueOptions oneOfMany) 19 | { 20 |@option.Name- @codeStyleRule.Title (@codeStyleRule.Id) 17 |-
21 | @foreach (var optionValue in oneOfMany.Options)
22 | {
23 |
-
24 |
@optionValue.Value- 25 | @optionValue.Description 26 |27 |
28 | }
29 |
34 | This rule takes an ordered list of the following options without repititions. 35 |
36 |-
37 | @foreach (var value in orderedSet.Options)
38 | {
39 |
-
40 | 41 |43 |
@value42 |
44 | }
45 |
49 | }
50 | }
51 | -
24 |
4 |
18 |
5 | @if (progress is not 0)
6 | {
7 |
8 | }
9 |
10 | 11 | @if (progress is not 0 && progress != totalQuestions + 1) 12 | { 13 | Question @progress of @totalQuestions 14 | } 15 |
16 | 17 |
19 | @if (currentCodeStyleRule is null && codeRuleIndex != codeStyleRules.Count)
20 | {
21 |
--------------------------------------------------------------------------------
/src/KristofferStrube.EditorConfigWizard/Pages/Wizard.razor.cs:
--------------------------------------------------------------------------------
1 | using KristofferStrube.EditorConfigWizard.Models;
2 | using KristofferStrube.EditorConfigWizard.Models.Options;
3 | using KristofferStrube.EditorConfigWizard.Services;
4 | using Microsoft.AspNetCore.Components;
5 | using Microsoft.JSInterop;
6 | using System.Text;
7 |
8 | namespace KristofferStrube.EditorConfigWizard.Pages;
9 |
10 | public partial class Wizard : ComponentBase
11 | {
12 | private const int TRANSITION_TIME = 200;
13 |
14 | private CodeStyleRule? currentCodeStyleRule = null;
15 | private RuleOption? currentRuleOption = null;
16 | private List
22 |
24 | Create an EditorConfig file for your .NET/C# project.
23 |
25 |
41 | }
42 | else if (currentRuleOption is not null)
43 | {
44 | 26 | Select Categories 27 |
28 | 29 |
30 | @foreach (var category in codeStyleCategories)
31 | {
32 |
39 |
40 |
33 |
34 |
35 |
36 | @category.Description
37 | } 38 |
45 |
52 |
46 |
47 |
50 |
51 |
47 | @((MarkupString)string.Join("_", currentRuleOption.Name.Split("_").Select(part => $"{part}")))
48 | – @currentCodeStyleRule.Title (@currentCodeStyleRule.Id)
49 |
50 |
53 |
65 | }
66 | else if (ruleOptionIndex == currentCodeStyleRule?.Options.Count)
67 | {
68 | Which do you prefer?
54 |
55 | @if (currentRuleOption.ValueOptions is OneOfManyValueOptions oneOfMany)
56 | {
57 |
64 |
69 |
73 | 70 | What severity should @(ruleOptionIndex is 0 or 1 ? "this rule" : "these rules") be prompted as? 71 |
72 |
74 |
101 | }
102 | else
103 | {
104 |
75 |
79 | 76 | @currentCodeStyleRule.Id: "@currentCodeStyleRule.Title" 77 |
78 |
80 |
81 |
82 |
83 |
84 |
85 |
86 | @if (currentCodeStyleRule.Sample is { Length: > 0 } sample)
87 | {
88 | Sample
89 |
90 |
92 | }
93 | @if (currentCodeStyleRule.FixedSample is { Length: > 0 } fixedSample)
94 | {
95 | Fixed
96 |
97 |
99 | }
100 |
105 |
106 |
108 |
109 |
106 | This is your new EditorConfig
107 |
108 |
110 |
112 |
113 |
114 |
115 | }
116 |
17 |
18 | @Code.Trim()
19 |
20 |
21 | }
22 |
23 | @code {
24 | private ElementReference codeBlock;
25 |
26 | private string commonClasses = "text-start";
27 |
28 | private string? hoverClasses;
29 |
30 | [Parameter, EditorRequired]
31 | public string Code { get; set; } = "";
32 |
33 | [Parameter, EditorRequired]
34 | public string Language { get; set; } = "";
35 |
36 | [Parameter]
37 | public Color? BorderHoverColor { get; set; }
38 |
39 | [Parameter]
40 | public Color? BorderColor { get; set; }
41 |
42 | [Parameter]
43 | public Func
5 |
8 |
9 |
10 |
17 | @Body
18 |
19 |
20 |
21 |
22 | @code {
23 | private string relativeUri => NavigationManager.ToBaseRelativePath(NavigationManager.Uri);
24 |
25 | protected string page => (string.IsNullOrEmpty(relativeUri) ? "Index" : relativeUri) + ".razor";
26 | }
--------------------------------------------------------------------------------
/src/KristofferStrube.EditorConfigWizard/Shared/MainLayout.razor.css:
--------------------------------------------------------------------------------
1 | .page {
2 | position: relative;
3 | display: flex;
4 | flex-direction: column;
5 | }
6 |
7 | main {
8 | flex: 1;
9 | }
10 |
11 | .sidebar {
12 | background-image: linear-gradient(180deg, rgb(5, 39, 103) 0%, #3a0647 70%);
13 | }
14 |
15 | .top-row {
16 | background-color: #f7f7f7;
17 | border-bottom: 1px solid #d6d5d5;
18 | justify-content: flex-end;
19 | height: 3.5rem;
20 | display: flex;
21 | align-items: center;
22 | }
23 |
24 | .top-row ::deep a, .top-row ::deep .btn-link {
25 | white-space: nowrap;
26 | margin-left: 1.5rem;
27 | text-decoration: none;
28 | }
29 |
30 | .top-row ::deep a:hover, .top-row ::deep .btn-link:hover {
31 | text-decoration: underline;
32 | }
33 |
34 | .top-row ::deep a:first-child {
35 | overflow: hidden;
36 | text-overflow: ellipsis;
37 | }
38 |
39 | @media (max-width: 767.98px) {
40 | .top-row:not(.auth) {
41 | display: none;
42 | }
43 |
44 | .top-row.auth {
45 | justify-content: space-between;
46 | }
47 |
48 | .top-row ::deep a, .top-row ::deep .btn-link {
49 | margin-left: 0;
50 | }
51 | }
52 |
53 | @media (min-width: 768px) {
54 | .page {
55 | flex-direction: row;
56 | }
57 |
58 | .sidebar {
59 | width: 250px;
60 | height: 100vh;
61 | position: sticky;
62 | top: 0;
63 | }
64 |
65 | .top-row {
66 | position: sticky;
67 | top: 0;
68 | z-index: 1;
69 | }
70 |
71 | .top-row.auth ::deep a:first-child {
72 | flex: 1;
73 | text-align: right;
74 | width: 0;
75 | }
76 |
77 | .top-row, article {
78 | padding-left: 2rem !important;
79 | padding-right: 1.5rem !important;
80 | }
81 | }
82 |
--------------------------------------------------------------------------------
/src/KristofferStrube.EditorConfigWizard/Shared/NavMenu.razor:
--------------------------------------------------------------------------------
1 |
9 |
10 |
11 |
23 |
24 |
25 | @code {
26 | private bool collapseNavMenu = true;
27 |
28 | private string? NavMenuCssClass => collapseNavMenu ? "collapse" : null;
29 |
30 | private void ToggleNavMenu()
31 | {
32 | collapseNavMenu = !collapseNavMenu;
33 | }
34 | }
35 |
--------------------------------------------------------------------------------
/src/KristofferStrube.EditorConfigWizard/Shared/NavMenu.razor.css:
--------------------------------------------------------------------------------
1 | .navbar-toggler {
2 | background-color: rgba(255, 255, 255, 0.1);
3 | }
4 |
5 | .top-row {
6 | height: 3.5rem;
7 | background-color: rgba(0,0,0,0.4);
8 | }
9 |
10 | .navbar-brand {
11 | font-size: 1.1rem;
12 | }
13 |
14 | .oi {
15 | width: 2rem;
16 | font-size: 1.1rem;
17 | vertical-align: text-top;
18 | top: -2px;
19 | }
20 |
21 | .nav-item {
22 | font-size: 0.9rem;
23 | padding-bottom: 0.5rem;
24 | }
25 |
26 | .nav-item:first-of-type {
27 | padding-top: 1rem;
28 | }
29 |
30 | .nav-item:last-of-type {
31 | padding-bottom: 1rem;
32 | }
33 |
34 | .nav-item ::deep a {
35 | color: #d7d7d7;
36 | border-radius: 4px;
37 | height: 3rem;
38 | display: flex;
39 | align-items: center;
40 | line-height: 3rem;
41 | }
42 |
43 | .nav-item ::deep a.active {
44 | background-color: rgba(255,255,255,0.25);
45 | color: white;
46 | }
47 |
48 | .nav-item ::deep a:hover {
49 | background-color: rgba(255,255,255,0.1);
50 | color: white;
51 | }
52 |
53 | @media (min-width: 768px) {
54 | .navbar-toggler {
55 | display: none;
56 | }
57 |
58 | .collapse {
59 | /* Never collapse the sidebar for wide screens */
60 | display: block;
61 | }
62 |
63 | .nav-scrollable {
64 | /* Allow sidebar to scroll for tall menus */
65 | height: calc(100vh - 3.5rem);
66 | overflow-y: auto;
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/src/KristofferStrube.EditorConfigWizard/Shared/OneOfManyValueOptionsPicker.razor:
--------------------------------------------------------------------------------
1 | -
2 | @foreach (var optionValue in ValueOptions.Options)
3 | {
4 |
-
5 | 6 |8 |
@optionValue.Value@(optionValue.Value == ValueOptions.DefaultOptionValue ? " (default)" : "") 7 |@optionValue.Description
9 |15 |
16 | }
17 |
2 | @ValueOptions.Description 3 |
4 |Currently selected Options
5 |
6 | @for (int i = 0; i < selectedOptions.Count(); i++)
7 | {
8 | var value = selectedOptions[i];
9 |
22 | @if (nonSelectedOptions.Count() > 0)
23 | {
24 |
10 |
20 | }
21 |
11 |
14 | @(i+1).
12 | @value
13 |
15 | <
16 | X
17 | >
18 |
19 | Non-selected options
25 |
26 | @foreach (var value in nonSelectedOptions)
27 | {
28 |
36 | }
37 |
29 |
34 | }
35 | @value
30 |
31 | +
32 |
33 | 38 | Samples 39 |
40 | @foreach(var template in ValueOptions.PresenterTemplates) 41 | { 42 |
30 | ```
31 |
32 | #### Using Open Iconic's SVG Sprite
33 |
34 | Open Iconic also comes in a SVG sprite which allows you to display all the icons in the set with a single request. It's like an icon font, without being a hack.
35 |
36 | Adding an icon from an SVG sprite is a little different than what you're used to, but it's still a piece of cake. *Tip: To make your icons easily style able, we suggest adding a general class to the* `