@alloy-js/go 0.0.1

package/src/components/SourceDirectory.tsx

@@ -0,0 +1,32 @@
+import {
+  SourceDirectory as CoreSourceDirectory,
+  SourceDirectoryProps as CoreSourceDirectoryProps,
+  Scope,
+  SourceDirectoryContext,
+  useContext,
+} from "@alloy-js/core";
+import { basename, join } from "pathe";
+import { useModule } from "../scopes/module.js";
+import { createGoPackageScope } from "../scopes/package.js";
+import { createPackageSymbol } from "../symbols/factories.js";
+
+export interface SourceDirectoryProps extends CoreSourceDirectoryProps {
+  name?: string;
+}
+
+export function SourceDirectory(props: SourceDirectoryProps) {
+  const mod = useModule();
+  const directoryContext = useContext(SourceDirectoryContext)!;
+  const currentDir = join(directoryContext.path, props.path);
+  const dname = basename(currentDir);
+  const modName = mod ? basename(mod.name) : "main";
+  const packageName = props.name ?? (dname === "." ? modName : dname);
+  const packageSymbol = createPackageSymbol(packageName, props.path);
+  const packageScope = createGoPackageScope(packageSymbol);
+
+  return (
+    <CoreSourceDirectory path={props.path}>
+      <Scope value={packageScope}>{props.children}</Scope>;
+    </CoreSourceDirectory>
+  );
+}

package/src/components/SourceFile.tsx

@@ -0,0 +1,74 @@
+import {
+  SourceFile as CoreSourceFile,
+  Scope,
+  Show,
+  SourceDirectoryContext,
+  useContext,
+  type Children,
+} from "@alloy-js/core";
+import { join } from "pathe";
+import { usePackage } from "../scopes/package.js";
+import { GoSourceFileScope } from "../scopes/source-file.js";
+import { ImportStatements } from "./ImportStatement.js";
+import { Reference } from "./Reference.js";
+import { LineComment } from "./doc/comment.js";
+
+export interface SourceFileProps {
+  path: string;
+  package?: string;
+  children?: Children;
+  header?: Children;
+  headerComment?: string;
+  export?: boolean | string;
+}
+
+export function SourceFile(props: SourceFileProps) {
+  const pkg = usePackage();
+  const directoryContext = useContext(SourceDirectoryContext)!;
+  const currentDir = directoryContext.path;
+  const path: string = join(currentDir, props.path);
+  const scope = new GoSourceFileScope(path, pkg);
+
+  const header = (
+    <SourceFileHeader
+      package={pkg?.ownerSymbol.name ?? "main"}
+      header={props.header}
+      headerComment={props.headerComment}
+    />
+  );
+
+  return (
+    <CoreSourceFile
+      path={props.path}
+      filetype="go"
+      reference={Reference}
+      header={header}
+    >
+      <Show when={scope.imports.size > 0}>
+        <ImportStatements records={scope.imports} />
+        <hbr />
+        <hbr />
+      </Show>
+      <Scope value={scope}>{props.children}</Scope>
+    </CoreSourceFile>
+  );
+}
+
+export interface SourceFileHeaderProps {
+  package: string;
+  header?: Children;
+  headerComment?: string;
+}
+
+function SourceFileHeader(props: SourceFileHeaderProps) {
+  return (
+    <>
+      <Show when={props.headerComment !== undefined}>
+        <LineComment>{props.headerComment}</LineComment>
+      </Show>
+      <Show when={props.header !== undefined}>{props.header}</Show>
+      package {props.package}
+      <hbr />
+    </>
+  );
+}

package/src/components/doc/comment.test.tsx

@@ -0,0 +1,278 @@
+import { List, Prose } from "@alloy-js/core";
+import "@alloy-js/core/testing";
+import { d } from "@alloy-js/core/testing";
+import { describe, expect, it } from "vitest";
+import { BlockComment, LineComment } from "./comment.jsx";
+
+describe("GoLineComment", () => {
+  it("formats properly a simple comment", () => {
+    const template = (
+      <>
+        <LineComment>Hello!</LineComment>
+        <hbr />
+        Should not be part of the comment
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        // Hello!
+        Should not be part of the comment
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("should not add extra line breaks", () => {
+    const template = (
+      <>
+        <List hardline>
+          <LineComment>
+            Hello!
+            <hbr />
+            <hbr />
+            This is another line
+          </LineComment>
+        </List>
+        <hbr />
+        Hello
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        // Hello!
+        //
+        // This is another line
+        Hello
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("formats properly multiple children", () => {
+    const template = (
+      <>
+        <LineComment>
+          <Prose>Hello!</Prose>
+          <hbr />
+          <hbr />
+          <Prose>This is another line</Prose>
+        </LineComment>
+        <hbr />
+        foo should be outside the comment
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        // Hello!
+        //
+        // This is another line
+        foo should be outside the comment
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("It correctly do word wrapping", () => {
+    const template = (
+      <>
+        <LineComment>
+          <Prose>
+            This is a very long line that should be broken into multiple lines.
+            It should also be aligned properly. The line breaks in this
+            paragraph should not be carried over into the JSDoc comment.
+          </Prose>
+        </LineComment>
+        <hbr />
+        <>This should not be part of the comment</>
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        // This is a very long line that should
+        // be broken into multiple lines. It
+        // should also be aligned properly. The
+        // line breaks in this paragraph should
+        // not be carried over into the JSDoc
+        // comment.
+        This should not be part of the comment
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("formats properly", () => {
+    const template = (
+      <LineComment>
+        <Prose>
+          This is a long paragraph that should end up being broken into multiple
+          paragraphs. Moreover, the line breaks in this paragraph should not be
+          carried over into the JSDoc comment.
+        </Prose>
+        <hbr />
+        <hbr />
+        <Prose>
+          This is another paragraph. There should be a couple breaks in front of
+          it.
+        </Prose>
+      </LineComment>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        // This is a long paragraph that should
+        // end up being broken into multiple
+        // paragraphs. Moreover, the line breaks
+        // in this paragraph should not be
+        // carried over into the JSDoc comment.
+        //
+        // This is another paragraph. There
+        // should be a couple breaks in front of
+        // it.
+      `,
+      { printWidth: 40 },
+    );
+  });
+});
+
+describe("GoBlockComment", () => {
+  it("formats properly a simple comment", () => {
+    const template = (
+      <>
+        <BlockComment>Hello!</BlockComment>
+        <hbr />
+        Should not be part of the comment
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        /*
+        Hello!
+        */
+        Should not be part of the comment
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("should not add extra line breaks", () => {
+    const template = (
+      <>
+        <List hardline>
+          <BlockComment>
+            <Prose>Hello!</Prose>
+            <Prose>World!</Prose>
+            <Prose>This is another line</Prose>
+          </BlockComment>
+        </List>
+        <hbr />
+        Hello
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        /*
+        Hello!
+
+        World!
+
+        This is another line
+        */
+        Hello
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("formats properly multiple children", () => {
+    const template = (
+      <>
+        <BlockComment>
+          <Prose>Hello!</Prose>
+          <Prose>This is another line</Prose>
+        </BlockComment>
+        <hbr />
+        foo should be outside the comment
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        /*
+        Hello!
+
+        This is another line
+        */
+        foo should be outside the comment
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("It correctly do word wrapping", () => {
+    const template = (
+      <>
+        <BlockComment>
+          <Prose>
+            This is a very long line that should be broken into multiple lines.
+            It should also be aligned properly. The line breaks in this
+            paragraph should not be carried over into the JSDoc comment.
+          </Prose>
+        </BlockComment>
+        <hbr />
+        <>This should not be part of the comment</>
+      </>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        /*
+        This is a very long line that should be
+        broken into multiple lines. It should
+        also be aligned properly. The line
+        breaks in this paragraph should not be
+        carried over into the JSDoc comment.
+        */
+        This should not be part of the comment
+      `,
+      { printWidth: 40 },
+    );
+  });
+
+  it("formats properly", () => {
+    const template = (
+      <BlockComment>
+        <Prose>
+          This is a long paragraph that should end up being broken into multiple
+          paragraphs. Moreover, the line breaks in this paragraph should not be
+          carried over into the JSDoc comment.
+        </Prose>
+        <Prose>
+          This is another paragraph. There should be a couple breaks in front of
+          it.
+        </Prose>
+      </BlockComment>
+    );
+
+    expect(template).toRenderTo(
+      d`
+        /*
+        This is a long paragraph that should end
+        up being broken into multiple
+        paragraphs. Moreover, the line breaks in
+        this paragraph should not be carried
+        over into the JSDoc comment.
+        
+        This is another paragraph. There should
+        be a couple breaks in front of it.
+        */
+      `,
+      { printWidth: 40 },
+    );
+  });
+});

package/src/components/doc/comment.tsx

@@ -0,0 +1,40 @@
+import { List, childrenArray, type Children } from "@alloy-js/core";
+
+export interface BlockCommentProps {
+  children: Children;
+}
+
+/**
+ * A Go block comment. In go, line comments are the norm, so consider
+ * using {@link LineComment} instead. The children of this component
+ * are joined with two hard linebreaks. This is useful for creating
+ * block comments with multiple paragraphs.
+ */
+export function BlockComment(props: BlockCommentProps) {
+  return (
+    <>
+      /*
+      <hbr />
+      <List doubleHardline>{childrenArray(() => props.children)}</List>
+      <hbr />
+      */
+    </>
+  );
+}
+
+export interface LineCommentProps {
+  children: Children;
+}
+
+/**
+ * A Go line comment block. The children of this component
+ * are joined with two hard linebreaks. This is useful for creating
+ * line comments with multiple paragraphs.
+ */
+export function LineComment(props: LineCommentProps) {
+  return (
+    <>
+      // <align string="// ">{props.children}</align>
+    </>
+  );
+}