Add 'and' keyword autoformatting

Author: Jbontt

CHANGELOG.md

@@ -2,11 +2,13 @@
 
 ## Improvements:
 
+* Update autoformatting to replace sequential equivalent keywords with the `And` keyword
+
 ## Bug fixes:
 
 * Fix: Error message box when creating feature file with space in its name (#50)
 
-*Contributors of this release (in alphabetical order):* @gasparnagy
+*Contributors of this release (in alphabetical order):* @gasparnagy, @jdb0123
 
 # v2024.7.204 - 2024-11-20
 

Reqnroll.VisualStudio/Editor/Services/Formatting/GherkinDocumentFormatter.cs

@@ -8,17 +8,18 @@ public class GherkinDocumentFormatter
     public void FormatGherkinDocument(DeveroomGherkinDocument gherkinDocument, DocumentLinesEditBuffer lines,
         GherkinFormatSettings formatSettings)
     {
-        if (gherkinDocument.Feature != null)
-        {
-            SetTagsAndLine(lines, gherkinDocument.Feature, string.Empty);
-            SetLinesForChildren(lines, gherkinDocument.Feature.Children, formatSettings,
-                formatSettings.FeatureChildrenIndentLevel);
-        }
+      if (gherkinDocument.Feature == null) 
+        return;
+
+      SetTagsAndLine(lines, gherkinDocument.Feature, string.Empty);
+      SetLinesForChildren(lines, gherkinDocument.Feature.Children, formatSettings, formatSettings.FeatureChildrenIndentLevel);
     }
 
     private void SetLinesForChildren(DocumentLinesEditBuffer lines, IEnumerable<IHasLocation> hasLocation,
         GherkinFormatSettings formatSettings, int indentLevel)
     {
+        var dialectProvider = ReqnrollGherkinDialectProvider.Get(formatSettings.Language);
+
         foreach (var featureChild in hasLocation)
         {
             SetTagsAndLine(lines, featureChild, GetIndent(formatSettings, indentLevel));
@@ -37,24 +38,55 @@ private void SetLinesForChildren(DocumentLinesEditBuffer lines, IEnumerable<IHas
                         examplesBlockIndentLevel + formatSettings.ExamplesTableIndentLevelWithinExamplesBlock);
                 }
 
-            if (featureChild is IHasSteps hasSteps)
-                foreach (var step in hasSteps.Steps)
-                {
-                    var stepIndentLevel = indentLevel + formatSettings.StepIndentLevelWithinStepContainer;
-                    if (step is DeveroomGherkinStep deveroomGherkinStep &&
-                        (deveroomGherkinStep.StepKeyword == StepKeyword.And ||
-                         deveroomGherkinStep.StepKeyword == StepKeyword.But))
-                        stepIndentLevel += formatSettings.AndStepIndentLevelWithinSteps;
-                    SetLine(lines, step, $"{GetIndent(formatSettings, stepIndentLevel)}{step.Keyword}{step.Text}");
-                    if (step.Argument is DataTable dataTable)
-                        FormatTable(lines, dataTable, formatSettings,
-                            stepIndentLevel + formatSettings.DataTableIndentLevelWithinStep);
-
-                    if (step.Argument is DocString docString)
-                        FormatDocString(lines, docString, formatSettings,
-                            stepIndentLevel + formatSettings.DocStringIndentLevelWithinStep);
-                }
+            if (featureChild is IHasSteps hasSteps) 
+              FormatSteps(lines, formatSettings, indentLevel, hasSteps, dialectProvider);
+        }
+    }
+
+    private void FormatSteps(DocumentLinesEditBuffer lines, GherkinFormatSettings formatSettings, int indentLevel,
+      IHasSteps hasSteps, GherkinDialectProvider dialectProvider)
+    {
+      var previousKeyword = "";
+
+      foreach (var step in hasSteps.Steps)
+      {
+        var stepIndentLevel = indentLevel + formatSettings.StepIndentLevelWithinStepContainer;
+
+        var newKeyword = step.Keyword;
+
+        if (step is DeveroomGherkinStep { StepKeyword: StepKeyword.And or StepKeyword.But })
+        {
+          stepIndentLevel += formatSettings.AndStepIndentLevelWithinSteps;
+        }
+        else
+        {
+          if (step.Keyword == previousKeyword)
+          {
+            var andKeyword = GetAndKeyword(dialectProvider);
+            newKeyword = $"{andKeyword}";
+          }
+          else
+            previousKeyword = step.Keyword;
+        }
+
+
+        SetLine(lines, step, $"{GetIndent(formatSettings, stepIndentLevel)}{newKeyword}{step.Text}");
+
+        switch (step.Argument)
+        {
+          case DataTable dataTable:
+            FormatTable(lines, dataTable, formatSettings, stepIndentLevel + formatSettings.DataTableIndentLevelWithinStep);
+            break;
+          case DocString docString:
+            FormatDocString(lines, docString, formatSettings, stepIndentLevel + formatSettings.DocStringIndentLevelWithinStep);
+            break;
         }
+      }
+    }
+
+    private static string GetAndKeyword(GherkinDialectProvider dialectProvider)
+    {
+      return dialectProvider.DefaultDialect.AndStepKeywords.First(keyword => keyword != GherkinDialect.AsteriskKeyword);
     }
 
     private void SetTagsAndLine(DocumentLinesEditBuffer lines, IHasLocation hasLocation, string indent)

Reqnroll.VisualStudio/Editor/Services/Formatting/GherkinFormatSettings.cs

@@ -23,6 +23,7 @@ public class GherkinFormatSettings
 
     public string TableCellPadding => new(' ', Configuration.TableCellPaddingSize);
 
+    public string Language { get; set; } = "en-US";
 
     public static GherkinFormatSettings Load(IEditorConfigOptionsProvider editorConfigOptionsProvider,
         IWpfTextView textView, DeveroomConfiguration configuration)
@@ -39,7 +40,8 @@ public static GherkinFormatSettings Load(IEditorConfigOptionsProvider editorConf
         var formatSettings = new GherkinFormatSettings
         {
             Indent = convertTabsToSpaces ? new string(' ', indentSize) : new string('\t', 1),
-            Configuration = gherkinFormatConfiguration
+            Configuration = gherkinFormatConfiguration,
+            Language = configuration?.DefaultFeatureLanguage ?? "en-US"
         };
 
         return formatSettings;

Reqnroll.VisualStudio/ProjectSystem/Configuration/ProjectScopeDeveroomConfigurationProvider.cs

@@ -116,7 +116,9 @@ private ConfigSource GetProjectConfigFilePath(string fileName)
         {
             var projectFolder = _projectScope.ProjectFolder;
             var fileSystem = _projectScope.IdeScope.FileSystem;
-            var configFilePath = fileSystem.GetFilePathIfExists(Path.Combine(projectFolder, fileName));
+            var assemblyPath = Path.GetDirectoryName(_projectScope.OutputAssemblyPath);
+      
+            var configFilePath = fileSystem.GetFilePathIfExists(Path.Combine(assemblyPath ?? projectFolder, fileName));
 
             if (fileName.Equals(SpecFlowAppConfigFileName)) configFilePath ??= GetAppConfigPathFromProject();
             if (configFilePath == null)