fix: hide generated assembly name (#8637)

* fix: hide generated assembly name * test(snapshot): update snapshots for 116a626 --------- Co-authored-by: yufeih <[email protected]>
dotnet · Apr 12, 2023 · 2d4f111 · 2d4f111
1 parent c968e07
commit 2d4f111
Show file tree

Hide file tree

Showing 17 changed files with 17 additions and 77 deletions.
diff --git a/src/Microsoft.DocAsCode.Dotnet/CompilationHelper.cs b/src/Microsoft.DocAsCode.Dotnet/CompilationHelper.cs
@@ -18,11 +18,11 @@ internal static class CompilationHelper
     {
         CS.SyntaxFactory.ParseSyntaxTree(
             """
-                class Bootstrap
-                {
-                    public static void Main(string[] foo) { }
-                }
-                """),
+            class Bootstrap
+            {
+                public static void Main(string[] foo) { }
+            }
+            """),
     };
 
     public static bool CheckDiagnostics(this Compilation compilation, bool errorAsWarning)
@@ -56,13 +56,13 @@ public static bool CheckDiagnostics(this Compilation compilation, bool errorAsWa
     public static Compilation CreateCompilationFromCSharpFiles(IEnumerable<string> files)
     {
         return CS.CSharpCompilation.Create(
-            assemblyName: "cs.temp.dll",
+            assemblyName: null,
             options: new CS.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary, xmlReferenceResolver: XmlFileResolver.Default),
             syntaxTrees: files.Select(path => CS.SyntaxFactory.ParseSyntaxTree(File.ReadAllText(path), path: path)),
             references: GetDefaultMetadataReferences("C#"));
     }
 
-    public static Compilation CreateCompilationFromCSharpCode(string code, string name = "cs.temp.dll", params MetadataReference[] references)
+    public static Compilation CreateCompilationFromCSharpCode(string code, string name = null, params MetadataReference[] references)
     {
         return CS.CSharpCompilation.Create(
             name,
@@ -74,13 +74,13 @@ public static Compilation CreateCompilationFromCSharpCode(string code, string na
     public static Compilation CreateCompilationFromVBFiles(IEnumerable<string> files)
     {
         return VB.VisualBasicCompilation.Create(
-            assemblyName: "vb.temp.dll",
+            assemblyName: null,
             options: new VB.VisualBasicCompilationOptions(OutputKind.DynamicallyLinkedLibrary, globalImports: GetVBGlobalImports(), xmlReferenceResolver: XmlFileResolver.Default),
             syntaxTrees: files.Select(path => VB.SyntaxFactory.ParseSyntaxTree(File.ReadAllText(path), path: path)),
             references: GetDefaultMetadataReferences("VB"));
     }
 
-    public static Compilation CreateCompilationFromVBCode(string code, string name = "vb.temp.dll", params MetadataReference[] references)
+    public static Compilation CreateCompilationFromVBCode(string code, string name = null, params MetadataReference[] references)
     {
         return VB.VisualBasicCompilation.Create(
             name,
@@ -93,7 +93,7 @@ public static (Compilation, IAssemblySymbol) CreateCompilationFromAssembly(strin
     {
         var metadataReference = CreateMetadataReference(assemblyPath);
         var compilation = CS.CSharpCompilation.Create(
-            "EmptyProjectWithAssembly",
+            assemblyName: null,
             options: new CS.CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary),
             syntaxTrees: s_assemblyBootstrap,
             references: GetReferenceAssemblies(assemblyPath)

diff --git a/src/Microsoft.DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs b/src/Microsoft.DocAsCode.Dotnet/Visitors/SymbolVisitorAdapter.cs
@@ -52,7 +52,7 @@ public override MetadataItem DefaultVisit(ISymbol symbol)
         item.DisplayQualifiedNames = new SortedList<SyntaxLanguage, string>();
         item.Source = VisitorHelper.GetSourceDetail(symbol, _compilation);
         var assemblyName = symbol.ContainingAssembly?.Name;
-        item.AssemblyNameList = string.IsNullOrEmpty(assemblyName) ? null : new List<string> { assemblyName };
+        item.AssemblyNameList = string.IsNullOrEmpty(assemblyName) || assemblyName is "?" ? null : new List<string> { assemblyName };
         if (symbol is not INamespaceSymbol)
         {
             var namespaceName = VisitorHelper.GetId(symbol.ContainingNamespace);

diff --git a/templates/modern/partials/class.header.tmpl.partial b/templates/modern/partials/class.header.tmpl.partial
@@ -7,7 +7,7 @@
 
 <div class="facts text-secondary">
   <dl><dt>{{__global.namespace}}</dt><dd>{{{namespace.specName.0.value}}}</dd></dl>
-  <dl><dt>{{__global.assembly}}</dt><dd>{{assemblies.0}}.dll</dd></dl>
+  {{#assemblies.0}}<dl><dt>{{__global.assembly}}</dt><dd>{{assemblies.0}}.dll</dd></dl>{{/assemblies.0}}
 </div>
 
 <div class="markdown summary">{{{summary}}}</div>

diff --git a/...hot.Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.-ctor.html.view.verified.json b/...hot.Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.-ctor.html.view.verified.json
@@ -78,9 +78,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "cs.temp.dll"
-          ],
           "namespace": "MyExample",
           "overload": {
             "uid": "MyExample.ExampleClass.#ctor*",
@@ -191,9 +188,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "namespace": {
     "uid": "MyExample",
     "isEii": false,

diff --git a/...t.Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.MyEvent.html.view.verified.json b/...t.Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.MyEvent.html.view.verified.json
@@ -64,9 +64,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "namespace": {
     "uid": "MyExample",
     "isEii": false,

diff --git a/....Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.MyMethod.html.view.verified.json b/....Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.MyMethod.html.view.verified.json
@@ -123,9 +123,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "cs.temp.dll"
-          ],
           "namespace": "MyExample",
           "overload": {
             "uid": "MyExample.ExampleClass.MyMethod*",
@@ -236,9 +233,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "namespace": {
     "uid": "MyExample",
     "isEii": false,

diff --git a/...ests/SamplesTest.Extensions/api/MyExample.ExampleClass.MyProperty.html.view.verified.json b/...ests/SamplesTest.Extensions/api/MyExample.ExampleClass.MyProperty.html.view.verified.json
@@ -125,9 +125,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "cs.temp.dll"
-          ],
           "namespace": "MyExample",
           "overload": {
             "uid": "MyExample.ExampleClass.MyProperty*",
@@ -238,9 +235,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "namespace": {
     "uid": "MyExample",
     "isEii": false,

diff --git a/....Snapshot.Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.html.view.verified.json b/....Snapshot.Tests/SamplesTest.Extensions/api/MyExample.ExampleClass.html.view.verified.json
@@ -370,9 +370,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "namespace": {
     "uid": "MyExample",
     "isEii": false,

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/MyExample.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Extensions/api/MyExample.html.view.verified.json
@@ -107,9 +107,6 @@
     }
   ],
   "type": "namespace",
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "level": 0.0,
   "_systemKeys": [
     "uid",

diff --git a/...pshot.Tests/SamplesTest.Seed/api/BuildFromCSharpSourceCode.CSharp.html.view.verified.json b/...pshot.Tests/SamplesTest.Seed/api/BuildFromCSharpSourceCode.CSharp.html.view.verified.json
@@ -173,9 +173,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "cs.temp.dll"
-          ],
           "namespace": "BuildFromCSharpSourceCode",
           "overload": {
             "uid": "BuildFromCSharpSourceCode.CSharp.Main*",
@@ -286,9 +283,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "namespace": {
     "uid": "BuildFromCSharpSourceCode",
     "isEii": false,

diff --git a/...cfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromCSharpSourceCode.html.view.verified.json b/...cfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromCSharpSourceCode.html.view.verified.json
@@ -107,9 +107,6 @@
     }
   ],
   "type": "namespace",
-  "assemblies": [
-    "cs.temp.dll"
-  ],
   "level": 0.0,
   "_appName": "Seed",
   "_appTitle": "docfx seed website",

diff --git a/...pshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.BaseClass1.html.view.verified.json b/...pshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.BaseClass1.html.view.verified.json
@@ -218,9 +218,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "vb.temp.dll"
-          ],
           "namespace": "BuildFromVBSourceCode",
           "overload": {
             "uid": "BuildFromVBSourceCode.BaseClass1.WithDeclarationKeyword*",
@@ -331,9 +328,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "vb.temp.dll"
-  ],
   "namespace": {
     "uid": "BuildFromVBSourceCode",
     "isEii": false,

diff --git a/....Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.Class1.html.view.verified.json b/....Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.Class1.html.view.verified.json
@@ -171,9 +171,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "vb.temp.dll"
-          ],
           "namespace": "BuildFromVBSourceCode",
           "example": [],
           "level": 0.0,
@@ -314,9 +311,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "vb.temp.dll"
-          ],
           "namespace": "BuildFromVBSourceCode",
           "overload": {
             "uid": "BuildFromVBSourceCode.Class1.Keyword*",
@@ -565,9 +559,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "vb.temp.dll"
-          ],
           "namespace": "BuildFromVBSourceCode",
           "example": [],
           "overload": {
@@ -791,9 +782,6 @@
             "endLine": 0.0,
             "isExternal": false
           },
-          "assemblies": [
-            "vb.temp.dll"
-          ],
           "namespace": "BuildFromVBSourceCode",
           "example": [],
           "overridden": {
@@ -947,9 +935,6 @@
     "endLine": 0.0,
     "isExternal": false
   },
-  "assemblies": [
-    "vb.temp.dll"
-  ],
   "namespace": {
     "uid": "BuildFromVBSourceCode",
     "isEii": false,

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/api/BuildFromVBSourceCode.html.view.verified.json
@@ -170,9 +170,6 @@
     }
   ],
   "type": "namespace",
-  "assemblies": [
-    "vb.temp.dll"
-  ],
   "level": 0.0,
   "_appName": "Seed",
   "_appTitle": "docfx seed website",

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.Seed/index.verified.json
@@ -12,7 +12,7 @@
   "api/BuildFromCSharpSourceCode.CSharp.html": {
     "href": "api/BuildFromCSharpSourceCode.CSharp.html",
     "title": "Class CSharp | docfx seed website",
-    "keywords": "Class CSharp Namespace BuildFromCSharpSourceCode Assembly cs.temp.dll.dll public class CSharp Inheritance object CSharp Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Main(string[]) public static void Main(string[] args) Parameters args string[]"
+    "keywords": "Class CSharp Namespace BuildFromCSharpSourceCode public class CSharp Inheritance object CSharp Inherited Members object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods Main(string[]) public static void Main(string[] args) Parameters args string[]"
   },
   "api/BuildFromCSharpSourceCode.html": {
     "href": "api/BuildFromCSharpSourceCode.html",
@@ -82,12 +82,12 @@
   "api/BuildFromVBSourceCode.BaseClass1.html": {
     "href": "api/BuildFromVBSourceCode.BaseClass1.html",
     "title": "Class BaseClass1 | docfx seed website",
-    "keywords": "Class BaseClass1 Namespace BuildFromVBSourceCode Assembly vb.temp.dll.dll This is the BaseClass public abstract class BaseClass1 Inheritance object BaseClass1 Derived Class1 Inherited Members object.Equals(object) object.Equals(object, object) object.Finalize() object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods WithDeclarationKeyword(Class1) public abstract DateTime WithDeclarationKeyword(Class1 keyword) Parameters keyword Class1 Returns DateTime"
+    "keywords": "Class BaseClass1 Namespace BuildFromVBSourceCode This is the BaseClass public abstract class BaseClass1 Inheritance object BaseClass1 Derived Class1 Inherited Members object.Equals(object) object.Equals(object, object) object.Finalize() object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Methods WithDeclarationKeyword(Class1) public abstract DateTime WithDeclarationKeyword(Class1 keyword) Parameters keyword Class1 Returns DateTime"
   },
   "api/BuildFromVBSourceCode.Class1.html": {
     "href": "api/BuildFromVBSourceCode.Class1.html",
     "title": "Class Class1 | docfx seed website",
-    "keywords": "Class Class1 Namespace BuildFromVBSourceCode Assembly vb.temp.dll.dll This is summary from vb class... public class Class1 : BaseClass1 Inheritance object BaseClass1 Class1 Inherited Members object.Equals(object) object.Equals(object, object) object.Finalize() object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields ValueClass This is a Value type public Class1 ValueClass Field Value Class1 Properties Keyword [Obsolete(\"This member is obsolete.\", true)] public Class1 Keyword { get; } Property Value Class1 Methods Value(string) This is a Function public int Value(string name) Parameters name string Name as the String value Returns int Returns Ahooo WithDeclarationKeyword(Class1) What is Sub? public override DateTime WithDeclarationKeyword(Class1 keyword) Parameters keyword Class1 Returns DateTime"
+    "keywords": "Class Class1 Namespace BuildFromVBSourceCode This is summary from vb class... public class Class1 : BaseClass1 Inheritance object BaseClass1 Class1 Inherited Members object.Equals(object) object.Equals(object, object) object.Finalize() object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() Fields ValueClass This is a Value type public Class1 ValueClass Field Value Class1 Properties Keyword [Obsolete(\"This member is obsolete.\", true)] public Class1 Keyword { get; } Property Value Class1 Methods Value(string) This is a Function public int Value(string name) Parameters name string Name as the String value Returns int Returns Ahooo WithDeclarationKeyword(Class1) What is Sub? public override DateTime WithDeclarationKeyword(Class1 keyword) Parameters keyword Class1 Returns DateTime"
   },
   "api/BuildFromVBSourceCode.html": {
     "href": "api/BuildFromVBSourceCode.html",

diff --git a/...x.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html b/...x.Snapshot.Tests/SamplesTest.SeedHtml/html/api-BuildFromProject.Class1.html.verified.html
@@ -477,7 +477,7 @@ <h1 id="BuildFromProject_Class1" data-uid="BuildFromProject.Class1" class="text-
 
   <div class="facts text-secondary">
     <dl><dt>Namespace</dt><dd><a class="xref" href="BuildFromProject.html">Build<wbr>From<wbr>Project</a></dd></dl>
-    <dl><dt>Assembly</dt><dd>BuildFromProject.dll</dd></dl>
+  <dl><dt>Assembly</dt><dd>BuildFromProject.dll</dd></dl>
   </div>
 
   <div class="markdown summary"></div>

diff --git a/...fx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html b/...fx.Snapshot.Tests/SamplesTest.SeedHtml/html/api-CatLibrary.Cat-2.html-q-cat.verified.html
@@ -477,7 +477,7 @@ <h1 id="CatLibrary_Cat_2" data-uid="CatLibrary.Cat`2" class="text-break">
 
   <div class="facts text-secondary">
     <dl><dt>Namespace</dt><dd><a class="xref" href="CatLibrary.html">Cat<wbr>Library</a></dd></dl>
-    <dl><dt>Assembly</dt><dd>CatLibrary.dll</dd></dl>
+  <dl><dt>Assembly</dt><dd>CatLibrary.dll</dd></dl>
   </div>
 
   <div class="markdown summary"><p>Here's main class of this <i>Demo</i>.</p>