fix(app): @example correct support

vogloblinsky · vogloblinsky · commit 9a1a7e1dd7a5 · 2022-02-10T21:31:09.000+01:00
fix #1099
diff --git a/src/utils/jsdoc-parser.util.ts b/src/utils/jsdoc-parser.util.ts
@@ -96,14 +96,26 @@ export class JsdocParserUtil {
 
         const CODE_FENCE = /^\s*```(?!.*```)/;
         let inCode = false;
-        function readLine(line: string) {
+        let inExample = false; // first line with @example, end line with empty string or string or */
+        let nbLines = 0;
+        function readLine(line: string, index: number) {
             line = line.replace(/^\s*\*? ?/, '');
             line = line.replace(/\s*$/, '');
 
             if (CODE_FENCE.test(line)) {
                 inCode = !inCode;
             }
 
+            if (line.indexOf('@example') !== -1) {
+                inExample = true;
+                line = '```html';
+            }
+
+            if (inExample && line === '') {
+                inExample = false;
+                line = '```';
+            }
+
             if (!inCode) {
                 const tag = /^@(\S+)/.exec(line);
                 const SeeTag = /^@see/.exec(line);
@@ -123,6 +135,8 @@ export class JsdocParserUtil {
         text = text.replace(/^\s*\/\*+/, '');
         text = text.replace(/\*+\/\s*$/, '');
 
+        nbLines = text.split(/\r\n?|\n/).length;
+
         text.split(/\r\n?|\n/).forEach(readLine);
 
         return comment;
@@ -272,8 +286,15 @@ export class JsdocParserUtil {
                         case SyntaxKind.JSDocLink:
                             if (JSDocNode.name) {
                                 let text = JSDocNode.name.escapedText;
-                                if (text === undefined && JSDocNode.name.left && JSDocNode.name.right) {
-                                    text = JSDocNode.name.left.escapedText + '.' + JSDocNode.name.right.escapedText;
+                                if (
+                                    text === undefined &&
+                                    JSDocNode.name.left &&
+                                    JSDocNode.name.right
+                                ) {
+                                    text =
+                                        JSDocNode.name.left.escapedText +
+                                        '.' +
+                                        JSDocNode.name.right.escapedText;
                                 }
                                 rawDescription += JSDocNode.text + '{@link ' + text + '}';
                             }
diff --git a/test/fixtures/todomvc-ng2/src/app/about/todomvc/todomvc.component.ts b/test/fixtures/todomvc-ng2/src/app/about/todomvc/todomvc.component.ts
@@ -2,6 +2,9 @@ import { Component } from '@angular/core';
 
 /**
  * The todomvc component
+ *
+ * @example
+ * <todomvc>The example of the component</todomvc>
  */
 @Component({
     selector: 'todomvc',
diff --git a/test/src/cli/cli-generation-big-app.spec.ts b/test/src/cli/cli-generation-big-app.spec.ts
@@ -12,6 +12,7 @@ describe('CLI simple generation - big app', () => {
     let searchFuncFile;
 
     let todoComponentFile,
+        todoMVCComponentFile,
         homeComponentFile,
         aboutComponentFile,
         appComponentFile,
@@ -50,6 +51,7 @@ describe('CLI simple generation - big app', () => {
 
         routesIndex = read(`${distFolder}/js/routes/routes_index.js`);
         todoComponentFile = read(`${distFolder}/components/TodoComponent.html`);
+        todoMVCComponentFile = read(`${distFolder}/components/TodoMVCComponent.html`);
         footerComponentFile = read(`${distFolder}/components/FooterComponent.html`);
         homeComponentFile = read(`${distFolder}/components/HomeComponent.html`);
         aboutComponentFile = read(`${distFolder}/components/AboutComponent.html`);
@@ -893,4 +895,10 @@ describe('CLI simple generation - big app', () => {
             '<a href="components/AppComponent.html" data-type="entity-link" >AppComponent</a>'
         );
     });
+
+    it('should support @example', () => {
+        expect(todoMVCComponentFile).to.contain(
+            '">&lt;todomvc&gt;The example of the component&lt;'
+        );
+    });
 });
