Use global usings and aliases for Esprima namespaces and types (#1824)

* Use global usings for Esprima namespaces and Nodes
* alias operators
* add SourceLocation alias
* cleanup Directory.Build.props

.gitignore

@@ -165,3 +165,4 @@ BenchmarkDotNet.Artifacts*
 
 # generated code
 Jint.Tests.Test262/Generated
+/artifacts

Directory.Build.props

@@ -1,7 +1,37 @@
 <Project>
 
   <PropertyGroup>
+
+    <Copyright>Sebastien Ros</Copyright>
+    <Authors>Sebastien Ros</Authors>
+
+    <Description>Javascript interpreter for .NET.</Description>
+    <PackageTags>javascript, interpreter, es5, es2015, es6, ecmascript, interop</PackageTags>
+    <PackageProjectUrl>https://github.com/sebastienros/jint</PackageProjectUrl>
+    <PackageLicenseExpression>BSD-2-Clause</PackageLicenseExpression>
+
+    <BuildNumber Condition="'$(BuildNumber)' == ''">0</BuildNumber>
+    <VersionPrefix>3.0.1</VersionPrefix>
+    <VersionSuffix>beta-$(BuildNumber)</VersionSuffix>
+    <FileVersion>$(VersionPrefix).$(BuildNumber)</FileVersion>
+
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <EmbedUntrackedSources>true</EmbedUntrackedSources>
+    <IncludeSymbols>true</IncludeSymbols>
+    <DebugType>portable</DebugType>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <UseArtifactsOutput>true</UseArtifactsOutput>
+
   </PropertyGroup>
 
+  <ItemGroup>
+    <Using Include="Esprima" />
+    <Using Include="Esprima.Ast" />
+    <Using Include="Esprima.Utils" />
+    <Using Include="Esprima.Location" Alias="SourceLocation" />
+    <Using Include="Esprima.Ast.Nodes" Alias="NodeType" />
+  </ItemGroup>
+
 </Project>

Jint.Benchmark/DromaeoBenchmark.cs

@@ -1,5 +1,4 @@
 using BenchmarkDotNet.Attributes;
-using Esprima.Ast;
 
 namespace Jint.Benchmark;
 

Jint.Benchmark/EngineComparisonBenchmark.cs

@@ -1,8 +1,6 @@
 using BenchmarkDotNet.Attributes;
 using BenchmarkDotNet.Configs;
 using BenchmarkDotNet.Order;
-using Esprima;
-using Esprima.Ast;
 
 namespace Jint.Benchmark;
 

Jint.Benchmark/EngineConstructionBenchmark.cs

@@ -1,6 +1,4 @@
 using BenchmarkDotNet.Attributes;
-using Esprima;
-using Esprima.Ast;
 using Jint.Native;
 
 namespace Jint.Benchmark;

Jint.Benchmark/Jint.Benchmark.csproj

@@ -10,6 +10,8 @@
     <GenerateAssemblyCopyrightAttribute>false</GenerateAssemblyCopyrightAttribute>
     <GenerateAssemblyVersionAttribute>false</GenerateAssemblyVersionAttribute>
     <GenerateAssemblyFileVersionAttribute>false</GenerateAssemblyFileVersionAttribute>
+    <GenerateAssemblyInformationalVersionAttribute>false</GenerateAssemblyInformationalVersionAttribute>
+    <GenerateTargetFrameworkAttribute>false</GenerateTargetFrameworkAttribute>
     <AssemblyOriginatorKeyFile>..\Jint\Jint.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <LangVersion>latest</LangVersion>
@@ -29,4 +31,8 @@
     <PackageReference Include="NiL.JS" />
     <PackageReference Include="YantraJS.Core" />
   </ItemGroup>
+  <ItemGroup>
+    <Using Include="Esprima" />
+    <Using Include="Esprima.Ast" />
+  </ItemGroup>
 </Project>

Jint.Benchmark/ObjectAccessBenchmark.cs

@@ -1,5 +1,4 @@
 using BenchmarkDotNet.Attributes;
-using Esprima.Ast;
 
 namespace Jint.Benchmark;
 

Jint.Benchmark/ShadowRealmBenchmark.cs

@@ -1,5 +1,4 @@
 using BenchmarkDotNet.Attributes;
-using Esprima.Ast;
 
 namespace Jint.Benchmark;
 

Jint.Benchmark/SingleScriptBenchmark.cs

@@ -1,5 +1,4 @@
 using BenchmarkDotNet.Attributes;
-using Esprima.Ast;
 
 namespace Jint.Benchmark;
 

Jint.Repl/Program.cs

@@ -1,5 +1,4 @@
 using System.Reflection;
-using Esprima;
 using Jint;
 using Jint.Native;
 using Jint.Native.Json;

Jint.Tests.CommonScripts/ConcurrencyTest.cs

@@ -1,5 +1,3 @@
-using Esprima;
-
 namespace Jint.Tests.CommonScripts;
 
 [Parallelizable(ParallelScope.Fixtures)]

Jint.Tests.PublicInterface/ModuleLoaderTests.cs

@@ -3,6 +3,8 @@
 using Jint.Native.Json;
 using Jint.Runtime.Modules;
 
+using Module = Jint.Runtime.Modules.Module;
+
 #nullable enable
 
 namespace Jint.Tests.PublicInterface;

Jint.Tests.PublicInterface/RavenApiUsageTests.cs

@@ -1,4 +1,3 @@
-using Esprima.Ast;
 using Jint.Constraints;
 using Jint.Native;
 using Jint.Native.Function;

Jint.Tests.Test262/State.cs

@@ -1,5 +1,3 @@
-using Esprima.Ast;
-
 namespace Jint.Tests.Test262;
 
 /// <summary>

Jint.Tests.Test262/Test262Test.cs

@@ -1,5 +1,4 @@
-using Esprima;
-using Jint.Native;
+using Jint.Native;
 using Jint.Runtime;
 using Jint.Runtime.Descriptors;
 using Jint.Runtime.Interop;

Jint.Tests/Parser/JavascriptParserTests.cs

@@ -1,6 +1,4 @@
-using Esprima;
-using Esprima.Ast;
-using Jint.Runtime;
+using Jint.Runtime;
 
 namespace Jint.Tests.Parser
 {
@@ -13,7 +11,7 @@ public void ShouldParseThis()
             var body = program.Body;
 
             Assert.Single(body);
-            Assert.Equal(Nodes.ThisExpression, body.First().As<ExpressionStatement>().Expression.Type);
+            Assert.Equal(NodeType.ThisExpression, body.First().As<ExpressionStatement>().Expression.Type);
         }
 
         [Fact]
@@ -23,7 +21,7 @@ public void ShouldParseNull()
             var body = program.Body;
 
             Assert.Single(body);
-            Assert.Equal(Nodes.Literal, body.First().As<ExpressionStatement>().Expression.Type);
+            Assert.Equal(NodeType.Literal, body.First().As<ExpressionStatement>().Expression.Type);
             Assert.Equal(null, body.First().As<ExpressionStatement>().Expression.As<Literal>().Value);
             Assert.Equal("null", body.First().As<ExpressionStatement>().Expression.As<Literal>().Raw);
         }
@@ -38,7 +36,7 @@ public void ShouldParseNumeric()
             var body = program.Body;
 
             Assert.Single(body);
-            Assert.Equal(Nodes.Literal, body.First().As<ExpressionStatement>().Expression.Type);
+            Assert.Equal(NodeType.Literal, body.First().As<ExpressionStatement>().Expression.Type);
             Assert.Equal(42d, body.First().As<ExpressionStatement>().Expression.As<Literal>().Value);
             Assert.Equal("42", body.First().As<ExpressionStatement>().Expression.As<Literal>().Raw);
         }

Jint.Tests/Runtime/Debugger/CallStackTests.cs

@@ -1,6 +1,4 @@
-using Esprima;
-using Esprima.Ast;
-using Jint.Runtime.Debugger;
+using Jint.Runtime.Debugger;
 
 namespace Jint.Tests.Runtime.Debugger
 {

Jint.Tests/Runtime/Debugger/EvaluateTests.cs

@@ -1,5 +1,4 @@
-using Esprima;
-using Jint.Native;
+using Jint.Native;
 using Jint.Runtime;
 using Jint.Runtime.Debugger;
 

Jint.Tests/Runtime/Debugger/StepFlowTests.cs

@@ -1,6 +1,4 @@
-using Esprima;
-using Esprima.Ast;
-using Jint.Runtime.Debugger;
+using Jint.Runtime.Debugger;
 
 namespace Jint.Tests.Runtime.Debugger
 {
@@ -271,7 +269,7 @@ private List<string> StepIntoScript(string script)
             engine.Execute(script);
             return stepStatements;
 
-            void OutputPosition(Location location)
+            void OutputPosition(in SourceLocation location)
             {
                 var line = scriptLines[location.Start.Line - 1];
                 var withPositionIndicator = string.Concat(line.Substring(0, location.Start.Column), "»", line.Substring(location.Start.Column));

Jint.Tests/Runtime/Debugger/TestHelpers.cs

@@ -1,5 +1,4 @@
-using Esprima.Ast;
-using Jint.Runtime.Debugger;
+using Jint.Runtime.Debugger;
 
 namespace Jint.Tests.Runtime.Debugger
 {

Jint.Tests/Runtime/EngineTests.ScriptPreparation.cs

@@ -1,5 +1,4 @@
 using System.Text.RegularExpressions;
-using Esprima.Ast;
 using Jint.Native;
 using Jint.Runtime.Interpreter;
 using Jint.Runtime.Interpreter.Expressions;

Jint.Tests/Runtime/EngineTests.cs

@@ -1,7 +1,5 @@
 using System.Globalization;
 using System.Reflection;
-using Esprima;
-using Esprima.Ast;
 using Jint.Native;
 using Jint.Native.Array;
 using Jint.Native.Number;

Jint.Tests/Runtime/ErrorTests.cs

@@ -1,5 +1,4 @@
 using System.Reflection;
-using Esprima;
 using Jint.Native;
 using Jint.Runtime;
 using Jint.Tests.Runtime.TestClasses;

Jint.Tests/Runtime/ModuleTests.cs

@@ -2,6 +2,8 @@
 using Jint.Runtime;
 using Jint.Runtime.Modules;
 
+using Module = Jint.Runtime.Modules.Module;
+
 namespace Jint.Tests.Runtime;
 
 public class ModuleTests

Jint/Engine.Ast.cs

@@ -1,7 +1,5 @@
 using System.Runtime.InteropServices;
 using System.Text.RegularExpressions;
-using Esprima;
-using Esprima.Ast;
 using Jint.Native;
 using Jint.Runtime;
 using Jint.Runtime.Interpreter;
@@ -70,7 +68,7 @@ public void NodeVisitor(Node node)
         {
             switch (node.Type)
             {
-                case Nodes.Identifier:
+                case NodeType.Identifier:
                     var identifier = (Identifier) node;
                     var name = identifier.Name;
 
@@ -82,7 +80,7 @@ public void NodeVisitor(Node node)
                     node.AssociatedData = new JintIdentifierExpression(identifier, bindingName);
                     break;
 
-                case Nodes.Literal:
+                case NodeType.Literal:
                     var literal = (Literal) node;
 
                     var constantValue = JintLiteralExpression.ConvertToJsValue(literal);
@@ -114,26 +112,26 @@ public void NodeVisitor(Node node)
 
                     break;
 
-                case Nodes.MemberExpression:
+                case NodeType.MemberExpression:
                     node.AssociatedData = JintMemberExpression.InitializeDeterminedProperty((MemberExpression) node, cache: true);
                     break;
 
-                case Nodes.ArrowFunctionExpression:
-                case Nodes.FunctionDeclaration:
-                case Nodes.FunctionExpression:
+                case NodeType.ArrowFunctionExpression:
+                case NodeType.FunctionDeclaration:
+                case NodeType.FunctionExpression:
                     var function = (IFunction) node;
                     node.AssociatedData = JintFunctionDefinition.BuildState(function);
                     break;
 
-                case Nodes.Program:
+                case NodeType.Program:
                     node.AssociatedData = new CachedHoistingScope((Program) node);
                     break;
 
-                case Nodes.UnaryExpression:
+                case NodeType.UnaryExpression:
                     node.AssociatedData = JintUnaryExpression.BuildConstantExpression((UnaryExpression) node);
                     break;
 
-                case Nodes.BinaryExpression:
+                case NodeType.BinaryExpression:
                     var binaryExpression = (BinaryExpression) node;
                     if (_options.FoldConstants
                         && binaryExpression.Operator != BinaryOperator.InstanceOf
@@ -161,7 +159,7 @@ public void NodeVisitor(Node node)
 
                     break;
 
-                case Nodes.ReturnStatement:
+                case NodeType.ReturnStatement:
                     var returnStatement = (ReturnStatement) node;
                     if (returnStatement.Argument is Literal returnedLiteral)
                     {

Jint/Engine.Modules.cs

@@ -1,10 +1,10 @@
-using Esprima;
-using Jint.Native;
+using Jint.Native;
 using Jint.Native.Object;
 using Jint.Native.Promise;
 using Jint.Runtime;
 using Jint.Runtime.Interpreter;
 using Jint.Runtime.Modules;
+using Module = Jint.Runtime.Modules.Module;
 
 namespace Jint;
 
@@ -172,7 +172,7 @@ private JsValue EvaluateModule(string specifier, Module module)
             {
                 var location = module is CyclicModule cyclicModuleRecord
                     ? cyclicModuleRecord.AbnormalCompletionLocation
-                    : Location.From(new Position(), new Position());
+                    : SourceLocation.From(new Position(), new Position());
 
                 var node = EsprimaExtensions.CreateLocationNode(location);
                 ExceptionHelper.ThrowJavaScriptException(_engine, promise.Value, node.Location);

Jint/Engine.cs

@@ -1,8 +1,6 @@
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Runtime.CompilerServices;
-using Esprima;
-using Esprima.Ast;
 using Jint.Native;
 using Jint.Native.Function;
 using Jint.Native.Generator;
@@ -531,7 +529,7 @@ internal void RunBeforeExecuteStatementChecks(StatementListItem? statement)
                 constraint.Check();
             }
 
-            if (_isDebugMode && statement != null && statement.Type != Nodes.BlockStatement)
+            if (_isDebugMode && statement != null && statement.Type != NodeType.BlockStatement)
             {
                 Debugger.OnStep(statement);
             }