Add evaluate mode feature with cli command example

Author: IVNSTN

README.md

@@ -17,6 +17,7 @@ The list of plugins must be specified in the [configuration file](./TeamTools.Li
 
 | Parameter | Shortcut | Description |
 |-----------|----------|-------------|
+| `--evaluate` | — | Evaluate mode to test linter features. It uses severity = warning and EvaluateConfig.json |
 | `--config` | `-c` | Path to the configuration file |
 | `--dir` | `-d` | Path to a directory containing files to be linted |
 | `--file` | `-f` | Path to a single file to be linted |
@@ -34,6 +35,17 @@ The list of plugins must be specified in the [configuration file](./TeamTools.Li
 
 ## Usage Examples
 
+### 🚀 First time run to evaluate linter features and capabilities
+
+```cmd
+.\TeamTools.Linter.CommandLine.exe --dir "c:\source\my_project" --evaluate
+```
+
+Evaluate-mode raises minimal severity to `warning` and forces `EvaluateConfig.json` to be used.
+Use this mode to find significant violations in a project which has never been analyzed by this linter before
+to test if the linter suffices your needs. Rules related to formatting standard, naming convention and such
+are disabled in this mode.
+
 ### Linting diff for a directory
 
 ```cmd

TeamTools.Linter.CommandLine/Config/CommandLineOptions.cs

@@ -8,6 +8,7 @@ namespace TeamTools.TSQL.Linter.CommandLine.Config
     public class CommandLineOptions
     {
         private string configFile = SanitizePath(Path.Combine(AppContext.BaseDirectory, "DefaultConfig.json"));
+        private string evaluateConfigFile = SanitizePath(Path.Combine(AppContext.BaseDirectory, "EvaluateConfig.json"));
         private string directoryName;
         private string fileName;
         private string fileListSource;
@@ -250,6 +251,23 @@ public string BasePath
             HelpText = "Show current version")]
         public bool Version { get; set; }
 
+        [Option(
+            longName: "evaluate",
+            Required = false,
+            Default = false,
+            HelpText = "Use this option for first run to detect significant violations only")]
+        public bool EvaluateApp
+        {
+            set
+            {
+                if (value)
+                {
+                    minimalSeverity = Severity.Warning;
+                    configFile = evaluateConfigFile;
+                }
+            }
+        }
+
         private static string SanitizePath(string value)
         {
             if (string.IsNullOrWhiteSpace(value))

TeamTools.Linter.CommandLine/EvaluateConfig.json

@@ -0,0 +1,43 @@
+{
+    "plugins": {
+        "SSDT": {
+            "dll": "./Plugins/TeamTools.Linter.SSDT/TeamTools.SSDT.ProjectValidator.dll",
+            "config": "./Plugins/TeamTools.Linter.SSDT/DefaultConfig.json"
+        },
+        "TSQL": {
+            "dll": "./Plugins/TeamTools.Linter.TSQL/TeamTools.TSQL.Linter.dll",
+            "config": "./Plugins/TeamTools.Linter.TSQL/EvaluateConfig.json"
+        }
+    },
+    "ignore": {
+        "folders": [
+            ".git",
+            ".vs",
+            ".stylecop",
+            "bin",
+            "obj",
+            "Framework",
+            "TestResults",
+            "TestSources",
+            "node_packages",
+            "packages",
+            "tSQLt"
+        ],
+        "extensions": [
+            ".dll",
+            ".orig",
+            ".exe",
+            ".user",
+            ".local",
+            ".dbmdl",
+            ".jfm",
+            ".dacpac",
+            ".rar",
+            ".zip",
+            ".7z"
+        ]
+    },
+    "options": {
+        "mainBranch": "master"
+    }
+}

TeamTools.Linter.CommandLine/TeamTools.Linter.CommandLine.csproj

@@ -33,6 +33,7 @@
   <ItemGroup>
     <Content Include="..\LICENSE" Pack="true" CopyToOutputDirectory="PreserveNewest" />
     <Content Include="DefaultConfig.json" CopyToOutputDirectory="PreserveNewest" />
+    <Content Include="EvaluateConfig.json" CopyToOutputDirectory="PreserveNewest" />
     <Folder Include="plugins\" />
   </ItemGroup>