@travetto/transformer 8.0.0-alpha.10 → 8.0.0-alpha.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/transformer",
-  "version": "8.0.0-alpha.10",
+  "version": "8.0.0-alpha.11",
   "type": "module",
   "description": "Functionality for AST transformations, with transformer registration, and general utils",
   "keywords": [
@@ -25,7 +25,7 @@
     "directory": "module/transformer"
   },
   "dependencies": {
-    "@travetto/manifest": "^8.0.0-alpha.7",
+    "@travetto/manifest": "^8.0.0-alpha.8",
     "tslib": "^2.8.1",
     "typescript": "^6.0.3"
   },

package/src/resolver/service.ts

@@ -148,7 +148,7 @@ export class SimpleResolver implements TransformResolver {
         result.templateTypeName = context?.templateTypeName;
 
         try {
-          result.comment = DocUtil.describeDocs(type).description;
+          result.description = DocUtil.describeDocs(type).description;
         } catch { }
 
         if ('tsTypeArguments' in result) {

package/src/resolver/types.ts

@@ -18,7 +18,11 @@ export interface Type<K extends string> {
   /**
    * JS Doc comment
    */
-  comment?: string;
+  description?: string;
+  /**
+   * JS Doc examples
+   */
+  examples?: string[];
   /**
    * Can be undefined
    */

package/src/types/shared.ts

@@ -14,6 +14,7 @@ export interface ParamDocumentation {
 export interface DeclDocumentation {
   return?: string;
   description?: string;
+  examples?: string[];
   params?: ParamDocumentation[];
 }
 

package/src/util/doc.ts

@@ -32,15 +32,17 @@ export class DocUtil {
     const out: DeclDocumentation = {
       description: undefined,
       return: undefined,
+      examples: undefined,
       params: []
     };
 
     if (toDescribe) {
-      const tags = ts.getJSDocTags(toDescribe);
       while (!this.hasJSDoc(toDescribe) && CoreUtil.hasOriginal(toDescribe)) {
         toDescribe = transformCast<ts.Declaration>(toDescribe.original);
       }
 
+      const tags = ts.getJSDocTags(toDescribe);
+
       const docs = this.hasJSDoc(toDescribe) ? toDescribe.jsDoc : undefined;
 
       if (docs) {
@@ -59,6 +61,8 @@ export class DocUtil {
               name: tag.name && tag.name.getText(),
               description: this.getDocComment(tag, '')!
             });
+          } else if (tag.tagName.getText() === 'example') {
+            (out.examples ??= []).push(this.getDocComment(tag, '')!);
           }
         }
       }