@alloy-js/core 0.23.0-dev.9 → 0.23.1

package/dist/dev/test/rendering/formatting.test.js

@@ -0,0 +1,797 @@
+import { createIntrinsic as _$createIntrinsic, createComponent as _$createComponent, memo as _$memo } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { For, Output, render, SourceFile } from "../../src/index.js";
+import "../../testing/extend-expect.js";
+import { d } from "../../testing/render.js";
+describe("group", () => {
+  it("breaks when shouldBreak is passed", () => {
+    expect(_$createIntrinsic("group", {
+      shouldBreak: true,
+      get children() {
+        return ["hi", _$createIntrinsic("sbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 17,
+          columnNumber: 9
+        }), "bye"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 15,
+      columnNumber: 7
+    })).toRenderTo(`
+        hi
+        bye
+      `);
+  });
+});
+describe("indent", () => {
+  it("indents its children", () => {
+    expect(["a", _$createIntrinsic("indent", {
+      get children() {
+        return [_$createIntrinsic("hardline", {}, {
+          fileName: import.meta.url,
+          lineNumber: 34,
+          columnNumber: 11
+        }), "b"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 33,
+      columnNumber: 9
+    })]).toRenderTo(`
+      a
+        b
+    `);
+  });
+});
+describe("dedent and markAsRoot", () => {
+  it("dedents its children", () => {
+    expect(["base", _$createIntrinsic("indent", {
+      get children() {
+        return [_$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 50,
+          columnNumber: 11
+        }), "a", _$createIntrinsic("dedent", {
+          get children() {
+            return [_$createIntrinsic("hardline", {}, {
+              fileName: import.meta.url,
+              lineNumber: 52,
+              columnNumber: 13
+            }), "b"];
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 51,
+          columnNumber: 11
+        })];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 49,
+      columnNumber: 9
+    })]).toRenderTo(`
+    base
+      a
+    b
+    `);
+  });
+});
+describe("dedentToRoot and setRoot", () => {
+  it("dedents to the indent level marked by the root when not marked", () => {
+    expect(["base", _$createIntrinsic("indent", {
+      get children() {
+        return [_$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 70,
+          columnNumber: 11
+        }), "a", _$createIntrinsic("dedentToRoot", {
+          get children() {
+            return [_$createIntrinsic("hbr", {}, {
+              fileName: import.meta.url,
+              lineNumber: 72,
+              columnNumber: 13
+            }), "b"];
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 71,
+          columnNumber: 11
+        })];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 69,
+      columnNumber: 9
+    })]).toRenderTo(`
+    base
+      a
+    b
+    `);
+  });
+  it("dedents to the indent level marked by the root when marked", () => {
+    expect(["base", _$createIntrinsic("indent", {
+      get children() {
+        return [_$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 87,
+          columnNumber: 11
+        }), "root", _$createIntrinsic("markAsRoot", {
+          get children() {
+            return _$createIntrinsic("indent", {
+              get children() {
+                return [_$createIntrinsic("hbr", {}, {
+                  fileName: import.meta.url,
+                  lineNumber: 91,
+                  columnNumber: 15
+                }), "a", _$createIntrinsic("dedentToRoot", {
+                  get children() {
+                    return [_$createIntrinsic("hbr", {}, {
+                      fileName: import.meta.url,
+                      lineNumber: 93,
+                      columnNumber: 17
+                    }), "b"];
+                  }
+                }, {
+                  fileName: import.meta.url,
+                  lineNumber: 92,
+                  columnNumber: 15
+                })];
+              }
+            }, {
+              fileName: import.meta.url,
+              lineNumber: 90,
+              columnNumber: 13
+            });
+          }
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 89,
+          columnNumber: 11
+        })];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 86,
+      columnNumber: 9
+    })]).toRenderTo(`
+    base
+      root
+        a
+      b
+    `);
+  });
+});
+describe("softline", () => {
+  it("breaks to to a new line when needed", () => {
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("softline", {}, {
+          fileName: import.meta.url,
+          lineNumber: 113,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 111,
+      columnNumber: 7
+    })).toRenderTo(`12345678901234567890`, {
+      printWidth: 25
+    });
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("softline", {}, {
+          fileName: import.meta.url,
+          lineNumber: 120,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 118,
+      columnNumber: 7
+    })).toRenderTo(`
+        1234567890
+        1234567890
+      `, {
+      printWidth: 15
+    });
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("sbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 133,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 131,
+      columnNumber: 7
+    })).toRenderTo(`12345678901234567890`, {
+      printWidth: 25
+    });
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("sbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 140,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 138,
+      columnNumber: 7
+    })).toRenderTo(`
+        1234567890
+        1234567890
+      `, {
+      printWidth: 15
+    });
+  });
+});
+describe("hardline", () => {
+  it("always breaks to a new line", () => {
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("hardline", {}, {
+          fileName: import.meta.url,
+          lineNumber: 158,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 156,
+      columnNumber: 7
+    })).toRenderTo(`
+        1234567890
+        1234567890
+      `);
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 170,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 168,
+      columnNumber: 7
+    })).toRenderTo(`
+        1234567890
+        1234567890
+      `);
+  });
+});
+describe("line", () => {
+  it("creates a new line when needed, is otherwise space", () => {
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("line", {}, {
+          fileName: import.meta.url,
+          lineNumber: 187,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 185,
+      columnNumber: 7
+    })).toRenderTo(`1234567890 1234567890`, {
+      printWidth: 25
+    });
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("line", {}, {
+          fileName: import.meta.url,
+          lineNumber: 194,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 192,
+      columnNumber: 7
+    })).toRenderTo(`
+        1234567890
+        1234567890
+      `, {
+      printWidth: 15
+    });
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("br", {}, {
+          fileName: import.meta.url,
+          lineNumber: 207,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 205,
+      columnNumber: 7
+    })).toRenderTo(`1234567890 1234567890`, {
+      printWidth: 25
+    });
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return ["1234567890", _$createIntrinsic("br", {}, {
+          fileName: import.meta.url,
+          lineNumber: 214,
+          columnNumber: 9
+        }), "1234567890"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 212,
+      columnNumber: 7
+    })).toRenderTo(`
+        1234567890
+        1234567890
+      `, {
+      printWidth: 15
+    });
+  });
+});
+describe("literalline", () => {
+  it("always creates a new line", () => {
+    expect(["base", _$createIntrinsic("indent", {
+      get children() {
+        return [_$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 233,
+          columnNumber: 11
+        }), "1234567890", _$createIntrinsic("literalline", {}, {
+          fileName: import.meta.url,
+          lineNumber: 235,
+          columnNumber: 11
+        }), "1234567890", _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 237,
+          columnNumber: 11
+        }), "x"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 232,
+      columnNumber: 9
+    })]).toRenderTo(`
+        base
+          1234567890
+        1234567890
+          x
+      `);
+    expect(["base", _$createIntrinsic("indent", {
+      get children() {
+        return [_$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 252,
+          columnNumber: 11
+        }), "1234567890", _$createIntrinsic("lbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 254,
+          columnNumber: 11
+        }), "1234567890", _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 256,
+          columnNumber: 11
+        }), "x"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 251,
+      columnNumber: 9
+    })]).toRenderTo(`
+        base
+          1234567890
+        1234567890
+          x
+      `);
+  });
+});
+describe("lineSuffix and lineSuffixBoundary", () => {
+  it("adds a line suffix", () => {
+    expect(["hello", _$createIntrinsic("lineSuffix", {
+      children: "// comment"
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 274,
+      columnNumber: 14
+    }), " there", _$createIntrinsic("hbr", {}, {
+      fileName: import.meta.url,
+      lineNumber: 275,
+      columnNumber: 9
+    }), "how", _$createIntrinsic("lineSuffix", {
+      children: "// another comment"
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 276,
+      columnNumber: 12
+    }), " are", " ", _$createIntrinsic("lineSuffixBoundary", {}, {
+      fileName: import.meta.url,
+      lineNumber: 277,
+      columnNumber: 9
+    }), "you"]).toRenderTo(`
+        hello there// comment
+        how are // another comment
+        you
+      `);
+  });
+});
+describe("breakParent", () => {
+  it("breaks the parent group", () => {
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return [_$createIntrinsic("breakParent", {}, {
+          fileName: import.meta.url,
+          lineNumber: 294,
+          columnNumber: 9
+        }), "one", _$createIntrinsic("sbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 296,
+          columnNumber: 9
+        }), "two"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 293,
+      columnNumber: 7
+    })).toRenderTo(`
+        one
+        two
+      `);
+  });
+});
+describe("ifBreak", () => {
+  it("renders the children when broken", () => {
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return _$createIntrinsic("ifBreak", {
+          flatContents: "bye",
+          children: "hi"
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 312,
+          columnNumber: 9
+        });
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 311,
+      columnNumber: 7
+    })).toRenderTo(`bye`);
+  });
+  it("renders the children when not broken", () => {
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return [_$createIntrinsic("ifBreak", {
+          flatContents: "bye",
+          children: "hi"
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 320,
+          columnNumber: 9
+        }), _$createIntrinsic("breakParent", {}, {
+          fileName: import.meta.url,
+          lineNumber: 321,
+          columnNumber: 9
+        })];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 319,
+      columnNumber: 7
+    })).toRenderTo(`hi`);
+  });
+  it("renders flatContents that are elements", () => {
+    function Foo() {
+      return "Foo";
+    }
+    const contents = [_$createComponent(Foo, {}, {
+      fileName: import.meta.url,
+      lineNumber: 332,
+      columnNumber: 9
+    }), _$createComponent(Foo, {}, {
+      fileName: import.meta.url,
+      lineNumber: 333,
+      columnNumber: 9
+    })];
+    expect(_$createIntrinsic("group", {
+      get children() {
+        return _$createIntrinsic("ifBreak", {
+          flatContents: contents,
+          children: "hi"
+        }, {
+          fileName: import.meta.url,
+          lineNumber: 339,
+          columnNumber: 9
+        });
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 338,
+      columnNumber: 7
+    })).toRenderTo(`FooFoo`);
+  });
+  it("works with a group id", () => {
+    const id = Symbol();
+    expect([_$createIntrinsic("group", {
+      id: id,
+      get children() {
+        return ["a", _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 349,
+          columnNumber: 12
+        }), "b", _$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 349,
+          columnNumber: 20
+        })];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 348,
+      columnNumber: 9
+    }), _$createIntrinsic("ifBreak", {
+      groupId: id,
+      children: "c"
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 351,
+      columnNumber: 9
+    })]).toRenderTo(`a\nb\nc`);
+  });
+});
+describe("fill", () => {
+  it("fills the group with its children", () => {
+    const items = ["one", "two", "three", "four", "five", "six"];
+    // place a <br /> after every item except the last
+    const filledItems = items.map((item, index) => [item, _$memo(() => _$memo(() => index < items.length - 1)() && _$createIntrinsic("br", {}, {
+      fileName: import.meta.url,
+      lineNumber: 364,
+      columnNumber: 38
+    }), false, "_$memo(\u2026)(\u2026) && \u2026")]);
+    expect(_$createIntrinsic("fill", {
+      children: filledItems
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 368,
+      columnNumber: 12
+    })).toRenderTo(`one two three four\nfive six`, {
+      printWidth: 20
+    });
+  });
+});
+describe("align", () => {
+  it("aligns contents with a number of spaces", () => {
+    expect(["base", _$createIntrinsic("align", {
+      width: 4,
+      get children() {
+        return [_$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 381,
+          columnNumber: 11
+        }), "hi"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 380,
+      columnNumber: 9
+    })]).toRenderTo(`
+        base
+            hi
+      `);
+  });
+  it("aligns contents with a string", () => {
+    expect(["base", _$createIntrinsic("align", {
+      string: "XXXX",
+      get children() {
+        return [_$createIntrinsic("hbr", {}, {
+          fileName: import.meta.url,
+          lineNumber: 398,
+          columnNumber: 11
+        }), "hi"];
+      }
+    }, {
+      fileName: import.meta.url,
+      lineNumber: 397,
+      columnNumber: 9
+    })]).toRenderTo(`
+        base
+        XXXXhi
+      `);
+  });
+});
+it("all works together", () => {
+  const argCount = 2;
+  const args = Array.from({
+    length: argCount
+  }, (_, i) => `arg${i + 1}`);
+  expect([_$createIntrinsic("group", {
+    get children() {
+      return ["async function foo(", _$createIntrinsic("indent", {
+        get children() {
+          return [_$createIntrinsic("sbr", {}, {
+            fileName: import.meta.url,
+            lineNumber: 419,
+            columnNumber: 11
+          }), _$createComponent(For, {
+            each: args,
+            get joiner() {
+              return [",", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 424,
+                columnNumber: 18
+              })];
+            },
+            children: arg => [arg, ": string"]
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 420,
+            columnNumber: 11
+          })];
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 418,
+        columnNumber: 9
+      }), _$createIntrinsic("sbr", {}, {
+        fileName: import.meta.url,
+        lineNumber: 431,
+        columnNumber: 9
+      }), ")"];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 416,
+    columnNumber: 7
+  }), ": void ", "{", _$createIntrinsic("indent", {
+    get children() {
+      return [_$createIntrinsic("hbr", {}, {
+        fileName: import.meta.url,
+        lineNumber: 435,
+        columnNumber: 9
+      }), "// function body"];
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 434,
+    columnNumber: 7
+  }), _$createIntrinsic("hbr", {}, {
+    fileName: import.meta.url,
+    lineNumber: 438,
+    columnNumber: 7
+  }), "}"]).toRenderTo(`
+    async function foo(arg1: string, arg2: string): void {
+      // function body
+    }
+  `, {
+    printWidth: 80
+  });
+});
+it("formats based on the output component props", () => {
+  const template = _$createComponent(Output, {
+    printWidth: 5,
+    get children() {
+      return _$createComponent(SourceFile, {
+        path: "foo.txt",
+        filetype: "text/plain",
+        get children() {
+          return _$createIntrinsic("group", {
+            get children() {
+              return ["1", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 456,
+                columnNumber: 12
+              }), "2", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 456,
+                columnNumber: 19
+              }), "3", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 456,
+                columnNumber: 26
+              }), "4", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 456,
+                columnNumber: 33
+              }), "5", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 456,
+                columnNumber: 40
+              }), "6"];
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 455,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 454,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 453,
+    columnNumber: 5
+  });
+  const tree = render(template);
+  expect(tree.contents[0].contents).toEqual(d`
+    1
+    2
+    3
+    4
+    5
+    6
+    
+  `);
+});
+it("formats based on the source file component props", () => {
+  const template = _$createComponent(Output, {
+    get children() {
+      return _$createComponent(SourceFile, {
+        path: "foo.txt",
+        filetype: "text/plain",
+        printWidth: 5,
+        get children() {
+          return _$createIntrinsic("group", {
+            get children() {
+              return ["1", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 479,
+                columnNumber: 12
+              }), "2", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 479,
+                columnNumber: 19
+              }), "3", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 479,
+                columnNumber: 26
+              }), "4", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 479,
+                columnNumber: 33
+              }), "5", _$createIntrinsic("br", {}, {
+                fileName: import.meta.url,
+                lineNumber: 479,
+                columnNumber: 40
+              }), "6"];
+            }
+          }, {
+            fileName: import.meta.url,
+            lineNumber: 478,
+            columnNumber: 9
+          });
+        }
+      }, {
+        fileName: import.meta.url,
+        lineNumber: 477,
+        columnNumber: 7
+      });
+    }
+  }, {
+    fileName: import.meta.url,
+    lineNumber: 476,
+    columnNumber: 5
+  });
+  const tree = render(template);
+  expect(tree.contents[0].contents).toEqual(d`
+    1
+    2
+    3
+    4
+    5
+    6
+
+  `);
+});
+//# sourceMappingURL=formatting.test.js.map