Merge pull request #102 from cake-contrib/feature/GH-99

(GH-99) modified CCG0007

Author: nils-a

docs/input/guidelines/RecommendedReferences.md

@@ -17,7 +17,7 @@ Title: Recommended References
 
 ## Goals
 
-To have consistency in code-style among the different tools/plugins the use of Analysers is recommended, especially the use of [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers). Additionally code-style anlysis using StyleCopy (and code generation in the IDE) should be properly configured using a `stylecop.json`-file as well as `.editorconfig`-file, respectively.
+To have consistency in code-style among the different tools/plugins the use of Analysers is recommended, especially the use of [StyleCop](https://github.com/DotNetAnalyzers/StyleCopAnalyzers). Additionally code-style analysis using StyleCopy (and code generation in the IDE) should be properly configured using a `stylecop.json`-file as well as `.editorconfig`-file, respectively.
 
 Example-Files can be found at:
 

docs/input/guidelines/TargetFramework.md

@@ -18,24 +18,27 @@ Title: Target Frameworks
 
 ## Goals
 
-Each addin should have maximum compatibility when being used. Toward that end some Framework versions are required and some others are 
+Each addin/module should have maximum compatibility when being used. Toward that end some Framework versions are required and some others are 
 suggested, depending on the Cake.Core version that is being referenced. 
 
 ### Required / Suggested versions
 
-Depending on the referenced `Cake.Core`-version different target versions are required and/or suggested.
+Depending on the package type and the referenced `Cake.Core`-version different target versions are required and/or suggested.
 Missing a required target version will raise [CCG0007](../rules/ccg0007) as an error
 while missing a suggested target version will raise [CCG0007](../rules/ccg0007) as a warning.
 
-* Cake.Core < 1.0.0
+* Package type: addin
+  * Cake.Core < 1.0.0
+    * Required: `netstandard2.0`
+    * Suggested: `net461`
+      * alternative: `net46`
+  * Cake.Core >= 1.0.0
+    * Required: `netstandard2.0`
+    * Suggested: `net461`
+      * alternative: `net46`
+    * Suggested: `net5.0`
+* Package type: module
   * Required: `netstandard2.0`
-  * Suggested: `net461`
-    * alternative: `net46`
-* Cake.Core >= 1.0.0
-  * Required: `netstandard2.0`
-  * Suggested: `net461`
-    * alternative: `net46`
-  * Suggested: `net5.0`
 
 ## Related rules
 

src/Guidelines/build/TargetFrameworkVersions.targets

@@ -8,14 +8,16 @@
     <Target
         Name="_CheckTargetFrameworkVersions"
         AfterTargets="BeforeBuild"
-        BeforeTargets="CoreBuild">
+        BeforeTargets="CoreBuild"
+        DependsOnTargets="EnsureProjectTypeIsSet">
+
         <!-- All other rules have some "configuration" here, this rules required/suggested targets are hard-coded in the task. Sadly. -->
 
         <TargetFrameworkVersions
             References="@(PackageReference)"
             TargetFramework="$(TargetFramework)"
             TargetFrameworks="$(TargetFrameworks)"
             Omitted="@(CakeContribGuidelinesOmitTargetFramework)"
-            ProjectFile="$(MSBuildProjectFullPath)" />
+            ProjectType="$(CakeContribGuidelinesProjectType)" />
     </Target>
 </Project>

src/Tasks.IntegrationTests/E2eTests.cs

@@ -251,6 +251,25 @@ public void Referencing_CakeCore_With_all_targets_raises_no_warning()
             result.WarningLines.Should().BeEmpty();
         }
 
+        [Fact]
+        public void Referencing_CakeCore_With_NetStandard_raises_no_warning_If_PackageType_Is_Module()
+        {
+            // given
+            fixture.WithPackageReference("Cake.Core", "1.0.0", "all");
+            fixture.WithTargetFrameworks("netstandard2.0");
+            fixture.WithCustomContent(@"
+<PropertyGroup>
+  <PackageId>Cake.Buildsystems.Module</PackageId>
+</PropertyGroup>");
+
+            // when
+            var result = fixture.Run();
+
+            // then
+            result.IsErrorExitCode.Should().BeFalse();
+            result.WarningLines.Should().BeEmpty();
+        }
+
         [Fact]
         public void ProjectType_Default_Is_Addin()
         {

src/Tasks.Tests/CalculateProjectTypeTests.cs

@@ -1,5 +1,3 @@
-using System.Linq;
-
 using CakeContrib.Guidelines.Tasks.Tests.Fixtures;
 
 using FluentAssertions;

src/Tasks.Tests/Fixtures/CalculateProjectTypeFixture.cs

@@ -1,11 +1,8 @@
-using System;
 using System.Collections.Generic;
 using System.Linq;
 
 using Microsoft.Build.Framework;
 
-using Moq;
-
 namespace CakeContrib.Guidelines.Tasks.Tests.Fixtures
 {
     public class CalculateProjectTypeFixture : BaseBuildFixture<CalculateProjectType>

src/Tasks.Tests/Fixtures/TargetFrameworkVersionsFixture.cs

@@ -56,9 +56,9 @@ public void WithCakeCoreReference(int major = 0, int minor = 0, int patch = 0)
             references.Add(cakeRef.Object);
         }
 
-        public void WithProjectFile(string fileName)
+        public void WithProjectType(string projectType)
         {
-            Task.ProjectFile = fileName;
+            Task.ProjectType = projectType;
         }
     }
 }

src/Tasks.Tests/TargetFrameworkVersionsTests.cs

@@ -137,5 +137,37 @@ public void Should_Not_Warn_If_All_References_for_Cake_Version_is_1_0_0_is_prese
             fixture.BuildEngine.ErrorEvents.Should().HaveCount(0);
             fixture.BuildEngine.WarningEvents.Should().HaveCount(0);
         }
+
+        [Fact]
+        public void Should_Error_If_ProjectType_Is_Module_And_Reference_Is_Missing()
+        {
+            // given
+            var fixture = new TargetFrameworkVersionsFixture();
+            fixture.WithCakeCoreReference(1);
+            fixture.WithProjectType("module");
+
+            // when
+            fixture.Execute();
+
+            // then
+            fixture.BuildEngine.ErrorEvents.Should().HaveCount(1);
+        }
+
+        [Fact]
+        public void Should_Not_Warn_If_ProjectType_Is_Module_And_Reference_Is_NetStandard()
+        {
+            // given
+            var fixture = new TargetFrameworkVersionsFixture();
+            fixture.WithCakeCoreReference(1);
+            fixture.WithTargetFramework("netstandard2.0");
+            fixture.WithProjectType("module");
+
+            // when
+            fixture.Execute();
+
+            // then
+            fixture.BuildEngine.ErrorEvents.Should().HaveCount(0);
+            fixture.BuildEngine.WarningEvents.Should().HaveCount(0);
+        }
     }
 }

src/Tasks/CcgLogError.cs

@@ -1,18 +1,14 @@
-using System.Diagnostics.CodeAnalysis;
-
 using CakeContrib.Guidelines.Tasks.Extensions;
 
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
+// ReSharper disable UnusedMember.Global
 namespace CakeContrib.Guidelines.Tasks
 {
     /// <summary>
     /// This is a convenience-Task to call CcgError from inside the msbuild.
     /// </summary>
-    [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global", Justification = "Needed in Tasks")]
-    [SuppressMessage("ReSharper", "MemberCanBePrivate.Global", Justification = "Needed in Tasks")]
-    [SuppressMessage("ReSharper", "UnusedType.Global", Justification = "Used as Task")]
     public class CcgLogError : Task
     {
         /// <summary>

src/Tasks/CcgLogWarning.cs

@@ -1,18 +1,14 @@
-using System.Diagnostics.CodeAnalysis;
-
 using CakeContrib.Guidelines.Tasks.Extensions;
 
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
+// ReSharper disable UnusedMember.Global
 namespace CakeContrib.Guidelines.Tasks
 {
     /// <summary>
     /// This is a convenience-Task to call CcgWarning from inside the msbuild.
     /// </summary>
-    [SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global", Justification = "Needed in Tasks")]
-    [SuppressMessage("ReSharper", "MemberCanBePrivate.Global", Justification = "Needed in Tasks")]
-    [SuppressMessage("ReSharper", "UnusedType.Global", Justification = "Used as Task")]
     public class CcgLogWarning : Task
     {
         /// <summary>