Merge remote-tracking branch 'origin/skip-error-checking'

Author: Gerrit0

.github/ISSUE_TEMPLATE/bug_report.md

@@ -19,6 +19,9 @@ labels: bug
 ## Steps to reproduce the bug
 
 <!--
+Note: Turn off skipErrorChecks before reporting a crash. Bug reports for crashes with that option
+on are out of scope.
+
 If possible, please create a *minimal* repo reproducing your problem and link it.
 You can easily do this by submitting a pull request to https://github.com/TypeStrong/typedoc-repros
 which changes the files necessary to reproduce your bug.

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Unreleased
 
+### Features
+
+-   Introduced a `skipErrorChecking` option which instructs TypeDoc to not ask TypeScript for compiler errors
+    before attempting to generate documentation. Turning this on may improve generation speed, but could also
+    cause a crash if your code contains compiler errors.
+
 ### Bug Fixes
 
 -   Readme files within monorepos now have `@link` tags resolved, #2029.

src/lib/application.ts

@@ -88,7 +88,11 @@ export class Application extends ChildableComponent<
 
     /** @internal */
     @BindOption("logger")
-    loggerType!: string | Function;
+    readonly loggerType!: string | Function;
+
+    /** @internal */
+    @BindOption("skipErrorChecking")
+    readonly skipErrorChecking!: boolean;
 
     /**
      * The version number of TypeDoc.
@@ -216,12 +220,14 @@ export class Application extends ChildableComponent<
             `Converting with ${programs.length} programs ${entryPoints.length} entry points`
         );
 
-        const errors = programs.flatMap((program) =>
-            ts.getPreEmitDiagnostics(program)
-        );
-        if (errors.length) {
-            this.logger.diagnostics(errors);
-            return;
+        if (this.skipErrorChecking === false) {
+            const errors = programs.flatMap((program) =>
+                ts.getPreEmitDiagnostics(program)
+            );
+            if (errors.length) {
+                this.logger.diagnostics(errors);
+                return;
+            }
         }
 
         if (this.options.getValue("emit") === "both") {

src/lib/utils/options/declaration.ts

@@ -76,75 +76,75 @@ export type TypeDocOptionValues = {
 export interface TypeDocOptionMap {
     options: string;
     tsconfig: string;
+    compilerOptions: unknown;
 
     entryPoints: string[];
     entryPointStrategy: typeof EntryPointStrategy;
 
     exclude: string[];
     externalPattern: string[];
     excludeExternals: boolean;
-    excludePrivate: boolean;
-    excludeProtected: boolean;
     excludeNotDocumented: boolean;
     excludeInternal: boolean;
-    disableSources: boolean;
-    basePath: string;
-    includes: string;
+    excludePrivate: boolean;
+    excludeProtected: boolean;
     media: string;
-
-    emit: typeof EmitStrategy;
-    watch: boolean;
-    preserveWatchOutput: boolean;
+    includes: string;
 
     out: string;
     json: string;
     pretty: boolean;
-
+    emit: typeof EmitStrategy;
     theme: string;
+
     lightHighlightTheme: ShikiTheme;
     darkHighlightTheme: ShikiTheme;
     customCss: string;
-    visibilityFilters: ManuallyValidatedOption<{
-        protected?: boolean;
-        private?: boolean;
-        inherited?: boolean;
-        external?: boolean;
-        [tag: `@${string}`]: boolean;
-    }>;
-
+    markedOptions: unknown;
     name: string;
     includeVersion: boolean;
+    disableSources: boolean;
+    basePath: string;
+    excludeTags: `@${string}`[];
     readme: string;
-    defaultCategory: string;
-    categoryOrder: string[];
-    categorizeByGroup: boolean;
     cname: string;
-    sort: SortStrategy[];
     gitRevision: string;
     gitRemote: string;
-    gaID: string;
-    githubPages: boolean;
     htmlLang: string;
+    githubPages: boolean;
+    gaID: string;
     hideGenerator: boolean;
     searchInComments: boolean;
     cleanOutputDir: boolean;
 
     commentStyle: typeof CommentStyle;
-    excludeTags: `@${string}`[];
     blockTags: `@${string}`[];
     inlineTags: `@${string}`[];
     modifierTags: `@${string}`[];
 
+    categorizeByGroup: boolean;
+    defaultCategory: string;
+    categoryOrder: string[];
+    sort: SortStrategy[];
+    visibilityFilters: ManuallyValidatedOption<{
+        protected?: boolean;
+        private?: boolean;
+        inherited?: boolean;
+        external?: boolean;
+        [tag: `@${string}`]: boolean;
+    }>;
+    searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
+    searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
+
+    watch: boolean;
+    preserveWatchOutput: boolean;
+    skipErrorChecking: boolean;
     help: boolean;
     version: boolean;
     showConfig: boolean;
     plugin: string[];
-    searchCategoryBoosts: ManuallyValidatedOption<Record<string, number>>;
-    searchGroupBoosts: ManuallyValidatedOption<Record<string, number>>;
     logger: unknown; // string | Function
     logLevel: typeof LogLevel;
-    markedOptions: unknown;
-    compilerOptions: unknown;
 
     // Validation
     treatWarningsAsErrors: boolean;

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

@@ -466,6 +466,12 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
         type: ParameterType.Boolean,
     });
 
+    options.addDeclaration({
+        name: "skipErrorChecking",
+        help: "Do not run TypeScript's type checking before generating docs.",
+        type: ParameterType.Boolean,
+        defaultValue: false,
+    });
     options.addDeclaration({
         name: "help",
         help: "Print this message.",