Skip to content

Latest commit

 

History

History
60 lines (34 loc) · 3.35 KB

readme.md

File metadata and controls

60 lines (34 loc) · 3.35 KB
Raw

EditorConfig Visual Studio Plugin

Join the chat at https://gitter.im/Mpdreamz/editorconfig-visualstudio

This plugin allows you to have per project checked in Visual Studio settings using an .editorconfig settings file.

See the project web site for more information.

VS 2017

As of Visual Studio 2017 Visual Studio ships with .editorconfig support baked in!

This is in fact part of roslyn and will mean that other editors relying on roslyn (omnisharp) to do the code formatting will also benefit from this.

On top of that roslyn will introduce more editorconfig extension properties to control additional formatting options per project see e.g: dotnet/roslyn#15029

For now this baked in implementation has 2 limitations:

  • Does not work for XML files
  • Does not support insert_final_newline and trim_trailing_whitespace (note that these options are supported from Visual Studio 2017 version 15.3)

If you feel strongly there is a need for editorconfig plugin (given these limitations still exists at the time of reading) and you want to submit a PR and become a maintainer ping one of the editorconfig team members!

Resharper

The plugin and resharper tend to not play nicely, resharper will also support .editorconfig files in the near future see: https://youtrack.jetbrains.com/issue/RSRP-461746

Installing

This plugin works with Visual Studio 2012, 2013, and 2015. Again, this plugin is not needed on 2017. The easiest way to install it is through Visual Studio's built-in Extension Manager. Just search for "EditorConfig" in the Online Gallery section. Or, download a copy from the Visual Studio gallery website.

Bleeding edge Build status

Bleeding edge vsix installer is build on every commit and can be found here:

https://ci.appveyor.com/project/Mpdreamz/editorconfig-visualstudio/build/artifacts

Building

We adhere to the F5 manifesto so you should be able to clone, open in VS and build.

Building from the command line can be done calling build.cmd this will create a vsix packages under artifacts directory in the root of the checkout.

Supported properties

The plugin supports the following EditorConfig properties:

  • indent_style
  • indent_size
  • tab_width
  • end_of_line
  • insert_final_newline
  • trim_trailing_whitespace
  • root (only used by EditorConfig core)

Reporting problems

If you encounter any problems, feel free to report them at the issue tracker.

Please note that you shouldn't expect to see settings from your .editorconfig file's configuration in the text editor options dialog. Those are your global settings that we try to restore whenever we can so we do not bleed into your projects not using editorconfig.