fix: preserve newlines in markdown lists (#697)

Author: domoritz

src/AnnotationsReader/ExtendedAnnotationsReader.ts

@@ -45,7 +45,7 @@ export class ExtendedAnnotationsReader extends BasicAnnotationsReader {
 
         return {
             description: comments
-                .map((comment) => comment.text.replace(/\r/g, "").replace(/(?<=[^\n])\n(?=[^\n])/g, " "))
+                .map((comment) => comment.text.replace(/\r/g, "").replace(/(?<=[^\n])\n(?=[^\n*-])/g, " "))
                 .join(" "),
         };
     }

test/config/jsdoc-complex-extended/main.ts

@@ -16,6 +16,10 @@ export interface MyObject {
      *
      * The type of this field is integer.
      *
+     * This is of type
+     * - integer
+     * - number
+     *
      * @title Number field title
      * @exclusiveMaximum 10
      * @multipleOf 3

test/config/jsdoc-complex-extended/schema.json

@@ -14,7 +14,7 @@
         "numberValue": {
           "type": "integer",
           "title": "Number field title",
-          "description": "This field is of integer type. Integer!\n\nThe type of this field is integer.",
+          "description": "This field is of integer type. Integer!\n\nThe type of this field is integer.\n\nThis is of type\n- integer\n- number",
           "exclusiveMaximum": 10,
           "multipleOf": 3
         },

test/utils.ts

@@ -41,19 +41,16 @@ export function assertValidSchema(
         }
 
         const generator = createGenerator(config);
-
         const schema = generator.createSchema(type);
-        const expected: any = JSON.parse(readFileSync(resolve(`${basePath}/${relativePath}/schema.json`), "utf8"));
-        const actual: any = JSON.parse(JSON.stringify(schema));
+        const schemaFile = resolve(`${basePath}/${relativePath}/schema.json`);
 
         if (process.env.UPDATE_SCHEMA) {
-            writeFileSync(
-                resolve(`${basePath}/${relativePath}/schema.json`),
-                stringify(schema, { space: 2 }) + "\n",
-                "utf8"
-            );
+            writeFileSync(schemaFile, stringify(schema, { space: 2 }) + "\n", "utf8");
         }
 
+        const expected: any = JSON.parse(readFileSync(schemaFile, "utf8"));
+        const actual: any = JSON.parse(JSON.stringify(schema));
+
         expect(typeof actual).toBe("object");
         expect(actual).toEqual(expected);
 

test/vega-lite.test.ts

@@ -16,12 +16,13 @@ describe("vega-lite", () => {
 
         const generator = createGenerator(config);
         const schema = generator.createSchema(type);
+        const schemaFile = resolve("test/vega-lite/schema.json");
 
         if (process.env.UPDATE_SCHEMA) {
-            writeFileSync(resolve("test/vega-lite/schema.json"), stringify(schema, { space: 2 }) + "\n", "utf8");
+            writeFileSync(schemaFile, stringify(schema, { space: 2 }) + "\n", "utf8");
         }
 
-        const vegaLiteSchema = JSON.parse(readFileSync(resolve("test/vega-lite/schema.json"), "utf8"));
+        const vegaLiteSchema = JSON.parse(readFileSync(schemaFile, "utf8"));
 
         expect(schema).toEqual(vegaLiteSchema);
     });