Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikerochip/editorconfig-monodevelop
EditorConfig plugin for MonoDevelop and Visual Studio for Mac http://editorconfig.org
https://github.com/mikerochip/editorconfig-monodevelop
Last synced: about 1 month ago
JSON representation
EditorConfig plugin for MonoDevelop and Visual Studio for Mac http://editorconfig.org
- Host: GitHub
- URL: https://github.com/mikerochip/editorconfig-monodevelop
- Owner: mikerochip
- License: bsd-2-clause
- Archived: true
- Created: 2018-02-02T01:38:08.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-04T18:01:31.000Z (almost 3 years ago)
- Last Synced: 2024-08-01T19:40:29.136Z (4 months ago)
- Language: C#
- Size: 58.6 KB
- Stars: 8
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-monodevelop - editorconfig-monodevelop
README
# ARCHIVE NOTE
March 4, 2022: This repo was an implementation of an EditorConfig addin to add support for .editorconfig to [MonoDevelop](https://github.com/mono/monodevelop). MonoDevelop was (is?) the underlying software behind Visual Studio for Mac. This addin [hasn't been needed since 2018](https://docs.microsoft.com/en-us/visualstudio/releasenotes/vs2017-mac-relnotes-v7.5#release-highlights), the MonoDevelop codebase hasn't been maintained since Jan 2020, and Microsoft is currently hinting at a rebuild of VS for Mac in their [roadmap page](https://docs.microsoft.com/en-us/visualstudio/productinfo/mac-roadmap). So this repo has effectively been obviated for quite a while.
---
# EditorConfig Plugin for MonoDevelop and Visual Studio for Mac
This is an [EditorConfig][] plugin for [MonoDevelop][] and [Visual Studio for Mac][].
## Installation
### Install from the Extension Manager
1. Open the Extension Manager in your IDE
2. Click the gallery tab
3. Search for EditorConfig
4. Select the extension and click install
5. Restart the IDE (this is due to a startup limitation)
### Install from Source
Source builds are currently only supported using Visual Studio for Mac.
#### Building the Solution
1. Clone the repo
2. Open the solution in Visual Studio for Mac
3. Project > Active Configuration > Release
4. Build > Build All
You should end up with some assemblies in your bin/Release folder. We'll need to use editorconfig-monodevelop.dll in the next step.
#### Building the Extension File (.mpack)
1. Find vstool in your Visual Studio for Mac app folder e.g. /Applications/Visual Studio.app/Contents/MacOS/
2. Run vstool on editorconfig-monodevelop.dll from the previous steps e.g.
> ./vstool setup pack /path/to/editorconfig-monodevelop/editorconfig-monodevelop/bin/Release/net472/editorconfig-monodevelop.dll
This should have generated an .mpack file e.g. EditorConfig.Addin.EditorConfig_1.0.mpack, which you can put wherever you want.
#### Installing the Extension in Visual Studio for Mac
1. Run Visual Studio for Mac
2. Visual Studio for Mac > Extensions...
3. Click Install from file...
4. Navigate to your .mpack and click Open
5. Click Install
6. Restart the IDE (this is due to a startup limitation)
## Supported Properties
This plugin supports the following EditorConfig [properties][]:
* `indent_style`
* `indent_size`
* `tab_width`
* `end_of_line` with option to convert on save
* `charset`
* `trim_trailing_whitespace`
* `insert_final_newline`
* `root` (only used by [EditorConfig .NET Core][])
These change editor settings on file open:
* `indent_style`
* `indent_size`
* `tab_width`
* `end_of_line`
These modify files on save:
* `charset`
* `trim_trailing_whitespace`
* `insert_final_newline`
* `end_of_line` (can enable via an option)
For reference: https://github.com/editorconfig/editorconfig/issues/248#issuecomment-166980703
## Bugs and Feature Requests
Adding an issue in the issue tracker is probably fine for now.
[EditorConfig]: http://editorconfig.org
[EditorConfig .NET Core]: https://github.com/editorconfig/editorconfig-core-net
[properties]: http://editorconfig.org/#supported-properties
[MonoDevelop]: http://www.monodevelop.com/
[Visual Studio for Mac]: https://www.visualstudio.com/vs/visual-studio-mac/