feat: Add the --treatWarningsAsErrors option

Resolves #1568
TypeStrong · May 1, 2021 · 58f1bac · 58f1bac
1 parent bb5a5ae
commit 58f1bac
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/bin/typedoc b/bin/typedoc
@@ -52,6 +52,12 @@ async function run(app) {
     if (app.logger.hasErrors()) {
         return ExitCodes.OptionError;
     }
+    if (
+        app.options.getValue("treatWarningsAsErrors") &&
+        app.logger.hasWarnings()
+    ) {
+        return ExitCodes.OptionError;
+    }
 
     if (app.options.getValue("entryPoints").length === 0) {
         app.logger.error("No entry points provided");
@@ -97,5 +103,11 @@ async function run(app) {
     if (app.logger.hasErrors()) {
         return ExitCodes.OutputError;
     }
+    if (
+        app.options.getValue("treatWarningsAsErrors") &&
+        app.logger.hasWarnings()
+    ) {
+        return ExitCodes.OutputError;
+    }
     return ExitCodes.Ok;
 }
diff --git a/src/lib/utils/options/declaration.ts b/src/lib/utils/options/declaration.ts
@@ -80,6 +80,7 @@ export interface TypeDocOptionMap {
     plugin: string[];
     logger: unknown; // string | Function
     logLevel: typeof LogLevel;
+    treatWarningsAsErrors: boolean;
     listInvalidSymbolLinks: boolean;
     markedOptions: unknown;
 

diff --git a/src/lib/utils/options/sources/typedoc.ts b/src/lib/utils/options/sources/typedoc.ts
@@ -260,6 +260,11 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         map: LogLevel,
         defaultValue: LogLevel.Info,
     });
+    options.addDeclaration({
+        name: "treatWarningsAsErrors",
+        help: "If set, warnings will be treated as errors.",
+        type: ParameterType.Boolean,
+    });
     options.addDeclaration({
         name: "listInvalidSymbolLinks",
         help: