Add --treatValidationWarningsAsErrors

Closes #2199

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+### Features
+
+-   Added `--treatValidationWarningsAsErrors` to turn treat only validation warnings as errors without treating all warnings as errors, #2199.
+
 ### Bug Fixes
 
 -   Fixed a bug where optional properties were not appropriately marked as optional, #2200.

bin/typedoc

@@ -94,13 +94,17 @@ async function run(app) {
         return ExitCodes.CompileError;
     }
 
+    const preValidationWarnCount = app.logger.warningCount;
     app.validate(project);
+    const hadValidationWarnings =
+        app.logger.warningCount !== preValidationWarnCount;
     if (app.logger.hasErrors()) {
         return ExitCodes.ValidationError;
     }
     if (
-        app.options.getValue("treatWarningsAsErrors") &&
-        app.logger.hasWarnings()
+        hadValidationWarnings &&
+        (app.options.getValue("treatWarningsAsErrors") ||
+            app.options.getValue("treatValidationWarningsAsErrors"))
     ) {
         return ExitCodes.ValidationError;
     }

src/lib/utils/options/declaration.ts

@@ -157,6 +157,7 @@ export interface TypeDocOptionMap {
 
     // Validation
     treatWarningsAsErrors: boolean;
+    treatValidationWarningsAsErrors: boolean;
     intentionallyNotExported: string[];
     validation: ValidationOptions;
     requiredToBeDocumented: (keyof typeof ReflectionKind)[];

src/lib/utils/options/sources/typedoc.ts

@@ -656,7 +656,12 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
 
     options.addDeclaration({
         name: "treatWarningsAsErrors",
-        help: "If set, warnings will be treated as errors.",
+        help: "If set, all warnings will be treated as errors.",
+        type: ParameterType.Boolean,
+    });
+    options.addDeclaration({
+        name: "treatValidationWarningsAsErrors",
+        help: "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings.",
         type: ParameterType.Boolean,
     });
     options.addDeclaration({