fix: long union type

issue: #181
hosseinmd · Oct 5, 2023 · 4f9ba4c · 4f9ba4c
1 parent 2f5de4f
commit 4f9ba4c
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 4 deletions.
diff --git a/src/utils.ts b/src/utils.ts
@@ -108,9 +108,12 @@ async function formatType(type: string, options?: Options): Promise<string> {
       filepath: "file.ts",
     });
     pretty = pretty.slice(TYPE_START.length);
-    pretty = pretty.replace(/^\s*/g, "");
-    pretty = pretty.replace(/[;\n]*$/g, "");
-    pretty = pretty.trim();
+
+    pretty = pretty
+      .replace(/^\s*/g, "")
+      .replace(/[;\n]*$/g, "")
+      .replace(/^\|/g, "")
+      .trim();
 
     if (rest) {
       pretty = "..." + pretty.replace(/\[\s*\]$/, "");

diff --git a/tests/__snapshots__/typeScript.test.ts.snap b/tests/__snapshots__/typeScript.test.ts.snap
@@ -49,9 +49,26 @@ export let User;
 "
 `;
 
+exports[`Long type Union types 1`] = `
+"/**
+ * Gets a configuration object assembled from environment variables and .env
+ * configuration files.
+ *
+ * @memberof Config
+ * @function getEnvConfig
+ * @returns {Config.SomeConfiguration
+ *   | Config.SomeOtherConfiguration
+ *   | Config.AnotherConfiguration
+ *   | Config.YetAnotherConfiguration}
+ *   The environment configuration
+ */
+export default () => configurator.config;
+"
+`;
+
 exports[`Union types 1`] = `
 "/**
- * @typedef {| { foo: string }
+ * @typedef {{ foo: string }
  *   | { bar: string; manyMoreLongArguments: object }
  *   | { baz: string }} Foo
  */

diff --git a/tests/typeScript.test.ts b/tests/typeScript.test.ts
@@ -175,3 +175,18 @@ test("Union types", async () => {
 
   expect(result).toMatchSnapshot();
 });
+
+test("Long type Union types", async () => {
+  const result = await subject(`
+  /**
+   * Gets a configuration object assembled from environment variables and .env configuration files.
+   *
+   * @memberof Config
+   * @function getEnvConfig
+   * @returns {Config.SomeConfiguration | Config.SomeOtherConfiguration | Config.AnotherConfiguration | Config.YetAnotherConfiguration } The environment configuration
+   */
+  export default () => configurator.config;
+`);
+
+  expect(result).toMatchSnapshot();
+});