Configuration API & detect SpecFlow version from output folder, fixes #14

Changelog.md

@@ -3,14 +3,21 @@
 New features:
 
 * Provide documentation in autocompletion of keywords (Issue #3)
+* Support projects with SpecFlow assembly references (non-NuGet) (Issue #14)
+  * see http://speclink.me/deveroomsfassref for details
+* Deveroom configuration file support
+  * see http://speclink.me/deveroomconfig for details
 
 Improvements:
 
 * Step completion should use word containment for filtering the list (Issue #28)
+* Display warning on config load error
+* Improved error handling for code-behind generation
 
 Bug fixes:
 
 * Editor: No syntax coloring when the file ends with doc-string open (Issue #6)
+* Default language is not detected for SpecFlow v3 from specflow.json config file
 
 # v1.3.0 - 2019-06-20
 

Deveroom.VisualStudio.ItemTemplates/Deveroom.VisualStudio.ItemTemplates.csproj

@@ -16,6 +16,9 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <VSTemplate Include="DeveroomConfig_CSharp\DeveroomConfig_CSharp.vstemplate">
+      <OutputSubPath>Deveroom</OutputSubPath>
+    </VSTemplate>
     <VSTemplate Include="FeatureFile_CSharp\FeatureFile_CSharp.vstemplate">
       <OutputSubPath>Deveroom</OutputSubPath>
     </VSTemplate>

Deveroom.VisualStudio.ItemTemplates/DeveroomConfig_CSharp/DeveroomConfig_CSharp.vstemplate

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<VSTemplate Version="3.0.0" Type="Item" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005">
+  <TemplateData>
+    <DefaultName>deveroom.json</DefaultName>
+    <Name>Deveroom configuration file</Name>
+    <Description>A json file containing Deveroom configuration settings. Place it in the project or solution root.</Description>
+    <ProjectType>CSharp</ProjectType>
+    <Icon>Deveroom-Icon.ico</Icon>
+  </TemplateData>
+  <TemplateContent>
+    <ProjectItem>deveroom.json</ProjectItem>
+  </TemplateContent>
+</VSTemplate>

Deveroom.VisualStudio.ItemTemplates/DeveroomConfig_CSharp/deveroom.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "http://schemas.specsolutions.eu/deveroom-config-latest.json"
+
+  // See configuration options and samples at http://speclink.me/deveroomconfig
+  // or use the auto-complete feature of your IDE to discover configuration options.
+
+  // The deveroom configuration file (deveroom.json) can be placed in 
+  // * the project folder -- project-level settings
+  // * the solution folder -- solution-level settings
+  // * the %LOCALAPPDATA%\Deveroom\ folder -- user-level settings for this machine
+
+
+}

Deveroom.VisualStudio.Package/Deveroom.VisualStudio.Package.csproj

@@ -81,6 +81,7 @@
     <AdditionalDeveroomDependencies Include="Utf8Json.dll" />
     <AdditionalDeveroomDependencies Include="System.Threading.Tasks.Extensions.dll" />
     <AdditionalDeveroomDependencies Include="System.IO.Abstractions.dll" />
+    <AdditionalDeveroomDependencies Include="Equ.dll" />
   </ItemGroup>
 
   <Import Project="..\Deveroom.VisualStudio.SpecFlowConnector.V1\DeploymentAssets.props" />

Deveroom.VisualStudio.Package/Generator/RegenerateAllFeatureFileCodeBehindCommand.cs

@@ -5,6 +5,7 @@
 using Deveroom.VisualStudio.Common;
 using Deveroom.VisualStudio.Diagonostics;
 using Deveroom.VisualStudio.Editor.Commands;
+using Deveroom.VisualStudio.Generation;
 using Deveroom.VisualStudio.ProjectSystem;
 using Deveroom.VisualStudio.ProjectSystem.Settings;
 using EnvDTE;
@@ -86,6 +87,13 @@ private void InvokeHandler(object sender, EventArgs e)
             if (project == null)
                 return;
 
+            var projectScope = _vsIdeScope.GetProjectScope(project);
+            if (projectScope == null)
+                return;
+
+            if (!GenerationService.CheckSpecFlowToolsFolder(projectScope))
+                return;
+
             foreach (var featureFileItem in GetFeatureFileItems(project))
             {
                 var vsProjectItem = featureFileItem.Object as VSProjectItem;

Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/DiscoveryProcessor.cs

@@ -1,11 +1,11 @@
 using System.Diagnostics;
 using System.IO;
 using Deveroom.VisualStudio.SpecFlowConnector.AppDomainHelper;
-using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V1090;
-using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V2000;
-using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V2010;
-using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V2020;
-using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V3000;
+using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V19;
+using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V20;
+using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V21;
+using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V22;
+using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V30;
 
 namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery
 {
@@ -25,25 +25,25 @@ public string Process()
                 var appDomain = new AppDomainManager(_options.AssemblyFilePath, _options.ConfigFilePath, false, null);
 
                 var specFlowVersion = GetSpecFlowVersion();
-                var discovererType = typeof(SpecFlowV2020Discoverer);
+                var discovererType = typeof(SpecFlowV30P220Discoverer); // assume recent version
                 if (specFlowVersion != null)
-                    switch (specFlowVersion.FileMajorPart * 1000 + specFlowVersion.FileMinorPart * 10)
-                    {
-                        case 1090:
-                            discovererType = typeof(SpecFlowV1090Discoverer);
-                            break;
-                        case 2000:
-                            discovererType = typeof(SpecFlowV2000Discoverer);
-                            break;
-                        case 2010:
-                            discovererType = typeof(SpecFlowV2010Discoverer);
-                            break;
-                        case 3000:
-                            discovererType = specFlowVersion.FileBuildPart >= 220 ? 
-                                typeof(SpecFlowV3000P220Discoverer) : 
-                                typeof(SpecFlowV3000Discoverer);
-                            break;
-                    }
+                {
+                    var versionNumber =
+                        ((specFlowVersion.FileMajorPart * 100) + specFlowVersion.FileMinorPart) * 1000 + specFlowVersion.FileBuildPart;
+
+                    if (versionNumber >= 3_00_220)
+                        discovererType = typeof(SpecFlowV30P220Discoverer);
+                    else if (versionNumber >= 3_00_000)
+                        discovererType = typeof(SpecFlowV30Discoverer);
+                    else if (versionNumber >= 2_02_000)
+                        discovererType = typeof(SpecFlowV22Discoverer);
+                    else if (versionNumber >= 2_01_000)
+                        discovererType = typeof(SpecFlowV21Discoverer);
+                    else if (versionNumber >= 2_00_000)
+                        discovererType = typeof(SpecFlowV20Discoverer);
+                    else if (versionNumber >= 1_09_000)
+                        discovererType = typeof(SpecFlowV19Discoverer);
+                }
 
                 appDomain.CreateObjectFrom<AssemblyHelper>(typeof(AssemblyHelper).Assembly.Location, typeof(AssemblyHelper).FullName, _options.TargetFolder);
                 appDomain.CreateObjectFrom<AssemblyHelper>(typeof(AssemblyHelper).Assembly.Location, typeof(AssemblyHelper).FullName, _options.ConnectorFolder);

Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V1090/SpecFlowV1090Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V19/SpecFlowV19Discoverer.cs

@@ -7,9 +7,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V1090
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V19
 {
-    public class SpecFlowV1090Discoverer : RemotingBaseDiscoverer
+    public class SpecFlowV19Discoverer : RemotingBaseDiscoverer
     {
         protected override IBindingRegistry GetBindingRegistry(Assembly testAssembly, string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V2000/SpecFlowV2000Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V20/SpecFlowV20Discoverer.cs

@@ -8,9 +8,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V2000
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V20
 {
-    public class SpecFlowV2000Discoverer : RemotingBaseDiscoverer
+    public class SpecFlowV20Discoverer : RemotingBaseDiscoverer
     {
         protected override IBindingRegistry GetBindingRegistry(Assembly testAssembly, string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V2010/SpecFlowV2010Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V21/SpecFlowV21Discoverer.cs

@@ -6,9 +6,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V2010
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V21
 {
-    public class SpecFlowV2010Discoverer : RemotingBaseDiscoverer
+    public class SpecFlowV21Discoverer : RemotingBaseDiscoverer
     {
         protected override IBindingRegistry GetBindingRegistry(Assembly testAssembly, string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V2020/SpecFlowV2020Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V22/SpecFlowV22Discoverer.cs

@@ -6,9 +6,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V2020
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V22
 {
-    public class SpecFlowV2020Discoverer : RemotingBaseDiscoverer
+    public class SpecFlowV22Discoverer : RemotingBaseDiscoverer
     {
         protected override IBindingRegistry GetBindingRegistry(Assembly testAssembly, string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V3000/SpecFlowV3000Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V30/SpecFlowV30Discoverer.cs

@@ -3,9 +3,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V3000
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V30
 {
-    public class SpecFlowV3000Discoverer : SpecFlowV3000P220Discoverer
+    public class SpecFlowV30Discoverer : SpecFlowV30P220Discoverer
     {
         protected override object CreateGlobalContainer(IConfigurationLoader configurationLoader, Assembly testAssembly)
         {

Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V3000/SpecFlowV3000P220Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Discovery/V30/SpecFlowV30P220Discoverer.cs

@@ -6,9 +6,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V3000
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V30
 {
-    public class SpecFlowV3000P220Discoverer : RemotingBaseDiscoverer
+    public class SpecFlowV30P220Discoverer : RemotingBaseDiscoverer
     {
         protected override IBindingRegistry GetBindingRegistry(Assembly testAssembly, string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V1/Generation/GenerationProcessor.cs

@@ -2,8 +2,8 @@
 using System.Diagnostics;
 using System.IO;
 using Deveroom.VisualStudio.SpecFlowConnector.AppDomainHelper;
-using Deveroom.VisualStudio.SpecFlowConnector.Generation.V1090;
-using Deveroom.VisualStudio.SpecFlowConnector.Generation.V2020;
+using Deveroom.VisualStudio.SpecFlowConnector.Generation.V19;
+using Deveroom.VisualStudio.SpecFlowConnector.Generation.V22;
 
 namespace Deveroom.VisualStudio.SpecFlowConnector.Generation
 {
@@ -22,18 +22,19 @@ public string Process()
             using (AssemblyHelper.SubscribeResolveForAssembly(generatorAssemblyPath))
             {
                 var specFlowAssemblyPath = Path.Combine(_options.SpecFlowToolsFolder, "TechTalk.SpecFlow.dll");
-                var fileVersionInfo = File.Exists(specFlowAssemblyPath) ? FileVersionInfo.GetVersionInfo(specFlowAssemblyPath) : null;
+                var specFlowVersion = File.Exists(specFlowAssemblyPath) ? FileVersionInfo.GetVersionInfo(specFlowAssemblyPath) : null;
 
-                var generatorType = typeof(SpecFlowV2020Generator);
-                if (fileVersionInfo != null)
-                    switch (fileVersionInfo.FileMajorPart * 1000 + fileVersionInfo.FileMinorPart * 10)
-                    {
-                        case 1090:
-                        case 2000:
-                        case 2010:
-                            generatorType = typeof(SpecFlowV1090Generator);
-                            break;
-                    }
+                var generatorType = typeof(SpecFlowV22Generator);
+                if (specFlowVersion != null)
+                {
+                    var versionNumber =
+                        ((specFlowVersion.FileMajorPart * 100) + specFlowVersion.FileMinorPart) * 1000 + specFlowVersion.FileBuildPart;
+
+                    if (versionNumber >= 2_02_000)
+                        generatorType = typeof(SpecFlowV22Generator);
+                    else if (versionNumber >= 1_09_000)
+                        generatorType = typeof(SpecFlowV19Generator);
+                }
 
                 var generator = (ISpecFlowGenerator)Activator.CreateInstance(generatorType);
                 return generator.Generate(_options.ProjectFolder, _options.ConfigFilePath, _options.TargetExtension, _options.FeatureFilePath, _options.TargetNamespace, _options.ProjectDefaultNamespace, _options.SaveResultToFile);

Deveroom.VisualStudio.SpecFlowConnector.V1/Generation/V1090/SpecFlowV1090Generator.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Generation/V19/SpecFlowV19Generator.cs

@@ -1,9 +1,9 @@
 using System.IO;
 using TechTalk.SpecFlow.Generator.Interfaces;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Generation.V1090
+namespace Deveroom.VisualStudio.SpecFlowConnector.Generation.V19
 {
-    public class SpecFlowV1090Generator : BaseGenerator
+    public class SpecFlowV19Generator : BaseGenerator
     {
         protected override SpecFlowConfigurationHolder CreateConfigHolder(string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V1/Generation/V2020/SpecFlowV2020Generator.cs → Deveroom.VisualStudio.SpecFlowConnector.V1/Generation/V22/SpecFlowV22Generator.cs

@@ -5,9 +5,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Generator.Interfaces;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Generation.V2020
+namespace Deveroom.VisualStudio.SpecFlowConnector.Generation.V22
 {
-    public class SpecFlowV2020Generator : BaseGenerator
+    public class SpecFlowV22Generator : BaseGenerator
     {
         protected override SpecFlowConfigurationHolder CreateConfigHolder(string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V2/Discovery/V3000/SpecFlowV3000Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V2/Discovery/V30/SpecFlowV30Discoverer.cs

@@ -4,9 +4,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V3000
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V30
 {
-    public class SpecFlowV3000Discoverer : SpecFlowV3000P220Discoverer
+    public class SpecFlowV30Discoverer : SpecFlowV30P220Discoverer
     {
         protected override IObjectContainer CreateGlobalContainer(IConfigurationLoader configurationLoader, Assembly testAssembly)
         {

Deveroom.VisualStudio.SpecFlowConnector.V2/Discovery/V3000/SpecFlowV3000P220Discoverer.cs → Deveroom.VisualStudio.SpecFlowConnector.V2/Discovery/V30/SpecFlowV30P220Discoverer.cs

@@ -7,9 +7,9 @@
 using TechTalk.SpecFlow.Configuration;
 using TechTalk.SpecFlow.Infrastructure;
 
-namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V3000
+namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery.V30
 {
-    public class SpecFlowV3000P220Discoverer : BaseDiscoverer
+    public class SpecFlowV30P220Discoverer : BaseDiscoverer
     {
         protected override IBindingRegistry GetBindingRegistry(Assembly testAssembly, string configFilePath)
         {

Deveroom.VisualStudio.SpecFlowConnector.V2/Discovery/VersionSelectorDiscoverer.cs

@@ -2,7 +2,7 @@
 using System.Diagnostics;
 using System.IO;
 using System.Reflection;
-using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V3000;
+using Deveroom.VisualStudio.SpecFlowConnector.Discovery.V30;
 using TechTalk.SpecFlow;
 
 namespace Deveroom.VisualStudio.SpecFlowConnector.Discovery
@@ -29,16 +29,17 @@ private ISpecFlowDiscoverer CreateDiscoverer()
         {
             var specFlowVersion = GetSpecFlowVersion();
 
-            var discovererType = typeof(SpecFlowV3000Discoverer);
+            var discovererType = typeof(SpecFlowV30P220Discoverer); // assume recent version
             if (specFlowVersion != null)
-                switch (specFlowVersion.FileMajorPart * 1000 + specFlowVersion.FileMinorPart * 10)
-                {
-                    case 3000:
-                        discovererType = specFlowVersion.FileBuildPart >= 220 ?
-                            typeof(SpecFlowV3000P220Discoverer) :
-                            typeof(SpecFlowV3000Discoverer);
-                        break;
-                }
+            {
+                var versionNumber =
+                    ((specFlowVersion.FileMajorPart * 100) + specFlowVersion.FileMinorPart) * 1000 + specFlowVersion.FileBuildPart;
+
+                if (versionNumber >= 3_00_220)
+                    discovererType = typeof(SpecFlowV30P220Discoverer);
+                else if (versionNumber >= 3_00_000)
+                    discovererType = typeof(SpecFlowV30Discoverer);
+            }
 
             return (ISpecFlowDiscoverer)Activator.CreateInstance(discovererType);
         }