node docs generator tool without MetaDataLoadContext #11950
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,8 +2,11 @@ | |
| using System.Collections.Generic; | ||
| using System.IO; | ||
| using System.Linq; | ||
| using System.Reflection; | ||
| using System.Text; | ||
| using System.Threading.Tasks; | ||
| using Dynamo.Interfaces; | ||
| using Dynamo.Logging; | ||
|
|
||
| namespace Dynamo.DocumentationBrowser | ||
| { | ||
|
|
@@ -18,14 +21,18 @@ public class PackageDocumentationManager : IDisposable | |
| /// key: node namespace - value: file path to markdown file. | ||
| /// </summary> | ||
| private Dictionary<string, string> nodeDocumentationFileLookup = new Dictionary<string, string>(); | ||
|
|
||
| /// <summary> | ||
| /// Dictionary to keep track of each FileSystemWatcher created for the package node annotation directory path | ||
| /// key: directory path - value: FileSystemWatcher | ||
| /// </summary> | ||
| private Dictionary<string, FileSystemWatcher> markdownFileWatchers = new Dictionary<string, FileSystemWatcher>(); | ||
|
|
||
| private const string VALID_DOC_FILEEXTENSION = "*.md"; | ||
| private const string FALLBACK_DOC_DIRECTORY_NAME = "fallback_docs"; | ||
| private static PackageDocumentationManager instance; | ||
| private DirectoryInfo dynamoCoreFallbackDocPath; | ||
| private DirectoryInfo hostDynamoFallbackDocPath; | ||
|
|
||
| /// <summary> | ||
| /// PackageDocManager singleton instance. | ||
|
|
@@ -39,17 +46,64 @@ public static PackageDocumentationManager Instance | |
| } | ||
| } | ||
|
|
||
| internal Action<ILogMessage> MessageLogged; | ||
|
|
||
| /// <summary> | ||
| /// Uses the path manager to set the fallback_doc path for DynamoCore and any Host running | ||
| /// </summary> | ||
| /// <param name="pathManager"></param> | ||
| internal void AddDynamoPaths(IPathManager pathManager) | ||
| { | ||
| if (pathManager is null) | ||
| { | ||
| return; | ||
| } | ||
|
|
||
| if (!string.IsNullOrEmpty(pathManager.DynamoCoreDirectory)) | ||
| { | ||
| var coreDir = new DirectoryInfo(Path.Combine(pathManager.DynamoCoreDirectory, FALLBACK_DOC_DIRECTORY_NAME)); | ||
| dynamoCoreFallbackDocPath = coreDir.Exists ? coreDir : null; | ||
| } | ||
|
|
||
| if (!string.IsNullOrEmpty(pathManager.HostApplicationDirectory)) | ||
| { | ||
| var hostDir = new DirectoryInfo(Path.Combine(pathManager.HostApplicationDirectory, FALLBACK_DOC_DIRECTORY_NAME)); | ||
| hostDynamoFallbackDocPath = hostDir.Exists ? hostDir : null; | ||
| } | ||
| } | ||
|
|
||
| private PackageDocumentationManager() { } | ||
|
|
||
| /// <summary> | ||
| /// Retrieves the markdown node documentation file associated with the input node namespace | ||
| /// </summary> | ||
| /// <param name="nodeNamespace">Namespace of the node to lookup documentation for</param> | ||
| /// <returns></returns> | ||
| public string GetAnnotationDoc(string nodeNamespace, string packageName) | ||
|
There was a problem hiding this comment. Add packageName to param list? There was a problem hiding this comment. yes @sm6srw, I had the same reaction initially, https://github.com/DynamoDS/Dynamo/pull/11725/files#r646888243 - but it's actually inside an extension, I think it's okay to break this with chance of risk and if possible it would be nice to decide and/or codify extensions being part of the API boundary or not but it will take a cross team effort / discussion I think. in this case I'm okay with the change unless there are objections. |
||
| { | ||
| if(nodeDocumentationFileLookup | ||
| .TryGetValue(Path.Combine(packageName, nodeNamespace), | ||
| out string output)) | ||
| { | ||
| return output; | ||
| } | ||
|
|
||
| FileInfo matchingDoc = null; | ||
| if (hostDynamoFallbackDocPath != null) | ||
| { | ||
| matchingDoc = hostDynamoFallbackDocPath.GetFiles($"{nodeNamespace}.md").FirstOrDefault(); | ||
| if (matchingDoc != null) | ||
| { | ||
| return matchingDoc.FullName; | ||
| } | ||
| } | ||
|
|
||
| if (dynamoCoreFallbackDocPath != null) | ||
| { | ||
| matchingDoc = dynamoCoreFallbackDocPath.GetFiles($"{nodeNamespace}.md").FirstOrDefault(); | ||
| } | ||
|
|
||
| return matchingDoc is null ? string.Empty : matchingDoc.FullName; | ||
| } | ||
|
|
||
| /// <summary> | ||
|
|
@@ -67,7 +121,7 @@ public bool ContainsAnnotationDoc(string nodeNamespace) | |
| /// Note this only works for Markdown files. | ||
| /// </summary> | ||
| /// <param name="package"></param> | ||
| internal void AddPackageDocumentation(string packageDocumentationPath, string packageName) | ||
| { | ||
| if (string.IsNullOrWhiteSpace(packageDocumentationPath)) | ||
| return; | ||
|
|
@@ -77,27 +131,34 @@ internal void AddPackageDocumentation(string packageDocumentationPath) | |
| return; | ||
|
|
||
| MonitorDirectory(directoryInfo); | ||
| var files = directoryInfo.GetFiles(VALID_DOC_FILEEXTENSION, SearchOption.AllDirectories); | ||
| TrackDocumentationFiles(files, packageName); | ||
| } | ||
|
|
||
| private void MonitorDirectory(DirectoryInfo directoryInfo) | ||
| { | ||
| if (markdownFileWatchers.ContainsKey(directoryInfo.FullName)) | ||
| return; | ||
|
|
||
| var watcher = new FileSystemWatcher(directoryInfo.FullName, VALID_DOC_FILEEXTENSION) { EnableRaisingEvents = true }; | ||
| watcher.Renamed += OnFileRenamed; | ||
| watcher.Deleted += OnFileDeleted; | ||
| watcher.Created += OnFileCreated; | ||
| markdownFileWatchers.Add(watcher.Path, watcher); | ||
| } | ||
|
|
||
| private void TrackDocumentationFiles(FileInfo[] files, string packageName) | ||
| { | ||
| foreach (var file in files) | ||
| { | ||
| try | ||
| { | ||
| nodeDocumentationFileLookup.Add(Path.Combine(packageName,Path.GetFileNameWithoutExtension(file.Name)), file.FullName); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| LogWarning(e.Message, WarningLevel.Error); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -110,20 +171,28 @@ private void OnFileDeleted(object sender, FileSystemEventArgs e) | |
| { | ||
| var fileName = Path.GetFileNameWithoutExtension(e.Name); | ||
| if (nodeDocumentationFileLookup.ContainsKey(fileName)) | ||
| { | ||
| nodeDocumentationFileLookup.Remove(fileName); | ||
| } | ||
| } | ||
|
|
||
| private void OnFileRenamed(object sender, RenamedEventArgs e) | ||
| { | ||
| var oldFileName = Path.GetFileNameWithoutExtension(e.OldName); | ||
| if (nodeDocumentationFileLookup.ContainsKey(oldFileName)) | ||
| { | ||
| nodeDocumentationFileLookup.Remove(oldFileName); | ||
| } | ||
|
|
||
| var newFileName = Path.GetFileNameWithoutExtension(e.Name); | ||
| if (!nodeDocumentationFileLookup.ContainsKey(newFileName)) | ||
| { | ||
| nodeDocumentationFileLookup.Add(newFileName, e.FullPath); | ||
| } | ||
| } | ||
|
|
||
| private void LogWarning(string msg, WarningLevel level) => this.MessageLogged?.Invoke(LogMessage.Warning(msg, level)); | ||
|
|
||
| public void Dispose() | ||
| { | ||
| foreach (var watcher in markdownFileWatchers.Values) | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sm6srw to answer your question about how useful this is - it actually uses the
DynamoHostPathproperty as the root - which can be set using a startupconfiguration - for example, DynamoRevit sets this to the location of theDynamoRevit.dllentry point.so I think this is pretty useful.