@alloy-js/csharp 0.18.0-dev.2 → 0.18.0-dev.21

package/dist/src/components/doc/comment.test.js

@@ -0,0 +1,348 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { DocC, DocCode, DocComment, DocDescription, DocExample, DocException, DocInclude, DocList, DocPara, DocParam, DocParamRef, DocPermission, DocRemarks, DocReturns, DocSee, DocSeeAlso, DocSummary, DocTypeParam, DocTypeParamRef, DocValue } from "./comment.js";
+it("define summary", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocSummary, {
+        children: "This is a sample doc comment"
+      });
+    }
+  })).toRenderTo(`
+    /// <summary>
+    /// This is a sample doc comment
+    /// </summary>
+  `);
+});
+it("define code", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocCode, {
+        children: "code sample"
+      });
+    }
+  })).toRenderTo(`
+    /// <code>
+    /// code sample
+    /// </code>
+  `);
+});
+it("define c", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocC, {
+        children: "inline code"
+      });
+    }
+  })).toRenderTo(`
+    /// <c>inline code</c>
+  `);
+});
+it("define example", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocExample, {
+        children: "example usage"
+      });
+    }
+  })).toRenderTo(`
+    /// <example>
+    /// example usage
+    /// </example>
+  `);
+});
+it("define exception", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocException, {
+        children: "exception info"
+      });
+    }
+  })).toRenderTo(`
+    /// <exception>
+    /// exception info
+    /// </exception>
+  `);
+});
+it("define include", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocInclude, {
+        file: "external.xml",
+        path: "/doc/summary"
+      });
+    }
+  })).toRenderTo(`
+    /// <include file="external.xml" path="/doc/summary" />
+  `);
+});
+it("define param", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocParam, {
+        name: "x",
+        children: "parameter x"
+      });
+    }
+  })).toRenderTo(`
+    /// <param name="x">parameter x</param>
+  `);
+});
+it("define typeparam", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocTypeParam, {
+        name: "T",
+        children: "type parameter T"
+      });
+    }
+  })).toRenderTo(`
+    /// <typeparam name="T">type parameter T</typeparam>
+  `);
+});
+it("define returns", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocReturns, {
+        children: "return value"
+      });
+    }
+  })).toRenderTo(`
+    /// <returns>
+    /// return value
+    /// </returns>
+  `);
+});
+it("define remarks", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocRemarks, {
+        children: "remarks here"
+      });
+    }
+  })).toRenderTo(`
+    /// <remarks>
+    /// remarks here
+    /// </remarks>
+  `);
+});
+it("define value", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocValue, {
+        children: "property value"
+      });
+    }
+  })).toRenderTo(`
+    /// <value>
+    /// property value
+    /// </value>
+  `);
+});
+it("define permission", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocPermission, {
+        children: "permission info"
+      });
+    }
+  })).toRenderTo(`
+    /// <permission>
+    /// permission info
+    /// </permission>
+  `);
+});
+it("define list", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocList, {
+        type: "bullet",
+        items: ["item 1", "item 2", "item 3"]
+      });
+    }
+  })).toRenderTo(`
+    /// <list type="bullet">
+    ///   <item><description>item 1</description></item>
+    ///   <item><description>item 2</description></item>
+    ///   <item><description>item 3</description></item>
+    /// </list>
+  `);
+});
+it("define description", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocDescription, {
+        children: "description content"
+      });
+    }
+  })).toRenderTo(`
+    /// <description>
+    /// description content
+    /// </description>
+  `);
+});
+it("define para", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocPara, {
+        children: "paragraph content"
+      });
+    }
+  })).toRenderTo(`
+    /// <para>
+    /// paragraph content
+    /// </para>
+  `);
+});
+describe("define see", () => {
+  it("with cref", () => {
+    expect(_$createComponent(DocComment, {
+      get children() {
+        return _$createComponent(DocSee, {
+          cref: "T:MyType"
+        });
+      }
+    })).toRenderTo(`
+      /// <see cref="T:MyType" />
+    `);
+  });
+  it("with href", () => {
+    expect(_$createComponent(DocComment, {
+      get children() {
+        return _$createComponent(DocSee, {
+          href: "https://github.com"
+        });
+      }
+    })).toRenderTo(`
+      /// <see href="https://github.com" />
+    `);
+  });
+  it("with href and children", () => {
+    expect(_$createComponent(DocComment, {
+      get children() {
+        return _$createComponent(DocSee, {
+          href: "https://github.com",
+          children: "GitHub"
+        });
+      }
+    })).toRenderTo(`
+      /// <see href="https://github.com">GitHub</see>
+    `);
+  });
+  it("with langword", () => {
+    expect(_$createComponent(DocComment, {
+      get children() {
+        return _$createComponent(DocSee, {
+          langword: "keyword"
+        });
+      }
+    })).toRenderTo(`
+      /// <see langword="keyword" />
+    `);
+  });
+});
+describe("define seealso", () => {
+  it("with cref", () => {
+    expect(_$createComponent(DocComment, {
+      get children() {
+        return _$createComponent(DocSeeAlso, {
+          cref: "T:OtherType"
+        });
+      }
+    })).toRenderTo(`
+      /// <seealso cref="T:OtherType" />
+    `);
+  });
+  it("with href", () => {
+    expect(_$createComponent(DocComment, {
+      get children() {
+        return _$createComponent(DocSeeAlso, {
+          href: "https://github.com"
+        });
+      }
+    })).toRenderTo(`
+      /// <seealso href="https://github.com" />
+    `);
+  });
+  it("with children", () => {
+    expect(_$createComponent(DocComment, {
+      get children() {
+        return _$createComponent(DocSeeAlso, {
+          cref: "T:OtherType",
+          children: "OtherType"
+        });
+      }
+    })).toRenderTo(`
+      /// <seealso cref="T:OtherType">OtherType</seealso>
+    `);
+  });
+});
+it("define paramref", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocParamRef, {
+        name: "x"
+      });
+    }
+  })).toRenderTo(`
+    /// <paramref name="${"x"}" />
+  `);
+});
+it("define typeparamref", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocTypeParamRef, {
+        name: "T"
+      });
+    }
+  })).toRenderTo(`
+    /// <typeparamref name="T" />
+  `);
+});
+it("wrap long summary", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return _$createComponent(DocSummary, {
+        children: "This is a very long sample doc comment that exceeds the typical line length limit and should be wrapped appropriately in the generated documentation."
+      });
+    }
+  })).toRenderTo(`
+    /// <summary>
+    /// This is a very long sample doc comment that exceeds the typical line length limit
+    /// and should be wrapped appropriately in the generated documentation.
+    /// </summary>
+  `);
+});
+it("combine multiple tags", () => {
+  expect(_$createComponent(DocComment, {
+    get children() {
+      return [_$createComponent(DocSummary, {
+        children: "This operator determines whether two Points have the same location."
+      }), _$createComponent(DocParam, {
+        name: "p1",
+        children: "The first Point to be compared."
+      }), _$createComponent(DocParam, {
+        name: "p2",
+        children: "The second Point to be compared."
+      }), _$createComponent(DocReturns, {
+        children: "True if the Points do not have the same location and the exact same type; otherwise, false."
+      }), _$createComponent(DocSeeAlso, {
+        cref: "Equals"
+      }), _$createComponent(DocSeeAlso, {
+        cref: "operator=="
+      })];
+    }
+  })).toRenderTo(`
+    /// <summary>
+    /// This operator determines whether two Points have the same location.
+    /// </summary>
+    /// <param name="p1">The first Point to be compared.</param>
+    /// <param name="p2">The second Point to be compared.</param>
+    /// <returns>
+    /// True if the Points do not have the same location and the exact same type; otherwise,
+    /// false.
+    /// </returns>
+    /// <seealso cref="Equals" />
+    /// <seealso cref="operator==" />
+  `);
+});

package/dist/src/components/doc/from-markdown.d.ts

@@ -0,0 +1,6 @@
+export interface DocFromMarkdownProps {
+    markdown: string;
+}
+/** Convert markdown to a Csharp doc comment */
+export declare function DocFromMarkdown(props: DocFromMarkdownProps): import("@alloy-js/core/jsx-runtime").Children;
+//# sourceMappingURL=from-markdown.d.ts.map

package/dist/src/components/doc/from-markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"from-markdown.d.ts","sourceRoot":"","sources":["../../../../src/components/doc/from-markdown.tsx"],"names":[],"mappings":"AAGA,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,+CAA+C;AAC/C,wBAAgB,eAAe,CAAC,KAAK,EAAE,oBAAoB,iDAG1D"}

package/dist/src/components/doc/from-markdown.js

@@ -0,0 +1,58 @@
+import { memo as _$memo, createComponent as _$createComponent, createIntrinsic as _$createIntrinsic } from "@alloy-js/core/jsx-runtime";
+import { marked } from "marked";
+import { DocC, DocCode, DocList, DocSee } from "./comment.js";
+/** Convert markdown to a Csharp doc comment */
+export function DocFromMarkdown(props) {
+  const tokens = marked.lexer(props.markdown);
+  return renderTokens(tokens);
+}
+function renderTokens(tokens) {
+  return [_$memo(() => tokens.map((token, index) => [_$createComponent(DocFromMarkedToken, {
+    token: token
+  }), _$memo(() => _$memo(() => !!(token.type === "paragraph" && index !== tokens.length - 1))() && _$createIntrinsic("br", {}))]))];
+}
+function DocFromMarkedToken(props) {
+  const {
+    token
+  } = props;
+  switch (token.type) {
+    case "paragraph":
+      return token.tokens ? renderTokens(token.tokens) : null;
+    case "code":
+      return _$createComponent(DocCode, {
+        get children() {
+          return token.text;
+        }
+      });
+    case "codespan":
+      return _$createComponent(DocC, {
+        get children() {
+          return token.text;
+        }
+      });
+    case "list":
+      return _$createComponent(DocList, {
+        get type() {
+          return token.ordered ? "number" : "bullet";
+        },
+        get items() {
+          return token.items.map(x => [_$memo(() => renderTokens(x.tokens))]);
+        }
+      });
+    case "link":
+      return _$createComponent(DocSee, {
+        get href() {
+          return token.href;
+        },
+        get children() {
+          return _$memo(() => !!token.tokens)() && renderTokens(token.tokens);
+        }
+      });
+    case "strong":
+    case "em":
+      return token.text;
+    case "text":
+    default:
+      return token.raw;
+  }
+}

package/dist/src/components/doc/from-markdown.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=from-markdown.test.d.ts.map

package/dist/src/components/doc/from-markdown.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"from-markdown.test.d.ts","sourceRoot":"","sources":["../../../../src/components/doc/from-markdown.test.tsx"],"names":[],"mappings":""}

package/dist/src/components/doc/from-markdown.test.js

@@ -0,0 +1,83 @@
+import { createComponent as _$createComponent } from "@alloy-js/core/jsx-runtime";
+import { d } from "@alloy-js/core/testing";
+import { describe, expect, it } from "vitest";
+import { DocFromMarkdown } from "./from-markdown.js";
+it("convert code block to <code>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        Some markdown with code
+        \`\`\`csharp
+        var foo = "bar";
+        \`\`\`
+    `
+  })).toRenderTo(`
+    Some markdown with code
+    <code>
+    var foo = "bar";
+    </code>
+  `);
+});
+it("convert inline code block to <c>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        Some markdown with \`inline\` code
+    `
+  })).toRenderTo(`
+    Some markdown with <c>inline</c> code
+  `);
+});
+it("convert link to <see>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        Some markdown with [link](https://example.com)
+    `
+  })).toRenderTo(`
+    Some markdown with <see href="https://example.com">link</see>
+  `);
+});
+it("convert bullet list to <list>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        - Item 1
+        - Item 2
+        - Item 3
+    `
+  })).toRenderTo(`
+    <list type="bullet">
+      <item><description>Item 1</description></item>
+      <item><description>Item 2</description></item>
+      <item><description>Item 3</description></item>
+    </list>
+  `);
+});
+it("convert numbered list to <list>", () => {
+  expect(_$createComponent(DocFromMarkdown, {
+    markdown: d`
+        1. Item 1
+        2. Item 2
+        3. Item 3
+    `
+  })).toRenderTo(`
+    <list type="number">
+      <item><description>Item 1</description></item>
+      <item><description>Item 2</description></item>
+      <item><description>Item 3</description></item>
+    </list>
+  `);
+});
+describe("strip unsupported elements", () => {
+  it("bold", () => {
+    expect(_$createComponent(DocFromMarkdown, {
+      markdown: d`
+        Some markdown with **bold** text
+    `
+    })).toRenderTo(`Some markdown with bold text`);
+  });
+  it("italic", () => {
+    expect(_$createComponent(DocFromMarkdown, {
+      markdown: d`
+        Some markdown with *italic* text
+    `
+    })).toRenderTo(`Some markdown with italic text`);
+  });
+});

package/dist/src/components/index.d.ts

@@ -1,12 +1,21 @@
-export * from "./Class.js";
-export { ClassMethod, type ClassMethodProps } from "./ClassMethod.jsx";
+export * from "./ClassDeclaration.jsx";
+export * from "./ClassMethod.jsx";
 export * from "./Declaration.js";
-export * from "./Enum.js";
+export * from "./doc/comment.jsx";
+export * from "./doc/from-markdown.jsx";
+export * from "./EnumDeclaration.jsx";
+export * from "./interface/declaration.js";
+export * from "./interface/method.js";
+export * from "./interface/property.js";
 export * from "./Name.js";
 export * from "./Namespace.js";
-export * from "./Parameters.js";
+export * from "./parameters/parameters.jsx";
 export * from "./ProjectDirectory.js";
+export * from "./property/property.jsx";
+export * from "./record/declaration.js";
 export * from "./Reference.js";
 export * from "./SourceFile.js";
+export type { TypeParameterProps } from "./type-parameters/type-parameter.jsx";
 export * from "./UsingDirective.js";
+export * from "./var/declaration.jsx";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/components/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,WAAW,EAAE,KAAK,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACvE,cAAc,kBAAkB,CAAC;AACjC,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,yBAAyB,CAAC;AACxC,cAAc,uBAAuB,CAAC;AACtC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,YAAY,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC"}

package/dist/src/components/index.js

@@ -1,11 +1,20 @@
-export * from "./Class.js";
-export { ClassMethod } from "./ClassMethod.js";
+export * from "./ClassDeclaration.js";
+export * from "./ClassMethod.js";
 export * from "./Declaration.js";
-export * from "./Enum.js";
+export * from "./doc/comment.js";
+export * from "./doc/from-markdown.js";
+export * from "./EnumDeclaration.js";
+export * from "./interface/declaration.js";
+export * from "./interface/method.js";
+export * from "./interface/property.js";
 export * from "./Name.js";
 export * from "./Namespace.js";
-export * from "./Parameters.js";
+export * from "./parameters/parameters.js";
 export * from "./ProjectDirectory.js";
+export * from "./property/property.js";
+export * from "./record/declaration.js";
 export * from "./Reference.js";
 export * from "./SourceFile.js";
-export * from "./UsingDirective.js";
+export * from "./UsingDirective.js";
+export * from "./var/declaration.js";
+export {};

package/dist/src/components/interface/declaration.d.ts

@@ -0,0 +1,47 @@
+import * as core from "@alloy-js/core";
+import { AccessModifiers } from "../../modifiers.js";
+import { TypeParameterProps } from "../type-parameters/type-parameter.jsx";
+export interface InterfaceModifiers {
+    readonly partial?: boolean;
+}
+export interface InterfaceDeclarationProps extends Omit<core.DeclarationProps, "nameKind">, AccessModifiers, InterfaceModifiers {
+    name: string;
+    /** Doc comment */
+    doc?: core.Children;
+    refkey?: core.Refkey;
+    /**
+     * Type parameters for the interface
+     *
+     * @example
+     * ```tsx
+     * <InterfaceDeclaration name="IList" typeParameters={["T"]} />
+     * ```
+     * This will produce:
+     * ```csharp
+     * public interface IList<T>
+     * ```
+     */
+    typeParameters?: (TypeParameterProps | string)[];
+}
+/**
+ * CSharp interface declaration.
+ * @example
+ * ```tsx
+ * <InterfaceDeclaration public name="IMyInterface">
+ *   <InterfaceMember public name="MyProperty" type="int" />
+ *   <InterfaceMethod public name="MyMethod" returnType="void">
+ *     <Parameter name="value" type="int" />
+ *   </InterfaceMethod>
+ * </InterfaceDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public interface MyIface
+ * {
+ *   public int MyProperty { get; set; }
+ *   public void MyMethod(int value);
+ * }
+ * ```
+ */
+export declare function InterfaceDeclaration(props: InterfaceDeclarationProps): core.Children;
+//# sourceMappingURL=declaration.d.ts.map

package/dist/src/components/interface/declaration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"declaration.d.ts","sourceRoot":"","sources":["../../../../src/components/interface/declaration.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gBAAgB,CAAC;AACvC,OAAO,EACL,eAAe,EAIhB,MAAM,oBAAoB,CAAC;AAO5B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uCAAuC,CAAC;AAG3E,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC5B;AAKD,MAAM,WAAW,yBACf,SAAQ,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAC7C,eAAe,EACf,kBAAkB;IACpB,IAAI,EAAE,MAAM,CAAC;IAEb,kBAAkB;IAClB,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC;IAErB;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,CAAC,kBAAkB,GAAG,MAAM,CAAC,EAAE,CAAC;CAClD;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,yBAAyB,iBAoCpE"}