Skip to content

Latest commit

 

History

History
55 lines (32 loc) · 2.58 KB

README.md

File metadata and controls

55 lines (32 loc) · 2.58 KB
Raw

C# Code Polisher

It's an extension for VS Code under Roslyn LSP manage. IT WILL NOT WORK FOR OMNISHARP AND OTHER LSP

The extension provides functions for:

  • Removing unnecessary usings in a separate .cs file and in a workspace as well. If you wish to remove unnecessary usings in a workspace, you have to setup project at first. Please read the requirements section for additional information.
  • Soritng usings by name in a file/workspace.
  • Cleaning unnecessary whitespaces in a file/workspace.

Features

Extension allows to do the chores for usings in C# files via VS code command palette. Keep in mind that removing of unnecessary usings can be executed successfully only when LSP finishes its file analyses. So you should wait until LSP lights up files in a workspace before execute the usings cleaning function. The whitespace cleaning function can be execute instantly.

  1. Shift + Command + P (Mac) / Ctrl + Shift + P (Windows/Linux)
  2. Insert 'CodePolisher'
  3. Choose the option

Code Polisher usage

Requirements

Extension works for VS Code editor (1.85.0 and higher) that uses Roslyn LSP. This extension will not work for OmniSharp LSP or any other due to differences in structure of diagnostics data that different LSPs collects.

If you wish to have ability to clean unnecessary usings for closed files of a workspace, then you have to add line to .vscode/settings.json of the project or of a user:

"dotnet.backgroundAnalysis.analyzerDiagnosticsScope": "fullSolution"

Because in other way analyzer will not execute diagnostics for closed files. In this case function for fixing usings in workspace will fix only documents that are opened in editor.

Extension Settings

This extension contributes the following settings:

  • cscodepolisher.saveOnEdit: boolean - false by default. If it is true then files that were changed during chores will be saved after editing.
  • cscodepolisher.excludePathFromChecking: GlobPattern - paths that need to be excluded from the check.

You can change them in Settings menu for certain project or for user

0.0.4

  • Rework of usings removing and sorting processes due to bugs.

0.0.3

  • Add function that removes unnecessary whitespace for current file and for workspace as well

0.0.2

  • Split functions on 3: sort, remove and clean up (sort+remove)
  • Add option to save on edit cscodepolisher.saveOnEdit which is switched off by default
  • Fix workspace functions to work when editor window is empty

0.0.1

Initial release. Let's go!