@alloy-js/csharp 0.17.0 → 0.18.0-dev.11

package/src/components/{Class.tsx → ClassDeclaration.tsx}

@@ -1,26 +1,68 @@
 import * as core from "@alloy-js/core";
 import {
-  AccessModifier,
+  AccessModifiers,
+  computeModifiersPrefix,
   getAccessModifier,
-  getMethodModifier,
-  MethodModifier,
+  makeModifiers,
 } from "../modifiers.js";
 import { CSharpElements, useCSharpNamePolicy } from "../name-policy.js";
 import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
-import { Name } from "./Name.js";
-import { ParameterProps, Parameters } from "./Parameters.js";
+import { Name } from "./Name.jsx";
+import { ParameterProps, Parameters } from "./Parameters.jsx";
+import { DocWhen } from "./doc/comment.jsx";
+
+export interface ClassModifiers {
+  readonly abstract?: boolean;
+  readonly partial?: boolean;
+  readonly sealed?: boolean;
+  readonly static?: boolean;
+}
+
+const getClassModifiers = makeModifiers<ClassModifiers>([
+  "abstract",
+  "partial",
+  "sealed",
+  "static",
+]);
 
 // properties for creating a class
-export interface ClassProps extends Omit<core.DeclarationProps, "nameKind"> {
+export interface ClassDeclarationProps
+  extends Omit<core.DeclarationProps, "nameKind">,
+    AccessModifiers,
+    ClassModifiers {
   name: string;
+  /** Doc comment */
+  doc?: core.Children;
   refkey?: core.Refkey;
-  accessModifier?: AccessModifier;
   typeParameters?: Record<string, core.Refkey>;
 }
 
-// a C# class declaration
-export function Class(props: ClassProps) {
+/**
+ * CSharp class declaration.
+ * @example
+ * ```tsx
+ * <ClassDeclaration public name="MyClass">
+ *   <ClassMember public name="MyField" type="int" />
+ *   <ClassConstructor>
+ *     <Parameter name="value" type="int" />
+ *     this.MyField = value;
+ *   </ClassConstructor>
+ * </ClassDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public class MyClass
+ * {
+ *   public int MyField;
+ *   public MyClass(int value)
+ *   {
+ *     this.MyField = value;
+ *   }
+ * }
+ * ```
+ */
+export function ClassDeclaration(props: ClassDeclarationProps) {
   const name = useCSharpNamePolicy().getName(props.name!, "class");
 
   const thisClassSymbol = new CSharpOutputSymbol(name, {
@@ -60,9 +102,14 @@ export function Class(props: ClassProps) {
     );
   }
 
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getClassModifiers(props),
+  ]);
   return (
     <core.Declaration symbol={thisClassSymbol}>
-      {getAccessModifier(props.accessModifier)}class <Name />
+      <DocWhen doc={props.doc} />
+      {modifiers}class <Name />
       {typeParams}
       {!props.children && ";"}
       {props.children && (
@@ -74,8 +121,7 @@ export function Class(props: ClassProps) {
   );
 }
 
-export interface ClassConstructorProps {
-  accessModifier?: AccessModifier;
+export interface ClassConstructorProps extends AccessModifiers {
   parameters?: Array<ParameterProps>;
   refkey?: core.Refkey;
   symbol?: core.OutputSymbol;
@@ -103,7 +149,8 @@ export function ClassConstructor(props: ClassConstructorProps) {
     owner: ctorSymbol,
   });
 
-  const accessModifier = getAccessModifier(props.accessModifier);
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
+
   const params =
     props.parameters ? <Parameters parameters={props.parameters} /> : "";
 
@@ -111,7 +158,7 @@ export function ClassConstructor(props: ClassConstructorProps) {
   return (
     <core.Declaration symbol={ctorSymbol}>
       <core.Scope value={ctorDeclScope}>
-        {accessModifier}
+        {modifiers}
         <Name />({params})<core.Block newline>{props.children}</core.Block>
       </core.Scope>
     </core.Declaration>
@@ -119,17 +166,18 @@ export function ClassConstructor(props: ClassConstructorProps) {
 }
 
 // properties for creating a class member
-export interface ClassMemberProps {
+export interface ClassMemberProps extends AccessModifiers {
   name: string;
   type: core.Children;
-  accessModifier?: AccessModifier;
   refkey?: core.Refkey;
+  /** Doc comment */
+  doc?: core.Children;
 }
 
 // a C# class member (i.e. a field within a class like "private int count")
 export function ClassMember(props: ClassMemberProps) {
   let nameElement: CSharpElements = "class-member-private";
-  if (props.accessModifier === "public") {
+  if (props.public) {
     nameElement = "class-member-public";
   }
   const name = useCSharpNamePolicy().getName(props.name, nameElement);
@@ -145,58 +193,12 @@ export function ClassMember(props: ClassMemberProps) {
     refkeys: props.refkey ?? core.refkey(props.name),
   });
 
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
   return (
     <core.Declaration symbol={memberSymbol}>
-      {getAccessModifier(props.accessModifier)}
+      <DocWhen doc={props.doc} />
+      {modifiers}
       {props.type} <Name />
     </core.Declaration>
   );
 }
-
-// properties for creating a method
-export interface ClassMethodProps {
-  name: string;
-  refkey?: core.Refkey;
-  children?: core.Children;
-  accessModifier?: AccessModifier;
-  methodModifier?: MethodModifier;
-  parameters?: Array<ParameterProps>;
-  returns?: core.Children;
-}
-
-// a C# class method
-export function ClassMethod(props: ClassMethodProps) {
-  const name = useCSharpNamePolicy().getName(props.name!, "class-method");
-  const scope = useCSharpScope();
-  if (scope.kind !== "member" || scope.name !== "class-decl") {
-    throw new Error("can't define a class method outside of a class scope");
-  }
-
-  const methodSymbol = new CSharpOutputSymbol(name, {
-    scope,
-    refkeys: props.refkey ?? core.refkey(props.name),
-  });
-
-  // scope for method declaration
-  const methodScope = new CSharpMemberScope("method-decl", {
-    owner: methodSymbol,
-  });
-
-  const accessModifier = getAccessModifier(props.accessModifier);
-  const methodModifier = getMethodModifier(props.methodModifier);
-  const params =
-    props.parameters ? <Parameters parameters={props.parameters} /> : "";
-  const returns = props.returns ?? "void";
-
-  // note that scope wraps the method decl so that the params get the correct scope
-  return (
-    <core.Declaration symbol={methodSymbol}>
-      <core.Scope value={methodScope}>
-        {accessModifier}
-        {methodModifier}
-        {returns} <Name />({params})
-        <core.Block newline>{props.children}</core.Block>
-      </core.Scope>
-    </core.Declaration>
-  );
-}

package/src/components/ClassMethod.tsx

@@ -0,0 +1,94 @@
+import {
+  Block,
+  Children,
+  MemberDeclaration,
+  refkey,
+  Refkey,
+  Scope,
+} from "@alloy-js/core";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+  getAsyncModifier,
+  makeModifiers,
+} from "../modifiers.js";
+import { useCSharpNamePolicy } from "../name-policy.js";
+import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
+import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
+import { ParameterProps, Parameters } from "./Parameters.jsx";
+import { DocWhen } from "./doc/comment.jsx";
+
+/** Method modifiers. Can only be one. */
+export interface ClassMethodModifiers {
+  readonly abstract?: boolean;
+  readonly sealed?: boolean;
+  readonly static?: boolean;
+  readonly virtual?: boolean;
+}
+
+const getMethodModifier = makeModifiers<ClassMethodModifiers>([
+  "abstract",
+  "sealed",
+  "static",
+  "virtual",
+]);
+
+// properties for creating a method
+export interface ClassMethodProps
+  extends AccessModifiers,
+    ClassMethodModifiers {
+  name: string;
+  refkey?: Refkey;
+  children?: Children;
+  parameters?: Array<ParameterProps>;
+  returns?: Children;
+
+  /**
+   * If true, the method will be declared as an async method.
+   */
+  async?: boolean;
+
+  /** Doc comment */
+  doc?: Children;
+}
+
+// a C# class method
+export function ClassMethod(props: ClassMethodProps) {
+  const name = useCSharpNamePolicy().getName(props.name, "class-method");
+  const scope = useCSharpScope();
+  if (scope.kind !== "member" || scope.name !== "class-decl") {
+    throw new Error("can't define a class method outside of a class scope");
+  }
+
+  const methodSymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name),
+  });
+
+  // scope for method declaration
+  const methodScope = new CSharpMemberScope("method-decl", {
+    owner: methodSymbol,
+  });
+
+  const params =
+    props.parameters ? <Parameters parameters={props.parameters} /> : "";
+  const returns = props.returns ?? (props.async ? "Task" : "void");
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getMethodModifier(props),
+    getAsyncModifier(props.async),
+  ]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return (
+    <MemberDeclaration symbol={methodSymbol}>
+      <Scope value={methodScope}>
+        <DocWhen doc={props.doc} />
+        {modifiers}
+        {returns} {name}({params})
+        {props.abstract ? ";" : <Block newline>{props.children}</Block>}
+      </Scope>
+    </MemberDeclaration>
+  );
+}

package/src/components/{Enum.tsx → EnumDeclaration.tsx}

@@ -1,20 +1,42 @@
 import * as core from "@alloy-js/core";
-import { AccessModifier, getAccessModifier } from "../modifiers.js";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+} from "../modifiers.js";
 import { useCSharpNamePolicy } from "../name-policy.js";
 import { CSharpOutputSymbol } from "../symbols/csharp-output-symbol.js";
 import { CSharpMemberScope, useCSharpScope } from "../symbols/scopes.js";
 import { Name } from "./Name.jsx";
 
 // properties for creating an enum
-export interface EnumProps {
+export interface EnumDeclarationProps extends AccessModifiers {
   name: string;
   refkey?: core.Refkey;
   children?: core.Children;
-  accessModifier?: AccessModifier;
 }
 
-// a C# enum declaration
-export function Enum(props: EnumProps) {
+/**
+ * A C# enum declaration
+ * @example
+ * ```tsx
+ * <EnumDeclaration public name="Color">
+ *   <EnumMember name="Red" />
+ *   <EnumMember name="Green" />
+ *   <EnumMember name="Blue" />
+ * </EnumDeclaration>
+ * ```
+ * This will produce:
+ * ```csharp
+ * public enum Color
+ * {
+ *   Red,
+ *   Green,
+ *   Blue
+ * }
+ * ```
+ */
+export function EnumDeclaration(props: EnumDeclarationProps) {
   const name = useCSharpNamePolicy().getName(props.name!, "enum");
   const scope = useCSharpScope();
 
@@ -32,10 +54,12 @@ export function Enum(props: EnumProps) {
     owner: thisEnumSymbol,
   });
 
+  const modifiers = computeModifiersPrefix([getAccessModifier(props)]);
+
   if (thisEnumScope.owner)
     return (
       <core.Declaration symbol={thisEnumSymbol}>
-        {getAccessModifier(props.accessModifier)}enum <Name />
+        {modifiers}enum <Name />
         {!props.children && ";"}
         {props.children && (
           <core.Scope value={thisEnumScope}>

package/src/components/class/property.test.tsx

@@ -0,0 +1,180 @@
+import { Children } from "@alloy-js/core/jsx-runtime";
+import { describe, expect, it } from "vitest";
+import { TestNamespace } from "../../../test/utils.jsx";
+import { ClassDeclaration } from "../ClassDeclaration.jsx";
+import { ClassProperty } from "./property.jsx";
+
+const Wrapper = (props: { children: Children }) => (
+  <TestNamespace>
+    <ClassDeclaration public name="TestClass">
+      {props.children}
+    </ClassDeclaration>
+  </TestNamespace>
+);
+
+describe("modifiers", () => {
+  describe("access modifiers", () => {
+    it.each(["public", "private", "protected", "internal"] as const)(
+      "%s",
+      (accessModifier) => {
+        expect(
+          <Wrapper>
+            <ClassProperty
+              {...{ [accessModifier]: true }}
+              name="TestProp"
+              type="string"
+              get
+            />
+          </Wrapper>,
+        ).toRenderTo(`
+        public class TestClass
+        {
+          ${accessModifier} string TestProp { get; }
+        }
+      `);
+      },
+    );
+  });
+
+  describe("property modifiers", () => {
+    it.each([
+      "new",
+      "static",
+      "virtual",
+      "sealed",
+      "override",
+      "abstract",
+      "extern",
+      "readonly",
+    ] as const)("%s", (methodModifier) => {
+      expect(
+        <Wrapper>
+          <ClassProperty
+            {...{ [methodModifier]: true }}
+            name="TestProp"
+            type="string"
+            get
+          />
+        </Wrapper>,
+      ).toRenderTo(`
+        public class TestClass
+        {
+          ${methodModifier} string TestProp { get; }
+        }
+      `);
+    });
+  });
+
+  it("combine modifiers", () => {
+    expect(
+      <Wrapper>
+        <ClassProperty public new name="TestProp" type="string" get />
+      </Wrapper>,
+    ).toRenderTo(`
+        public class TestClass
+        {
+          public new string TestProp { get; }
+        }
+      `);
+  });
+});
+
+it("applies PascalCase naming policy", () => {
+  expect(
+    <Wrapper>
+      <ClassProperty name="test_prop" type="string" get />
+    </Wrapper>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; }
+    }
+`);
+});
+
+it("has getter only", () => {
+  expect(
+    <Wrapper>
+      <ClassProperty name="TestProp" type="string" get />
+    </Wrapper>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; }
+    }
+  `);
+});
+
+it("has setter only", () => {
+  expect(
+    <Wrapper>
+      <ClassProperty name="TestProp" type="string" set />
+    </Wrapper>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { set; }
+    }
+  `);
+});
+
+it("has getter and setter", () => {
+  expect(
+    <Wrapper>
+      <ClassProperty name="TestProp" type="string" get set />
+    </Wrapper>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; set; }
+    }
+  `);
+});
+
+it("specify doc comment", () => {
+  expect(
+    <TestNamespace>
+      <ClassDeclaration name="Test">
+        <ClassProperty
+          name="Method"
+          type="string"
+          get
+          set
+          doc="This is a test"
+        />
+      </ClassDeclaration>
+    </TestNamespace>,
+  ).toRenderTo(`
+    class Test
+    {
+      /// This is a test
+      string Method { get; set; }
+    }
+  `);
+});
+
+it("specify nullable property", () => {
+  expect(
+    <Wrapper>
+      <ClassProperty name="TestProp" type="string" nullable get set />
+    </Wrapper>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+      string? TestProp { get; set; }
+    }
+  `);
+});
+
+it("specify initializer", () => {
+  expect(
+    <Wrapper>
+      <ClassProperty name="TestProp" type="string" get set init={`"abc"`} />
+    </Wrapper>,
+  ).toRenderTo(`
+    public class TestClass
+    {
+      string TestProp { get; set; } = "abc";
+    }
+  `);
+});

package/src/components/class/property.tsx

@@ -0,0 +1,135 @@
+import {
+  Block,
+  Children,
+  code,
+  List,
+  MemberDeclaration,
+  refkey,
+  Refkey,
+  Scope,
+} from "@alloy-js/core";
+import {
+  AccessModifiers,
+  computeModifiersPrefix,
+  getAccessModifier,
+  makeModifiers,
+} from "../../modifiers.js";
+import { useCSharpNamePolicy } from "../../name-policy.js";
+import { CSharpOutputSymbol } from "../../symbols/csharp-output-symbol.js";
+import { CSharpMemberScope, useCSharpScope } from "../../symbols/scopes.js";
+import { DocWhen } from "../doc/comment.jsx";
+
+/** Method modifiers. Can only be one. */
+export interface ClassPropertyModifiers {
+  readonly new?: boolean;
+  readonly static?: boolean;
+  readonly virtual?: boolean;
+  readonly sealed?: boolean;
+  readonly override?: boolean;
+  readonly abstract?: boolean;
+  readonly extern?: boolean;
+  readonly readonly?: boolean;
+}
+
+const getModifiers = makeModifiers<ClassPropertyModifiers>([
+  "new",
+  "static",
+  "virtual",
+  "sealed",
+  "override",
+  "abstract",
+  "extern",
+  "readonly",
+]);
+
+/** Properties for {@link ClassProperty} component */
+export interface ClassPropertyProps
+  extends AccessModifiers,
+    ClassPropertyModifiers {
+  name: string;
+  refkey?: Refkey;
+
+  /** Property type */
+  type: Children;
+
+  /** If property should have a getter */
+  get?: boolean;
+
+  /** If property should have a setter */
+  set?: boolean;
+
+  /** Doc comment */
+  doc?: Children;
+
+  /**
+   * Property initializer
+   * @example `<ClassProperty name="My" get set nullable />`
+   *
+   * ```cs
+   * int? My { get; set; };
+   * ```
+   */
+  nullable?: boolean;
+
+  /**
+   * Property initializer
+   * @example `<ClassProperty name="My" get set init={42} />`
+   *
+   * ```cs
+   * int My { get; set; } = 42;
+   * ```
+   */
+  init?: Children;
+}
+
+/**
+ * Render a C# class property.
+ *
+ * @example `<ClassProperty public name="My" get set  />`
+ *
+ * ```cs
+ * public int My { get; set; };
+ * ```
+ */
+export function ClassProperty(props: ClassPropertyProps) {
+  const name = useCSharpNamePolicy().getName(props.name, "class-property");
+  const scope = useCSharpScope();
+  if (scope.kind !== "member" || scope.name !== "class-decl") {
+    throw new Error(
+      "can't define an interface method outside of an interface scope",
+    );
+  }
+
+  const propertySymbol = new CSharpOutputSymbol(name, {
+    scope,
+    refkeys: props.refkey ?? refkey(props.name),
+  });
+
+  // scope for property declaration
+  const propertyScope = new CSharpMemberScope("property-decl", {
+    owner: propertySymbol,
+  });
+
+  const modifiers = computeModifiersPrefix([
+    getAccessModifier(props),
+    getModifiers(props),
+  ]);
+  // note that scope wraps the method decl so that the params get the correct scope
+  return (
+    <MemberDeclaration symbol={propertySymbol}>
+      <Scope value={propertyScope}>
+        <DocWhen doc={props.doc} />
+        {modifiers}
+        {props.type}
+        {props.nullable && "?"} {name}{" "}
+        <Block newline inline>
+          <List joiner=" ">
+            {props.get && "get;"}
+            {props.set && "set;"}
+          </List>
+        </Block>
+        {props.init && code` = ${props.init};`}
+      </Scope>
+    </MemberDeclaration>
+  );
+}