fix: wordwrap for jsdoc

Author: maxholman

__tests__/fixtures/petstore/methods.ts

@@ -3,7 +3,7 @@
  *
  * WARN: Do not edit directly.
  *
- * Generated on 2022-10-29T10:44:17.417Z
+ * Generated on 2022-10-29T11:20:35.437Z
  *
  */
 import type {
@@ -17,9 +17,28 @@ import type { Simplify } from 'type-fest';
 
 /**
  * Returns all pets from the system that the user has access to
- * Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
+ * Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem
+ * sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio
+ * lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis,
+ * pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea
+ * dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra
+ * tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit
+ * non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat
+ * venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim
+ * enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor,
+ * consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis
+ * libero sed lacinia.
  *
- * Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
+ * Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu
+ * condimentum ligula luctus nec. Phasellus semper velit eget aliquet
+ * faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem
+ * id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio.
+ * Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et
+ * sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel
+ * tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis
+ * gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi.
+ * Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem.
+ * Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
  * @param parameters.query.tags? {String} tags to filter by
  * @param parameters.query.limit? {String} maximum number of results to return
  * @returns {RequestMethodCaller<Pet[]>} HTTP 200
@@ -38,7 +57,6 @@ export function findPets(parameters?: {
 
 /**
  * Creates a new pet in the store. Duplicates are allowed
- *
  * @param parameters.body {NewPet}
  * @returns {RequestMethodCaller<Pet>} HTTP 200
  * @returns {RequestMethodCaller<Error>} HTTP default
@@ -55,7 +73,8 @@ export function addPet(parameters: {
 }
 
 /**
- * Returns a user based on a single ID, if the user does not have access to the pet
+ * Returns a user based on a single ID, if the user does not have access to
+ * the pet
  * @param id {String} ID of pet to fetch
  * @returns {RequestMethodCaller<Pet>} HTTP 200
  * @returns {RequestMethodCaller<Error>} HTTP default

lib/process-document.ts

@@ -10,12 +10,18 @@ import {
   VariableDeclarationKind,
   Writers,
 } from 'ts-morph';
+import wrap from 'word-wrap';
 import { registerTypesFromSchema, schemaToType } from './process-schema.js';
 import {
   maybeJsDocDescription,
   schemaIsOrHasReferenceObject,
 } from './utils.js';
 
+function wordWrap(text: string) {
+  // max width is 75 as it will be indented already inside a multi-line comment
+  return wrap(text, { width: 75, indent: '' });
+}
+
 export async function processOpenApiDocument(
   entryFile: SourceFile,
   typesFile: SourceFile,
@@ -174,9 +180,11 @@ export async function processOpenApiDocument(
           });
 
           const jsdoc = func.addJsDoc({
-            description: `${
-              operationObject.description || operationObject.operationId
-            }\n\n`,
+            description: wordWrap(
+              `\n${
+                operationObject.description || operationObject.operationId
+              }\n\n`,
+            ),
           });
 
           if (operationObject.deprecated) {
@@ -217,9 +225,11 @@ export async function processOpenApiDocument(
 
               jsdoc.addTag({
                 tagName: 'param',
-                text: `${parameterName} {String} ${
-                  parameter.description || ''
-                }`.trim(),
+                text: wordWrap(
+                  `${parameterName} {String} ${
+                    resolvedParameter.description || ''
+                  }`,
+                ).trim(),
               });
             }
 

package.json

@@ -28,6 +28,7 @@
     "json-schema-ref-parser": "^9.0.9",
     "ts-morph": "^16.0.0",
     "type-fest": "^3.1.0",
+    "word-wrap": "^1.2.3",
     "yargs": "^17.6.0"
   },
   "devDependencies": {