Releasing 0.19.0 (#714)

Author: belav

CHANGELOG.md

@@ -1,3 +1,42 @@
+# 0.19.0
+## What's Changed
+#### Adding a cache to speed up formatting. [#692](https://github.com/belav/csharpier/issues/692)
+CSharpier now caches information about files that it has formatted to speed up subsequent runs.  
+By default the following are used as cache keys and a file is only formatted if one of them has changed.
+
+- CSharpier Version
+- CSharpier Options
+- Content of the file
+
+The cache is stored at [LocalApplicationData]/CSharpier/.formattingCache.
+
+#### Ignore node_modules [#699](https://github.com/belav/csharpier/issues/699)
+
+CSharpier now ignores any files within a node_modules folder.
+
+Thanks go to @RichiCoder1 for the suggestion and @SubjectAlpha for the implementation.
+
+#### Extra space before curly brace in array initializer [#693](https://github.com/belav/csharpier/issues/693)
+
+```c#
+// 0.18.0
+public class ClassName
+{
+    public int[] SomeArray { get; set; } =  { 1, 2, 3 };
+}
+// 0.19.0
+public class MyClass
+{
+    public int[] SomeArray { get; set; } = { 1, 2, 3 };
+}
+
+```
+
+Thanks go to @TiraelSedai for reporting the bug.
+
+**Full Changelog**: https://github.com/belav/csharpier/compare/0.18.0...0.19.0
+
+
 # 0.18.0
 ## What's Changed
 #### Initial C# 11 support [#686](https://github.com/belav/csharpier/pull/686)

CSharpier.Build.props

@@ -1,6 +1,6 @@
 <Project>
     <PropertyGroup>
-        <Version>0.18.0</Version>
+        <Version>0.19.0</Version>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <RepositoryUrl>https://github.com/belav/csharpier</RepositoryUrl>
         <RepositoryType>git</RepositoryType>

Src/Website/docs/About.md

@@ -9,31 +9,38 @@ The printing process was ported from [prettier](https://github.com/prettier/pret
 
 CSharpier provides a few basic options that affect formatting and has no plans to add more. It follows the [Option Philosophy](https://prettier.io/docs/en/option-philosophy.html) of prettier.
 
+### Quick Start
+Install CSharpier globally using the following command.
+```bash
+dotnet tool install csharpier -g
+```
+Then format the contents of a directory and its children with the following command.
+```bash
+dotnet csharpier .
+```
+
+CSharpier can also format [on save in your editor](https://csharpier.com/docs/Editors) or as a [pre-commit hook](https://csharpier.com/docs/Pre-commit). Then you can ensure code was formatted with a [CI/CD tool](https://csharpier.com/docs/ContinuousIntegration).
+
+---
+
+[Try it out](https://playground.csharpier.com)
+
+---
+
 ### Before
-```csharp
+```c#
 public class ClassName {
-    public string ShortPropertyName {
-        get;
-        set; 
-    }
-
-    public void LongUglyMethod(string longParameter1, string longParameter2, string longParameter3) { 
+    public void CallMethod() { 
         this.LongUglyMethod("1234567890", "abcdefghijklmnopqrstuvwxyz", "ABCDEFGHIJKLMNOPQRSTUVWXYZ");
     }
 }
 ```
 
 ### After
-```csharp
+```c#
 public class ClassName
 {
-    public string ShortPropertyName { get; set; }
-
-    public void LongUglyMethod(
-        string longParameter1,
-        string longParameter2,
-        string longParameter3
-    )
+    public void CallMethod()
     {
         this.LongUglyMethod(
             "1234567890",
@@ -42,3 +49,4 @@ public class ClassName
         );
     }
 }
+```

Src/Website/docs/CLI.md

@@ -1,6 +1,16 @@
 ---
 hide_table_of_contents: true
 ---
+Use the `dotnet csharpier` command to run CSharpier from the command line.
+
+In practice, it will look something like:
+```
+dotnet csharpier .
+```
+This command will format all c# files in the current directory and its children.
+
+You may want to set up an [ignore file](Ignore.md) or [configuration file](Configuration.md).
+
 ### Command Line Options
 ```console
 Usage:
@@ -11,6 +21,7 @@ Arguments:
 
 Options:
   --check           Check that files are formatted. Will not write any changes.
+  --no-cache        Bypass the cache to determine if a file needs to be formatted.
   --fast            Skip comparing syntax tree of formatted file to original file to validate changes.
   --skip-write      Skip writing changes. Generally used for testing to ensure csharpier doesn't throw any errors or cause syntax tree validation failures.
   --write-stdout    Write the results of formatting any files to stdout.
@@ -33,11 +44,20 @@ If a list of paths is not supplied, then stdin is read.
 Used to check if your files are already formatted. Outputs any files that have not already been formatted.
 This will return exit code 1 if there are unformatted files which is useful for CI pipelines.
 
+### --no-cache
+This option can be used to bypass the cache that is normally used to speed up formatting files.  
+By default the following are used as cache keys and a file is only formatted if one of them has changed.
+* CSharpier Version
+* CSharpier Options
+* Content of the file
+
+The cache is stored at `[LocalApplicationData]/CSharpier/.formattingCache`.
+
 ### --fast
 CSharpier validates the changes it makes to a file.
 It does this by comparing the syntax tree before and after formatting, but ignoring any whitespace trivia in the syntax tree.
 If a file fails validation, CSharpier will output the lines that differ. If this happens it indicates a bug in CSharpier's code.  
-This validation may be skipped by passing the --fast argument. Validation appears to increase the formatting time by ~50%.
+This validation may be skipped by passing the --fast argument.
 
 An example of CSharpier finding a file that failed validation.
 ```

Src/Website/docs/ContinuousIntegration.md

@@ -22,7 +22,7 @@ Normally when using a code formatter like CSharpier, you'll want to ensure that
 2. Use your preferred CI/CD tool to run the following commands.
    ```bash
    dotnet tool restore
-   dotnet-csharpier --check
+   dotnet-csharpier . --check
    ```   
    An example of a github action to accomplish this
    ```yaml
@@ -38,7 +38,7 @@ Normally when using a code formatter like CSharpier, you'll want to ensure that
          - uses: actions/checkout@v2
          - run: |
            dotnet tool restore
-           dotnet csharpier --check
+           dotnet csharpier . --check
    
    ```
 

Src/Website/docs/ExtensionTestCases.md

@@ -13,7 +13,8 @@
 - Formatting
   - Existing open documents get warmed
   - Edit warms
-  - Finds local version
+  - Finds msbuild version in csproj
+  - Finds local version in dotnet tools
   - Finds global version
   - Uses correct version - use 0.12.0, ensure that it adds blank lines between methods
   - Unsaved document can be formatted (may just apply to vscode)