(GH-99) modified CCG0007

so the current rules are only valid for addins and
added a new rule, for modules, to target only NetStandard20

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/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/TargetFrameworkVersions.cs

@@ -42,11 +42,19 @@ public class TargetFrameworkVersions : Task
             SuggestedTargets = new[] { TargetsDefinition.From(Net461, Net46) },
         };
 
-        private static readonly Dictionary<Predicate<Version>, TargetsDefinitions> SpecificTargets =
-            new Dictionary<Predicate<Version>, TargetsDefinitions>
+        private static readonly Dictionary<Predicate<Differentiator>, TargetsDefinitions> SpecificTargets =
+            new Dictionary<Predicate<Differentiator>, TargetsDefinitions>
             {
                 {
-                    v => v.GreaterEqual(V0_26_0) && v.LessThan(V1_0_0),
+                    d => d.IsModuleProject,
+                    new TargetsDefinitions
+                    {
+                        Name = "Module",
+                        RequiredTargets = new[] { TargetsDefinition.From(NetStandard20) },
+                    }
+                },
+                {
+                    d => !d.IsModuleProject && d.Version.GreaterEqual(V0_26_0) && d.Version.LessThan(V1_0_0),
                     new TargetsDefinitions
                     {
                         Name = "0.26.0 <= x < 1.0.0",
@@ -55,7 +63,7 @@ public class TargetFrameworkVersions : Task
                     }
                 },
                 {
-                    v => v.GreaterEqual(V1_0_0),
+                    d => !d.IsModuleProject && d.Version.GreaterEqual(V1_0_0),
                     new TargetsDefinitions
                     {
                         Name = "x >= 1.0.0",
@@ -88,9 +96,10 @@ public class TargetFrameworkVersions : Task
         public ITaskItem TargetFramework { get; set; }
 
         /// <summary>
-        /// Gets or sets the project file.
+        /// Gets or sets the ProjectType.
         /// </summary>
-        public string ProjectFile { get; set; }
+        [Required]
+        public string ProjectType { get; set; }
 
         /// <summary>
         /// Gets or sets Targets to omit. I.e. if those are missing, they will not be reported.
@@ -115,7 +124,7 @@ public override bool Execute()
             {
                 Log.CcgWarning(
                     7,
-                    ProjectFile,
+                    BuildEngine.ProjectFileOfTaskNode,
                     $"Cake.Core has a version of {cakeCore.GetMetadata("version")} which is not a valid version. Using default TargetVersions.");
                 return Execute(DefaultTarget);
             }
@@ -126,7 +135,12 @@ public override bool Execute()
 
             foreach (var targetsDefinition in SpecificTargets)
             {
-                var match = targetsDefinition.Key(version);
+                var differentiator = new Differentiator
+                {
+                    IsModuleProject = "module".Equals(ProjectType, StringComparison.OrdinalIgnoreCase),
+                    Version = version,
+                };
+                var match = targetsDefinition.Key(differentiator);
                 if (!match)
                 {
                     continue;
@@ -187,7 +201,7 @@ private bool Execute(TargetsDefinitions targets)
 
                 Log.CcgError(
                     7,
-                    ProjectFile,
+                    BuildEngine.ProjectFileOfTaskNode,
                     "Missing required target: " + requiredTarget.Name);
                 return false;
             }
@@ -220,7 +234,7 @@ private bool Execute(TargetsDefinitions targets)
 
                 Log.CcgWarning(
                     7,
-                    ProjectFile,
+                    BuildEngine.ProjectFileOfTaskNode,
                     "Missing suggested target: " + suggestedTarget.Name);
             }
 
@@ -229,6 +243,12 @@ private bool Execute(TargetsDefinitions targets)
 
         private class TargetsDefinitions
         {
+            public TargetsDefinitions()
+            {
+                RequiredTargets = Array.Empty<TargetsDefinition>();
+                SuggestedTargets = Array.Empty<TargetsDefinition>();
+            }
+
             public string Name { get; set; }
 
             public TargetsDefinition[] RequiredTargets { get; set; }
@@ -247,5 +267,12 @@ public static TargetsDefinition From(string name, params string[] alternatives)
                 return new TargetsDefinition { Name = name, Alternatives = alternatives ?? Array.Empty<string>(), };
             }
         }
+
+        private class Differentiator
+        {
+            internal Version Version { get; set; }
+
+            internal bool IsModuleProject { get; set; }
+        }
     }
 }