typedoc 0.23.26 → 0.23.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/bin/typedoc
CHANGED
|
@@ -94,13 +94,17 @@ async function run(app) {
|
|
|
94
94
|
return ExitCodes.CompileError;
|
|
95
95
|
}
|
|
96
96
|
|
|
97
|
+
const preValidationWarnCount = app.logger.warningCount;
|
|
97
98
|
app.validate(project);
|
|
99
|
+
const hadValidationWarnings =
|
|
100
|
+
app.logger.warningCount !== preValidationWarnCount;
|
|
98
101
|
if (app.logger.hasErrors()) {
|
|
99
102
|
return ExitCodes.ValidationError;
|
|
100
103
|
}
|
|
101
104
|
if (
|
|
102
|
-
|
|
103
|
-
app.
|
|
105
|
+
hadValidationWarnings &&
|
|
106
|
+
(app.options.getValue("treatWarningsAsErrors") ||
|
|
107
|
+
app.options.getValue("treatValidationWarningsAsErrors"))
|
|
104
108
|
) {
|
|
105
109
|
return ExitCodes.ValidationError;
|
|
106
110
|
}
|
|
@@ -354,8 +354,10 @@ function convertProperty(context, symbol, exportSymbol) {
|
|
|
354
354
|
(typescript_1.default.isPropertyDeclaration(declaration) ||
|
|
355
355
|
typescript_1.default.isPropertySignature(declaration) ||
|
|
356
356
|
typescript_1.default.isParameter(declaration) ||
|
|
357
|
-
typescript_1.default.isPropertyAccessExpression(declaration)
|
|
358
|
-
|
|
357
|
+
typescript_1.default.isPropertyAccessExpression(declaration) ||
|
|
358
|
+
typescript_1.default.isPropertyAssignment(declaration))) {
|
|
359
|
+
if (!typescript_1.default.isPropertyAccessExpression(declaration) &&
|
|
360
|
+
!typescript_1.default.isPropertyAssignment(declaration)) {
|
|
359
361
|
parameterType = declaration.type;
|
|
360
362
|
}
|
|
361
363
|
setModifiers(symbol, declaration, reflection);
|
|
@@ -115,6 +115,7 @@ export interface TypeDocOptionMap {
|
|
|
115
115
|
logger: unknown;
|
|
116
116
|
logLevel: typeof LogLevel;
|
|
117
117
|
treatWarningsAsErrors: boolean;
|
|
118
|
+
treatValidationWarningsAsErrors: boolean;
|
|
118
119
|
intentionallyNotExported: string[];
|
|
119
120
|
validation: ValidationOptions;
|
|
120
121
|
requiredToBeDocumented: (keyof typeof ReflectionKind)[];
|
|
@@ -582,7 +582,12 @@ function addTypeDocOptions(options) {
|
|
|
582
582
|
});
|
|
583
583
|
options.addDeclaration({
|
|
584
584
|
name: "treatWarningsAsErrors",
|
|
585
|
-
help: "If set, warnings will be treated as errors.",
|
|
585
|
+
help: "If set, all warnings will be treated as errors.",
|
|
586
|
+
type: declaration_1.ParameterType.Boolean,
|
|
587
|
+
});
|
|
588
|
+
options.addDeclaration({
|
|
589
|
+
name: "treatValidationWarningsAsErrors",
|
|
590
|
+
help: "If set, warnings emitted during validation will be treated as errors. This option cannot be used to disable treatWarningsAsErrors for validation warnings.",
|
|
586
591
|
type: declaration_1.ParameterType.Boolean,
|
|
587
592
|
});
|
|
588
593
|
options.addDeclaration({
|
package/package.json
CHANGED
package/static/style.css
CHANGED
|
@@ -483,10 +483,9 @@ blockquote {
|
|
|
483
483
|
.has-menu .col-menu {
|
|
484
484
|
visibility: visible;
|
|
485
485
|
transform: translate(0, 0);
|
|
486
|
-
display:
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
grid-gap: 1.5rem;
|
|
486
|
+
display: flex;
|
|
487
|
+
flex-direction: column;
|
|
488
|
+
gap: 1.5rem;
|
|
490
489
|
max-height: 100vh;
|
|
491
490
|
padding: 1rem 2rem;
|
|
492
491
|
}
|
|
@@ -911,7 +910,7 @@ a.tsd-index-link {
|
|
|
911
910
|
margin-right: 0.8rem;
|
|
912
911
|
}
|
|
913
912
|
|
|
914
|
-
@media (min-width:
|
|
913
|
+
@media (min-width: 1025px) {
|
|
915
914
|
.col-content {
|
|
916
915
|
margin: 2rem auto;
|
|
917
916
|
}
|
package/tsdoc.json
CHANGED