Allow bypassing compiler errors, see #116

Author: sebastian-lenz

bin/typedoc.d.ts

@@ -276,6 +276,10 @@ declare module td {
          * Has an error been raised through the log method?
          */
         hasErrors(): boolean;
+        /**
+         * Reset the error counter.
+         */
+        resetErrors(): void;
         /**
          * Log the given message.
          *
@@ -403,6 +407,10 @@ declare module td {
          * Path and filename of the json file.
          */
         json?: string;
+        /**
+         * Should TypeDoc generate documentation pages even after the compiler has returned errors?
+         */
+        ignoreCompilerErrors?: boolean;
         /**
          * Does the user want to display the help message?
          */

bin/typedoc.js

@@ -430,7 +430,13 @@ var td;
             var result = this.converter.convert(src);
             if (result.errors && result.errors.length) {
                 this.logger.diagnostics(result.errors);
-                return null;
+                if (this.options.ignoreCompilerErrors) {
+                    this.logger.resetErrors();
+                    return result.project;
+                }
+                else {
+                    return null;
+                }
             }
             else {
                 return result.project;
@@ -584,6 +590,12 @@ var td;
         Logger.prototype.hasErrors = function () {
             return this.errorCount > 0;
         };
+        /**
+         * Reset the error counter.
+         */
+        Logger.prototype.resetErrors = function () {
+            this.errorCount = 0;
+        };
         /**
          * Log the given message.
          *
@@ -915,6 +927,10 @@ var td;
                 name: 'exclude',
                 help: 'Define a pattern for excluded files when specifying paths.',
                 type: ParameterType.String
+            }, {
+                name: 'ignoreCompilerErrors',
+                help: 'Should TypeDoc generate documentation pages even after the compiler has returned errors?',
+                type: ParameterType.Boolean
             }, {
                 name: 'plugin',
                 help: 'Specify the npm plugins that should be loaded. Omit to load all installed plugins, set to \'none\' to load no plugins.',

src/td/Application.ts

@@ -342,7 +342,12 @@ module td
             var result = this.converter.convert(src);
             if (result.errors && result.errors.length) {
                 this.logger.diagnostics(result.errors);
-                return null;
+                if (this.options.ignoreCompilerErrors) {
+                    this.logger.resetErrors();
+                    return result.project;
+                } else {
+                    return null;
+                }
             } else {
                 return result.project;
             }

src/td/Logger.ts

@@ -41,6 +41,14 @@ module td
         }
 
 
+        /**
+         * Reset the error counter.
+         */
+        public resetErrors() {
+            this.errorCount = 0;
+        }
+
+
         /**
          * Log the given message.
          *

src/td/Options.ts

@@ -32,6 +32,11 @@ declare module td
          */
         json?:string;
 
+        /**
+         * Should TypeDoc generate documentation pages even after the compiler has returned errors?
+         */
+        ignoreCompilerErrors?:boolean;
+
         /**
          * Does the user want to display the help message?
          */
@@ -260,6 +265,10 @@ module td
                 name: 'exclude',
                 help: 'Define a pattern for excluded files when specifying paths.',
                 type: ParameterType.String
+            },{
+                name: 'ignoreCompilerErrors',
+                help: 'Should TypeDoc generate documentation pages even after the compiler has returned errors?',
+                type: ParameterType.Boolean
             },{
                 name: 'plugin',
                 help: 'Specify the npm plugins that should be loaded. Omit to load all installed plugins, set to \'none\' to load no plugins.',