editorconfig codestyle options #15029

jmarolf · 2016-11-05T22:00:51Z

@dotnet/roslyn-ide @jasonmalinowski
Adds the following options

Code Style Options

editorconfig name	possible values
csharp_style_var_for_locals	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_var_for_built_in_types	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_var_when_type_is_apparent	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_var_elsewhere	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_expression_bodied_methods	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_expression_bodied_constructors	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_expression_bodied_operators	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_expression_bodied_properties	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_expression_bodied_indexers	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_expression_bodied_accessors	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_pattern_matching_over_is_with_cast_check	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_pattern_matching_over_as_with_null_check	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_inlined_variable_declaration	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_throw_expression	true: none,suggestion,warning,error , false: none,suggestion,warning,error
csharp_style_conditional_delegate_call	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_qualification_for_field	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_qualification_for_property	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_qualification_for_method	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_qualification_for_event	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_predefined_type_for_locals_parameters_members	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_predefined_type_for_member_access	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_object_initializer	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_collection_initializer	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_coalesce_expression	true: none,suggestion,warning,error , false: none,suggestion,warning,error
dotnet_style_null_propagation	true: none,suggestion,warning,error , false: none,suggestion,warning,error

jmarolf · 2016-11-05T22:49:48Z

retest vsi please

brettfo · 2016-11-08T21:40:20Z

src/Workspaces/Core/Portable/CodeStyle/CodeStyleHelpers.cs

@@ -0,0 +1,29 @@
+namespace Microsoft.CodeAnalysis.CodeStyle


Copyright. #Closed

jasonmalinowski · 2016-11-11T02:06:20Z

@jmarolf Is this now subsumed by your other PR or does this still need a review?

jmarolf · 2016-11-11T03:28:20Z

@jasonmalinowski #15065 depends on changes in this PR. I was thinking that that this would merge in before #15065 but I am going to take the feedback you left there and apply it here.

jasonmalinowski

I'd move the parsing logic into the core .editorconfig logic since a CodeStyleOption is a core concept to us, just to save some verbosity. We did that in other persisters already.

jasonmalinowski · 2016-11-11T20:53:07Z

src/Workspaces/Core/Portable/CodeStyle/CodeStyleHelpers.cs

+            bool isEnabled = false;
+            if (args.Length != 2)
+            {
+                if (arg.Length == 1)


Not sure why we have nested ifs here...this seems a bit tricky.

This handles the case where the user specified that a rule should be on but has not specified a severity, so we just use the default.

In reply to: 87656798 [](ancestors = 87656798)

jasonmalinowski · 2016-11-11T20:57:14Z

src/Workspaces/Core/Portable/CodeStyle/CodeStyleHelpers.cs

+                        return CodeStyleOption<bool>.Default;
+                    }
+                }
+                return CodeStyleOption<bool>.Default;


Is this right? Wouldn't we want to say that we should return the default for the option which might be different than this?

The semantics for these editorconfig files is that if the user has specified the option, but we can't parse it, we pass the default option. Would you prefer we throw?

In reply to: 87657312 [](ancestors = 87657312)

jasonmalinowski · 2016-11-11T20:58:03Z

src/Workspaces/Core/Portable/CodeStyle/CodeStyleOptions.cs

@@ -20,55 +21,73 @@ public class CodeStyleOptions
        /// This option says if we should simplify away the <see langword="this"/>. or <see langword="Me"/>. in field access expressions.
        /// </summary>
        public static readonly PerLanguageOption<CodeStyleOption<bool>> QualifyFieldAccess = new PerLanguageOption<CodeStyleOption<bool>>(nameof(CodeStyleOptions), nameof(QualifyFieldAccess), defaultValue: CodeStyleOption<bool>.Default,
-            storageLocations: new RoamingProfileStorageLocation("TextEditor.%LANGUAGE%.Specific.QualifyFieldAccess"));
+            storageLocations: new OptionStorageLocation[]{
+                new EditorConfigStorageLocation("dotnet_style_qualification_for_field", ParseEditorConfigCodeStyleOption),


I'm not morally against teaching EditorConfigStorageLocation about CodeStyle options directly to avoid having to pass the parser to each one specifically. We did that in the RoamingProfileStorageLocation as well.

jasonmalinowski · 2016-11-11T20:59:45Z

src/Workspaces/Core/Portable/CodeStyle/CodeStyleHelpers.cs

+
+            switch (args[1].Trim())
+            {
+                case "none": return new CodeStyleOption<bool>(value: isEnabled, notification: NotificationOption.None);


Still not sure I like "none" because it's confusing to me if that's the severity or the value. 'silent' perhaps?

jmarolf · 2016-11-15T23:27:41Z

@Pilchie @MattGertz @natidea I've re-targeted the PR against RC.2, please let me know it we want to take this.

Customer scenario

The customer can now set visual studio settings in editorconfig files that allow codestyle options to be specified per folder.

Bugs this fixes: (either VSO or GitHub links)

Support enforcing "Code Style" in the IDE #7071

Workarounds

The user can manually change their code style settings each time they open a solution file, but cannot have different settings from different folders within that solution.

Risk

This uses the editorconfig API from the Visual Studio Platfrom team, it does not introduce code into roslyn other than consuming that API and handing it to the options service

Performance impact

When folders are quieried is set by the Visual Studio Platfrom team which has done the work to not requery unless their are file changes. Perf impact should be Low

Is this a regression from a previous update?

No.

Root cause analysis: how did we miss it? What tests are we adding to guard against it in the future?

This is not a regression. It is new feature work.

How was the bug found? (E.g. customer reported it vs. ad hoc testing)

This is not a bug. It is new feature work.

jmarolf · 2016-11-17T00:29:18Z

Tests seemed to have stalled. Closing and reopening to restart them

kuhlenh · 2016-11-30T18:59:04Z

@jmarolf -- hey, so when making this work for Roslyn, I realized that it in our coding guidelines we call "predefined types" actually "language types". Perhaps let's reconsider the naming here? Might not be worth it...

AdmiralSnyder · 2021-02-18T15:15:50Z

hey, i would love to see these style categories added.
csharp_style_var_when_type_is_generic
csharp_style_var_when_type_is_long
(for example longer that 15 chars) - should i create a new issue?

dnfclas added the cla-already-signed label Nov 5, 2016

jmarolf force-pushed the feature/editorconfig-codestyle-options branch from 3b462ea to a0f7ab0 Compare November 5, 2016 22:18

editorconfig codestyle options

b887870

jmarolf force-pushed the feature/editorconfig-codestyle-options branch from a0f7ab0 to b887870 Compare November 5, 2016 22:44

jmarolf added the Area-IDE label Nov 7, 2016

brettfo approved these changes Nov 8, 2016

View reviewed changes

adding tests

3fba790

jasonmalinowski approved these changes Nov 11, 2016

View reviewed changes

jmarolf added 2 commits November 14, 2016 13:47

changing option to "silent" from "none"

3230a15

teach EditorConfigStorageLocation about code style options

3d6680b

jmarolf force-pushed the feature/editorconfig-codestyle-options branch from f846c80 to 3d6680b Compare November 14, 2016 22:54

jmarolf changed the base branch from master to dev15-rc2 November 15, 2016 23:24

jmarolf mentioned this pull request Nov 15, 2016

editor config naming style #15065

Merged

MattGertz added the Approved to merge label Nov 15, 2016

jmarolf closed this Nov 17, 2016

jmarolf reopened this Nov 17, 2016

dnfclas added the cla-already-signed label Nov 17, 2016

Pilchie approved these changes Nov 17, 2016

View reviewed changes

jmarolf merged commit 2e27639 into dotnet:dev15-rc2 Nov 17, 2016

Mpdreamz mentioned this pull request Nov 18, 2016

Future of this project with regards to VS 2017 editorconfig/editorconfig-visualstudio#49

Open

sharwell mentioned this pull request Dec 5, 2016

Proposal: Configurable Spacings DotNetAnalyzers/StyleCopAnalyzers#2233

Open

jmarolf mentioned this pull request Dec 8, 2016

Added .editorconfig files for Roslyn project #15620

Merged

tannergooding mentioned this pull request Mar 10, 2017

Improved Asin and ACos dotnet/corefx#16484

Merged

RehanSaeed mentioned this pull request Mar 17, 2017

Missing Settings madskristensen/EditorConfigLanguage#10

Open

angelsix mentioned this pull request Mar 31, 2017

Complete list of .editorconfig supported names #18342

Closed

andresmoschini mentioned this pull request Apr 18, 2017

Add DotNet style guide basic layout MakingSense/code-style-guides#20

Merged

jmarolf deleted the feature/editorconfig-codestyle-options branch January 27, 2020 16:59

This was referenced Jan 31, 2020

The .editorconfig should be updated to support the code style options made available in VS2017 dotnet/runtime#7602

Closed

The .editorconfig should be updated to support the code style options made available in VS2017 dotnet/runtime#20563

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

editorconfig codestyle options #15029

editorconfig codestyle options #15029

jmarolf commented Nov 5, 2016

jmarolf commented Nov 5, 2016

brettfo Nov 8, 2016 •

edited by jmarolf

Loading

jasonmalinowski commented Nov 11, 2016

jmarolf commented Nov 11, 2016

jasonmalinowski left a comment

jasonmalinowski Nov 11, 2016

jmarolf Nov 14, 2016

jasonmalinowski Nov 11, 2016

jmarolf Nov 14, 2016

jasonmalinowski Nov 11, 2016

jasonmalinowski Nov 11, 2016

jmarolf commented Nov 15, 2016

jmarolf commented Nov 17, 2016

kuhlenh commented Nov 30, 2016

AdmiralSnyder commented Feb 18, 2021

editorconfig codestyle options #15029

editorconfig codestyle options #15029

Conversation

jmarolf commented Nov 5, 2016

Code Style Options

jmarolf commented Nov 5, 2016

brettfo Nov 8, 2016 • edited by jmarolf Loading

Choose a reason for hiding this comment

jasonmalinowski commented Nov 11, 2016

jmarolf commented Nov 11, 2016

jasonmalinowski left a comment

Choose a reason for hiding this comment

jasonmalinowski Nov 11, 2016

Choose a reason for hiding this comment

jmarolf Nov 14, 2016

Choose a reason for hiding this comment

jasonmalinowski Nov 11, 2016

Choose a reason for hiding this comment

jmarolf Nov 14, 2016

Choose a reason for hiding this comment

jasonmalinowski Nov 11, 2016

Choose a reason for hiding this comment

jasonmalinowski Nov 11, 2016

Choose a reason for hiding this comment

jmarolf commented Nov 15, 2016

Customer scenario

Bugs this fixes: (either VSO or GitHub links)

Workarounds

Risk

Performance impact

Is this a regression from a previous update?

Root cause analysis: how did we miss it? What tests are we adding to guard against it in the future?

How was the bug found? (E.g. customer reported it vs. ad hoc testing)

jmarolf commented Nov 17, 2016

kuhlenh commented Nov 30, 2016

AdmiralSnyder commented Feb 18, 2021

brettfo Nov 8, 2016 •

edited by jmarolf

Loading