Skip to content

Update naming styles to ensure .editorconfig is the code style "source of truth"#27942

Merged
sharwell merged 1 commit intodotnet:masterfrom
sharwell:isolate-editorconfig
Jun 19, 2019
Merged

Update naming styles to ensure .editorconfig is the code style "source of truth"#27942
sharwell merged 1 commit intodotnet:masterfrom
sharwell:isolate-editorconfig

Conversation

@sharwell
Copy link
Copy Markdown
Contributor

@sharwell sharwell commented Jun 17, 2018

Prior to this change, user settings could interact with .editorconfig in unknown ways to produce deviations in code style across a team which could not be controlled by simply updating .editorconfig. This change ensures that .editorconfig, when used, becomes the code style "source of truth" for affected documents.

Previous design

Prior to this change, the current editor options are made available to code deserializing values from .editorconfig. This was only used in one place in the current code: naming styles defined in Tools → Options were appended to options (if any) that were defined in .editorconfig.

New design

  • The API is modified to not allow simultaneous consideration of both .editorconfig and Tools → Options for a single code style option
  • The naming styles code is updated to use only .editorconfig if naming styles are defined there, and fall back to using Tools → Options only in the case where .editorconfig does not define naming styles

@sharwell sharwell added the Need Design Review The end user experience design needs to be reviewed and approved. label Jun 17, 2018
@sharwell sharwell requested a review from a team as a code owner June 17, 2018 20:43
@sharwell sharwell force-pushed the isolate-editorconfig branch from 18f5044 to ed3c52c Compare March 25, 2019 02:57
@sharwell
Copy link
Copy Markdown
Contributor Author

This went to a design review 18 June 2018. The conclusion from that meeting was the following:

If any naming convention exists in .editorconfig ignore all Tools→Options naming conventions. This will make the experience consistent between NuGet and VSIX.

@sharwell sharwell added 3 - Working Area-IDE Need Design Review The end user experience design needs to be reviewed and approved. and removed Need Design Review The end user experience design needs to be reviewed and approved. 3 - Working labels Mar 25, 2019
@sharwell sharwell added this to the 16.1.P1 milestone Mar 25, 2019
@jinujoseph jinujoseph modified the milestones: 16.1.P1, 16.2 Apr 24, 2019
@sharwell sharwell force-pushed the isolate-editorconfig branch from ed3c52c to d43103d Compare June 12, 2019 14:09
…e of truth"

Prior to this change, user settings could interact with .editorconfig in unknown ways to
produce deviations in code style across a team which could not be controlled by simply
updating .editorconfig. This change ensures that .editorconfig, when used, becomes the
code style "source of truth" for affected documents.
Copy link
Copy Markdown
Member

@JoeRobich JoeRobich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable

@sharwell sharwell modified the milestones: 16.2, 16.2.P4 Jun 19, 2019
@sharwell sharwell merged commit 89160f0 into dotnet:master Jun 19, 2019
@sharwell sharwell deleted the isolate-editorconfig branch June 19, 2019 10:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants