@skyux/docs-tools 9.0.0-alpha.0 → 9.0.0-alpha.1
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/esm2022/modules/type-definitions/type-definitions-format.service.mjs +2 -4
- package/esm2022/modules/type-definitions/type-definitions.service.mjs +2 -2
- package/esm2022/modules/type-definitions/typedoc-adapter.service.mjs +61 -24
- package/esm2022/modules/type-definitions/typedoc-types.mjs +1 -1
- package/fesm2022/skyux-docs-tools.mjs +62 -27
- package/fesm2022/skyux-docs-tools.mjs.map +1 -1
- package/modules/type-definitions/typedoc-types.d.ts +12 -7
- package/package.json +1 -1
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export {};
|
|
2
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
2
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidHlwZWRvYy10eXBlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uLy4uL3Byb2plY3RzL2RvY3MtdG9vbHMvc3JjL21vZHVsZXMvdHlwZS1kZWZpbml0aW9ucy90eXBlZG9jLXR5cGVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgaW50ZXJmYWNlIFR5cGVEb2NDb21tZW50IHtcbiAgc3VtbWFyeT86IHsga2luZDogc3RyaW5nOyB0ZXh0OiBzdHJpbmcgfVtdO1xuXG4gIGJsb2NrVGFncz86IHtcbiAgICBwYXJhbT86IHN0cmluZztcbiAgICBjb250ZW50PzogeyBraW5kOiBzdHJpbmc7IHRleHQ6IHN0cmluZyB9W107XG4gICAgdGFnOlxuICAgICAgfCAnQGRlZmF1bHQnXG4gICAgICB8ICdAZGVmYXVsdFZhbHVlJ1xuICAgICAgfCAnQGRlcHJlY2F0ZWQnXG4gICAgICB8ICdAZXhhbXBsZSdcbiAgICAgIHwgJ0BwYXJhbSdcbiAgICAgIHwgJ0ByZXF1aXJlZCc7XG4gIH1bXTtcbn1cblxuZXhwb3J0IGludGVyZmFjZSBUeXBlRG9jU291cmNlIHtcbiAgZmlsZU5hbWU6IHN0cmluZztcbn1cblxuZXhwb3J0IGludGVyZmFjZSBUeXBlRG9jU2lnbmF0dXJlIHtcbiAgY29tbWVudD86IFR5cGVEb2NDb21tZW50O1xuXG4gIGtpbmRTdHJpbmc/OiAnQ2FsbCBzaWduYXR1cmUnIHwgJ0NvbnN0cnVjdG9yIHNpZ25hdHVyZScgfCAnSW5kZXggc2lnbmF0dXJlJztcblxuICBuYW1lOiBzdHJpbmc7XG5cbiAgcGFyYW1ldGVycz86IFR5cGVEb2NQYXJhbWV0ZXJbXTtcblxuICByZXR1cm5UeXBlPzogVHlwZURvY1R5cGU7XG5cbiAgdHlwZT86IFR5cGVEb2NUeXBlO1xuXG4gIHR5cGVQYXJhbWV0ZXI/OiBUeXBlRG9jVHlwZVBhcmFtZXRlcltdO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIFR5cGVEb2NUeXBlUGFyYW1ldGVyIHtcbiAgbmFtZTogc3RyaW5nO1xuICBraW5kU3RyaW5nOiAnVHlwZSBwYXJhbWV0ZXInO1xuICB0eXBlPzogVHlwZURvY1R5cGU7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgVHlwZURvY1R5cGUge1xuICBjb25zdHJhaW50Pzoge1xuICAgIG5hbWU6IHN0cmluZztcbiAgfTtcblxuICBjYWxsU2lnbmF0dXJlPzogVHlwZURvY1NpZ25hdHVyZTtcblxuICBkZWNsYXJhdGlvbj86IHtcbiAgICBjaGlsZHJlbj86IFR5cGVEb2NFbnRyeUNoaWxkW107XG4gICAgaW5kZXhTaWduYXR1cmU/OiBUeXBlRG9jU2lnbmF0dXJlO1xuICAgIHNpZ25hdHVyZXM/OiBUeXBlRG9jU2lnbmF0dXJlW107XG4gIH07XG5cbiAgZWxlbWVudFR5cGU/OiBUeXBlRG9jVHlwZTtcblxuICBuYW1lPzogc3RyaW5nO1xuXG4gIG9wZXJhdG9yPzogJ2tleW9mJztcblxuICB0YXJnZXQ/OiB7XG4gICAgbmFtZTogc3RyaW5nO1xuICB9O1xuXG4gIHR5cGU/OlxuICAgIHwgJ2FycmF5J1xuICAgIHwgJ2ludHJpbnNpYydcbiAgICB8ICdsaXRlcmFsJ1xuICAgIHwgJ3JlZmVyZW5jZSdcbiAgICB8ICdyZWZsZWN0aW9uJ1xuICAgIHwgJ3R5cGVQYXJhbWV0ZXInXG4gICAgfCAndHlwZU9wZXJhdG9yJ1xuICAgIHwgJ3VuaW9uJ1xuICAgIHwgJ3Vua25vd24nO1xuXG4gIHR5cGVBcmd1bWVudHM/OiBUeXBlRG9jVHlwZVtdO1xuXG4gIHR5cGVzPzogVHlwZURvY1R5cGVbXTtcblxuICB2YWx1ZT86IHN0cmluZztcbn1cblxuZXhwb3J0IGludGVyZmFjZSBUeXBlRG9jUGFyYW1ldGVyIHtcbiAgY29tbWVudD86IFR5cGVEb2NDb21tZW50O1xuXG4gIGRlZmF1bHRWYWx1ZT86IHN0cmluZztcblxuICBraW5kU3RyaW5nOiAnUGFyYW1ldGVyJztcblxuICBuYW1lOiBzdHJpbmc7XG5cbiAgdHlwZTogVHlwZURvY1R5cGU7XG5cbiAgZmxhZ3M/OiB7XG4gICAgaXNPcHRpb25hbD86IGJvb2xlYW47XG4gIH07XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgVHlwZURvY0VudHJ5Q2hpbGQge1xuICBjb21tZW50PzogVHlwZURvY0NvbW1lbnQ7XG5cbiAgZGVjb3JhdG9ycz86IHtcbiAgICBhcmd1bWVudHM/OiB7XG4gICAgICBiaW5kaW5nUHJvcGVydHlOYW1lPzogc3RyaW5nO1xuICAgIH07XG4gICAgbmFtZTogJ0lucHV0JyB8ICdPdXRwdXQnO1xuICAgIHR5cGU6IFR5cGVEb2NUeXBlO1xuICB9W107XG5cbiAgZGVmYXVsdFZhbHVlPzogc3RyaW5nO1xuXG4gIGZsYWdzPzoge1xuICAgIGlzT3B0aW9uYWw/OiBib29sZWFuO1xuICAgIGlzU3RhdGljPzogYm9vbGVhbjtcbiAgfTtcblxuICBraW5kU3RyaW5nPzpcbiAgICB8ICdBY2Nlc3NvcidcbiAgICB8ICdDYWxsIHNpZ25hdHVyZSdcbiAgICB8ICdDb25zdHJ1Y3RvcidcbiAgICB8ICdDb25zdHJ1Y3RvciBzaWduYXR1cmUnXG4gICAgfCAnSW5kZXggc2lnbmF0dXJlJ1xuICAgIHwgJ0VudW1lcmF0aW9uIG1lbWJlcidcbiAgICB8ICdQYXJhbWV0ZXInXG4gICAgfCAnUHJvcGVydHknXG4gICAgfCAnTWV0aG9kJztcblxuICBnZXRTaWduYXR1cmU/OiB7XG4gICAgY29tbWVudDogVHlwZURvY0NvbW1lbnQ7XG4gICAgbmFtZTogc3RyaW5nO1xuICAgIHR5cGU6IFR5cGVEb2NUeXBlO1xuICB9O1xuXG4gIG5hbWU/OiBzdHJpbmc7XG5cbiAgc2V0U2lnbmF0dXJlPzoge1xuICAgIGNvbW1lbnQ6IFR5cGVEb2NDb21tZW50O1xuICAgIG5hbWU6IHN0cmluZztcbiAgICBwYXJhbWV0ZXJzPzogVHlwZURvY1BhcmFtZXRlcltdO1xuICAgIHR5cGU6IFR5cGVEb2NUeXBlO1xuICB9O1xuXG4gIHNpZ25hdHVyZXM/OiBUeXBlRG9jU2lnbmF0dXJlW107XG5cbiAgc291cmNlcz86IFR5cGVEb2NTb3VyY2VbXTtcblxuICB0eXBlPzogVHlwZURvY1R5cGU7XG59XG5cbmV4cG9ydCBpbnRlcmZhY2UgVHlwZURvY0VudHJ5IHtcbiAgYW5jaG9ySWQ/OiBzdHJpbmc7XG5cbiAgY2hpbGRyZW4/OiBUeXBlRG9jRW50cnlDaGlsZFtdO1xuXG4gIGNvbW1lbnQ/OiBUeXBlRG9jQ29tbWVudDtcblxuICBkZWNvcmF0b3JzPzoge1xuICAgIGFyZ3VtZW50cz86IHtcbiAgICAgIG9iaj86IHN0cmluZztcbiAgICB9O1xuICAgIG5hbWU6ICdDb21wb25lbnQnIHwgJ0RpcmVjdGl2ZScgfCAnSW5qZWN0YWJsZScgfCAnTmdNb2R1bGUnIHwgJ1BpcGUnO1xuICAgIHR5cGU6IFR5cGVEb2NUeXBlO1xuICB9W107XG5cbiAga2luZFN0cmluZz86ICdDbGFzcycgfCAnRW51bWVyYXRpb24nIHwgJ0ludGVyZmFjZScgfCAnVHlwZSBhbGlhcyc7XG5cbiAgaW5kZXhTaWduYXR1cmU/OiBUeXBlRG9jU2lnbmF0dXJlO1xuXG4gIG5hbWU/OiBzdHJpbmc7XG5cbiAgc291cmNlcz86IFR5cGVEb2NTb3VyY2VbXTtcblxuICB0eXBlPzogVHlwZURvY1R5cGU7XG5cbiAgdHlwZVBhcmFtZXRlcj86IFR5cGVEb2NUeXBlUGFyYW1ldGVyW107XG59XG4iXX0=
|
|
@@ -1479,9 +1479,7 @@ class SkyDocsTypeDefinitionsFormatService {
|
|
|
1479
1479
|
escapeSpecialCharacters(value) {
|
|
1480
1480
|
return value.replace(/</g, '<').replace(/>/g, '>');
|
|
1481
1481
|
}
|
|
1482
|
-
getFormattedCallSignature(callSignature, config
|
|
1483
|
-
escapeSpecialCharacters: true,
|
|
1484
|
-
}) {
|
|
1482
|
+
getFormattedCallSignature(callSignature, config) {
|
|
1485
1483
|
const returnType = this.getFormattedType(callSignature.returnType, config);
|
|
1486
1484
|
if (!callSignature.parameters) {
|
|
1487
1485
|
return `() => ${returnType}`;
|
|
@@ -2311,7 +2309,14 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2311
2309
|
return [];
|
|
2312
2310
|
}
|
|
2313
2311
|
const definitions = entry.children
|
|
2314
|
-
.filter((child) =>
|
|
2312
|
+
.filter((child) =>
|
|
2313
|
+
// We only want properties (both with or without a getter/setter)
|
|
2314
|
+
child.kindString === 'Property' || child.kindString === 'Accessor')
|
|
2315
|
+
.filter((child) =>
|
|
2316
|
+
// We only want accessors that don't have a setter if they are not inputs
|
|
2317
|
+
child.kindString !== 'Accessor' ||
|
|
2318
|
+
child.setSignature ||
|
|
2319
|
+
this.getDecorator(child)?.name !== 'Input')
|
|
2315
2320
|
.map((child) => {
|
|
2316
2321
|
let definition = {
|
|
2317
2322
|
isOptional: true,
|
|
@@ -2321,18 +2326,21 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2321
2326
|
let defaultValue;
|
|
2322
2327
|
/* Ensure we are properly capturing definitions which use a getter/setter. Final check is a sanity check */
|
|
2323
2328
|
if (child.kindString === 'Accessor' &&
|
|
2324
|
-
!child.comment?.
|
|
2325
|
-
|
|
2329
|
+
!child.comment?.summary
|
|
2330
|
+
?.map((item) => item.text)
|
|
2331
|
+
.join('')
|
|
2332
|
+
.trim() &&
|
|
2333
|
+
(child.setSignature || child.getSignature)) {
|
|
2326
2334
|
const mainTags = this.getCommentTags(child.comment);
|
|
2327
2335
|
this.applyCommentTagValues(definition, mainTags);
|
|
2328
|
-
if (child.getSignature
|
|
2329
|
-
const getTags = this.getCommentTags(child.getSignature
|
|
2336
|
+
if (child.getSignature) {
|
|
2337
|
+
const getTags = this.getCommentTags(child.getSignature.comment);
|
|
2330
2338
|
definition.isOptional = !getTags.extras.required;
|
|
2331
2339
|
this.applyCommentTagValues(definition, getTags);
|
|
2332
2340
|
defaultValue = this.getDefaultValue(child, getTags);
|
|
2333
2341
|
}
|
|
2334
|
-
if (child.setSignature
|
|
2335
|
-
const setTags = this.getCommentTags(child.setSignature
|
|
2342
|
+
if (child.setSignature) {
|
|
2343
|
+
const setTags = this.getCommentTags(child.setSignature.comment);
|
|
2336
2344
|
this.applyCommentTagValues(definition, setTags);
|
|
2337
2345
|
definition.isOptional =
|
|
2338
2346
|
definition.isOptional && !setTags.extras.required;
|
|
@@ -2346,7 +2354,10 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2346
2354
|
else {
|
|
2347
2355
|
let tags;
|
|
2348
2356
|
if (child.kindString === 'Property' &&
|
|
2349
|
-
!child.comment?.
|
|
2357
|
+
!child.comment?.summary
|
|
2358
|
+
?.map((item) => item.text)
|
|
2359
|
+
.join('')
|
|
2360
|
+
.trim() &&
|
|
2350
2361
|
child.type.declaration?.signatures?.length > 0 &&
|
|
2351
2362
|
child.type.declaration.signatures[0].comment) {
|
|
2352
2363
|
tags = this.getCommentTags(child.type.declaration.signatures[0].comment);
|
|
@@ -2419,6 +2430,10 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2419
2430
|
if (child.kindString === 'Method' && child.signatures.length > 0) {
|
|
2420
2431
|
tags = this.getCommentTags(child.signatures[0].comment);
|
|
2421
2432
|
}
|
|
2433
|
+
else if (child.type.type === 'reflection' &&
|
|
2434
|
+
child.type?.declaration?.signatures?.length > 0) {
|
|
2435
|
+
tags = this.getCommentTags(child.type.declaration.signatures[0].comment);
|
|
2436
|
+
}
|
|
2422
2437
|
else {
|
|
2423
2438
|
tags = this.getCommentTags(child.comment);
|
|
2424
2439
|
}
|
|
@@ -2466,9 +2481,9 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2466
2481
|
switch (kindString) {
|
|
2467
2482
|
case 'Accessor':
|
|
2468
2483
|
if (child.setSignature) {
|
|
2469
|
-
return this.getTypeDefinition(child.setSignature
|
|
2484
|
+
return this.getTypeDefinition(child.setSignature.parameters[0]);
|
|
2470
2485
|
}
|
|
2471
|
-
return this.getTypeDefinition(child.getSignature
|
|
2486
|
+
return this.getTypeDefinition(child.getSignature);
|
|
2472
2487
|
case 'Method':
|
|
2473
2488
|
definition = {
|
|
2474
2489
|
callSignature: this.getCallSignatureDefinition(child.signatures[0], this.getCommentTags(child.comment)),
|
|
@@ -2599,38 +2614,58 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2599
2614
|
let parameters;
|
|
2600
2615
|
const extras = {};
|
|
2601
2616
|
if (comment) {
|
|
2602
|
-
if (comment.
|
|
2603
|
-
comment.
|
|
2617
|
+
if (comment.blockTags) {
|
|
2618
|
+
comment.blockTags.forEach((tag) => {
|
|
2604
2619
|
switch (tag.tag) {
|
|
2605
|
-
case 'deprecated':
|
|
2606
|
-
deprecationWarning = tag.
|
|
2620
|
+
case '@deprecated':
|
|
2621
|
+
deprecationWarning = tag.content
|
|
2622
|
+
.map((item) => item.text)
|
|
2623
|
+
.join('')
|
|
2624
|
+
.trim();
|
|
2607
2625
|
break;
|
|
2608
|
-
case 'default':
|
|
2609
|
-
case 'defaultValue':
|
|
2610
|
-
defaultValue = tag.
|
|
2626
|
+
case '@default':
|
|
2627
|
+
case '@defaultValue':
|
|
2628
|
+
defaultValue = tag.content
|
|
2629
|
+
.map((item) => item.text)
|
|
2630
|
+
.join('')
|
|
2631
|
+
.trim();
|
|
2611
2632
|
break;
|
|
2612
|
-
case 'example':
|
|
2613
|
-
codeExample = tag.
|
|
2633
|
+
case '@example':
|
|
2634
|
+
codeExample = tag.content
|
|
2635
|
+
.map((item) => item.text)
|
|
2636
|
+
.join('')
|
|
2637
|
+
.trim()
|
|
2638
|
+
.split('```')[1]
|
|
2639
|
+
.trim();
|
|
2614
2640
|
const language = codeExample.split('\n')[0];
|
|
2615
2641
|
if (language === 'markup' || language === 'typescript') {
|
|
2616
2642
|
codeExample = codeExample.slice(language.length).trim();
|
|
2617
2643
|
codeExampleLanguage = language;
|
|
2618
2644
|
}
|
|
2619
2645
|
break;
|
|
2620
|
-
case 'param':
|
|
2646
|
+
case '@param':
|
|
2621
2647
|
parameters = parameters || [];
|
|
2622
2648
|
parameters.push({
|
|
2623
2649
|
name: tag.param,
|
|
2624
|
-
description: tag.
|
|
2650
|
+
description: tag.content
|
|
2651
|
+
.map((item) => item.text)
|
|
2652
|
+
.join('')
|
|
2653
|
+
.trim(),
|
|
2625
2654
|
});
|
|
2626
2655
|
break;
|
|
2656
|
+
case '@required':
|
|
2657
|
+
extras['required'] = true;
|
|
2658
|
+
break;
|
|
2659
|
+
/* istanbul ignore next */
|
|
2627
2660
|
default:
|
|
2628
|
-
extras[tag.tag] = tag.text;
|
|
2629
2661
|
break;
|
|
2630
2662
|
}
|
|
2631
2663
|
});
|
|
2632
2664
|
}
|
|
2633
|
-
description =
|
|
2665
|
+
description = comment.summary
|
|
2666
|
+
?.map((item) => item.text)
|
|
2667
|
+
.join('')
|
|
2668
|
+
.trim();
|
|
2634
2669
|
}
|
|
2635
2670
|
return {
|
|
2636
2671
|
codeExample,
|
|
@@ -2769,7 +2804,7 @@ class SkyDocsTypeDefinitionsService {
|
|
|
2769
2804
|
console.warn(`Type definitions were not found for location: ${requestedDir}`);
|
|
2770
2805
|
}
|
|
2771
2806
|
typeDefinitions.forEach((item) => {
|
|
2772
|
-
const decorator = item.decorators && item.decorators[0]
|
|
2807
|
+
const decorator = item.decorators && item.decorators[0]?.name;
|
|
2773
2808
|
const kindString = item.kindString;
|
|
2774
2809
|
switch (decorator) {
|
|
2775
2810
|
case 'Component':
|