https://github.com/elders/vse-formatdocumentonsave
Visual Studio - Format Document on Save
https://github.com/elders/vse-formatdocumentonsave
c-sharp code-formatter document formatter formatting visual-studio
Last synced: 5 months ago
JSON representation
Visual Studio - Format Document on Save
- Host: GitHub
- URL: https://github.com/elders/vse-formatdocumentonsave
- Owner: Elders
- License: apache-2.0
- Created: 2013-10-28T16:21:11.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T09:47:19.000Z (about 1 year ago)
- Last Synced: 2025-05-10T22:52:13.726Z (5 months ago)
- Topics: c-sharp, code-formatter, document, formatter, formatting, visual-studio
- Language: C#
- Homepage:
- Size: 140 KB
- Stars: 123
- Watchers: 17
- Forks: 23
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
VSE-FormatDocumentOnSave
========================
Enables auto formatting of the code when you save a file. Visual Studio supports auto formatting of the code with the CTRL+E,D or CTRL+E,F key shortcuts but with this extension the command `Edit.FormatDocument` is executed on Save.
# Versions
Up until now the extension supported older versions of Visual Studio (2012-2019).
Since Visual Studio 2022 there are a lot of breaking changes in the VSIX SDK and it is really hard to support older versions of Visual Studio. For that reason the extension is split into two:
## Visual Studio 2022
Going forward this will be the version which will be supported and maintained. If possible, future versions of Visual Studio will be supported within this package.
https://marketplace.visualstudio.com/items?itemName=mynkow.FormatDocumentOnSave
## Visual Studio 2012-2019
https://marketplace.visualstudio.com/items?itemName=mynkow.FormatDocumentOnSaveLegacy
# Configuration
There are 5 settings which you could configure:
* Command
* Allowed extensions
* Denied Extensions
* Enable
* Enable in Debug
### Command
This is the Visual Studio command which will be invoked when a document is saved. For multiple values you could use `space` separated list.
##### Default
`Edit.FormatDocument`
##### CodeCleanup
Many people were asking how to execute a CodeCleanup on save. It is possible to replace the default command with `Analyze.RunDefaultCodeCleanupOnSolution` which executes all the commands configured in the default profile.
note: In rare occasions VisualStudio2019 enters in a infinite loop. A restart or extension reinstall helps. If you know how to reproduce this bug please log an issue.
### Allowed extensions
Specifies all file extensions where the `command` is allowed to be executed. For multiple values you could use `space` separated list.
##### Default
`allowed_extensions = .*`
### Denied extensions
Specifies all file extensions where the `command` is NOT allowed to be executed. For multiple values you could use `space` separated list.
##### Default
`denied_extensions = `
### Debug mode
By default the plugin is disabled in debug mode. You could explicitly configure to have the extension enabled while in a debug session.
##### Default
`enable_in_debug = false`
# Examples
## Scenario 1
- `allowed_extensions = .*`
- `denied_extensions = .cs`
**Result:** All documents will be formatted because we explicitly specified that all extensions will be formatted using `allowed_extensions = .*`.
## Scenario 2
- `allowed_extensions = `
- `denied_extensions = .js`
**Result:** All documents will be formatted except those with `.js` extension
## Scenario 3
- `allowed_extensions = `
- `denied_extensions = .*`
**Result:** No documents will be formatted
## Scenario 4
- `allowed_extensions = .cs`
- `denied_extensions = .*`
**Result:** Only documents with `.cs` extension will be formatted
## Scenario 5
- `allowed_extensions = .cs`
- `denied_extensions =`
**Result:** All documents will be formatted because nothing is denied
## Scenario 6
- `allowed_extensions = .cs`
- `denied_extensions = .cs`
**Result:** All documents will be formatted because there is a conflict
# Visual Studio
You can configure these settings from the Visual Studio Options menu
# Format Config
Create a `.formatconfig` file in the root of your project
Note: If you have a `.formatconfig` file, the VS options are ignored!
## Example
```
root = true
[*.*]
enable = true
command = Edit.FormatDocument
allowed_extensions =
denied_extensions = .js .html
```
## Example with multiple commands
```
root = true
[*.*]
command = Edit.FormatDocument Edit.FormatDocument
allowed_extensions =
denied_extensions = .js .html
```
## Disable the extension
If you wish to temporarily disable to extension you could press CapsLock.
By default the extension is disabled while in a debug session. You could change that from the configuration.
You can enable or disable the extension in the configuration, or disable in a `.formatconfig` file.
# Contribute
To setup development environment follow the steps:
* Install `Visual Studio SDK` from Visual Studio Installer
https://prnt.sc/umv2ak
* Clone the project
* Configure debug
Open project properties and go to the `Debug` tab. Select `Start external program:` and enter the path to your Visual Studio exe. For example `C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\IDE\devenv.exe`. In the `Command line arguments:` type `/rootsuffix Exp`
https://prnt.sc/umv47r
* Debug
When you press `F5` a new instance of Visual Studio will open. From there you need to load an exising solution, file or create a new one. When you press `ctrl` + `s` it will trigger break points you have set in the initial Visual Studio instance.