PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
carlossanlop merged 3 commits into from
Mar 17, 2022
Merged

PortToDocs: Add methods that either collect files automatically, or allow passing documents manually #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f09ecd3
PortToDocs: Add public method to collect files automatically, include…
carlossanlop Mar 15, 2022
4ee9bab
Apply some minor Roslyn suggestions.
carlossanlop Mar 15, 2022
7d6b8ea
Rename method in tests that ports from file to file.
carlossanlop Mar 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/PortToDocs/src/app/PortToDocs.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
{
Configuration config = Configuration.GetCLIArguments(args);
ToDocsPorter porter = new(config);
porter.CollectFiles();
porter.Start();
}
}
Expand Down
79 changes: 19 additions & 60 deletions src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
{
private Configuration Config { get; set; }

private XDocument? xDoc = null;

public readonly Dictionary<string, DocsType> Types = new();
public readonly Dictionary<string, DocsMember> Members = new();

public DocsCommentsContainer(Configuration config)
{
Config = config;
}

public void CollectFiles()
{
Log.Info("Looking for Docs xml files...");

foreach (FileInfo fileInfo in EnumerateFiles())
{
LoadFile(fileInfo);
}

Log.Success("Finished looking for Docs xml files.");
Log.Line();
}
public DocsCommentsContainer(Configuration config) => Config = config;

public void Save()
{
Expand All@@ -51,7 +33,7 @@ public void Save()
}

List<string> savedFiles = new();
foreach (var type in Types.Values.Where(x => x.Changed))
foreach (DocsType type in Types.Values.Where(x => x.Changed))
{
Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
}
}

private bool HasAllowedDirName(DirectoryInfo dirInfo)
{
return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
}

private bool HasAllowedFileName(FileInfo fileInfo)
{
return !fileInfo.Name.StartsWith("ns-") &&
fileInfo.Name != "index.xml" &&
fileInfo.Name != "_filter.xml";
}

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
{
// Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
{
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
}
}

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
{
Encoding? encoding = null;
try
{
var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
{
xDoc = XDocument.Load(sr);
encoding = sr.CurrentEncoding;
}

}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
return;
}

if (IsXmlMalformed(xDoc, fileInfo.FullName))
if (IsXmlMalformed(xDoc, filePath))
{
return;
}

DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

bool add = false;
bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
// Interface files start with I, and have an 2nd alphabetic character
addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
add |= addedAsInterface;

}

bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
{
foreach (XElement xeMember in xeMembers.Elements("Member"))
{
DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
DocsMember member = new(filePath, docsType, xeMember);
totalMembersAdded++;
Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
}
}

string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
if (addedAsInterface)
{
Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
}
}

private bool IsXmlMalformed(XDocument? xDoc, string fileName)
private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
!Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

private static bool HasAllowedFileName(FileInfo fileInfo) =>
!fileInfo.Name.StartsWith("ns-") &&
fileInfo.Name != "index.xml" &&
fileInfo.Name != "_filter.xml";

private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
{
if (xDoc == null)
{
Expand Down
53 changes: 12 additions & 41 deletions src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
{
private Configuration Config { get; set; }

private XDocument? xDoc = null;

// The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
public Dictionary<string, IntelliSenseXmlMember> Members = new();

public IntelliSenseXmlCommentsContainer(Configuration config)
{
Config = config;
}

public void CollectFiles()
{
Log.Info("Looking for IntelliSense xml files...");

foreach (FileInfo fileInfo in EnumerateFiles())
{
LoadFile(fileInfo, printSuccess: true);
}

Log.Success("Finished looking for IntelliSense xml files.");
Log.Line();
}
public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
{
foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
{
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
}
}

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
{
try
{
xDoc = XDocument.Load(fileInfo.FullName);
}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
return;
}

if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
{
return;
}
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
{
foreach (XElement xeMember in xeMembers.Elements("member"))
{
IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
IntelliSenseXmlMember member = new(xeMember, assembly);

if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
!Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
!Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
{
// No namespaces provided by the user means they want to port everything from that assembly
if (!Config.IncludedNamespaces.Any() ||
(Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
!Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
(Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
!Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
{
totalAdded++;
Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
}
}

if (printSuccess && totalAdded > 0)
if (totalAdded > 0)
{
Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
}
}

// Verifies the file is properly formed while attempting to retrieve the assembly name.
private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
{
assembly = null;

Expand Down
65 changes: 62 additions & 3 deletions src/PortToDocs/src/libraries/ToDocsPorter.cs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

}

public void Start()
public void CollectFiles()
{
IntelliSenseXmlComments.CollectFiles();
Log.Info("Looking for IntelliSense xml files...");
foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
{
XDocument? xDoc = null;
try
{
xDoc = XDocument.Load(fileInfo.FullName);
}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
}

if (xDoc != null)
{
IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
}
}
Log.Success("Finished looking for IntelliSense xml files.");
Log.Line();

Log.Info("Looking for Docs xml files...");
foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
{
XDocument? xDoc = null;
Encoding? encoding = null;
try
{
var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
{
xDoc = XDocument.Load(sr);
encoding = sr.CurrentEncoding;
}
}
catch (Exception ex)
{
Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
}

if (xDoc != null && encoding != null)
{
DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
}
}
Log.Success("Finished looking for Docs xml files.");
Log.Line();
}

public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
DocsComments.LoadDocsFile(xDoc, filePath, encoding);

public void Start()
{
if (!IntelliSenseXmlComments.Members.Any())
{
Log.Error("No IntelliSense xml comments found.");
return;
}

DocsComments.CollectFiles();
if (!DocsComments.Types.Any())
{
Log.Error("No Docs Type APIs found.");
return;
}

PortMissingComments();
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

carlossanlop
merged 3 commits into

from

Mar 17, 2022
 Merged


PortToDocs: Add methods that either collect files automatically, or allow passing documents manually
#110
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f09ecd3

PortToDocs: Add public method to collect files automatically, include…


carlossanlop Mar 15, 2022
4ee9bab

Apply some minor Roslyn suggestions.


carlossanlop Mar 15, 2022
7d6b8ea

Rename method in tests that ports from file to file.


carlossanlop Mar 15, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
src/PortToDocs/src/app/PortToDocs.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
 {
 Configuration config = Configuration.GetCLIArguments(args);
 ToDocsPorter porter = new(config);
 porter.CollectFiles();
 porter.Start();
 }
 }
Expand Down

79 changes: 19 additions & 60 deletions
src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 public readonly Dictionary<string, DocsType> Types = new();
 public readonly Dictionary<string, DocsMember> Members = new();

 public DocsCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for Docs xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo);
 }

 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }
 public DocsCommentsContainer(Configuration config) => Config = config;

 public void Save()
 {
Expand All@@ -51,7 +33,7 @@ public void Save()
 }

 List<string> savedFiles = new();
 foreach (var type in Types.Values.Where(x => x.Changed))
 foreach (DocsType type in Types.Values.Where(x => x.Changed))
 {
 Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
 }
 }

 private bool HasAllowedDirName(DirectoryInfo dirInfo)
 {
 return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
 }

 private bool HasAllowedFileName(FileInfo fileInfo)
 {
 return !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";
 }

 private IEnumerable<FileInfo> EnumerateFiles()
 internal IEnumerable<FileInfo> EnumerateFiles()
 {
 // Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

 foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
 {
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
 {
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }

 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (IsXmlMalformed(xDoc, fileInfo.FullName))
 if (IsXmlMalformed(xDoc, filePath))
 {
 return;
 }

 DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
 DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

 bool add = false;
 bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
 // Interface files start with I, and have an 2nd alphabetic character
 addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
 add |= addedAsInterface;

 }

 bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
 {
 foreach (XElement xeMember in xeMembers.Elements("Member"))
 {
 DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
 DocsMember member = new(filePath, docsType, xeMember);
 totalMembersAdded++;
 Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
 }
 }

 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
 if (addedAsInterface)
 {
 Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
 }
 }

 private bool IsXmlMalformed(XDocument? xDoc, string fileName)
 private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
 !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

 private static bool HasAllowedFileName(FileInfo fileInfo) =>
 !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";

 private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
 {
 if (xDoc == null)
 {
Expand Down

53 changes: 12 additions & 41 deletions
src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 // The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
 public Dictionary<string, IntelliSenseXmlMember> Members = new();

 public IntelliSenseXmlCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for IntelliSense xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo, printSuccess: true);
 }

 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();
 }
 public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
 {
 foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
 {
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
 {
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
 if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
 {
 return;
 }
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 {
 foreach (XElement xeMember in xeMembers.Elements("member"))
 {
 IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
 IntelliSenseXmlMember member = new(xeMember, assembly);

 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
 {
 // No namespaces provided by the user means they want to port everything from that assembly
 if (!Config.IncludedNamespaces.Any() ||
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
 {
 totalAdded++;
 Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 }
 }

 if (printSuccess && totalAdded > 0)
 if (totalAdded > 0)
 {
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
 }
 }

 // Verifies the file is properly formed while attempting to retrieve the assembly name.
 private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 {
 assembly = null;

Expand Down

65 changes: 62 additions & 3 deletions
src/PortToDocs/src/libraries/ToDocsPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

 }

 public void Start()
 public void CollectFiles()
 {
 IntelliSenseXmlComments.CollectFiles();
 Log.Info("Looking for IntelliSense xml files...");
 foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null)
 {
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
 }
 }
 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();

 Log.Info("Looking for Docs xml files...");
 foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null && encoding != null)
 {
 DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
 }
 }
 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }

 public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

 public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
 DocsComments.LoadDocsFile(xDoc, filePath, encoding);

 public void Start()
 {
 if (!IntelliSenseXmlComments.Members.Any())
 {
 Log.Error("No IntelliSense xml comments found.");
 return;
 }

 DocsComments.CollectFiles();
 if (!DocsComments.Types.Any())
 {
 Log.Error("No Docs Type APIs found.");
 return;
 }

 PortMissingComments();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

carlossanlop
merged 3 commits into

from

Mar 17, 2022
 Merged


PortToDocs: Add methods that either collect files automatically, or allow passing documents manually
#110
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f09ecd3

PortToDocs: Add public method to collect files automatically, include…


carlossanlop Mar 15, 2022
4ee9bab

Apply some minor Roslyn suggestions.


carlossanlop Mar 15, 2022
7d6b8ea

Rename method in tests that ports from file to file.


carlossanlop Mar 15, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
src/PortToDocs/src/app/PortToDocs.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
 {
 Configuration config = Configuration.GetCLIArguments(args);
 ToDocsPorter porter = new(config);
 porter.CollectFiles();
 porter.Start();
 }
 }
Expand Down

79 changes: 19 additions & 60 deletions
src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 public readonly Dictionary<string, DocsType> Types = new();
 public readonly Dictionary<string, DocsMember> Members = new();

 public DocsCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for Docs xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo);
 }

 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }
 public DocsCommentsContainer(Configuration config) => Config = config;

 public void Save()
 {
Expand All@@ -51,7 +33,7 @@ public void Save()
 }

 List<string> savedFiles = new();
 foreach (var type in Types.Values.Where(x => x.Changed))
 foreach (DocsType type in Types.Values.Where(x => x.Changed))
 {
 Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
 }
 }

 private bool HasAllowedDirName(DirectoryInfo dirInfo)
 {
 return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
 }

 private bool HasAllowedFileName(FileInfo fileInfo)
 {
 return !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";
 }

 private IEnumerable<FileInfo> EnumerateFiles()
 internal IEnumerable<FileInfo> EnumerateFiles()
 {
 // Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

 foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
 {
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
 {
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }

 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (IsXmlMalformed(xDoc, fileInfo.FullName))
 if (IsXmlMalformed(xDoc, filePath))
 {
 return;
 }

 DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
 DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

 bool add = false;
 bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
 // Interface files start with I, and have an 2nd alphabetic character
 addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
 add |= addedAsInterface;

 }

 bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
 {
 foreach (XElement xeMember in xeMembers.Elements("Member"))
 {
 DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
 DocsMember member = new(filePath, docsType, xeMember);
 totalMembersAdded++;
 Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
 }
 }

 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
 if (addedAsInterface)
 {
 Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
 }
 }

 private bool IsXmlMalformed(XDocument? xDoc, string fileName)
 private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
 !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

 private static bool HasAllowedFileName(FileInfo fileInfo) =>
 !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";

 private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
 {
 if (xDoc == null)
 {
Expand Down

53 changes: 12 additions & 41 deletions
src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 // The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
 public Dictionary<string, IntelliSenseXmlMember> Members = new();

 public IntelliSenseXmlCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for IntelliSense xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo, printSuccess: true);
 }

 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();
 }
 public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
 {
 foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
 {
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
 {
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
 if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
 {
 return;
 }
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 {
 foreach (XElement xeMember in xeMembers.Elements("member"))
 {
 IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
 IntelliSenseXmlMember member = new(xeMember, assembly);

 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
 {
 // No namespaces provided by the user means they want to port everything from that assembly
 if (!Config.IncludedNamespaces.Any() ||
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
 {
 totalAdded++;
 Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 }
 }

 if (printSuccess && totalAdded > 0)
 if (totalAdded > 0)
 {
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
 }
 }

 // Verifies the file is properly formed while attempting to retrieve the assembly name.
 private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 {
 assembly = null;

Expand Down

65 changes: 62 additions & 3 deletions
src/PortToDocs/src/libraries/ToDocsPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

 }

 public void Start()
 public void CollectFiles()
 {
 IntelliSenseXmlComments.CollectFiles();
 Log.Info("Looking for IntelliSense xml files...");
 foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null)
 {
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
 }
 }
 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();

 Log.Info("Looking for Docs xml files...");
 foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null && encoding != null)
 {
 DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
 }
 }
 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }

 public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

 public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
 DocsComments.LoadDocsFile(xDoc, filePath, encoding);

 public void Start()
 {
 if (!IntelliSenseXmlComments.Members.Any())
 {
 Log.Error("No IntelliSense xml comments found.");
 return;
 }

 DocsComments.CollectFiles();
 if (!DocsComments.Types.Any())
 {
 Log.Error("No Docs Type APIs found.");
 return;
 }

 PortMissingComments();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

carlossanlop
merged 3 commits into

from

Mar 17, 2022
 Merged


PortToDocs: Add methods that either collect files automatically, or allow passing documents manually
#110
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f09ecd3

PortToDocs: Add public method to collect files automatically, include…


carlossanlop Mar 15, 2022
4ee9bab

Apply some minor Roslyn suggestions.


carlossanlop Mar 15, 2022
7d6b8ea

Rename method in tests that ports from file to file.


carlossanlop Mar 15, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
src/PortToDocs/src/app/PortToDocs.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
 {
 Configuration config = Configuration.GetCLIArguments(args);
 ToDocsPorter porter = new(config);
 porter.CollectFiles();
 porter.Start();
 }
 }
Expand Down

79 changes: 19 additions & 60 deletions
src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 public readonly Dictionary<string, DocsType> Types = new();
 public readonly Dictionary<string, DocsMember> Members = new();

 public DocsCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for Docs xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo);
 }

 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }
 public DocsCommentsContainer(Configuration config) => Config = config;

 public void Save()
 {
Expand All@@ -51,7 +33,7 @@ public void Save()
 }

 List<string> savedFiles = new();
 foreach (var type in Types.Values.Where(x => x.Changed))
 foreach (DocsType type in Types.Values.Where(x => x.Changed))
 {
 Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
 }
 }

 private bool HasAllowedDirName(DirectoryInfo dirInfo)
 {
 return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
 }

 private bool HasAllowedFileName(FileInfo fileInfo)
 {
 return !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";
 }

 private IEnumerable<FileInfo> EnumerateFiles()
 internal IEnumerable<FileInfo> EnumerateFiles()
 {
 // Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

 foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
 {
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
 {
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }

 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (IsXmlMalformed(xDoc, fileInfo.FullName))
 if (IsXmlMalformed(xDoc, filePath))
 {
 return;
 }

 DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
 DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

 bool add = false;
 bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
 // Interface files start with I, and have an 2nd alphabetic character
 addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
 add |= addedAsInterface;

 }

 bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
 {
 foreach (XElement xeMember in xeMembers.Elements("Member"))
 {
 DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
 DocsMember member = new(filePath, docsType, xeMember);
 totalMembersAdded++;
 Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
 }
 }

 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
 if (addedAsInterface)
 {
 Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
 }
 }

 private bool IsXmlMalformed(XDocument? xDoc, string fileName)
 private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
 !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

 private static bool HasAllowedFileName(FileInfo fileInfo) =>
 !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";

 private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
 {
 if (xDoc == null)
 {
Expand Down

53 changes: 12 additions & 41 deletions
src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 // The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
 public Dictionary<string, IntelliSenseXmlMember> Members = new();

 public IntelliSenseXmlCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for IntelliSense xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo, printSuccess: true);
 }

 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();
 }
 public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
 {
 foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
 {
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
 {
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
 if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
 {
 return;
 }
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 {
 foreach (XElement xeMember in xeMembers.Elements("member"))
 {
 IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
 IntelliSenseXmlMember member = new(xeMember, assembly);

 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
 {
 // No namespaces provided by the user means they want to port everything from that assembly
 if (!Config.IncludedNamespaces.Any() ||
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
 {
 totalAdded++;
 Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 }
 }

 if (printSuccess && totalAdded > 0)
 if (totalAdded > 0)
 {
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
 }
 }

 // Verifies the file is properly formed while attempting to retrieve the assembly name.
 private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 {
 assembly = null;

Expand Down

65 changes: 62 additions & 3 deletions
src/PortToDocs/src/libraries/ToDocsPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

 }

 public void Start()
 public void CollectFiles()
 {
 IntelliSenseXmlComments.CollectFiles();
 Log.Info("Looking for IntelliSense xml files...");
 foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null)
 {
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
 }
 }
 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();

 Log.Info("Looking for Docs xml files...");
 foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null && encoding != null)
 {
 DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
 }
 }
 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }

 public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

 public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
 DocsComments.LoadDocsFile(xDoc, filePath, encoding);

 public void Start()
 {
 if (!IntelliSenseXmlComments.Members.Any())
 {
 Log.Error("No IntelliSense xml comments found.");
 return;
 }

 DocsComments.CollectFiles();
 if (!DocsComments.Types.Any())
 {
 Log.Error("No Docs Type APIs found.");
 return;
 }

 PortMissingComments();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

carlossanlop
merged 3 commits into

from

Mar 17, 2022
 Merged


PortToDocs: Add methods that either collect files automatically, or allow passing documents manually
#110
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f09ecd3

PortToDocs: Add public method to collect files automatically, include…


carlossanlop Mar 15, 2022
4ee9bab

Apply some minor Roslyn suggestions.


carlossanlop Mar 15, 2022
7d6b8ea

Rename method in tests that ports from file to file.


carlossanlop Mar 15, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
src/PortToDocs/src/app/PortToDocs.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
 {
 Configuration config = Configuration.GetCLIArguments(args);
 ToDocsPorter porter = new(config);
 porter.CollectFiles();
 porter.Start();
 }
 }
Expand Down

79 changes: 19 additions & 60 deletions
src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 public readonly Dictionary<string, DocsType> Types = new();
 public readonly Dictionary<string, DocsMember> Members = new();

 public DocsCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for Docs xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo);
 }

 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }
 public DocsCommentsContainer(Configuration config) => Config = config;

 public void Save()
 {
Expand All@@ -51,7 +33,7 @@ public void Save()
 }

 List<string> savedFiles = new();
 foreach (var type in Types.Values.Where(x => x.Changed))
 foreach (DocsType type in Types.Values.Where(x => x.Changed))
 {
 Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
 }
 }

 private bool HasAllowedDirName(DirectoryInfo dirInfo)
 {
 return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
 }

 private bool HasAllowedFileName(FileInfo fileInfo)
 {
 return !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";
 }

 private IEnumerable<FileInfo> EnumerateFiles()
 internal IEnumerable<FileInfo> EnumerateFiles()
 {
 // Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

 foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
 {
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
 {
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }

 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (IsXmlMalformed(xDoc, fileInfo.FullName))
 if (IsXmlMalformed(xDoc, filePath))
 {
 return;
 }

 DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
 DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

 bool add = false;
 bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
 // Interface files start with I, and have an 2nd alphabetic character
 addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
 add |= addedAsInterface;

 }

 bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
 {
 foreach (XElement xeMember in xeMembers.Elements("Member"))
 {
 DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
 DocsMember member = new(filePath, docsType, xeMember);
 totalMembersAdded++;
 Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
 }
 }

 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
 if (addedAsInterface)
 {
 Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
 }
 }

 private bool IsXmlMalformed(XDocument? xDoc, string fileName)
 private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
 !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

 private static bool HasAllowedFileName(FileInfo fileInfo) =>
 !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";

 private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
 {
 if (xDoc == null)
 {
Expand Down

53 changes: 12 additions & 41 deletions
src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 // The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
 public Dictionary<string, IntelliSenseXmlMember> Members = new();

 public IntelliSenseXmlCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for IntelliSense xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo, printSuccess: true);
 }

 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();
 }
 public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
 {
 foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
 {
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
 {
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
 if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
 {
 return;
 }
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 {
 foreach (XElement xeMember in xeMembers.Elements("member"))
 {
 IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
 IntelliSenseXmlMember member = new(xeMember, assembly);

 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
 {
 // No namespaces provided by the user means they want to port everything from that assembly
 if (!Config.IncludedNamespaces.Any() ||
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
 {
 totalAdded++;
 Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 }
 }

 if (printSuccess && totalAdded > 0)
 if (totalAdded > 0)
 {
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
 }
 }

 // Verifies the file is properly formed while attempting to retrieve the assembly name.
 private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 {
 assembly = null;

Expand Down

65 changes: 62 additions & 3 deletions
src/PortToDocs/src/libraries/ToDocsPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

 }

 public void Start()
 public void CollectFiles()
 {
 IntelliSenseXmlComments.CollectFiles();
 Log.Info("Looking for IntelliSense xml files...");
 foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null)
 {
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
 }
 }
 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();

 Log.Info("Looking for Docs xml files...");
 foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null && encoding != null)
 {
 DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
 }
 }
 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }

 public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

 public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
 DocsComments.LoadDocsFile(xDoc, filePath, encoding);

 public void Start()
 {
 if (!IntelliSenseXmlComments.Members.Any())
 {
 Log.Error("No IntelliSense xml comments found.");
 return;
 }

 DocsComments.CollectFiles();
 if (!DocsComments.Types.Any())
 {
 Log.Error("No Docs Type APIs found.");
 return;
 }

 PortMissingComments();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

carlossanlop
merged 3 commits into

from

Mar 17, 2022
 Merged


PortToDocs: Add methods that either collect files automatically, or allow passing documents manually
#110
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f09ecd3

PortToDocs: Add public method to collect files automatically, include…


carlossanlop Mar 15, 2022
4ee9bab

Apply some minor Roslyn suggestions.


carlossanlop Mar 15, 2022
7d6b8ea

Rename method in tests that ports from file to file.


carlossanlop Mar 15, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
src/PortToDocs/src/app/PortToDocs.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
 {
 Configuration config = Configuration.GetCLIArguments(args);
 ToDocsPorter porter = new(config);
 porter.CollectFiles();
 porter.Start();
 }
 }
Expand Down

79 changes: 19 additions & 60 deletions
src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 public readonly Dictionary<string, DocsType> Types = new();
 public readonly Dictionary<string, DocsMember> Members = new();

 public DocsCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for Docs xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo);
 }

 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }
 public DocsCommentsContainer(Configuration config) => Config = config;

 public void Save()
 {
Expand All@@ -51,7 +33,7 @@ public void Save()
 }

 List<string> savedFiles = new();
 foreach (var type in Types.Values.Where(x => x.Changed))
 foreach (DocsType type in Types.Values.Where(x => x.Changed))
 {
 Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
 }
 }

 private bool HasAllowedDirName(DirectoryInfo dirInfo)
 {
 return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
 }

 private bool HasAllowedFileName(FileInfo fileInfo)
 {
 return !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";
 }

 private IEnumerable<FileInfo> EnumerateFiles()
 internal IEnumerable<FileInfo> EnumerateFiles()
 {
 // Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

 foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
 {
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
 {
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }

 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (IsXmlMalformed(xDoc, fileInfo.FullName))
 if (IsXmlMalformed(xDoc, filePath))
 {
 return;
 }

 DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
 DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

 bool add = false;
 bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
 // Interface files start with I, and have an 2nd alphabetic character
 addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
 add |= addedAsInterface;

 }

 bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
 {
 foreach (XElement xeMember in xeMembers.Elements("Member"))
 {
 DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
 DocsMember member = new(filePath, docsType, xeMember);
 totalMembersAdded++;
 Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
 }
 }

 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
 if (addedAsInterface)
 {
 Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
 }
 }

 private bool IsXmlMalformed(XDocument? xDoc, string fileName)
 private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
 !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

 private static bool HasAllowedFileName(FileInfo fileInfo) =>
 !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";

 private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
 {
 if (xDoc == null)
 {
Expand Down

53 changes: 12 additions & 41 deletions
src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 // The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
 public Dictionary<string, IntelliSenseXmlMember> Members = new();

 public IntelliSenseXmlCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for IntelliSense xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo, printSuccess: true);
 }

 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();
 }
 public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
 {
 foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
 {
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
 {
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
 if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
 {
 return;
 }
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 {
 foreach (XElement xeMember in xeMembers.Elements("member"))
 {
 IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
 IntelliSenseXmlMember member = new(xeMember, assembly);

 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
 {
 // No namespaces provided by the user means they want to port everything from that assembly
 if (!Config.IncludedNamespaces.Any() ||
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
 {
 totalAdded++;
 Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 }
 }

 if (printSuccess && totalAdded > 0)
 if (totalAdded > 0)
 {
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
 }
 }

 // Verifies the file is properly formed while attempting to retrieve the assembly name.
 private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 {
 assembly = null;

Expand Down

65 changes: 62 additions & 3 deletions
src/PortToDocs/src/libraries/ToDocsPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

 }

 public void Start()
 public void CollectFiles()
 {
 IntelliSenseXmlComments.CollectFiles();
 Log.Info("Looking for IntelliSense xml files...");
 foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null)
 {
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
 }
 }
 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();

 Log.Info("Looking for Docs xml files...");
 foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null && encoding != null)
 {
 DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
 }
 }
 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }

 public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

 public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
 DocsComments.LoadDocsFile(xDoc, filePath, encoding);

 public void Start()
 {
 if (!IntelliSenseXmlComments.Members.Any())
 {
 Log.Error("No IntelliSense xml comments found.");
 return;
 }

 DocsComments.CollectFiles();
 if (!DocsComments.Types.Any())
 {
 Log.Error("No Docs Type APIs found.");
 return;
 }

 PortMissingComments();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

carlossanlop
merged 3 commits into

from

Mar 17, 2022
 Merged


PortToDocs: Add methods that either collect files automatically, or allow passing documents manually
#110
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f09ecd3

PortToDocs: Add public method to collect files automatically, include…


carlossanlop Mar 15, 2022
4ee9bab

Apply some minor Roslyn suggestions.


carlossanlop Mar 15, 2022
7d6b8ea

Rename method in tests that ports from file to file.


carlossanlop Mar 15, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
src/PortToDocs/src/app/PortToDocs.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
 {
 Configuration config = Configuration.GetCLIArguments(args);
 ToDocsPorter porter = new(config);
 porter.CollectFiles();
 porter.Start();
 }
 }
Expand Down

79 changes: 19 additions & 60 deletions
src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 public readonly Dictionary<string, DocsType> Types = new();
 public readonly Dictionary<string, DocsMember> Members = new();

 public DocsCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for Docs xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo);
 }

 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }
 public DocsCommentsContainer(Configuration config) => Config = config;

 public void Save()
 {
Expand All@@ -51,7 +33,7 @@ public void Save()
 }

 List<string> savedFiles = new();
 foreach (var type in Types.Values.Where(x => x.Changed))
 foreach (DocsType type in Types.Values.Where(x => x.Changed))
 {
 Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
 }
 }

 private bool HasAllowedDirName(DirectoryInfo dirInfo)
 {
 return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
 }

 private bool HasAllowedFileName(FileInfo fileInfo)
 {
 return !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";
 }

 private IEnumerable<FileInfo> EnumerateFiles()
 internal IEnumerable<FileInfo> EnumerateFiles()
 {
 // Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

 foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
 {
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
 {
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }

 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (IsXmlMalformed(xDoc, fileInfo.FullName))
 if (IsXmlMalformed(xDoc, filePath))
 {
 return;
 }

 DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
 DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

 bool add = false;
 bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
 // Interface files start with I, and have an 2nd alphabetic character
 addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
 add |= addedAsInterface;

 }

 bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
 {
 foreach (XElement xeMember in xeMembers.Elements("Member"))
 {
 DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
 DocsMember member = new(filePath, docsType, xeMember);
 totalMembersAdded++;
 Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
 }
 }

 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
 if (addedAsInterface)
 {
 Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
 }
 }

 private bool IsXmlMalformed(XDocument? xDoc, string fileName)
 private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
 !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

 private static bool HasAllowedFileName(FileInfo fileInfo) =>
 !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";

 private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
 {
 if (xDoc == null)
 {
Expand Down

53 changes: 12 additions & 41 deletions
src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 // The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
 public Dictionary<string, IntelliSenseXmlMember> Members = new();

 public IntelliSenseXmlCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for IntelliSense xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo, printSuccess: true);
 }

 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();
 }
 public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
 {
 foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
 {
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
 {
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
 if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
 {
 return;
 }
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 {
 foreach (XElement xeMember in xeMembers.Elements("member"))
 {
 IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
 IntelliSenseXmlMember member = new(xeMember, assembly);

 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
 {
 // No namespaces provided by the user means they want to port everything from that assembly
 if (!Config.IncludedNamespaces.Any() ||
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
 {
 totalAdded++;
 Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 }
 }

 if (printSuccess && totalAdded > 0)
 if (totalAdded > 0)
 {
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
 }
 }

 // Verifies the file is properly formed while attempting to retrieve the assembly name.
 private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 {
 assembly = null;

Expand Down

65 changes: 62 additions & 3 deletions
src/PortToDocs/src/libraries/ToDocsPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

 }

 public void Start()
 public void CollectFiles()
 {
 IntelliSenseXmlComments.CollectFiles();
 Log.Info("Looking for IntelliSense xml files...");
 foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null)
 {
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
 }
 }
 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();

 Log.Info("Looking for Docs xml files...");
 foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null && encoding != null)
 {
 DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
 }
 }
 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }

 public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

 public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
 DocsComments.LoadDocsFile(xDoc, filePath, encoding);

 public void Start()
 {
 if (!IntelliSenseXmlComments.Members.Any())
 {
 Log.Error("No IntelliSense xml comments found.");
 return;
 }

 DocsComments.CollectFiles();
 if (!DocsComments.Types.Any())
 {
 Log.Error("No Docs Type APIs found.");
 return;
 }

 PortMissingComments();
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
PortToDocs: Add methods that either collect files automatically, or allow passing documents manually#110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

carlossanlop
merged 3 commits into

from

Mar 17, 2022
 Merged


PortToDocs: Add methods that either collect files automatically, or allow passing documents manually
#110
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
f09ecd3

PortToDocs: Add public method to collect files automatically, include…


carlossanlop Mar 15, 2022
4ee9bab

Apply some minor Roslyn suggestions.


carlossanlop Mar 15, 2022
7d6b8ea

Rename method in tests that ports from file to file.


carlossanlop Mar 15, 2022

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
src/PortToDocs/src/app/PortToDocs.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@ public static void Main(string[] args)
 {
 Configuration config = Configuration.GetCLIArguments(args);
 ToDocsPorter porter = new(config);
 porter.CollectFiles();
 porter.Start();
 }
 }
Expand Down

79 changes: 19 additions & 60 deletions
src/PortToDocs/src/libraries/Docs/DocsCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,28 +15,10 @@ internal class DocsCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 public readonly Dictionary<string, DocsType> Types = new();
 public readonly Dictionary<string, DocsMember> Members = new();

 public DocsCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for Docs xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo);
 }

 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }
 public DocsCommentsContainer(Configuration config) => Config = config;

 public void Save()
 {
Expand All@@ -51,7 +33,7 @@ public void Save()
 }

 List<string> savedFiles = new();
 foreach (var type in Types.Values.Where(x => x.Changed))
 foreach (DocsType type in Types.Values.Where(x => x.Changed))
 {
 Log.Info(false, $"Saving changes for {type.FilePath} ... ");

Expand DownExpand Up@@ -95,23 +77,11 @@ public void Save()
 }
 }

 private bool HasAllowedDirName(DirectoryInfo dirInfo)
 {
 return !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests");
 }

 private bool HasAllowedFileName(FileInfo fileInfo)
 {
 return !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";
 }

 private IEnumerable<FileInfo> EnumerateFiles()
 internal IEnumerable<FileInfo> EnumerateFiles()
 {
 // Union avoids duplication
var includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
var excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);
IEnumerable<string> includedAssembliesAndNamespaces = Config.IncludedAssemblies.Union(Config.IncludedNamespaces);
IEnumerable<string> excludedAssembliesAndNamespaces = Config.ExcludedAssemblies.Union(Config.ExcludedNamespaces);

 foreach (DirectoryInfo rootDir in Config.DirsDocsXml)
 {
Expand DownExpand Up@@ -164,32 +134,14 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo)
internal void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding)
 {
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }

 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (IsXmlMalformed(xDoc, fileInfo.FullName))
 if (IsXmlMalformed(xDoc, filePath))
 {
 return;
 }

 DocsType docsType = new DocsType(fileInfo.FullName, xDoc, xDoc.Root!, encoding);
 DocsType docsType = new(filePath, xDoc, xDoc.Root!, encoding);

 bool add = false;
 bool addedAsInterface = false;
Expand All@@ -208,7 +160,6 @@ private void LoadFile(FileInfo fileInfo)
 // Interface files start with I, and have an 2nd alphabetic character
 addedAsInterface = docsType.Name.Length >= 2 && docsType.Name[0] == 'I' && docsType.Name[1] >= 'A' && docsType.Name[1] <= 'Z';
 add |= addedAsInterface;

 }

 bool containsAllowedAssembly = docsType.AssemblyInfos.Any(assemblyInfo =>
Expand DownExpand Up@@ -246,13 +197,13 @@ private void LoadFile(FileInfo fileInfo)
 {
 foreach (XElement xeMember in xeMembers.Elements("Member"))
 {
 DocsMember member = new DocsMember(fileInfo.FullName, docsType, xeMember);
 DocsMember member = new(filePath, docsType, xeMember);
 totalMembersAdded++;
 Members.TryAdd(member.DocId, member); // is it OK this encounters duplicates?
 }
 }

 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {fileInfo.FullName}";
 string message = $"Type '{docsType.DocId}' added with {totalMembersAdded} member(s) included: {filePath}";
 if (addedAsInterface)
 {
 Log.Magenta("[Interface] - " + message);
Expand All@@ -268,7 +219,15 @@ private void LoadFile(FileInfo fileInfo)
 }
 }

 private bool IsXmlMalformed(XDocument? xDoc, string fileName)
 private static bool HasAllowedDirName(DirectoryInfo dirInfo) =>
 !Configuration.ForbiddenBinSubdirectories.Contains(dirInfo.Name) && !dirInfo.Name.EndsWith(".Tests", StringComparison.InvariantCultureIgnoreCase);

 private static bool HasAllowedFileName(FileInfo fileInfo) =>
 !fileInfo.Name.StartsWith("ns-") &&
 fileInfo.Name != "index.xml" &&
 fileInfo.Name != "_filter.xml";

 private static bool IsXmlMalformed(XDocument? xDoc, string fileName)
 {
 if (xDoc == null)
 {
Expand Down

53 changes: 12 additions & 41 deletions
src/PortToDocs/src/libraries/IntelliSenseXml/IntelliSenseXmlCommentsContainer.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,6 @@
using System.Diagnostics.CodeAnalysis;
using System.IO;
using System.Linq;
using System.Xml;
using System.Xml.Linq;

/*
Expand DownExpand Up@@ -36,30 +35,12 @@ internal class IntelliSenseXmlCommentsContainer
 {
 private Configuration Config { get; set; }

 private XDocument? xDoc = null;

 // The IntelliSense xml files do not separate types from members, like ECMA xml files do - Everything is a member.
 public Dictionary<string, IntelliSenseXmlMember> Members = new();

 public IntelliSenseXmlCommentsContainer(Configuration config)
 {
 Config = config;
 }

 public void CollectFiles()
 {
 Log.Info("Looking for IntelliSense xml files...");

 foreach (FileInfo fileInfo in EnumerateFiles())
 {
 LoadFile(fileInfo, printSuccess: true);
 }

 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();
 }
 public IntelliSenseXmlCommentsContainer(Configuration config) => Config = config;

private IEnumerable<FileInfo> EnumerateFiles()
internal IEnumerable<FileInfo> EnumerateFiles()
 {
 foreach (DirectoryInfo dirInfo in Config.DirsIntelliSense)
 {
Expand All@@ -85,19 +66,9 @@ private IEnumerable<FileInfo> EnumerateFiles()
 }
 }

private void LoadFile(FileInfo fileInfo, bool printSuccess)
internal void LoadIntellisenseXmlFile(XDocument xDoc, string filePath)
 {
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 return;
 }

 if (!TryGetAssemblyName(xDoc, fileInfo.FullName, out string? assembly))
 if (!TryGetAssemblyName(xDoc, filePath, out string? assembly))
 {
 return;
 }
Expand All@@ -107,15 +78,15 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 {
 foreach (XElement xeMember in xeMembers.Elements("member"))
 {
 IntelliSenseXmlMember member = new IntelliSenseXmlMember(xeMember, assembly);
 IntelliSenseXmlMember member = new(xeMember, assembly);

 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded)))
 if (Config.IncludedAssemblies.Any(included => member.Assembly.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedAssemblies.Any(excluded => member.Assembly.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase)))
 {
 // No namespaces provided by the user means they want to port everything from that assembly
 if (!Config.IncludedNamespaces.Any() ||
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded))))
 (Config.IncludedNamespaces.Any(included => member.Namespace.StartsWith(included, StringComparison.InvariantCultureIgnoreCase)) &&
 !Config.ExcludedNamespaces.Any(excluded => member.Namespace.StartsWith(excluded, StringComparison.InvariantCultureIgnoreCase))))
 {
 totalAdded++;
 Members.TryAdd(member.Name, member); // is it OK this encounters duplicates?
Expand All@@ -124,14 +95,14 @@ private void LoadFile(FileInfo fileInfo, bool printSuccess)
 }
 }

 if (printSuccess && totalAdded > 0)
 if (totalAdded > 0)
 {
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{fileInfo.FullName}'");
 Log.Success($"{totalAdded} IntelliSense xml member(s) added from xml file '{filePath}'");
 }
 }

 // Verifies the file is properly formed while attempting to retrieve the assembly name.
 private bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 private static bool TryGetAssemblyName(XDocument? xDoc, string fileName, [NotNullWhen(returnValue: true)] out string? assembly)
 {
 assembly = null;

Expand Down

65 changes: 62 additions & 3 deletions
src/PortToDocs/src/libraries/ToDocsPorter.cs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,7 +3,9 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Xml.Linq;
using ApiDocsSync.Libraries.Docs;
using ApiDocsSync.Libraries.IntelliSenseXml;
Expand DownExpand Up@@ -32,19 +34,76 @@ public ToDocsPorter(Configuration config)

 }

 public void Start()
 public void CollectFiles()
 {
 IntelliSenseXmlComments.CollectFiles();
 Log.Info("Looking for IntelliSense xml files...");
 foreach (FileInfo fileInfo in IntelliSenseXmlComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 try
 {
 xDoc = XDocument.Load(fileInfo.FullName);
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null)
 {
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, fileInfo.FullName);
 }
 }
 Log.Success("Finished looking for IntelliSense xml files.");
 Log.Line();

 Log.Info("Looking for Docs xml files...");
 foreach (FileInfo fileInfo in DocsComments.EnumerateFiles())
 {
 XDocument? xDoc = null;
 Encoding? encoding = null;
 try
 {
 var utf8NoBom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
 var utf8Bom = new UTF8Encoding(encoderShouldEmitUTF8Identifier: true);
 using (StreamReader sr = new(fileInfo.FullName, utf8NoBom, detectEncodingFromByteOrderMarks: true))
 {
 xDoc = XDocument.Load(sr);
 encoding = sr.CurrentEncoding;
 }
 }
 catch (Exception ex)
 {
 Log.Error($"Failed to load '{fileInfo.FullName}'. {ex}");
 }

 if (xDoc != null && encoding != null)
 {
 DocsComments.LoadDocsFile(xDoc, fileInfo.FullName, encoding);
 }
 }
 Log.Success("Finished looking for Docs xml files.");
 Log.Line();
 }

 public void LoadIntellisenseXmlFile(XDocument xDoc, string filePath) =>
 IntelliSenseXmlComments.LoadIntellisenseXmlFile(xDoc, filePath);

 public void LoadDocsFile(XDocument xDoc, string filePath, Encoding encoding) =>
 DocsComments.LoadDocsFile(xDoc, filePath, encoding);

 public void Start()
 {
 if (!IntelliSenseXmlComments.Members.Any())
 {
 Log.Error("No IntelliSense xml comments found.");
 return;
 }

 DocsComments.CollectFiles();
 if (!DocsComments.Types.Any())
 {
 Log.Error("No Docs Type APIs found.");
 return;
 }

 PortMissingComments();
Expand Down
Loading