From 55e3188f8fed9bb346118fedfb2ce20f41dd5f7a Mon Sep 17 00:00:00 2001 From: Bela VanderVoort Date: Wed, 10 Apr 2024 12:50:16 -0500 Subject: [PATCH] update readme --- Src/CSharpier.Rider/README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/Src/CSharpier.Rider/README.md b/Src/CSharpier.Rider/README.md index bbf199cef..2255d5bc3 100644 --- a/Src/CSharpier.Rider/README.md +++ b/Src/CSharpier.Rider/README.md @@ -1,18 +1,24 @@ # csharpier-rider -This plugin makes use of the dotnet tool [CSharpier](https://github.com/belav/csharpier) to format your code. CSharpier an opinionated code formatter for c#. -It uses Roslyn to parse your code and re-prints it using its own rules. + +This plugin makes use of the dotnet tool [CSharpier](https://github.com/belav/csharpier) to format your code. CSharpier an opinionated code formatter for c#. +It uses Roslyn to parse your code and re-prints it using its own rules. The printing process was ported from [prettier](https://prettier.io/) but has evolved over time. ## CSharpier Version + The plugin determines which version of csharpier is needed to format a give file by looking for a dotnet manifest file. If one is not found it looks for a globally installed version of CSharpier. ### To format files: + - Install csharpier - as a local tool versioned to your project with `dotnet tool install csharpier` - globally with `dotnet tool install -g csharpier` - Use the `Reformat with CSharpier` action. + - Available when right clicking on a file in the editor + - Available via "Search Everywhere" + - Does not have a default keyboard shortcut but can be assigned one. - Optionally configure CSharpier to `Run on Save` under Preferences/Settings | Tools | CSharpier Please report any [issues](https://github.com/belav/csharpier/issues) @@ -20,9 +26,10 @@ Please report any [issues](https://github.com/belav/csharpier/issues) ## Installation - Using IDE built-in plugin system: - + Settings/Preferences > Plugins > Marketplace > Search for "CSharpier" > Install Plugin + --- ## Troubleshooting @@ -32,13 +39,14 @@ See [Editor Troubleshooting](https://csharpier.com/docs/EditorsTroubleshooting) **Note** This plugin does not do any formatting and is versioned separately from CSharpier. ### Viewing CSharpier Logs + - Use the action "Show Log in Explorer" - Look for entries for "CSharpierLogger" ### Enable Debug Logging for CSharpier + - Use the action "Debug Log Settings" - Add entry for "#com.intellij.csharpier.CSharpierLogger" - Restart Rider -