Adding editorconfig, switch to file-scoped cleanup. [release]

AddActionsWorkflow/.editorconfig

@@ -0,0 +1,166 @@
+# Rules in this file were initially inferred by Visual Studio IntelliCode from the D:\GitHub\AddActionsWorkflow\AddActionsWorkflow\ codebase based on best match to current usage at 18-Feb-22
+# You can modify the rules from these initially generated values to suit your own policies
+# You can learn more about editorconfig here: https://docs.microsoft.com/en-us/visualstudio/ide/editorconfig-code-style-settings-reference
+[*.cs]
+
+
+#Core editorconfig formatting - indentation
+
+#use soft tabs (spaces) for indentation
+indent_style = space
+
+#Formatting - new line options
+
+#place else statements on a new line
+csharp_new_line_before_else = true
+#require braces to be on a new line for types, methods, and control_blocks (also known as "Allman" style)
+csharp_new_line_before_open_brace = types, methods, control_blocks
+
+#Formatting - organize using options
+
+#do not place System.* using directives before other using directives
+dotnet_sort_system_directives_first = false
+
+#Formatting - spacing options
+
+#require a space before the colon for bases or interfaces in a type declaration
+csharp_space_after_colon_in_inheritance_clause = true
+#require a space after a keyword in a control flow statement such as a for loop
+csharp_space_after_keywords_in_control_flow_statements = true
+#require a space before the colon for bases or interfaces in a type declaration
+csharp_space_before_colon_in_inheritance_clause = true
+#remove space within empty argument list parentheses
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+#remove space between method call name and opening parenthesis
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+#do not place space characters after the opening parenthesis and before the closing parenthesis of a method call
+csharp_space_between_method_call_parameter_list_parentheses = false
+#place a space character after the opening parenthesis and before the closing parenthesis of a method declaration parameter list.
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+
+#Formatting - wrapping options
+
+#leave code block on single line
+csharp_preserve_single_line_blocks = true
+#leave statements and member declarations on the same line
+csharp_preserve_single_line_statements = true
+
+#Style - Code block preferences
+
+#prefer curly braces even for one line of code
+csharp_prefer_braces = true:suggestion
+
+#Style - expression bodied member options
+
+#prefer block bodies for methods
+csharp_style_expression_bodied_methods = false:suggestion
+
+#Style - implicit and explicit types
+
+#prefer var over explicit type in all cases, unless overridden by another code style rule
+csharp_style_var_elsewhere = true:suggestion
+#prefer var is used to declare variables with built-in system types such as int
+csharp_style_var_for_built_in_types = true:suggestion
+#prefer var when the type is already mentioned on the right-hand side of a declaration expression
+csharp_style_var_when_type_is_apparent = true:suggestion
+
+#Style - language keyword and framework type options
+
+#prefer the language keyword for local variables, method parameters, and class members, instead of the type name, for types that have a keyword to represent them
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+
+#Style - modifier options
+
+#prefer accessibility modifiers to be declared except for public interface members. This will currently not differ from always and will act as future proofing for if C# adds default interface methods.
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
+
+#Style - Modifier preferences
+
+#when this rule is set to a list of modifiers, prefer the specified ordering.
+csharp_preferred_modifier_order = public,internal,protected,async,override,sealed:suggestion
+
+#Style - qualification options
+
+#prefer fields not to be prefaced with this. or Me. in Visual Basic
+dotnet_style_qualification_for_field = false:suggestion
+#prefer methods not to be prefaced with this. or Me. in Visual Basic
+dotnet_style_qualification_for_method = false:suggestion
+csharp_indent_labels = one_less_than_current
+csharp_using_directive_placement = outside_namespace:suggestion
+csharp_prefer_simple_using_statement = true:suggestion
+csharp_style_namespace_declarations = file_scoped:warning
+csharp_style_prefer_method_group_conversion = true: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
+
+[*.{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_operator_placement_when_wrapping = beginning_of_line
+tab_width = 4
+indent_size = 4
+end_of_line = crlf
+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_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

AddActionsWorkflow/AddActionsWorkflow.csproj

@@ -62,6 +62,7 @@
     </Compile>
   </ItemGroup>
   <ItemGroup>
+    <None Include=".editorconfig" />
     <None Include="source.extension.vsixmanifest">
       <SubType>Designer</SubType>
       <Generator>VsixManifestGenerator</Generator>

AddActionsWorkflow/AddActionsWorkflowPackage.cs

@@ -6,19 +6,18 @@
 using System.Threading;
 using AddActionsWorkflow.Options;
 
-namespace AddActionsWorkflow
+namespace AddActionsWorkflow;
+
+[PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]
+[InstalledProductRegistration(Vsix.Name, Vsix.Description, Vsix.Version)]
+[ProvideMenuResource("Menus.ctmenu", 1)]
+[Guid(PackageGuids.AddActionsWorkflowString)]
+[ProvideOptionPage(typeof(OptionsProvider.GeneralOptions), "GitHub Actions Workflow", "General", 0, 0, true)]
+[ProvideProfile(typeof(OptionsProvider.GeneralOptions), "GitHub Actions Workflow", "General", 0, 0, true)]
+public sealed class AddActionsWorkflowPackage : ToolkitPackage
 {
-    [PackageRegistration(UseManagedResourcesOnly = true, AllowsBackgroundLoading = true)]
-    [InstalledProductRegistration(Vsix.Name, Vsix.Description, Vsix.Version)]
-    [ProvideMenuResource("Menus.ctmenu", 1)]
-    [Guid(PackageGuids.AddActionsWorkflowString)]
-    [ProvideOptionPage(typeof(OptionsProvider.GeneralOptions), "GitHub Actions Workflow", "General", 0, 0, true)]
-    [ProvideProfile(typeof(OptionsProvider.GeneralOptions), "GitHub Actions Workflow", "General", 0, 0, true)]
-    public sealed class AddActionsWorkflowPackage : ToolkitPackage
+    protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
     {
-        protected override async Task InitializeAsync(CancellationToken cancellationToken, IProgress<ServiceProgressData> progress)
-        {
-            await this.RegisterCommandsAsync();
-        }
+        await this.RegisterCommandsAsync();
     }
-}
+}

AddActionsWorkflow/Commands/LaunchRemoteUrlCommand.cs

@@ -8,40 +8,39 @@
 using System.Text;
 using System.Threading.Tasks;
 
-namespace AddActionsWorkflow.Commands
+namespace AddActionsWorkflow.Commands;
+
+[Command(PackageIds.LaunchRemoteUrlCommand)]
+internal class LaunchRemoteUrlCommand : BaseCommand<LaunchRemoteUrlCommand>
 {
-    [Command(PackageIds.LaunchRemoteUrlCommand)]
-    internal class LaunchRemoteUrlCommand : BaseCommand<LaunchRemoteUrlCommand>
+    protected override async Task ExecuteAsync(OleMenuCmdEventArgs e)
     {
-        protected override async Task ExecuteAsync(OleMenuCmdEventArgs e)
-        {
-            // get the repo URI
-            var dirInfo = new DirectoryInfo((await VS.Solutions.GetCurrentSolutionAsync()).FullPath);
-            var slnDir = dirInfo.Parent.FullName;
+        // get the repo URI
+        var dirInfo = new DirectoryInfo((await VS.Solutions.GetCurrentSolutionAsync()).FullPath);
+        var slnDir = dirInfo.Parent.FullName;
 
-            var stdOutBuffer = new StringBuilder();
-            var stdErrBuffer = new StringBuilder();
+        var stdOutBuffer = new StringBuilder();
+        var stdErrBuffer = new StringBuilder();
 
-            var result = await Cli.Wrap("git")
-                .WithArguments("remote get-url origin --push")
-                .WithWorkingDirectory(slnDir)
-                .WithStandardOutputPipe(PipeTarget.ToStringBuilder(stdOutBuffer))
-                .WithStandardErrorPipe(PipeTarget.ToStringBuilder(stdErrBuffer))
-                .WithValidation(CommandResultValidation.None)
-                .ExecuteAsync();
+        var result = await Cli.Wrap("git")
+            .WithArguments("remote get-url origin --push")
+            .WithWorkingDirectory(slnDir)
+            .WithStandardOutputPipe(PipeTarget.ToStringBuilder(stdOutBuffer))
+            .WithStandardErrorPipe(PipeTarget.ToStringBuilder(stdErrBuffer))
+            .WithValidation(CommandResultValidation.None)
+            .ExecuteAsync();
 
-            var stdOut = stdOutBuffer.ToString();
-            var stdErr = stdErrBuffer.ToString();
+        var stdOut = stdOutBuffer.ToString();
+        var stdErr = stdErrBuffer.ToString();
 
-            if (result.ExitCode == 0)
-            {
-                _ = Process.Start(stdOut);
-            }
-            else
-            {
-                var argError = new UriFormatException(stdErr);
-                await argError.LogAsync();
-            }
+        if (result.ExitCode == 0)
+        {
+            _ = Process.Start(stdOut);
+        }
+        else
+        {
+            var argError = new UriFormatException(stdErr);
+            await argError.LogAsync();
         }
     }
 }

AddActionsWorkflow/Options/General.cs

@@ -1,42 +1,41 @@
 using System.ComponentModel;
 
-namespace AddActionsWorkflow.Options
+namespace AddActionsWorkflow.Options;
+
+internal partial class OptionsProvider
 {
-    internal partial class OptionsProvider
-    {
-        public class GeneralOptions : BaseOptionPage<General> { }
-    }
+    public class GeneralOptions : BaseOptionPage<General> { }
+}
 
-    public class General : BaseOptionModel<General>
-    {
-        [Category("Generator")]
-        [DisplayName("Default file name")]
-        [Description("The base name of the workflow (.yaml) file to be generated")]
-        [DefaultValue("build")]
-        public string DefaultName { get; set; } = "build";
+public class General : BaseOptionModel<General>
+{
+    [Category("Generator")]
+    [DisplayName("Default file name")]
+    [Description("The base name of the workflow (.yaml) file to be generated")]
+    [DefaultValue("build")]
+    public string DefaultName { get; set; } = "build";
 
-        [Category("Generator")]
-        [DisplayName("Randomize file name")]
-        [Description("If true, a suffix is added to the Default file name to avoid conflicts")]
-        [DefaultValue(true)]
-        public bool RandomizeFileName { get; set; } = true;
+    [Category("Generator")]
+    [DisplayName("Randomize file name")]
+    [Description("If true, a suffix is added to the Default file name to avoid conflicts")]
+    [DefaultValue(true)]
+    public bool RandomizeFileName { get; set; } = true;
 
-        [Category("Generator")]
-        [DisplayName("Overwrite if exists")]
-        [Description("If true, this will overwrite same-named workflow files if exists")]
-        [DefaultValue(false)]
-        public bool OverwriteExisting { get; set; } = false;
+    [Category("Generator")]
+    [DisplayName("Overwrite if exists")]
+    [Description("If true, this will overwrite same-named workflow files if exists")]
+    [DefaultValue(false)]
+    public bool OverwriteExisting { get; set; } = false;
 
-        [Category("Generator")]
-        [DisplayName("Solution Folder")]
-        [Description("The Solution Items folder to add these to in the Visual Studio solution")]
-        [DefaultValue("Solution Items")]
-        public string SolutionFolderName { get; set; } = "Solution Items";
+    [Category("Generator")]
+    [DisplayName("Solution Folder")]
+    [Description("The Solution Items folder to add these to in the Visual Studio solution")]
+    [DefaultValue("Solution Items")]
+    public string SolutionFolderName { get; set; } = "Solution Items";
 
-        [Category("Generator")]
-        [DisplayName("Current branch")]
-        [Description("Will use the current branch name or 'main' if false")]
-        [DefaultValue(true)]
-        public bool UseCurrentBranchName { get; set; } = true;
-    }
+    [Category("Generator")]
+    [DisplayName("Current branch")]
+    [Description("Will use the current branch name or 'main' if false")]
+    [DefaultValue(true)]
+    public bool UseCurrentBranchName { get; set; } = true;
 }