Merge pull request #14771 from lukasmatta/fix/14770-api-generator

Fixed #14770 - api-generator problem
primefaces · Mar 28, 2024 · 3d7db6f · 3d7db6f
2 parents eed5029 + 52c76ba
commit 3d7db6f
Show file tree

Hide file tree

Showing 4 changed files with 126 additions and 40 deletions.
diff --git a/api-generator/build-apidoc.ts b/api-generator/build-apidoc.ts
@@ -46,6 +46,11 @@ async function main() {
             return text.replace(/&#123;/g, '{').replace(/&#125;/g, '}');
         };
 
+        const getDeprecatedText = (signature) => {
+            const deprecatedTag = signature?.comment?.getTag('@deprecated');
+            return deprecatedTag ? parseText(deprecatedTag.content[0].text) : undefined;
+        };
+
         const modules = project.groups.find((g) => g.title === 'Modules');
 
         if (isProcessable(modules)) {
@@ -89,13 +94,10 @@ async function main() {
                                             readonly: prop.flags.isReadonly,
                                             type: prop.getSignature && prop.getSignature.type ? prop.getSignature.type.toString() : prop.type ? prop.type.toString() : null,
                                             default: prop.type && prop.type.name === 'boolean' && !prop.defaultValue ? 'false' : prop.defaultValue ? prop.defaultValue.replace(/^'|'$/g, '') : undefined,
-                                            description: prop.getSignature && prop.getSignature.comment ? prop.getSignature.comment.summary.map((s) => s.text || '').join(' ') : prop.comment && prop.comment.summary.map((s) => s.text || '').join(' '),
-                                            deprecated:
-                                                prop.getSignature && prop.getSignature.comment && prop.getSignature.comment.getTag('@deprecated')
-                                                    ? parseText(prop.getSignature.comment.getTag('@deprecated').content[0].text)
-                                                    : prop.comment && prop.comment.getTag('@deprecated')
-                                                    ? parseText(prop.comment.getTag('@deprecated').content[0].text)
-                                                    : undefined
+                                            description: ((prop.getSignature?.comment?.summary || prop.setSignature?.comment?.summary) || prop.comment?.summary)?.map((s) => s.text || '').join(' '),
+                                            deprecated: getDeprecatedText(prop.getSignature)
+                                                || getDeprecatedText(prop.setSignature)
+                                                || getDeprecatedText(prop)
                                         });
                                     });
                                     doc[name]['components'][componentName]['props'] = props;
@@ -113,7 +115,7 @@ async function main() {
                                             name: emitter.name,
                                             parameters: [{ name: extractParameter(emitter) && extractParameter(emitter).includes('Event') ? 'event' : 'value', type: extractParameter(emitter) }],
                                             description: emitter.comment && emitter.comment.summary.map((s) => s.text || '').join(' '),
-                                            deprecated: emitter.comment && emitter.comment.getTag('@deprecated') ? parseText(emitter.comment.getTag('@deprecated').content[0].text) : undefined
+                                            deprecated: getDeprecatedText(emitter)
                                         });
                                     });
 
@@ -164,7 +166,7 @@ async function main() {
                                                     readonly: child.flags.isReadonly,
                                                     type: child.type && child.type.toString(),
                                                     description: child.comment && child.comment.summary.map((s) => s.text || '').join(' '),
-                                                    deprecated: child.comment && child.comment.getTag('@deprecated') ? parseText(child.comment.getTag('@deprecated').content[0].text) : undefined
+                                                    deprecated: getDeprecatedText(child)
                                                 }))
                                         });
                                     });
@@ -192,7 +194,7 @@ async function main() {
                                             readonly: child.flags.isReadonly,
                                             type: child.type && child.type.toString(),
                                             description: child.comment && child.comment.summary.map((s) => s.text || '').join(' '),
-                                            deprecated: child.comment && child.comment.getTag('@deprecated') ? parseText(child.comment.getTag('@deprecated').content[0].text) : undefined
+                                            deprecated: getDeprecatedText(child)
                                         }))
                                 });
                             });
@@ -243,7 +245,7 @@ async function main() {
                                             };
                                         }),
                                         description: signature.comment && signature.comment.summary.map((s) => s.text || '').join(' '),
-                                        deprecated: signature.comment && signature.comment.getTag('@deprecated') ? parseText(signature.comment.getTag('@deprecated').content[0].text) : undefined
+                                        deprecated: getDeprecatedText(signature)
                                     });
                                 });
                             });
@@ -269,7 +271,7 @@ async function main() {
                                             readonly: child.flags.isReadonly,
                                             type: child.type ? child.type.toString() : extractParameter(int),
                                             description: child.comment && child.comment.summary.map((s) => s.text || '').join(' '),
-                                            deprecated: child.comment && child.comment.getTag('@deprecated') ? parseText(child.comment.getTag('@deprecated').content[0].text) : undefined
+                                            deprecated: getDeprecatedText(child)
                                         }))
                                 });
                             });

diff --git a/package.json b/package.json
@@ -89,4 +89,4 @@
         "@docsearch/js": "^3.3.4",
         "esbuild": "^0.19.8"
     }
-}
+}
diff --git a/src/app/components/api/messageservice.ts b/src/app/components/api/messageservice.ts
@@ -23,7 +23,7 @@ export class MessageService {
         }
     }
     /**
-     * Insterts new messages.
+     * Inserts new messages.
      * @param {Message[]} messages - Messages to be added.
      * @group Method
      */
-Original file line number
+Diff line change
@@ Expand Up / @@ -89,4 +89,4 @@ @@
             "@docsearch/js": "^3.3.4",
             "esbuild": "^0.19.8"
         }
-    }
+    }