Fix minor issues related to class auto accessors (#360)

* Fix minor issue in setting up write context in AstToJsonConverter.VisitAccessorProperty * Add missing VisitAccessorProperty override to AstRewriter * Maintain alphabetical order in visitors
sebastienros · Dec 28, 2022 · 556a2b5 · 556a2b5
1 parent 29ccbb2
commit 556a2b5
Show file tree

Hide file tree

Showing 5 changed files with 96 additions and 85 deletions.
diff --git a/src/Esprima/Utils/AstRewriter.cs b/src/Esprima/Utils/AstRewriter.cs
@@ -64,6 +64,15 @@ public virtual bool VisitAndConvert<T>(in NodeList<T> nodes, out NodeList<T> new
         return false;
     }
 
+    protected internal override object? VisitAccessorProperty(AccessorProperty accessorProperty)
+    {
+        VisitAndConvert(accessorProperty.Decorators, out var decorators);
+        var key = VisitAndConvert(accessorProperty.Key);
+        var value = VisitAndConvert(accessorProperty.Value, allowNull: true);
+
+        return accessorProperty.UpdateWith(key, value, decorators);
+    }
+
     protected internal override object? VisitArrayExpression(ArrayExpression arrayExpression)
     {
         VisitAndConvert(arrayExpression.Elements, out var elements, allowNullElement: true);

diff --git a/src/Esprima/Utils/AstToJavascriptConverter.cs b/src/Esprima/Utils/AstToJavascriptConverter.cs
@@ -67,6 +67,47 @@ public void Convert(Node node)
         return result;
     }
 
+    protected internal override object? VisitAccessorProperty(AccessorProperty accessorProperty)
+    {
+        if (accessorProperty.Decorators.Count > 0)
+        {
+            _writeContext.SetNodeProperty(nameof(accessorProperty.Decorators), static node => ref node.As<AccessorProperty>().Decorators);
+            VisitAuxiliaryNodeList(accessorProperty.Decorators, separator: string.Empty);
+
+            _writeContext.ClearNodeProperty();
+        }
+
+        if (accessorProperty.Static)
+        {
+            _writeContext.SetNodeProperty(nameof(accessorProperty.Static), static node => node.As<AccessorProperty>().Static);
+            Writer.WriteKeyword("static", TokenFlags.SurroundingSpaceRecommended, ref _writeContext);
+
+            _writeContext.ClearNodeProperty();
+        }
+        else
+        {
+            Writer.SpaceRecommendedAfterLastToken();
+        }
+
+        Writer.WriteKeyword("accessor", TokenFlags.SurroundingSpaceRecommended, ref _writeContext);
+
+        _writeContext.SetNodeProperty(nameof(accessorProperty.Key), static node => node.As<AccessorProperty>().Key);
+        VisitPropertyKey(accessorProperty.Key, accessorProperty.Computed, leadingBracketFlags: TokenFlags.LeadingSpaceRecommended);
+
+        if (accessorProperty.Value is not null)
+        {
+            _writeContext.ClearNodeProperty();
+            Writer.WritePunctuator("=", TokenFlags.InBetween | TokenFlags.SurroundingSpaceRecommended, ref _writeContext);
+
+            _writeContext.SetNodeProperty(nameof(accessorProperty.Value), static node => node.As<AccessorProperty>().Value);
+            VisitRootExpression(accessorProperty.Value, RootExpressionFlags(needsBrackets: ExpressionNeedsBracketsInList(accessorProperty.Value)));
+        }
+
+        Writer.WritePunctuator(";", TokenFlags.Trailing | TokenFlags.TrailingSpaceRecommended, ref _writeContext);
+
+        return accessorProperty;
+    }
+
     protected internal override object? VisitArrayExpression(ArrayExpression arrayExpression)
     {
         _writeContext.SetNodeProperty(nameof(arrayExpression.Elements), static node => ref node.As<ArrayExpression>().Elements);
@@ -1395,45 +1436,6 @@ binaryExpression.Right is UnaryExpression rightUnaryExpression &&
         return propertyDefinition;
     }
 
-    protected internal override object? VisitAccessorProperty(AccessorProperty accessorProperty)
-    {
-        if (accessorProperty.Decorators.Count > 0)
-        {
-            _writeContext.SetNodeProperty(nameof(accessorProperty.Decorators), static node => ref node.As<AccessorProperty>().Decorators);
-            VisitAuxiliaryNodeList(accessorProperty.Decorators, separator: string.Empty);
-
-            _writeContext.ClearNodeProperty();
-        }
-
-        if (accessorProperty.Static)
-        {
-            _writeContext.SetNodeProperty(nameof(accessorProperty.Static), static node => node.As<AccessorProperty>().Static);
-            Writer.WriteKeyword("static", TokenFlags.SurroundingSpaceRecommended, ref _writeContext);
-        }
-        else
-        {
-            Writer.SpaceRecommendedAfterLastToken();
-        }
-
-        Writer.WriteKeyword("accessor", TokenFlags.SurroundingSpaceRecommended, ref _writeContext);
-
-        _writeContext.SetNodeProperty(nameof(accessorProperty.Key), static node => node.As<AccessorProperty>().Key);
-        VisitPropertyKey(accessorProperty.Key, accessorProperty.Computed, leadingBracketFlags: TokenFlags.LeadingSpaceRecommended);
-
-        if (accessorProperty.Value is not null)
-        {
-            _writeContext.ClearNodeProperty();
-            Writer.WritePunctuator("=", TokenFlags.InBetween | TokenFlags.SurroundingSpaceRecommended, ref _writeContext);
-
-            _writeContext.SetNodeProperty(nameof(accessorProperty.Value), static node => node.As<AccessorProperty>().Value);
-            VisitRootExpression(accessorProperty.Value, RootExpressionFlags(needsBrackets: ExpressionNeedsBracketsInList(accessorProperty.Value)));
-        }
-
-        Writer.WritePunctuator(";", TokenFlags.Trailing | TokenFlags.TrailingSpaceRecommended, ref _writeContext);
-
-        return accessorProperty;
-    }
-
     protected internal override object? VisitRestElement(RestElement restElement)
     {
         _writeContext.SetNodeProperty(nameof(restElement.Argument), static node => node.As<RestElement>().Argument);

diff --git a/src/Esprima/Utils/AstToJsonConverter.cs b/src/Esprima/Utils/AstToJsonConverter.cs
@@ -257,6 +257,24 @@ public void Convert(Node node)
         }
     }
 
+    protected internal override object? VisitAccessorProperty(AccessorProperty accessorProperty)
+    {
+        using (StartNodeObject(accessorProperty))
+        {
+            Member("key", accessorProperty.Key);
+            Member("computed", accessorProperty.Computed);
+            Member("value", accessorProperty.Value);
+            Member("kind", accessorProperty.Kind);
+            Member("static", accessorProperty.Static);
+            if (accessorProperty.Decorators.Count > 0)
+            {
+                Member("decorators", accessorProperty.Decorators);
+            }
+        }
+
+        return accessorProperty;
+    }
+
     protected internal override object? VisitArrayExpression(ArrayExpression arrayExpression)
     {
         using (StartNodeObject(arrayExpression))
@@ -974,24 +992,6 @@ public ImportCompat() : base(Nodes.Import) { }
         return propertyDefinition;
     }
 
-    protected internal override object? VisitAccessorProperty(AccessorProperty accessorProperty)
-    {
-        using (StartNodeObject(accessorProperty))
-        {
-            Member("key", accessorProperty.Key);
-            Member("computed", accessorProperty.Computed);
-            Member("value", accessorProperty.Value);
-            Member("kind", accessorProperty.Kind);
-            Member("static", accessorProperty.Static);
-            if (accessorProperty.Decorators.Count > 0)
-            {
-                Member("decorators", accessorProperty.Decorators);
-            }
-        }
-
-        return accessorProperty;
-    }
-
     protected internal override object? VisitRestElement(RestElement restElement)
     {
         using (StartNodeObject(restElement))

diff --git a/src/Esprima/Utils/AstVisitor.cs b/src/Esprima/Utils/AstVisitor.cs
@@ -13,6 +13,24 @@ private static Exception UnsupportedNodeType(Type nodeType, [CallerMemberName] s
         return node.Accept(this);
     }
 
+    protected internal virtual object? VisitAccessorProperty(AccessorProperty accessorProperty)
+    {
+        ref readonly var decorators = ref accessorProperty.Decorators;
+        for (var i = 0; i < decorators.Count; i++)
+        {
+            Visit(decorators[i]);
+        }
+
+        Visit(accessorProperty.Key);
+
+        if (accessorProperty.Value is not null)
+        {
+            Visit(accessorProperty.Value);
+        }
+
+        return accessorProperty;
+    }
+
     protected internal virtual object? VisitArrayExpression(ArrayExpression arrayExpression)
     {
         ref readonly var elements = ref arrayExpression.Elements;
@@ -602,24 +620,6 @@ private static Exception UnsupportedNodeType(Type nodeType, [CallerMemberName] s
         return propertyDefinition;
     }
 
-    protected internal virtual object? VisitAccessorProperty(AccessorProperty accessorProperty)
-    {
-        ref readonly var decorators = ref accessorProperty.Decorators;
-        for (var i = 0; i < decorators.Count; i++)
-        {
-            Visit(decorators[i]);
-        }
-
-        Visit(accessorProperty.Key);
-
-        if (accessorProperty.Value is not null)
-        {
-            Visit(accessorProperty.Value);
-        }
-
-        return accessorProperty;
-    }
-
     protected internal virtual object? VisitRestElement(RestElement restElement)
     {
         Visit(restElement.Argument);

diff --git a/src/Esprima/Utils/AstVisitorEventSource.cs b/src/Esprima/Utils/AstVisitorEventSource.cs
@@ -8,6 +8,8 @@ namespace Esprima.Utils;
 /// </summary>
 public class AstVisitorEventSource : AstVisitor
 {
+    public event EventHandler<AccessorProperty>? VisitingAccessorProperty;
+    public event EventHandler<AccessorProperty>? VisitedAccessorProperty;
     public event EventHandler<ArrayExpression>? VisitingArrayExpression;
     public event EventHandler<ArrayExpression>? VisitedArrayExpression;
     public event EventHandler<ArrayPattern>? VisitedArrayPattern;
@@ -112,8 +114,6 @@ public class AstVisitorEventSource : AstVisitor
     public event EventHandler<Property>? VisitedProperty;
     public event EventHandler<PropertyDefinition>? VisitingPropertyDefinition;
     public event EventHandler<PropertyDefinition>? VisitedPropertyDefinition;
-    public event EventHandler<AccessorProperty>? VisitingAccessorProperty;
-    public event EventHandler<AccessorProperty>? VisitedAccessorProperty;
     public event EventHandler<RestElement>? VisitingRestElement;
     public event EventHandler<RestElement>? VisitedRestElement;
     public event EventHandler<ReturnStatement>? VisitingReturnStatement;
@@ -163,6 +163,14 @@ public class AstVisitorEventSource : AstVisitor
         return result;
     }
 
+    protected internal override object? VisitAccessorProperty(AccessorProperty accessorProperty)
+    {
+        VisitingAccessorProperty?.Invoke(this, accessorProperty);
+        var result = base.VisitAccessorProperty(accessorProperty);
+        VisitedAccessorProperty?.Invoke(this, accessorProperty);
+        return result;
+    }
+
     protected internal override object? VisitArrayExpression(ArrayExpression arrayExpression)
     {
         VisitingArrayExpression?.Invoke(this, arrayExpression);
@@ -571,14 +579,6 @@ public class AstVisitorEventSource : AstVisitor
         return result;
     }
 
-    protected internal override object? VisitAccessorProperty(AccessorProperty accessorProperty)
-    {
-        VisitingAccessorProperty?.Invoke(this, accessorProperty);
-        var result = base.VisitAccessorProperty(accessorProperty);
-        VisitedAccessorProperty?.Invoke(this, accessorProperty);
-        return result;
-    }
-
     protected internal override object? VisitRestElement(RestElement restElement)
     {
         VisitingRestElement?.Invoke(this, restElement);