feat(code-gen): add expected patterns to docs if no docs exist on `T.…

…uuid()`, `T.date().{timeOnly,dateOnly}()`
compasjs · May 14, 2023 · 41e3e3f · 41e3e3f
1 parent 9744e6c
commit 41e3e3f
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/packages/code-gen/src/processors/doc-string.js b/packages/code-gen/src/processors/doc-string.js
@@ -20,6 +20,19 @@ export function docStringCleanup(generateContext) {
 
           type.docString = normalizeIndentationAndTrim(src);
 
+          if (type.docString.trim().length === 0) {
+            // Add default patterns to the doc string.
+            if (type.type === "date") {
+              if (type.specifier === "dateOnly") {
+                type.docString = `Expected pattern: yyyy-MM-dd`;
+              } else if (type.specifier === "timeOnly") {
+                type.docString = `Expected pattern: HH:mm(:ss(.SSS))`;
+              }
+            } else if (type.type === "uuid") {
+              type.docString += `Expected pattern: UUID (v4)`;
+            }
+          }
+
           callback(type);
         }
       },