added some settings validation for better error message (closes #154)

Doraku · Nov 1, 2024 · 361844c · 361844c
1 parent 8d1fee3
commit 361844c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/documentation/NEXT_RELEASENOTES.txt b/documentation/NEXT_RELEASENOTES.txt
@@ -12,6 +12,7 @@
 - added ExcludeGenerator to exclude DocItem from the documentation generation based on regex (closes #160)
 - list code and note elements now display a placeholder value `...` when displayed as a single line
 - added DirectoryName IFileNameFactory implementation (closes #104)
+- added some settings validation for better error message (closes #154)
 
 ## Bug fixes
 

diff --git a/source/DefaultDocumentation.Common/Generator.cs b/source/DefaultDocumentation.Common/Generator.cs
@@ -89,6 +89,8 @@ private Generator(Target loggerTarget, IRawSettings settings)
             GetSetting<string>(nameof(settings.LinksBaseUrl)),
             GetSetting<string[]>(nameof(settings.ExternLinksFilePaths)));
 
+        resolvedSettings.Validate();
+
         AppDomain.CurrentDomain.AssemblyResolve += (object sender, ResolveEventArgs args) =>
         {
             AssemblyName assemblyName = new(args.Name);

diff --git a/source/DefaultDocumentation.Common/Internal/Settings.cs b/source/DefaultDocumentation.Common/Internal/Settings.cs
@@ -79,6 +79,19 @@ private static IEnumerable<string> GetFilePaths(string filePath)
         }
     }
 
+    public void Validate()
+    {
+        if (!AssemblyFile.Exists)
+        {
+            throw new FileNotFoundException("The assembly file does not exist", AssemblyFile.FullName);
+        }
+
+        if (!DocumentationFile.Exists)
+        {
+            throw new FileNotFoundException("The xml documentation file does not exist, ensure you activated the \"GenerateDocumentationFile\" property of the project", DocumentationFile.FullName);
+        }
+    }
+
     #region ISettings
 
     public ILogger Logger { get; }