Convert to js

src/Esprima.SourceGenerators/Esprima.SourceGenerators.csproj

@@ -15,6 +15,7 @@
 
   <ItemGroup>
     <Compile Include="..\Shared\Compatibility\IsExternalInit.cs" Link="Compatibility\IsExternalInit.cs" />
+    <Compile Include="..\Shared\Compatibility\NullableAttributes.cs" Link="Compatibility\NullableAttributes.cs" />
   </ItemGroup>
 
 </Project>

src/Esprima/Ast/ArrayExpression.cs

@@ -12,6 +12,9 @@ public ArrayExpression(in NodeList<Expression?> elements) : base(Nodes.ArrayExpr
             _elements = elements;
         }
 
+        /// <summary>
+        /// { <see cref="Expression"/> (incl. <see cref="SpreadElement"/>) | <see langword="null"/> }
+        /// </summary>
         public ref readonly NodeList<Expression?> Elements { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _elements; }
 
         internal override Node? NextChildNode(ref ChildNodes.Enumerator enumerator) => enumerator.MoveNextNullable(Elements);

src/Esprima/Ast/ArrayPattern.cs

@@ -12,6 +12,9 @@ public ArrayPattern(in NodeList<Expression?> elements) : base(Nodes.ArrayPattern
             _elements = elements;
         }
 
+        /// <summary>
+        /// { <see cref="Identifier"/> | <see cref="BindingPattern"/> | <see cref="AssignmentPattern"/> | <see cref="RestElement"/> | <see langword="null"/> }
+        /// </summary>
         public ref readonly NodeList<Expression?> Elements { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _elements; }
 
         internal override Node? NextChildNode(ref ChildNodes.Enumerator enumerator) => enumerator.MoveNextNullable(Elements);

src/Esprima/Ast/ArrowFunctionExpression.cs

@@ -23,9 +23,12 @@ public ArrowFunctionExpression(
         }
 
         Identifier? IFunction.Id => null;
+        /// <summary>
+        /// { <see cref="Identifier"/> | <see cref="BindingPattern"/> | <see cref="AssignmentPattern"/> | <see cref="RestElement"/> }
+        /// </summary>
         public ref readonly NodeList<Expression> Params { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _params; }
         /// <remarks>
-        /// <see cref="BlockStatement" /> | <see cref="Ast.Expression" />
+        /// <see cref="BlockStatement"/> | <see cref="Ast.Expression"/>
         /// </remarks>
         public Node Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         bool IFunction.Generator => false;

src/Esprima/Ast/AssignmentExpression.cs

@@ -94,8 +94,9 @@ public static string GetAssignmentOperatorToken(AssignmentOperator op)
         }
 
         public AssignmentOperator Operator { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
+
         /// <remarks>
-        /// Can be something else than Expression (<see cref="ObjectPattern"/>, <see cref="ArrayPattern"/>) in case of destructuring assignment
+        /// <see cref="Identifier"/> | <see cref="BindingPattern"/>
         /// </remarks>
         public Expression Left { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public Expression Right { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/AssignmentPattern.cs

@@ -13,6 +13,9 @@ public AssignmentPattern(Expression left, Expression right) : base(Nodes.Assignm
             _right = right;
         }
 
+        /// <summary>
+        /// <see cref="Identifier"/> | <see cref="BindingPattern"/>
+        /// </summary>
         public Expression Left { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public Expression Right { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => _right; }
 

src/Esprima/Ast/CatchClause.cs

@@ -13,7 +13,7 @@ public CatchClause(Expression? param, BlockStatement body) :
         }
 
         /// <remarks>
-        /// BindingIdentifier | <see cref="BindingPattern"/> | <see langword="null"/>
+        /// <see cref="Identifier"/> | <see cref="BindingPattern"/>
         /// </remarks>
         public Expression? Param { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public BlockStatement Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ChainExpression.cs

@@ -11,7 +11,7 @@ public ChainExpression(Expression expression) : base(Nodes.ChainExpression)
         }
 
         /// <remarks>
-        /// <see cref="CallExpression" /> | <see cref="ComputedMemberExpression" />| <see cref="StaticMemberExpression" />
+        /// <see cref="CallExpression"/> | <see cref="ComputedMemberExpression"/>| <see cref="StaticMemberExpression"/>
         /// </remarks>
         public Expression Expression { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
 

src/Esprima/Ast/ClassBody.cs

@@ -13,7 +13,7 @@ public ClassBody(in NodeList<ClassElement> body) : base(Nodes.ClassBody)
         }
 
         /// <remarks>
-        /// <see cref="MethodDefinition" /> | <see cref="PropertyDefinition" /> | <see cref="StaticBlock" />
+        /// <see cref="MethodDefinition"/> | <see cref="PropertyDefinition"/> | <see cref="StaticBlock"/>
         /// </remarks>
         public ref readonly NodeList<ClassElement> Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _body; }
 

src/Esprima/Ast/ClassDeclaration.cs

@@ -18,7 +18,7 @@ public ClassDeclaration(Identifier? id, Expression? superClass, ClassBody body,
 
         public Identifier? Id { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         /// <remarks>
-        /// <see cref="Identifier" /> | <see cref="CallExpression" />
+        /// <see cref="Identifier"/> | <see cref="CallExpression"/>
         /// </remarks>
         public Expression? SuperClass { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public ClassBody Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ClassExpression.cs

@@ -21,7 +21,7 @@ public ClassExpression(
 
         public Identifier? Id { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         /// <remarks>
-        /// <see cref="Identifier" /> | <see cref="CallExpression" />
+        /// <see cref="Identifier"/> | <see cref="CallExpression"/>
         /// </remarks>
         public Expression? SuperClass { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public ClassBody Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ClassProperty.cs

@@ -13,7 +13,7 @@ protected ClassProperty(Nodes type, PropertyKind kind, Expression key, bool comp
 
         public PropertyKind Kind { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         /// <remarks>
-        /// <see cref="Identifier"/> | <see cref="Literal"/> | '[' <see cref="Expression"/> ']'
+        /// <see cref="Identifier"/> | <see cref="Literal"/> (string or numeric) | '[' <see cref="Expression"/> ']' | <see cref="PrivateIdentifier"/>
         /// </remarks>
         public Expression Key { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public bool Computed { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ExportAllDeclaration.cs

@@ -20,7 +20,7 @@ public ExportAllDeclaration(Literal source, Expression? exported, in NodeList<Im
 
         public Literal Source { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         /// <remarks>
-        /// <see cref="Identifier" /> | StringLiteral (<see cref="Literal" />)
+        /// <see cref="Identifier"/> | <see cref="Literal"/> (string)
         /// </remarks>
         public Expression? Exported { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public ref readonly NodeList<ImportAttribute> Assertions { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _assertions; }

src/Esprima/Ast/ExportDefaultDeclaration.cs

@@ -11,7 +11,7 @@ public ExportDefaultDeclaration(StatementListItem declaration) : base(Nodes.Expo
         }
 
         /// <remarks>
-        /// BindingIdentifier | <see cref="BindingPattern" /> | <see cref="ClassDeclaration" /> | <see cref="Expression" /> | <see cref="FunctionDeclaration" />
+        /// <see cref="Expression"/> | <see cref="ClassDeclaration"/> | <see cref="FunctionDeclaration"/>
         /// </remarks>
         public StatementListItem Declaration { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
 

src/Esprima/Ast/ExportNamedDeclaration.cs

@@ -21,6 +21,9 @@ public ExportNamedDeclaration(
             _assertions = assertions;
         }
 
+        /// <remarks>
+        /// <see cref="VariableDeclaration"/> | <see cref="ClassDeclaration"/> | <see cref="FunctionDeclaration"/>
+        /// </remarks>
         public StatementListItem? Declaration { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public ref readonly NodeList<ExportSpecifier> Specifiers { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _specifiers; }
         public Literal? Source { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ExportSpecifier.cs

@@ -12,11 +12,11 @@ public ExportSpecifier(Expression local, Expression exported) : base(Nodes.Expor
         }
 
         /// <remarks>
-        /// <see cref="Identifier" /> | StringLiteral (<see cref="Literal" />)
+        /// <see cref="Identifier"/> | <see cref="Literal"/> (string)
         /// </remarks>
         public Expression Local { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         /// <remarks>
-        /// <see cref="Identifier" /> | <see cref="Literal" />
+        /// <see cref="Identifier"/> | <see cref="Literal"/> (string)
         /// </remarks>
         public Expression Exported { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
 

src/Esprima/Ast/ForInStatement.cs

@@ -15,6 +15,9 @@ public ForInStatement(
             Body = body;
         }
 
+        /// <remarks>
+        /// <see cref="VariableDeclaration"/> (may have an initializer in non-strict mode) | <see cref="Identifier"/> | <see cref="BindingPattern"/>
+        /// </remarks>
         public Node Left { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public Expression Right { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public Statement Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ForOfStatement.cs

@@ -17,6 +17,9 @@ public ForOfStatement(
             Await = await;
         }
 
+        /// <remarks>
+        /// <see cref="VariableDeclaration"/> (cannot have an initializer) | <see cref="Identifier"/> | <see cref="BindingPattern"/>
+        /// </remarks>
         public Node Left { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public Expression Right { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public Statement Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ForStatement.cs

@@ -19,7 +19,7 @@ public ForStatement(
         }
 
         /// <remarks>
-        /// <see cref="Statement"/> (var i) | <see cref="Expression"/> (i=0)
+        /// <see cref="VariableDeclaration"/> (var i) | <see cref="Expression"/> (i=0)
         /// </remarks>
         public StatementListItem? Init { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public Expression? Test { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/FunctionDeclaration.cs

@@ -25,6 +25,9 @@ public FunctionDeclaration(
         }
 
         public Identifier? Id { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
+        /// <summary>
+        /// { <see cref="Identifier"/> | <see cref="BindingPattern"/> | <see cref="AssignmentPattern"/> | <see cref="RestElement"/> }
+        /// </summary>
         public ref readonly NodeList<Expression> Params { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _params; }
 
         public BlockStatement Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/FunctionExpression.cs

@@ -25,6 +25,9 @@ public FunctionExpression(
         }
 
         public Identifier? Id { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
+        /// <summary>
+        /// { <see cref="Identifier"/> | <see cref="BindingPattern"/> | <see cref="AssignmentPattern"/> | <see cref="RestElement"/> }
+        /// </summary>
         public ref readonly NodeList<Expression> Params { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _params; }
 
         public BlockStatement Body { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/IClass.cs

@@ -5,6 +5,7 @@
     /// </summary>
     public interface IClass
     {
+        Nodes Type { get; }
         Identifier? Id { get; }
         Expression? SuperClass { get; }
         ClassBody Body { get; }

src/Esprima/Ast/IFunction.cs

@@ -5,6 +5,7 @@
     /// </summary>
     public interface IFunction
     {
+        Nodes Type { get; }
         Identifier? Id { get; }
         ref readonly NodeList<Expression> Params { get; }
         Node Body { get; }

src/Esprima/Ast/IProperty.cs

@@ -2,6 +2,7 @@
 {
     public interface IProperty
     {
+        Nodes Type { get; }
         PropertyKind Kind { get; }
         Expression Key { get; }
         bool Computed { get; }

src/Esprima/Ast/Identifier.cs

@@ -1,10 +1,8 @@
-using System.Diagnostics;
-using System.Runtime.CompilerServices;
+using System.Runtime.CompilerServices;
 using Esprima.Utils;
 
 namespace Esprima.Ast
 {
-    [DebuggerDisplay("{Name,nq}")]
     public sealed class Identifier : Expression
     {
         public Identifier(string? name) : base(Nodes.Identifier)

src/Esprima/Ast/ImportAttribute.cs

@@ -12,7 +12,7 @@ public ImportAttribute(Expression key, Literal value) : base(Nodes.ImportAttribu
     }
 
     /// <remarks>
-    /// <see cref="Identifier" /> | <see cref="Literal" />
+    /// <see cref="Identifier"/> | <see cref="Literal"/>
     /// </remarks>
     public Expression Key { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
     public Literal Value { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }

src/Esprima/Ast/ImportSpecifier.cs

@@ -11,7 +11,7 @@ public ImportSpecifier(Identifier local, Expression imported) : base(local, Node
         }
 
         /// <remarks>
-        /// <see cref="Identifier" /> | StringLiteral (<see cref="Literal" />)
+        /// <see cref="Identifier"/> | <see cref="Literal"/> (string)
         /// </remarks>
         public Expression Imported { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
 

src/Esprima/Ast/Literal.cs

@@ -1,12 +1,10 @@
-using System.Diagnostics;
-using System.Numerics;
+using System.Numerics;
 using System.Runtime.CompilerServices;
 using System.Text.RegularExpressions;
 using Esprima.Utils;
 
 namespace Esprima.Ast
 {
-    [DebuggerDisplay("{Raw,nq}")]
     public sealed class Literal : Expression
     {
         internal Literal(TokenType tokenType, object? value, string raw) : base(Nodes.Literal)

src/Esprima/Ast/Node.cs

@@ -1,8 +1,10 @@
-using System.Runtime.CompilerServices;
+using System.Diagnostics;
+using System.Runtime.CompilerServices;
 using Esprima.Utils;
 
 namespace Esprima.Ast
 {
+    [DebuggerDisplay($"{{{nameof(GetDebuggerDisplay)}(), nq}}")]
     public abstract class Node
     {
         protected Node(Nodes type)
@@ -43,5 +45,12 @@ protected Node(Nodes type)
         {
             return visitor.VisitExtension(this);
         }
+
+        public override string ToString() => this.ToJavascriptString(beautify: true);
+
+        private string GetDebuggerDisplay()
+        {
+            return $"/*{Type}*/  {this}";
+        }
     }
 }

src/Esprima/Ast/NodeExtensions.cs

@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using System.Runtime.CompilerServices;
 using static Esprima.EsprimaExceptionHelper;
 using NodeSysList = System.Collections.Generic.List<Esprima.Ast.Node>;
 
@@ -7,6 +8,7 @@ namespace Esprima.Ast
     public static class NodeExtensions
     {
         [DebuggerStepThrough]
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public static T As<T>(this Node node) where T : Node
         {
             return (T) node;

src/Esprima/Ast/NodeList.cs

@@ -32,11 +32,18 @@ public int Count
             get => _count;
         }
 
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
         public NodeList<Node?> AsNodes()
         {
             return new NodeList<Node?>(_items /* conversion by co-variance! */, _count);
         }
 
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public NodeList<TTo> As<TTo>() where TTo : Node?
+        {
+            return new NodeList<TTo>((TTo[]?) (object?) _items, _count);
+        }
+
         public T this[int index]
         {
             [MethodImpl(MethodImplOptions.AggressiveInlining)]
@@ -203,6 +210,7 @@ var count
             }
         }
 
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
         internal static bool AreSame<T>(in NodeList<T> nodeList1, in NodeList<T> nodeList2) where T : Node?
         {
             return nodeList1._items == nodeList2._items;

src/Esprima/Ast/ObjectExpression.cs

@@ -12,6 +12,9 @@ public ObjectExpression(in NodeList<Expression> properties) : base(Nodes.ObjectE
             _properties = properties;
         }
 
+        /// <summary>
+        /// { <see cref="Property"/> | <see cref="SpreadElement"/> }
+        /// </summary>
         public ref readonly NodeList<Expression> Properties { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _properties; }
 
         internal override Node? NextChildNode(ref ChildNodes.Enumerator enumerator) => enumerator.MoveNext(Properties);

src/Esprima/Ast/ObjectPattern.cs

@@ -12,6 +12,9 @@ public ObjectPattern(in NodeList<Node> properties) : base(Nodes.ObjectPattern)
             _properties = properties;
         }
 
+        /// <summary>
+        /// { <see cref="Property"/> | <see cref="RestElement"/> }
+        /// </summary>
         public ref readonly NodeList<Node> Properties { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => ref _properties; }
 
         internal override Node? NextChildNode(ref ChildNodes.Enumerator enumerator) => enumerator.MoveNext(Properties);

src/Esprima/Ast/Property.cs

@@ -26,11 +26,15 @@ public Property(
 
         public PropertyKind Kind { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         /// <remarks>
-        /// <see cref="Identifier"/> | <see cref="Literal"/> | '[' <see cref="Expression"/> ']'
+        /// <see cref="Identifier"/> | <see cref="Literal"/> (string or numeric) | '[' <see cref="Expression"/> ']'
         /// </remarks>
         public Expression Key { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
         public bool Computed { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }
 
+        /// <remarks>
+        /// When property of an object literal: <see cref="Expression"/> (incl. <see cref="SpreadElement"/> and <see cref="FunctionExpression"/> for getters/setters/methods) <br />
+        /// When property of an object binding pattern: <see cref="Identifier"/> | <see cref="BindingPattern"/> | <see cref="AssignmentPattern"/> | <see cref="RestElement"/>
+        /// </remarks>
         public Expression Value { [MethodImpl(MethodImplOptions.AggressiveInlining)] get => _value; }
         Expression? IProperty.Value => Value;
 

src/Esprima/Ast/RestElement.cs

@@ -11,7 +11,7 @@ public RestElement(Expression argument) : base(Nodes.RestElement)
         }
 
         /// <remarks>
-        /// BindingIdentifier | <see cref="BindingPattern"/>
+        /// <see cref="Identifier"/> | <see cref="BindingPattern"/>
         /// </remarks>
         public Expression Argument { [MethodImpl(MethodImplOptions.AggressiveInlining)] get; }