Merge pull request #200 from shocklateboy92/features/msbuild

Add package with build tasks to format on build
belav · May 24, 2021 · 25d7abe · 25d7abe
2 parents b657585 + c2bf1a8
commit 25d7abe
Show file tree

Hide file tree

Showing 10 changed files with 118 additions and 33 deletions.
diff --git a/.github/workflows/nuget_publish.yml b/.github/workflows/nuget_publish.yml
@@ -15,10 +15,17 @@ jobs:
     needs: test
     steps:
       - uses: actions/checkout@v2
-      - name: publish on version change
+      - name: publish csharpier on version change
         id: publish_nuget
         uses: rohith/publish-nuget@v2
         with:
           PROJECT_FILE_PATH: Src/CSharpier/CSharpier.csproj
           TAG_FORMAT: "*"
-          NUGET_KEY: ${{secrets.NUGET_API_KEY}}
+          NUGET_KEY: ${{secrets.NUGET_API_KEY}}
+     - name: publish csharpier.msbuild on version change
+       id: publish_nuget
+       uses: rohith/publish-nuget@v2
+       with:
+         PROJECT_FILE_PATH: Src/CSharpier.MsBuild/CSharpier.MsBuild.csproj
+         TAG_FORMAT: "*"
+         NUGET_KEY: ${{secrets.NUGET_API_KEY}}
diff --git a/CSharpier.Targets b/CSharpier.Targets
@@ -0,0 +1,8 @@
+<Project>
+    <PropertyGroup>
+        <Version>0.9.2</Version>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+        <RepositoryUrl>https://github.com/belav/csharpier</RepositoryUrl>
+        <RepositoryType>git</RepositoryType>
+    </PropertyGroup>
+</Project>
diff --git a/CSharpier.sln b/CSharpier.sln
@@ -1,4 +1,4 @@
-
+
 Microsoft Visual Studio Solution File, Format Version 12.00
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSharpier.Playground", "Src\CSharpier.Playground\CSharpier.Playground.csproj", "{E7F03E73-82C7-4DB2-AF20-F25C45231A72}"
 EndProject
@@ -21,26 +21,27 @@ EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Workflows", "Workflows", "{176BB0EA-B72B-4ACA-82AE-C16A732BE023}"
 ProjectSection(SolutionItems) = preProject
-				.github\workflows\format_repositories.yml = .github\workflows\format_repositories.yml
+	.github\workflows\format_repositories.yml = .github\workflows\format_repositories.yml
 	.github\workflows\nuget_publish.yml = .github\workflows\nuget_publish.yml
 	.github\workflows\playground_publish.yml = .github\workflows\playground_publish.yml
 	.github\workflows\validatePR.yml = .github\workflows\validatePR.yml
 EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Scripts", "Scripts", "{62DCCDB3-45D3-4236-B34A-E01618028BFE}"
 ProjectSection(SolutionItems) = preProject
-				Scripts/RunLinuxTests.ps1 = Scripts/RunLinuxTests.ps1
-				Scripts/CreateReviewCodePRs.ps1 = Scripts/CreateReviewCodePRs.ps1
-				Scripts/ChangeLog.ps1 = Scripts/ChangeLog.ps1
-				Scripts/UpdateForkedRepos.ps1 = Scripts/UpdateForkedRepos.ps1
+	Scripts/RunLinuxTests.ps1 = Scripts/RunLinuxTests.ps1
+	Scripts/CreateReviewCodePRs.ps1 = Scripts/CreateReviewCodePRs.ps1
+	Scripts/ChangeLog.ps1 = Scripts/ChangeLog.ps1
+	Scripts/UpdateForkedRepos.ps1 = Scripts/UpdateForkedRepos.ps1
 EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{7C99AEA7-E608-40B5-9B2E-353B6E4C9DBE}"
 ProjectSection(SolutionItems) = preProject
-				Docs/EditorsAndCICD.md = Docs/EditorsAndCICD.md
-				Docs/Configuration.md = Docs/Configuration.md
-				Docs/CLI.md = Docs/CLI.md
-				Docs/Ignore.md = Docs/Ignore.md
+	Docs/EditorsAndCICD.md = Docs/EditorsAndCICD.md
+	Docs/Configuration.md = Docs/Configuration.md
+	Docs/CLI.md = Docs/CLI.md
+	Docs/Ignore.md = Docs/Ignore.md
+	Docs\MSBuild.md = Docs\MSBuild.md
 EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CSharpier.Benchmarks", "Src\CSharpier.Benchmarks\CSharpier.Benchmarks.csproj", "{A338903F-69AD-4950-B827-8EE75F98B620}"

diff --git a/Docs/MSBuild.md b/Docs/MSBuild.md
@@ -0,0 +1,16 @@
+### MSBuild Package
+CSharpier can be run when a package is built by installing the CSharpier.MSBuild nuget package
+```console
+Install-Package CSharpier.MSBuild
+```
+
+By default this will 
+- In Debug - on build will run `dotnet csharpier` in the project folder to format all files in the project.
+- In Release - on build will run `dotnet csharpier --check` in the project folder to validate that all files in the project have already been formatted.
+
+You can control when `--check` is used with the following Property
+```xml
+  <PropertyGroup>
+    <CSharpier_Check>false</CSharpier_Check>
+  </PropertyGroup>
+```
diff --git a/README.md b/README.md
@@ -55,22 +55,31 @@ public class ClassName
 ```
 
 ## Installation
+
 ```console
 dotnet tool install -g csharpier
 ```
 
-## Basic Usage
+### Basic Usage
 Run csharpier from the directory you wish to format.
 ```console
 dotnet csharpier
 ```
 
+### MsBuild Package
+If you prefer to have csharpier run when a project is built, you can use the CSharpier.MSBuild nuget package
+```console
+Install-Package CShariper.MSBuild
+```
+
 ## Documentation
 [Command Line Interface](Docs/CLI.md)  
 [Configuration File](Docs/Configure.md)  
 [Editors and CI/CD](Docs/EditorsAndCICD.md)  
 [Ignoring Files](Docs/Ignore.md)  
-[ChangeLog](CHANGELOG.md)
+[ChangeLog](CHANGELOG.md)  
+[MSBuild Package](Docs/MSBuild.md)
+
 
 ## Contributing
 See [Development Readme](CONTRIBUTING.md)  

diff --git a/Src/CSharpier.MsBuild/CSharpier.MsBuild.csproj b/Src/CSharpier.MsBuild/CSharpier.MsBuild.csproj
@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <Import Project="../../CSharpier.Targets"/>
+    <PropertyGroup>
+        <TargetFrameworks>net5.0;netstandard2.0</TargetFrameworks>
+        <PackageId>CSharpier.MsBuild</PackageId>
+        <CSharpierOutputDir>../CSharpier/bin/$(Configuration)/net5.0</CSharpierOutputDir>
+    </PropertyGroup>
+
+    <!--
+        Note: There is no <ProjectReference /> here because that would cause msbuild to
+        make it a dependency in the output package, which causes all sorts of issues as
+        CSharpier is a net5.0 project with <PackAsTool> and this is neither.
+    -->
+    <Target Name="BuildCSharpier" BeforeTargets="Build">
+		<Exec command="dotnet build -c $(Configuration)" WorkingDirectory="../CSharpier" />
+    </Target>
+
+    <ItemGroup>
+        <Content Include="build/*" PackagePath="build/" />
+        <Content Include="$(CSharpierOutputDir)/**" PackagePath="tools/csharpier" />
+    </ItemGroup>
+</Project>
diff --git a/Src/CSharpier.MsBuild/README.md b/Src/CSharpier.MsBuild/README.md
@@ -0,0 +1,3 @@
+You can test this by doing
+`dotnet pack -o publish`
+Then add a nuget source pointing to that folder and install the nuget package into a project
diff --git a/Src/CSharpier.MsBuild/build/CSharpier.MsBuild.props b/Src/CSharpier.MsBuild/build/CSharpier.MsBuild.props
@@ -0,0 +1,10 @@
+<Project>
+    <PropertyGroup>
+        <!-- Setting default value here, so it can be overwritten by caller -->
+        <CSharpier_Check>false</CSharpier_Check>
+    </PropertyGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+        <CSharpier_Check>true</CSharpier_Check>
+    </PropertyGroup>
+</Project>
diff --git a/Src/CSharpier.MsBuild/build/CSharpier.MsBuild.targets b/Src/CSharpier.MsBuild/build/CSharpier.MsBuild.targets
@@ -0,0 +1,13 @@
+<Project>
+    <PropertyGroup>
+        <CSharpierDllPath>$(MSBuildThisFileDirectory)../tools/csharpier/dotnet-csharpier.dll</CSharpierDllPath>
+        <CSharpierArgs Condition="$(CSharpier_Check)">$(CSharpierArgs) --check</CSharpierArgs>
+    </PropertyGroup>
+
+    <!-- Target invokes the copy of csharpier from this package on the current project -->
+    <Target 
+        Name="CSharpierFormat"
+        BeforeTargets="Build">
+        <Exec Command="dotnet $(CSharpierDllPath) $(CSharpierArgs) $(MSBuildProjectDirectory)" />
+    </Target>
+</Project>
diff --git a/Src/CSharpier/CSharpier.csproj b/Src/CSharpier/CSharpier.csproj
@@ -1,33 +1,29 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
+	<Import Project="../../CSharpier.Targets"/>
     <PropertyGroup>
-		<OutputType>Exe</OutputType>
-		<PackageId>CSharpier</PackageId>
-		<AssemblyName>dotnet-csharpier</AssemblyName>
+        <OutputType>Exe</OutputType>
+        <PackageId>CSharpier</PackageId>
+        <AssemblyName>dotnet-csharpier</AssemblyName>
         <TargetFramework>net5.0</TargetFramework>
         <RootNamespace>CSharpier</RootNamespace>
-		<PackAsTool>true</PackAsTool>
-		<Version>0.9.3</Version>
-		<PackageLicenseExpression>MIT</PackageLicenseExpression>
-		<RepositoryUrl>https://github.com/belav/csharpier</RepositoryUrl> 
-		<RepositoryType>git</RepositoryType>
+        <PackAsTool>true</PackAsTool>
         <Nullable>enable</Nullable>
     </PropertyGroup>
 
     <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
-      <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+        <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="Ignore" Version="0.1.42" />
-      <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.8.0" />
-      <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
-	  <PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20574.7" />
-	  <PackageReference Include="System.IO.Abstractions" Version="13.2.29" />
-	  <PackageReference Include="System.IO.Abstractions.TestingHelpers" Version="13.2.29" />
-	  <PackageReference Include="System.Text.Encoding.CodePages" Version="5.0.0" />
-	  <PackageReference Include="UTF.Unknown" Version="2.3.0" />
-	  <PackageReference Include="YamlDotNet" Version="11.1.1" />
+        <PackageReference Include="Ignore" Version="0.1.42" />
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="3.8.0" />
+        <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
+        <PackageReference Include="System.CommandLine" Version="2.0.0-beta1.20574.7" />
+        <PackageReference Include="System.IO.Abstractions" Version="13.2.29" />
+        <PackageReference Include="System.IO.Abstractions.TestingHelpers" Version="13.2.29" />
+        <PackageReference Include="System.Text.Encoding.CodePages" Version="5.0.0" />
+        <PackageReference Include="UTF.Unknown" Version="2.3.0" />
+        <PackageReference Include="YamlDotNet" Version="11.1.1" />
     </ItemGroup>
 
 </Project>