Add additional checks to configuration and improve config file handling

Author: EmilZackrisson

RepositoryLinter/GlobalConfiguration.cs

@@ -29,13 +29,17 @@ public class GlobalConfiguration
 
     public List<CheckerConfiguration> Checks { get; set; } = new();
 
+    public bool IsFromConfigFile { get; set; }
+
     public static GlobalConfiguration ReadConfiguration(string path)
     {
+        Console.WriteLine("Reading configuration file");
         var deserializer = new DeserializerBuilder()
             .IgnoreUnmatchedProperties()
             .Build();
         var yaml = File.ReadAllText(path);
         var config = deserializer.Deserialize<GlobalConfiguration>(yaml);
+        config.IsFromConfigFile = true;
 
         return config;
     }

RepositoryLinter/Program.cs

@@ -35,7 +35,8 @@
 rootCommand.AddOption(configOption);
 
 // Create global config
-var config = new GlobalConfiguration();
+var config = GlobalConfiguration.ReadConfiguration("/app/config.yaml");
+
 
 var commandLineBuilder = new CommandLineBuilder(rootCommand);
 
@@ -45,25 +46,13 @@
     var tokens = context.ParseResult.Tokens;
     var args = tokens.Select(t => t.Value).ToArray();
 
-    // Set global options
-    config.GitIgnoreEnabled = !args.Contains("--ignore-gitignore");
-    config.TruncateOutput = !args.Contains("--disable-truncate");
-    config.CleanUp = !args.Contains("--disable-cleanup");
-
-    // Set path to save to
-    if (context.ParseResult.HasOption(pathToSaveOption))
-    {
-        config.PathToSaveGitRepos = context.ParseResult.GetValueForOption(pathToSaveOption)!;
-    }
-
-    // Handle config file
     if (context.ParseResult.HasOption(configOption))
     {
         try
         {
             var configFile = context.ParseResult.GetValueForOption(configOption)!;
             var newConfig = GlobalConfiguration.ReadConfiguration(configFile.FullName);
-            if (newConfig != null)
+            if (newConfig.IsFromConfigFile)
             {
                 config = newConfig;
             }
@@ -75,6 +64,17 @@
         }
     }
 
+    // Set global options
+    config.GitIgnoreEnabled = !args.Contains("--ignore-gitignore");
+    config.TruncateOutput = !args.Contains("--disable-truncate");
+    config.CleanUp = !args.Contains("--disable-cleanup");
+
+    // Set path to save to
+    if (context.ParseResult.HasOption(pathToSaveOption))
+    {
+        config.PathToSaveGitRepos = context.ParseResult.GetValueForOption(pathToSaveOption)!;
+    }
+
     await next(context);
 });
 

RepositoryLinter/config.yaml

@@ -1,5 +1,13 @@
 Checks:
   - Name: "License Exists"
     AllowedToFail: true
-
-PathToSaveGitRepos: "~/RepositoryLinter/git_repos"
+  - Name: ".gitignore exists"
+    AllowedToFail: true
+  - Name: "README exists"
+    AllowedToFail: true
+  - Name: "GitHub Workdflow exists"
+    AllowedToFail: true
+  - Name: "Secrets check"
+    AllowedToFail: true
+  - Name: "Tests exists"
+    AllowedToFail: true